External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-11-08 14:29:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
a863b89010
libvirt/docs/formatdomain.html.in

5207 lines
212 KiB
HTML
Raw Normal View History

Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
Split website out into one file per page. APply new layout and styling
2008-04-23 17:08:31 +00:00
<body>
<h1>Domain XML format</h1>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<ul id="toc"></ul>
<p>
This section describes the XML format used to represent domains, there are
variations on the format based on the kind of domains run and the options
used to launch them. For hypervisor specific details consult the
<a href="drivers.html">driver docs</a>
</p>
<h2><a name="elements">Element and attribute overview</a></h2>
<p>
The root element required for all virtual machines is
named <code>domain</code>. It has two attributes, the
<code>type</code> specifies the hypervisor used for running
the domain. The allowed values are driver specific, but
include "xen", "kvm", "qemu", "lxc" and "kqemu". The
second attribute is <code>id</code> which is a unique
integer identifier for the running guest machine. Inactive
machines have no id value.
</p>
<h3><a name="elementsMetadata">General metadata</a></h3>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
&lt;domain type='xen' id='3'&gt;
&lt;name&gt;fv0&lt;/name&gt;
&lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
xml: Add element <title> to allow short description of domains This patch adds a new element <title> to the domain XML. This attribute can hold a short title defined by the user to ease the identification of domains. The title may not contain newlines and should be reasonably short. *docs/formatdomain.html.in *docs/schemas/domaincommon.rng - add schema grammar for the new element and documentation *src/conf/domain_conf.c *src/conf/domain_conf.h - add field to hold the new attribute - add code to parse and create XML with the new attribute
2012-02-01 13:03:49 +00:00
&lt;title&gt;A short description - title - of the domain&lt;/title&gt;
docs: domain: Document <description> element
2010-02-22 21:06:04 +00:00
&lt;description&gt;Some human readable description&lt;/description&gt;
metadata: group metadata next to description It's better to group all the metadata together. This is a cosmetic output change; since the RNG allows interleave, it doesn't matter where the user stuck it on input, and an XPath query will find the same information when parsing the output. * src/conf/domain_conf.c (virDomainDefFormatInternal): Output metadata earlier. * docs/formatdomain.html.in: Update documentation. * tests/domainsnapshotxml2xmlout/metadata.xml: Update test. * tests/qemuxml2xmloutdata/qemuxml2xmlout-metadata.xml: Likewise.
2012-01-25 00:26:38 +00:00
&lt;metadata&gt;
&lt;app1:foo xmlns:app1="http://app1.org/app1/"&gt;..&lt;/app1:foo&gt;
&lt;app2:bar xmlns:app2="http://app1.org/app2/"&gt;..&lt;/app2:bar&gt;
&lt;/metadata&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>name</code></dt>
<dd>The content of the <code>name</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
a short name for the virtual machine. This name should
consist only of alpha-numeric characters and is required
to be unique within the scope of a single host. It is
often used to form the filename for storing the persistent
configuration file. <span class="since">Since 0.0.1</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>uuid</code></dt>
<dd>The content of the <code>uuid</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
a globally unique identifier for the virtual machine.
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
The format must be RFC 4122 compliant,
eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
If omitted when defining/creating a new machine, a random
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
UUID is generated. It is also possible to provide the UUID
via a <a href="#elementsSysinfo"><code>sysinfo</code></a>
specification. <span class="since">Since 0.0.1, sysinfo
since 0.8.7</span></dd>
docs: domain: Document <description> element
2010-02-22 21:06:04 +00:00
xml: Add element <title> to allow short description of domains This patch adds a new element <title> to the domain XML. This attribute can hold a short title defined by the user to ease the identification of domains. The title may not contain newlines and should be reasonably short. *docs/formatdomain.html.in *docs/schemas/domaincommon.rng - add schema grammar for the new element and documentation *src/conf/domain_conf.c *src/conf/domain_conf.h - add field to hold the new attribute - add code to parse and create XML with the new attribute
2012-02-01 13:03:49 +00:00
<dt><code>title</code></dt>
<dd>The optional element <code>title</code> provides space for a
short description of the domain. The title should not contain
any newlines. <span class="since">Since 0.9.10</span>.</dd>
docs: domain: Document <description> element
2010-02-22 21:06:04 +00:00
<dt><code>description</code></dt>
<dd>The content of the <code>description</code> element provides a
metadata: group metadata next to description It's better to group all the metadata together. This is a cosmetic output change; since the RNG allows interleave, it doesn't matter where the user stuck it on input, and an XPath query will find the same information when parsing the output. * src/conf/domain_conf.c (virDomainDefFormatInternal): Output metadata earlier. * docs/formatdomain.html.in: Update documentation. * tests/domainsnapshotxml2xmlout/metadata.xml: Update test. * tests/qemuxml2xmloutdata/qemuxml2xmlout-metadata.xml: Likewise.
2012-01-25 00:26:38 +00:00
human readable description of the virtual machine. This data is not
used by libvirt in any way, it can contain any information the user
wants. <span class="since">Since 0.7.2</span></dd>
<dt><code>metadata</code></dt>
<dd>The <code>metadata</code> node can be used by applications
to store custom metadata in the form of XML
nodes/trees. Applications must use custom namespaces on their
XML nodes/trees, with only one top-level element per namespace
(if the application needs structure, they should have
sub-elements to their namespace
element). <span class="since">Since 0.9.10</span></dd>
xml: Add element <title> to allow short description of domains This patch adds a new element <title> to the domain XML. This attribute can hold a short title defined by the user to ease the identification of domains. The title may not contain newlines and should be reasonably short. *docs/formatdomain.html.in *docs/schemas/domaincommon.rng - add schema grammar for the new element and documentation *src/conf/domain_conf.c *src/conf/domain_conf.h - add field to hold the new attribute - add code to parse and create XML with the new attribute
2012-02-01 13:03:49 +00:00
</dl>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h3><a name="elementsOS">Operating system booting</a></h3>
<p>
There are a number of different ways to boot virtual machines
each with their own pros and cons.
</p>
<h4><a name="elementsOSBIOS">BIOS bootloader</a></h4>
<p>
Booting via the BIOS is available for hypervisors supporting
full virtualization. In this case the BIOS has a boot order
priority (floppy, harddisk, cdrom, network) determining where
to obtain/find the boot image.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;os&gt;
&lt;type&gt;hvm&lt;/type&gt;
&lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
&lt;boot dev='hd'/&gt;
qemu: Allow setting boot menu on/off Add a new element to the <os> block: <bootmenu enable="yes|no"/> Which maps to -boot,menu=on|off on the QEMU command line. I decided to use an explicit 'enable' attribute rather than just make the bootmenu element boolean. This allows us to treat lack of a bootmenu element as 'use hypervisor default'.
2010-07-26 14:28:58 +00:00
&lt;boot dev='cdrom'/&gt;
&lt;bootmenu enable='yes'/&gt;
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
&lt;smbios mode='sysinfo'/&gt;
Add support for reboot-timeout Whenever the guest machine fails to boot, new parameter (reboot-timeout) controls whether it should reboot and after how many ms it should do so. Docs included.
2012-09-18 10:30:52 +00:00
&lt;bios useserial='yes' rebootTimeout='0'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/os&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>type</code></dt>
<dd>The content of the <code>type</code> element specifies the
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
type of operating system to be booted in the virtual machine.
<code>hvm</code> indicates that the OS is one designed to run
on bare metal, so requires full virtualization. <code>linux</code>
(badly named!) refers to an OS that supports the Xen 3 hypervisor
guest ABI. There are also two optional attributes, <code>arch</code>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
specifying the CPU architecture to virtualization,
and <code>machine</code> referring to the machine
type. The <a href="formatcaps.html">Capabilities XML</a>
provides details on allowed values for
these. <span class="since">Since 0.0.1</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>loader</code></dt>
<dd>The optional <code>loader</code> tag refers to a firmware blob
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
used to assist the domain creation process. At this time, it is
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
only needed by Xen fully virtualized
domains. <span class="since">Since 0.1.0</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>boot</code></dt>
<dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
"cdrom" or "network" and is used to specify the next boot device
to consider. The <code>boot</code> element can be repeated multiple
docs: Enhance documentation of the old-style boot configuration Also encourages people to use per-device boot elements for better control.
2012-02-03 12:33:36 +00:00
times to setup a priority list of boot devices to try in turn.
Multiple devices of the same type are sorted according to their
targets while preserving the order of buses. After defining the
domain, its XML configuration returned by libvirt (through
virDomainGetXMLDesc) lists devices in the sorted order. Once sorted,
the first device is marked as bootable. Thus, e.g., a domain
configured to boot from "hd" with vdb, hda, vda, and hdc disks
assigned to it will boot from vda (the sorted list is vda, vdb, hda,
hdc). Similar domain with hdc, vda, vdb, and hda disks will boot from
hda (sorted disks are: hda, hdc, vda, vdb). It can be tricky to
configure in the desired way, which is why per-device boot elements
(see <a href="#elementsDisks">disks</a>,
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
<a href="#elementsNICS">network interfaces</a>, and
doc: Fix reference to #elementsUSB aae0fc2a922b3e31dae7648c547fca2ac2587625 removed the #elementsUSB anchor but did not update the links to point to the new section #elementsHostDev. Signed-off-by: Philipp Hahn <hahn@univention.de>
2013-06-28 17:06:30 +00:00
<a href="#elementsHostDev">USB and PCI devices</a> sections below) were
docs: Enhance documentation of the old-style boot configuration Also encourages people to use per-device boot elements for better control.
2012-02-03 12:33:36 +00:00
introduced and they are the preferred way providing full control over
booting order. The <code>boot</code> element and per-device boot
elements are mutually exclusive. <span class="since">Since 0.1.3,
per-device boot since 0.8.8</span>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
qemu: Allow setting boot menu on/off Add a new element to the <os> block: <bootmenu enable="yes|no"/> Which maps to -boot,menu=on|off on the QEMU command line. I decided to use an explicit 'enable' attribute rather than just make the bootmenu element boolean. This allows us to treat lack of a bootmenu element as 'use hypervisor default'.
2010-07-26 14:28:58 +00:00
<dt><code>bootmenu</code></dt>
<dd> Whether or not to enable an interactive boot menu prompt on guest
startup. The <code>enable</code> attribute can be either "yes" or "no".
If not specified, the hypervisor default is used. <span class="since">
Since 0.8.3</span>
</dd>
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
<dt><code>smbios</code></dt>
<dd>How to populate SMBIOS information visible in the guest.
The <code>mode</code> attribute must be specified, and is either
"emulate" (let the hypervisor generate all values), "host" (copy
all of Block 0 and Block 1, except for the UUID, from the host's
sysinfo: implement the public API * src/libvirt.c (virConnectGetSysinfo): New function. * docs/formatdomain.html.in: Mention it.
2011-02-07 21:48:24 +00:00
SMBIOS values;
the <a href="html/libvirt-libvirt.html#virConnectGetSysinfo">
<code>virConnectGetSysinfo</code></a> call can be
used to see what values are copied), or "sysinfo" (use the values in
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
the <a href="#elementsSysinfo">sysinfo</a> element). If not
specified, the hypervisor default is used. <span class="since">
Since 0.8.7</span>
</dd>
bios: Add support for SGA This patch creates new <bios> element which, at this time has only the attribute useserial='yes|no'. This attribute allow users to use Serial Graphics Adapter and see BIOS messages from the very first moment domain boots up. Therefore, users can choose boot medium, set PXE, etc.
2011-07-08 07:56:17 +00:00
<dt><code>bios</code></dt>
<dd>This element has attribute <code>useserial</code> with possible
values <code>yes</code> or <code>no</code>. It enables or disables
Serial Graphics Adapter which allows users to see BIOS messages
on a serial port. Therefore, one needs to have
<a href="#elementCharSerial">serial port</a> defined.
Add support for reboot-timeout Whenever the guest machine fails to boot, new parameter (reboot-timeout) controls whether it should reboot and after how many ms it should do so. Docs included.
2012-09-18 10:30:52 +00:00
<span class="since">Since 0.9.4</span>.
<span class="since">Since 0.10.2 (QEMU only)</span> there is
another attribute, <code>rebootTimeout</code> that controls
whether and after how long the guest should start booting
again in case the boot fails (according to BIOS). The value is
in milliseconds with maximum of <code>65535</code> and special
value <code>-1</code> disables the reboot.
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
<h4><a name="elementsOSBootloader">Host bootloader</a></h4>
<p>
Hypervisors employing paravirtualization do not usually emulate
a BIOS, and instead the host is responsible to kicking off the
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
operating system boot. This may use a pseudo-bootloader in the
Update domain XML docs
2008-05-08 14:20:07 +00:00
host to provide an interface to choose a kernel for the guest.
An example is <code>pygrub</code> with Xen.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
&lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>bootloader</code></dt>
<dd>The content of the <code>bootloader</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
a fully qualified path to the bootloader executable in the
host OS. This bootloader will be run to choose which kernel
to boot. The required output of the bootloader is dependent
on the hypervisor in use. <span class="since">Since 0.1.0</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>bootloader_args</code></dt>
<dd>The optional <code>bootloader_args</code> element allows
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
command line arguments to be passed to the bootloader.
<span class="since">Since 0.2.3</span>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
<h4><a name="elementsOSKernel">Direct kernel boot</a></h4>
<p>
When installing a new guest OS it is often useful to boot directly
from a kernel and initrd stored in the host OS, allowing command
line arguments to be passed directly to the installer. This capability
is usually available for both para and full virtualized guests.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;os&gt;
&lt;type&gt;hvm&lt;/type&gt;
&lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
&lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
&lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
&lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
conf: support <dtb> tag in XML domain file
2013-03-14 04:49:42 +00:00
&lt;dtb&gt;/root/ppc.dtb&lt;/dtb&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/os&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>type</code></dt>
<dd>This element has the same semantics as described earlier in the
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<a href="#elementsOSBIOS">BIOS boot section</a></dd>
"copy-paste" errors * docs/formatdomain.html docs/formatdomain.html.in: Anton Protopopov pointed out a few "copy-paste" errors daniel
2008-05-22 14:57:32 +00:00
<dt><code>loader</code></dt>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dd>This element has the same semantics as described earlier in the
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<a href="#elementsOSBIOS">BIOS boot section</a></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>kernel</code></dt>
<dd>The contents of this element specify the fully-qualified path
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to the kernel image in the host OS.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>initrd</code></dt>
<dd>The contents of this element specify the fully-qualified path
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to the (optional) ramdisk image in the host OS.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>cmdline</code></dt>
<dd>The contents of this element specify arguments to be passed to
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
the kernel (or installer) at boot time. This is often used to
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
specify an alternate primary console (eg serial port), or the
installation media source / kickstart file</dd>
conf: support <dtb> tag in XML domain file
2013-03-14 04:49:42 +00:00
<dt><code>dtb</code></dt>
<dd>The contents of this element specify the fully-qualified path
to the (optional) device tree binary (dtb) image in the host OS.
<span class="since">Since 1.0.4</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
Update docs about user namespace for LXC Mention that user namespace can be enabled using the UID/GID mapping schema. Fix typo in link anchor for container args in domain XML docs. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-09-10 09:00:15 +00:00
<h4><a name="elementsOSContainer">Container boot</a></h4>
Add support for setting init argv for LXC Pass argv to the init binary of LXC, using a new <initarg> element. * docs/formatdomain.html.in: Document <os> usage for containers * docs/schemas/domaincommon.rng: Add <initarg> element * src/conf/domain_conf.c, src/conf/domain_conf.h: parsing and formatting of <initarg> * src/lxc/lxc_container.c: Setup LXC argv * tests/Makefile.am, tests/lxcxml2xmldata/lxc-systemd.xml, tests/lxcxml2xmltest.c, tests/testutilslxc.c, tests/testutilslxc.h: Test parsing/formatting of LXC related XML parts
2012-03-26 17:09:31 +00:00
<p>
When booting a domain using container based virtualization, instead
of a kernel / boot image, a path to the init binary is required, using
the <code>init</code> element. By default this will be launched with
no arguments. To specify the initial argv, use the <code>initarg</code>
element, repeated as many time as is required. The <code>cmdline</code>
element, if set will be used to provide an equivalent to <code>/proc/cmdline</code>
but will not effect init argv.
</p>
<pre>
&lt;os&gt;
&lt;type arch='x86_64'&gt;exe&lt;/type&gt;
&lt;init&gt;/bin/systemd&lt;/init&gt;
&lt;initarg&gt;--unit&lt;/initarg&gt;
&lt;initarg&gt;emergency.service&lt;/initarg&gt;
&lt;/os&gt;
</pre>
LXC: Introduce New XML element for user namespace This patch introduces new element <idmap> for user namespace. for example <idmap> <uid start='0' target='1000' count='10'/> <gid start='0' target='1000' count='10'/> </idmap> this new element is used for setting proc files /proc/<pid>/{uid_map,gid_map}. This patch also supports multiple uid/gid elements setting in XML configuration. We don't support the semi configuation, user has to configure uid and gid both. Signed-off-by: Gao feng <gaofeng@cn.fujitsu.com>
2013-06-07 07:12:18 +00:00
<p>
If you want to enable user namespace,set the <code>idmap</code> element.
the <code>uid</code> and <code>gid</code> elements have three attributes:
</p>
<dl>
<dt><code>start</code></dt>
<dd>First user id in container.</dd>
<dt><code>target</code></dt>
<dd>The first user id in container will be mapped to this target user
id in host.</dd>
<dt><code>count</code></dt>
<dd>How many users in container being allowed to map to host's user.</dd>
</dl>
<pre>
&lt;idmap&gt;
&lt;uid start='0' target='1000' count='10'/&gt;
&lt;gid start='0' target='1000' count='10'/&gt;
&lt;/idmap&gt;
</pre>
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
<h3><a name="elementsSysinfo">SMBIOS System Information</a></h3>
<p>
Some hypervisors allow control over what system information is
presented to the guest (for example, SMBIOS fields can be
populated by a hypervisor and inspected via
the <code>dmidecode</code> command in the guest). The
optional <code>sysinfo</code> element covers all such categories
of information. <span class="since">Since 0.8.7</span>
</p>
<pre>
...
&lt;os&gt;
&lt;smbios mode='sysinfo'/&gt;
...
&lt;/os&gt;
&lt;sysinfo type='smbios'&gt;
&lt;bios&gt;
&lt;entry name='vendor'&gt;LENOVO&lt;/entry&gt;
&lt;/bios&gt;
&lt;system&gt;
&lt;entry name='manufacturer'&gt;Fedora&lt;/entry&gt;
docs: Fix/update syntax in Sysinfo/SMBIOS description
2013-04-25 20:42:31 +00:00
&lt;entry name='product'&gt;Virt-Manager&lt;/entry&gt;
&lt;entry name='version'&gt;0.9.4&lt;/entry&gt;
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
&lt;/system&gt;
&lt;/sysinfo&gt;
...</pre>
<p>
The <code>sysinfo</code> element has a mandatory
attribute <code>type</code> that determine the layout of
sub-elements, with supported values of:
</p>
<dl>
<dt><code>smbios</code></dt>
<dd>Sub-elements call out specific SMBIOS values, which will
affect the guest if used in conjunction with
the <code>smbios</code> sub-element of
the <a href="#elementsOS"><code>os</code></a> element. Each
sub-element of <code>sysinfo</code> names a SMBIOS block, and
within those elements can be a list of <code>entry</code>
elements that describe a field within the block. The following
blocks and entries are recognized:
<dl>
<dt><code>bios</code></dt>
<dd>
docs: Fix/update syntax in Sysinfo/SMBIOS description
2013-04-25 20:42:31 +00:00
This is block 0 of SMBIOS, with entry names drawn from:
<dl>
<dt><code>vendor</code></dt>
<dd>BIOS Vendor's Name</dd>
<dt><code>version</code></dt>
<dd>BIOS Version</dd>
<dt><code>date</code></dt>
<dd>BIOS release date. If supplied, is in either mm/dd/yy or
mm/dd/yyyy format. If the year portion of the string is
two digits, the year is assumed to be 19yy.</dd>
<dt><code>release</code></dt>
<dd>System BIOS Major and Minor release number values
concatenated together as one string separated by
a period, for example, 10.22.</dd>
</dl>
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
</dd>
<dt><code>system</code></dt>
<dd>
docs: Fix/update syntax in Sysinfo/SMBIOS description
2013-04-25 20:42:31 +00:00
This is block 1 of SMBIOS, with entry names drawn from:
<dl>
<dt><code>manufacturer</code></dt>
<dd>Manufacturer of BIOS</dd>
<dt><code>product</code></dt>
<dd>Product Name</dd>
<dt><code>version</code></dt>
<dd>Version of the product</dd>
<dt><code>serial</code></dt>
<dd>Serial number</dd>
<dt><code>uuid</code></dt>
<dd>Universal Unique ID number. If this entry is provided
alongside a top-level
<a href="#elementsMetadata"><code>uuid</code></a> element,
then the two values must match.</dd>
<dt><code>sku</code></dt>
<dd>SKU number to identify a particular configuration.</dd>
<dt><code>family</code></dt>
<dd>Identify the family a particular computer belongs to.</dd>
</dl>
NB: Incorrectly supplied entries in either the <code>bios</code>
or <code>system</code> blocks will be ignored without error.
Other than <code>uuid</code> validation and <code>date</code>
format checking, all values are passed as strings to the
hypervisor driver.
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
</dd>
</dl>
</dd>
</dl>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<h3><a name="elementsCPUAllocation">CPU Allocation</a></h3>
Update domain XML docs
2008-05-08 14:20:07 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&lt;domain&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...
qemu: Support numad numad is an user-level daemon that monitors NUMA topology and processes resource consumption to facilitate good NUMA resource alignment of applications/virtual machines to improve performance and minimize cost of remote memory latencies. It provides a pre-placement advisory interface, so significant processes can be pre-bound to nodes with sufficient available resources. More details: http://fedoraproject.org/wiki/Features/numad "numad -w ncpus:memory_amount" is the advisory interface numad provides currently. This patch add the support by introducing a new XML attribute for <vcpu>. e.g. <vcpu placement="auto">4</vcpu> <vcpu placement="static" cpuset="1-10^6">4</vcpu> The returned advisory nodeset from numad will be printed in domain's dumped XML. e.g. <vcpu placement="auto" cpuset="1-10^6">4</vcpu> If placement is "auto", the number of vcpus and the current memory amount specified in domain XML will be used for numad command line (numad uses MB for memory amount): numad -w $num_of_vcpus:$current_memory_amount / 1024 The advisory nodeset returned from numad will be used to set domain process CPU affinity then. (e.g. qemuProcessInitCpuAffinity). If the user specifies both CPU affinity policy (e.g. (<vcpu cpuset="1-10,^7,^8">4</vcpu>) and placement == "auto" the specified CPU affinity will be overridden. Only QEMU/KVM drivers support it now. See docs update in patch for more details.
2012-03-08 13:36:26 +00:00
&lt;vcpu placement='static' cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
...
&lt;/domain&gt;
</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>vcpu</code></dt>
vcpu: add current attribute to <vcpu> element Syntax agreed on in https://www.redhat.com/archives/libvir-list/2010-September/msg00476.html <domain ...> <vcpu current='x'>y</vcpu> ... can now be used to specify 1 <= x <= y current vcpus, in relation to the boot-time max of y vcpus. If current is omitted, then current and max are assumed to be the same value. * docs/schemas/domain.rng: Add new attribute. * docs/formatdomain.html.in: Document it. * tests/qemuxml2argvdata/qemuxml2argv-smp.xml: Add to domainschematest. * tests/xml2sexprdata/xml2sexpr-pv-vcpus.xml: Likewise.
2010-09-27 23:36:06 +00:00
<dd>The content of this element defines the maximum number of virtual
vcpu: improve cpuset attribute The <vcpu cpuset=...> attribute has been available since commit e193b5dd, but without documentation or RNG validation. * docs/schemas/domain.rng (vcpu): Further validate cpuset. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.c: Fix typos.
2010-09-27 23:29:13 +00:00
CPUs allocated for the guest OS, which must be between 1 and
the maximum supported by the hypervisor. <span class="since">Since
0.4.4</span>, this element can contain an optional
<code>cpuset</code> attribute, which is a comma-separated
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin> These 3 elements conflicts with each other in either the doc or the underlying codes. Current problems: Problem 1: The doc shouldn't simply say "These settings are superseded by CPU tuning. " for element <vcpu>. As except the tuning, <vcpu> allows to specify the current, maxmum vcpu number. Apart from that, <vcpu> also allows to specify the placement as "auto", which binds the domain process to the advisory nodeset from numad. Problem 2: Doc for <vcpu> says its "cpuset" specify the physical CPUs that the vcpus can be pinned. But it's not the truth, as actually it only pin domain process to the specified physical CPUs. So either it's a document bug, or code bug. Problem 3: Doc for <vcpupin> says it supersed "cpuset" of <vcpu>, it's not quite correct, as each <vcpupin> specify the pinning policy only for one vcpu. How about the ones which doesn't have <vcpupin> specified? it says the vcpu will be pinned to all available physical CPUs, but what's the meaning of attribute "cpuset" of <vcpu> then? Problem 4: Doc for <emulatorpin> says it pin the emulator threads (domain process in other context, perhaps another follow up patch to cleanup the inconsistency is needed) to the physical CPUs specified its attribute "cpuset". Which conflicts with <vcpu>'s "cpuset". And actually in the underlying codes, it set the affinity for domain process twice if both "cpuset" for <vcpu> and <emulatorpin> are specified, and <emulatorpin>'s pinning will override <vcpu>'s. Problem 5: When "placement" of <vcpu> is "auto" (I.e. uses numad to get the advisory nodeset to which the domain process is pinned to), it will also be overridden by <emulatorpin>, This patch is trying to sort out the conflicts or bugs by: 1) Don't say <vcpu> is superseded by <cputune> 2) Keep the semanteme for "cpuset" of <vcpu> (I.e. Still says it specify the physical CPUs the virtual CPUs). But modifying it to mention it also set the pinning policy for domain process, and the CPU placement of domain process specified by "cpuset" of <vcpu> will be ingored if <emulatorpin> specified, and similary, the CPU placement of vcpu thread will be ignored if it has <vcpupin> specified, for vcpu which doesn't have <vcpupin> specified, it inherits "cpuset" of <vcpu>. 3) Don't say <vcpu> is supersed by <vcpupin>. If neither <vcpupin> nor "cpuset" of <vcpu> is specified, the vcpu will be pinned to all available pCPUs. 4) If neither <emulatorpin> nor "cpuset" of <vcpu> is specified, the domain process (emulator threads in the context) will be pinned to all available pCPUs. 5) If "placement" of <vcpu> is "auto", <emulatorpin> is not allowed. 6) hotplugged vcpus will also inherit "cpuset" of <vcpu> Codes changes according to above document changes: 1) Inherit def->cpumask for each vcpu which doesn't have <vcpupin> specified, during parsing. 2) ping the vcpu which doesn't have <vcpupin> specified to def->cpumask either by cgroup for sched_setaffinity(2), which is actually done by 1). 3) Error out if "placement" == "auto", and <emulatorpin> is specified. Otherwise, <emulatorpin> is honored, and "cpuset" of <cpuset> is ignored. 4) Setup cgroup for each hotplugged vcpu, and setup the pinning policy by either cgroup or sched_setaffinity(2). 5) Remove cgroup and <vcpupin> for each hot unplugged vcpu. Patches are following (6 in total except this patch)
2012-10-12 09:50:43 +00:00
list of physical CPU numbers that domain process and virtual CPUs
can be pinned to by default. (NB: The pinning policy of domain
process and virtual CPUs can be specified separately by
<code>cputune</code>. If attribute <code>emulatorpin</code>
of <code>cputune</code> is specified, <code>cpuset</code>
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
specified by <code>vcpu</code> here will be ignored; Similarly,
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin> These 3 elements conflicts with each other in either the doc or the underlying codes. Current problems: Problem 1: The doc shouldn't simply say "These settings are superseded by CPU tuning. " for element <vcpu>. As except the tuning, <vcpu> allows to specify the current, maxmum vcpu number. Apart from that, <vcpu> also allows to specify the placement as "auto", which binds the domain process to the advisory nodeset from numad. Problem 2: Doc for <vcpu> says its "cpuset" specify the physical CPUs that the vcpus can be pinned. But it's not the truth, as actually it only pin domain process to the specified physical CPUs. So either it's a document bug, or code bug. Problem 3: Doc for <vcpupin> says it supersed "cpuset" of <vcpu>, it's not quite correct, as each <vcpupin> specify the pinning policy only for one vcpu. How about the ones which doesn't have <vcpupin> specified? it says the vcpu will be pinned to all available physical CPUs, but what's the meaning of attribute "cpuset" of <vcpu> then? Problem 4: Doc for <emulatorpin> says it pin the emulator threads (domain process in other context, perhaps another follow up patch to cleanup the inconsistency is needed) to the physical CPUs specified its attribute "cpuset". Which conflicts with <vcpu>'s "cpuset". And actually in the underlying codes, it set the affinity for domain process twice if both "cpuset" for <vcpu> and <emulatorpin> are specified, and <emulatorpin>'s pinning will override <vcpu>'s. Problem 5: When "placement" of <vcpu> is "auto" (I.e. uses numad to get the advisory nodeset to which the domain process is pinned to), it will also be overridden by <emulatorpin>, This patch is trying to sort out the conflicts or bugs by: 1) Don't say <vcpu> is superseded by <cputune> 2) Keep the semanteme for "cpuset" of <vcpu> (I.e. Still says it specify the physical CPUs the virtual CPUs). But modifying it to mention it also set the pinning policy for domain process, and the CPU placement of domain process specified by "cpuset" of <vcpu> will be ingored if <emulatorpin> specified, and similary, the CPU placement of vcpu thread will be ignored if it has <vcpupin> specified, for vcpu which doesn't have <vcpupin> specified, it inherits "cpuset" of <vcpu>. 3) Don't say <vcpu> is supersed by <vcpupin>. If neither <vcpupin> nor "cpuset" of <vcpu> is specified, the vcpu will be pinned to all available pCPUs. 4) If neither <emulatorpin> nor "cpuset" of <vcpu> is specified, the domain process (emulator threads in the context) will be pinned to all available pCPUs. 5) If "placement" of <vcpu> is "auto", <emulatorpin> is not allowed. 6) hotplugged vcpus will also inherit "cpuset" of <vcpu> Codes changes according to above document changes: 1) Inherit def->cpumask for each vcpu which doesn't have <vcpupin> specified, during parsing. 2) ping the vcpu which doesn't have <vcpupin> specified to def->cpumask either by cgroup for sched_setaffinity(2), which is actually done by 1). 3) Error out if "placement" == "auto", and <emulatorpin> is specified. Otherwise, <emulatorpin> is honored, and "cpuset" of <cpuset> is ignored. 4) Setup cgroup for each hotplugged vcpu, and setup the pinning policy by either cgroup or sched_setaffinity(2). 5) Remove cgroup and <vcpupin> for each hot unplugged vcpu. Patches are following (6 in total except this patch)
2012-10-12 09:50:43 +00:00
For virtual CPUs which has <code>vcpupin</code> specified,
<code>cpuset</code> specified by <code>cpuset</code> here
will be ignored; For virtual CPUs which doesn't have
<code>vcpupin</code> specified, it will be pinned to the physical
CPUs specified by <code>cpuset</code> here).
Each element in that list is either a single CPU number,
vcpu: improve cpuset attribute The <vcpu cpuset=...> attribute has been available since commit e193b5dd, but without documentation or RNG validation. * docs/schemas/domain.rng (vcpu): Further validate cpuset. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.c: Fix typos.
2010-09-27 23:29:13 +00:00
a range of CPU numbers, or a caret followed by a CPU number to
vcpu: add current attribute to <vcpu> element Syntax agreed on in https://www.redhat.com/archives/libvir-list/2010-September/msg00476.html <domain ...> <vcpu current='x'>y</vcpu> ... can now be used to specify 1 <= x <= y current vcpus, in relation to the boot-time max of y vcpus. If current is omitted, then current and max are assumed to be the same value. * docs/schemas/domain.rng: Add new attribute. * docs/formatdomain.html.in: Document it. * tests/qemuxml2argvdata/qemuxml2argv-smp.xml: Add to domainschematest. * tests/xml2sexprdata/xml2sexpr-pv-vcpus.xml: Likewise.
2010-09-27 23:36:06 +00:00
be excluded from a previous range. <span class="since">Since
0.8.5</span>, the optional attribute <code>current</code> can
be used to specify whether fewer than the maximum number of
qemu: Support numad numad is an user-level daemon that monitors NUMA topology and processes resource consumption to facilitate good NUMA resource alignment of applications/virtual machines to improve performance and minimize cost of remote memory latencies. It provides a pre-placement advisory interface, so significant processes can be pre-bound to nodes with sufficient available resources. More details: http://fedoraproject.org/wiki/Features/numad "numad -w ncpus:memory_amount" is the advisory interface numad provides currently. This patch add the support by introducing a new XML attribute for <vcpu>. e.g. <vcpu placement="auto">4</vcpu> <vcpu placement="static" cpuset="1-10^6">4</vcpu> The returned advisory nodeset from numad will be printed in domain's dumped XML. e.g. <vcpu placement="auto" cpuset="1-10^6">4</vcpu> If placement is "auto", the number of vcpus and the current memory amount specified in domain XML will be used for numad command line (numad uses MB for memory amount): numad -w $num_of_vcpus:$current_memory_amount / 1024 The advisory nodeset returned from numad will be used to set domain process CPU affinity then. (e.g. qemuProcessInitCpuAffinity). If the user specifies both CPU affinity policy (e.g. (<vcpu cpuset="1-10,^7,^8">4</vcpu>) and placement == "auto" the specified CPU affinity will be overridden. Only QEMU/KVM drivers support it now. See docs update in patch for more details.
2012-03-08 13:36:26 +00:00
virtual CPUs should be enabled. <span class="since">Since
docs: add missing </span> in <vcpu placement> doc
2012-04-16 16:40:44 +00:00
0.9.11 (QEMU and KVM only)</span>, the optional attribute
qemu: Support numad numad is an user-level daemon that monitors NUMA topology and processes resource consumption to facilitate good NUMA resource alignment of applications/virtual machines to improve performance and minimize cost of remote memory latencies. It provides a pre-placement advisory interface, so significant processes can be pre-bound to nodes with sufficient available resources. More details: http://fedoraproject.org/wiki/Features/numad "numad -w ncpus:memory_amount" is the advisory interface numad provides currently. This patch add the support by introducing a new XML attribute for <vcpu>. e.g. <vcpu placement="auto">4</vcpu> <vcpu placement="static" cpuset="1-10^6">4</vcpu> The returned advisory nodeset from numad will be printed in domain's dumped XML. e.g. <vcpu placement="auto" cpuset="1-10^6">4</vcpu> If placement is "auto", the number of vcpus and the current memory amount specified in domain XML will be used for numad command line (numad uses MB for memory amount): numad -w $num_of_vcpus:$current_memory_amount / 1024 The advisory nodeset returned from numad will be used to set domain process CPU affinity then. (e.g. qemuProcessInitCpuAffinity). If the user specifies both CPU affinity policy (e.g. (<vcpu cpuset="1-10,^7,^8">4</vcpu>) and placement == "auto" the specified CPU affinity will be overridden. Only QEMU/KVM drivers support it now. See docs update in patch for more details.
2012-03-08 13:36:26 +00:00
<code>placement</code> can be used to indicate the CPU placement
mode for domain process, its value can be either "static" or
numad: Set memory policy from numad advisory nodeset Though numad will manage the memory allocation of task dynamically, it wants management application (libvirt) to pre-set the memory policy according to the advisory nodeset returned from querying numad, (just like pre-bind CPU nodeset for domain process), and thus the performance could benefit much more from it. This patch introduces new XML tag 'placement', value 'auto' indicates whether to set the memory policy with the advisory nodeset from numad, and its value defaults to the value of <vcpu> placement, or 'static' if 'nodeset' is specified. Example of the new XML tag's usage: <numatune> <memory placement='auto' mode='interleave'/> </numatune> Just like what current "numatune" does, the 'auto' numa memory policy setting uses libnuma's API too. If <vcpu> "placement" is "auto", and <numatune> is not specified explicitly, a default <numatume> will be added with "placement" set as "auto", and "mode" set as "strict". The following XML can now fully drive numad: 1) <vcpu> placement is 'auto', no <numatune> is specified. <vcpu placement='auto'>10</vcpu> 2) <vcpu> placement is 'auto', no 'placement' is specified for <numatune>. <vcpu placement='auto'>10</vcpu> <numatune> <memory mode='interleave'/> </numatune> And it's also able to control the CPU placement and memory policy independently. e.g. 1) <vcpu> placement is 'auto', and <numatune> placement is 'static' <vcpu placement='auto'>10</vcpu> <numatune> <memory mode='strict' nodeset='0-10,^7'/> </numatune> 2) <vcpu> placement is 'static', and <numatune> placement is 'auto' <vcpu placement='static' cpuset='0-24,^12'>10</vcpu> <numatune> <memory mode='interleave' placement='auto'/> </numatume> A follow up patch will change the XML formatting codes to always output 'placement' for <vcpu>, even it's 'static'.
2012-05-08 16:04:34 +00:00
"auto", defaults to <code>placement</code> of <code>numatune</code>,
or "static" if <code>cpuset</code> is specified. "auto" indicates
the domain process will be pinned to the advisory nodeset from querying
numad, and the value of attribute <code>cpuset</code> will be ignored
if it's specified. If both <code>cpuset</code> and <code>placement</code>
are not specified, or if <code>placement</code> is "static", but no
<code>cpuset</code> is specified, the domain process will be pinned to
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin> These 3 elements conflicts with each other in either the doc or the underlying codes. Current problems: Problem 1: The doc shouldn't simply say "These settings are superseded by CPU tuning. " for element <vcpu>. As except the tuning, <vcpu> allows to specify the current, maxmum vcpu number. Apart from that, <vcpu> also allows to specify the placement as "auto", which binds the domain process to the advisory nodeset from numad. Problem 2: Doc for <vcpu> says its "cpuset" specify the physical CPUs that the vcpus can be pinned. But it's not the truth, as actually it only pin domain process to the specified physical CPUs. So either it's a document bug, or code bug. Problem 3: Doc for <vcpupin> says it supersed "cpuset" of <vcpu>, it's not quite correct, as each <vcpupin> specify the pinning policy only for one vcpu. How about the ones which doesn't have <vcpupin> specified? it says the vcpu will be pinned to all available physical CPUs, but what's the meaning of attribute "cpuset" of <vcpu> then? Problem 4: Doc for <emulatorpin> says it pin the emulator threads (domain process in other context, perhaps another follow up patch to cleanup the inconsistency is needed) to the physical CPUs specified its attribute "cpuset". Which conflicts with <vcpu>'s "cpuset". And actually in the underlying codes, it set the affinity for domain process twice if both "cpuset" for <vcpu> and <emulatorpin> are specified, and <emulatorpin>'s pinning will override <vcpu>'s. Problem 5: When "placement" of <vcpu> is "auto" (I.e. uses numad to get the advisory nodeset to which the domain process is pinned to), it will also be overridden by <emulatorpin>, This patch is trying to sort out the conflicts or bugs by: 1) Don't say <vcpu> is superseded by <cputune> 2) Keep the semanteme for "cpuset" of <vcpu> (I.e. Still says it specify the physical CPUs the virtual CPUs). But modifying it to mention it also set the pinning policy for domain process, and the CPU placement of domain process specified by "cpuset" of <vcpu> will be ingored if <emulatorpin> specified, and similary, the CPU placement of vcpu thread will be ignored if it has <vcpupin> specified, for vcpu which doesn't have <vcpupin> specified, it inherits "cpuset" of <vcpu>. 3) Don't say <vcpu> is supersed by <vcpupin>. If neither <vcpupin> nor "cpuset" of <vcpu> is specified, the vcpu will be pinned to all available pCPUs. 4) If neither <emulatorpin> nor "cpuset" of <vcpu> is specified, the domain process (emulator threads in the context) will be pinned to all available pCPUs. 5) If "placement" of <vcpu> is "auto", <emulatorpin> is not allowed. 6) hotplugged vcpus will also inherit "cpuset" of <vcpu> Codes changes according to above document changes: 1) Inherit def->cpumask for each vcpu which doesn't have <vcpupin> specified, during parsing. 2) ping the vcpu which doesn't have <vcpupin> specified to def->cpumask either by cgroup for sched_setaffinity(2), which is actually done by 1). 3) Error out if "placement" == "auto", and <emulatorpin> is specified. Otherwise, <emulatorpin> is honored, and "cpuset" of <cpuset> is ignored. 4) Setup cgroup for each hotplugged vcpu, and setup the pinning policy by either cgroup or sched_setaffinity(2). 5) Remove cgroup and <vcpupin> for each hot unplugged vcpu. Patches are following (6 in total except this patch)
2012-10-12 09:50:43 +00:00
all the available physical CPUs.
vcpu: improve cpuset attribute The <vcpu cpuset=...> attribute has been available since commit e193b5dd, but without documentation or RNG validation. * docs/schemas/domain.rng (vcpu): Further validate cpuset. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.c: Fix typos.
2010-09-27 23:29:13 +00:00
</dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
<h3><a name="elementsCPUTuning">CPU Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;cputune&gt;
&lt;vcpupin vcpu="0" cpuset="1-4,^2"/&gt;
&lt;vcpupin vcpu="1" cpuset="0,1"/&gt;
&lt;vcpupin vcpu="2" cpuset="2,3"/&gt;
&lt;vcpupin vcpu="3" cpuset="0,4"/&gt;
docs: Fix typo in CPU tuning
2012-08-31 06:22:57 +00:00
&lt;emulatorpin cpuset="1-3"/&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&lt;shares&gt;2048&lt;/shares&gt;
&lt;period&gt;1000000&lt;/period&gt;
&lt;quota&gt;-1&lt;/quota&gt;
doc: Fix emulator pinning example in formatdomain.html Add correct closing tags.
2012-08-31 07:59:34 +00:00
&lt;emulator_period&gt;1000000&lt;/emulator_period&gt;
&lt;emulator_quota&gt;-1&lt;/emulator_quota&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&lt;/cputune&gt;
...
&lt;/domain&gt;
</pre>
<dl>
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
<dt><code>cputune</code></dt>
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
<dd>
The optional <code>cputune</code> element provides details
regarding the cpu tunable parameters for the domain.
<span class="since">Since 0.9.0</span>
</dd>
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
<dt><code>vcpupin</code></dt>
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
<dd>
docs: CPU allocation and pinning clarification There was a request for clarifying this part of the documentation. This also fixes a case used with CPU.
2012-08-27 14:26:26 +00:00
The optional <code>vcpupin</code> element specifies which of host's
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin> These 3 elements conflicts with each other in either the doc or the underlying codes. Current problems: Problem 1: The doc shouldn't simply say "These settings are superseded by CPU tuning. " for element <vcpu>. As except the tuning, <vcpu> allows to specify the current, maxmum vcpu number. Apart from that, <vcpu> also allows to specify the placement as "auto", which binds the domain process to the advisory nodeset from numad. Problem 2: Doc for <vcpu> says its "cpuset" specify the physical CPUs that the vcpus can be pinned. But it's not the truth, as actually it only pin domain process to the specified physical CPUs. So either it's a document bug, or code bug. Problem 3: Doc for <vcpupin> says it supersed "cpuset" of <vcpu>, it's not quite correct, as each <vcpupin> specify the pinning policy only for one vcpu. How about the ones which doesn't have <vcpupin> specified? it says the vcpu will be pinned to all available physical CPUs, but what's the meaning of attribute "cpuset" of <vcpu> then? Problem 4: Doc for <emulatorpin> says it pin the emulator threads (domain process in other context, perhaps another follow up patch to cleanup the inconsistency is needed) to the physical CPUs specified its attribute "cpuset". Which conflicts with <vcpu>'s "cpuset". And actually in the underlying codes, it set the affinity for domain process twice if both "cpuset" for <vcpu> and <emulatorpin> are specified, and <emulatorpin>'s pinning will override <vcpu>'s. Problem 5: When "placement" of <vcpu> is "auto" (I.e. uses numad to get the advisory nodeset to which the domain process is pinned to), it will also be overridden by <emulatorpin>, This patch is trying to sort out the conflicts or bugs by: 1) Don't say <vcpu> is superseded by <cputune> 2) Keep the semanteme for "cpuset" of <vcpu> (I.e. Still says it specify the physical CPUs the virtual CPUs). But modifying it to mention it also set the pinning policy for domain process, and the CPU placement of domain process specified by "cpuset" of <vcpu> will be ingored if <emulatorpin> specified, and similary, the CPU placement of vcpu thread will be ignored if it has <vcpupin> specified, for vcpu which doesn't have <vcpupin> specified, it inherits "cpuset" of <vcpu>. 3) Don't say <vcpu> is supersed by <vcpupin>. If neither <vcpupin> nor "cpuset" of <vcpu> is specified, the vcpu will be pinned to all available pCPUs. 4) If neither <emulatorpin> nor "cpuset" of <vcpu> is specified, the domain process (emulator threads in the context) will be pinned to all available pCPUs. 5) If "placement" of <vcpu> is "auto", <emulatorpin> is not allowed. 6) hotplugged vcpus will also inherit "cpuset" of <vcpu> Codes changes according to above document changes: 1) Inherit def->cpumask for each vcpu which doesn't have <vcpupin> specified, during parsing. 2) ping the vcpu which doesn't have <vcpupin> specified to def->cpumask either by cgroup for sched_setaffinity(2), which is actually done by 1). 3) Error out if "placement" == "auto", and <emulatorpin> is specified. Otherwise, <emulatorpin> is honored, and "cpuset" of <cpuset> is ignored. 4) Setup cgroup for each hotplugged vcpu, and setup the pinning policy by either cgroup or sched_setaffinity(2). 5) Remove cgroup and <vcpupin> for each hot unplugged vcpu. Patches are following (6 in total except this patch)
2012-10-12 09:50:43 +00:00
physical CPUs the domain VCPU will be pinned to. If this is omitted,
and attribute <code>cpuset</code> of element <code>vcpu</code> is
not specified, the vCPU is pinned to all the physical CPUs by default.
It contains two required attributes, the attribute <code>vcpu</code>
specifies vcpu id, and the attribute <code>cpuset</code> is same as
attribute <code>cpuset</code> of element <code>vcpu</code>.
(NB: Only qemu driver support)
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
<span class="since">Since 0.9.0</span>
</dd>
Support emulatorpin xml parse. This patch adds a new xml element <emulatorpin>, which is a sibling to the existing <vcpupin> element under the <cputune>, to pin emulator threads to specified physical CPUs. Signed-off-by: Tang Chen <tangchen@cn.fujitsu.com> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
2012-08-21 09:18:32 +00:00
<dt><code>emulatorpin</code></dt>
<dd>
The optional <code>emulatorpin</code> element specifies which of host
physical CPUs the "emulator", a subset of a domain not including vcpu,
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin> These 3 elements conflicts with each other in either the doc or the underlying codes. Current problems: Problem 1: The doc shouldn't simply say "These settings are superseded by CPU tuning. " for element <vcpu>. As except the tuning, <vcpu> allows to specify the current, maxmum vcpu number. Apart from that, <vcpu> also allows to specify the placement as "auto", which binds the domain process to the advisory nodeset from numad. Problem 2: Doc for <vcpu> says its "cpuset" specify the physical CPUs that the vcpus can be pinned. But it's not the truth, as actually it only pin domain process to the specified physical CPUs. So either it's a document bug, or code bug. Problem 3: Doc for <vcpupin> says it supersed "cpuset" of <vcpu>, it's not quite correct, as each <vcpupin> specify the pinning policy only for one vcpu. How about the ones which doesn't have <vcpupin> specified? it says the vcpu will be pinned to all available physical CPUs, but what's the meaning of attribute "cpuset" of <vcpu> then? Problem 4: Doc for <emulatorpin> says it pin the emulator threads (domain process in other context, perhaps another follow up patch to cleanup the inconsistency is needed) to the physical CPUs specified its attribute "cpuset". Which conflicts with <vcpu>'s "cpuset". And actually in the underlying codes, it set the affinity for domain process twice if both "cpuset" for <vcpu> and <emulatorpin> are specified, and <emulatorpin>'s pinning will override <vcpu>'s. Problem 5: When "placement" of <vcpu> is "auto" (I.e. uses numad to get the advisory nodeset to which the domain process is pinned to), it will also be overridden by <emulatorpin>, This patch is trying to sort out the conflicts or bugs by: 1) Don't say <vcpu> is superseded by <cputune> 2) Keep the semanteme for "cpuset" of <vcpu> (I.e. Still says it specify the physical CPUs the virtual CPUs). But modifying it to mention it also set the pinning policy for domain process, and the CPU placement of domain process specified by "cpuset" of <vcpu> will be ingored if <emulatorpin> specified, and similary, the CPU placement of vcpu thread will be ignored if it has <vcpupin> specified, for vcpu which doesn't have <vcpupin> specified, it inherits "cpuset" of <vcpu>. 3) Don't say <vcpu> is supersed by <vcpupin>. If neither <vcpupin> nor "cpuset" of <vcpu> is specified, the vcpu will be pinned to all available pCPUs. 4) If neither <emulatorpin> nor "cpuset" of <vcpu> is specified, the domain process (emulator threads in the context) will be pinned to all available pCPUs. 5) If "placement" of <vcpu> is "auto", <emulatorpin> is not allowed. 6) hotplugged vcpus will also inherit "cpuset" of <vcpu> Codes changes according to above document changes: 1) Inherit def->cpumask for each vcpu which doesn't have <vcpupin> specified, during parsing. 2) ping the vcpu which doesn't have <vcpupin> specified to def->cpumask either by cgroup for sched_setaffinity(2), which is actually done by 1). 3) Error out if "placement" == "auto", and <emulatorpin> is specified. Otherwise, <emulatorpin> is honored, and "cpuset" of <cpuset> is ignored. 4) Setup cgroup for each hotplugged vcpu, and setup the pinning policy by either cgroup or sched_setaffinity(2). 5) Remove cgroup and <vcpupin> for each hot unplugged vcpu. Patches are following (6 in total except this patch)
2012-10-12 09:50:43 +00:00
will be pinned to. If this is omitted, and attribute
<code>cpuset</code> of element <code>vcpu</code> is not specified,
"emulator" is pinned to all the physical CPUs by default. It contains
one required attribute <code>cpuset</code> specifying which physical
CPUs to pin to. NB, <code>emulatorpin</code> is not allowed if
attribute <code>placement</code> of element <code>vcpu</code> is
"auto".
Support emulatorpin xml parse. This patch adds a new xml element <emulatorpin>, which is a sibling to the existing <vcpupin> element under the <cputune>, to pin emulator threads to specified physical CPUs. Signed-off-by: Tang Chen <tangchen@cn.fujitsu.com> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
2012-08-21 09:18:32 +00:00
</dd>
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
<dt><code>shares</code></dt>
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
<dd>
The optional <code>shares</code> element specifies the proportional
docs: fix 'omitted' typo in <cputune> doc 'omitted' was mispelt 'commited' twice. One of the sentences with the typo was also missing an 'is' ('each VCPU *is* pinned to all...') which I added in this commit while I was at it.
2012-04-16 16:41:25 +00:00
weighted share for the domain. If this is omitted, it defaults to
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
the OS provided defaults. NB, There is no unit for the value,
it's a relative measure based on the setting of other VM,
e.g. A VM configured with value
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
2048 will get twice as much CPU time as a VM configured with value 1024.
<span class="since">Since 0.9.0</span>
</dd>
doc: Add documentation for new cputune elements period and quota We have added element period and quota. Document them in formatdomain.html.in.
2011-07-21 08:36:39 +00:00
<dt><code>period</code></dt>
<dd>
The optional <code>period</code> element specifies the enforcement
interval(unit: microseconds). Within <code>period</code>, each vcpu of
the domain will not be allowed to consume more than <code>quota</code>
worth of runtime. The value should be in range [1000, 1000000]. A period
Update documentation for CPU quota/period support for LXC Following commit added suport the CPU quota/period to the LXC driver. Update the documentation to reflect that. commit d9724a81b3c53a40f45bf76067a976cce73ed278 Author: Daniel P. Berrange <berrange@redhat.com> Date: Thu Nov 10 12:16:26 2011 +0000 Add support for CPU quota/period to LXC driver Signed-off-by: Sukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
2012-08-15 00:09:11 +00:00
with value 0 means no value.
<span class="since">Only QEMU driver support since 0.9.4, LXC since
0.9.10</span>
doc: Add documentation for new cputune elements period and quota We have added element period and quota. Document them in formatdomain.html.in.
2011-07-21 08:36:39 +00:00
</dd>
<dt><code>quota</code></dt>
<dd>
The optional <code>quota</code> element specifies the maximum allowed
bandwidth(unit: microseconds). A domain with <code>quota</code> as any
negative value indicates that the domain has infinite bandwidth, which
means that it is not bandwidth controlled. The value should be in range
[1000, 18446744073709551] or less than 0. A quota with value 0 means no
value. You can use this feature to ensure that all vcpus run at the same
Update documentation for CPU quota/period support for LXC Following commit added suport the CPU quota/period to the LXC driver. Update the documentation to reflect that. commit d9724a81b3c53a40f45bf76067a976cce73ed278 Author: Daniel P. Berrange <berrange@redhat.com> Date: Thu Nov 10 12:16:26 2011 +0000 Add support for CPU quota/period to LXC driver Signed-off-by: Sukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
2012-08-15 00:09:11 +00:00
speed.
<span class="since">Only QEMU driver support since 0.9.4, LXC since
0.9.10</span>
doc: Add documentation for new cputune elements period and quota We have added element period and quota. Document them in formatdomain.html.in.
2011-07-21 08:36:39 +00:00
</dd>
qemu: introduce period/quota tuning for emulator This patch introduces support of setting emulator's period and quota to limit cpu bandwidth when the vm starts. Also updates XML Schema for new entries and docs.
2012-08-21 09:18:42 +00:00
<dt><code>emulator_period</code></dt>
<dd>
The optional <code>emulator_period</code> element specifies the enforcement
interval(unit: microseconds). Within <code>emulator_period</code>, emulator
threads(those excluding vcpus) of the domain will not be allowed to consume
more than <code>emulator_quota</code> worth of runtime. The value should be
in range [1000, 1000000]. A period with value 0 means no value.
<span class="since">Only QEMU driver support since 0.10.0</span>
</dd>
<dt><code>emulator_quota</code></dt>
<dd>
The optional <code>emulator_quota</code> element specifies the maximum
allowed bandwidth(unit: microseconds) for domain's emulator threads(those
excluding vcpus). A domain with <code>emulator_quota</code> as any negative
value indicates that the domain has infinite bandwidth for emulator threads
(those excluding vcpus), which means that it is not bandwidth controlled.
The value should be in range [1000, 18446744073709551] or less than 0. A
quota with value 0 means no value.
<span class="since">Only QEMU driver support since 0.10.0</span>
</dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
<h3><a name="elementsMemoryAllocation">Memory Allocation</a></h3>
<pre>
&lt;domain&gt;
...
xml: allow scaled memory on input Output is still in kibibytes, but input can now be in different scales for ease of typing. * src/conf/domain_conf.c (virDomainParseMemory): New helper. (virDomainDefParseXML): Use it when parsing. * docs/schemas/domaincommon.rng: Expand XML; rename memoryKBElement to memoryElement and update callers. * docs/formatdomain.html.in (elementsMemoryAllocation): Document scaling. * tests/qemuxml2argvdata/qemuxml2argv-memtune.xml: Adjust test. * tests/qemuxml2xmltest.c: Likewise. * tests/qemuxml2xmloutdata/qemuxml2xmlout-memtune.xml: New file.
2012-03-05 21:52:07 +00:00
&lt;memory unit='KiB'&gt;524288&lt;/memory&gt;
&lt;currentMemory unit='KiB'&gt;524288&lt;/currentMemory&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
...
&lt;/domain&gt;
</pre>
<dl>
<dt><code>memory</code></dt>
<dd>The maximum allocation of memory for the guest at boot time.
xml: allow scaled memory on input Output is still in kibibytes, but input can now be in different scales for ease of typing. * src/conf/domain_conf.c (virDomainParseMemory): New helper. (virDomainDefParseXML): Use it when parsing. * docs/schemas/domaincommon.rng: Expand XML; rename memoryKBElement to memoryElement and update callers. * docs/formatdomain.html.in (elementsMemoryAllocation): Document scaling. * tests/qemuxml2argvdata/qemuxml2argv-memtune.xml: Adjust test. * tests/qemuxml2xmltest.c: Likewise. * tests/qemuxml2xmloutdata/qemuxml2xmlout-memtune.xml: New file.
2012-03-05 21:52:07 +00:00
The units for this value are determined by the optional
Fix some typos in messages, docs and comments.
2012-08-22 18:29:18 +00:00
attribute <code>unit</code>, which defaults to "KiB"
xml: allow scaled memory on input Output is still in kibibytes, but input can now be in different scales for ease of typing. * src/conf/domain_conf.c (virDomainParseMemory): New helper. (virDomainDefParseXML): Use it when parsing. * docs/schemas/domaincommon.rng: Expand XML; rename memoryKBElement to memoryElement and update callers. * docs/formatdomain.html.in (elementsMemoryAllocation): Document scaling. * tests/qemuxml2argvdata/qemuxml2argv-memtune.xml: Adjust test. * tests/qemuxml2xmltest.c: Likewise. * tests/qemuxml2xmloutdata/qemuxml2xmlout-memtune.xml: New file.
2012-03-05 21:52:07 +00:00
(kibibytes, 2<sup>10</sup> or blocks of 1024 bytes). Valid
units are "b" or "bytes" for bytes, "KB" for kilobytes
(10<sup>3</sup> or 1,000 bytes), "k" or "KiB" for kibibytes
(1024 bytes), "MB" for megabytes (10<sup>6</sup> or 1,000,000
bytes), "M" or "MiB" for mebibytes (2<sup>20</sup> or
1,048,576 bytes), "GB" for gigabytes (10<sup>9</sup> or
1,000,000,000 bytes), "G" or "GiB" for gibibytes
(2<sup>30</sup> or 1,073,741,824 bytes), "TB" for terabytes
(10<sup>12</sup> or 1,000,000,000,000 bytes), or "T" or "TiB"
for tebibytes (2<sup>40</sup> or 1,099,511,627,776 bytes).
However, the value will be rounded up to the nearest kibibyte
by libvirt, and may be further rounded to the granularity
supported by the hypervisor. Some hypervisors also enforce a
Add support for limiting guest coredump Sometimes when guest machine crashes, coredump can get huge due to the guest memory. This can be limited using madvise(2) system call and is being used in QEMU hypervisor. This patch adds an option for configuring that in the domain XML and related documentation.
2012-08-15 07:51:58 +00:00
minimum, such as 4000KiB.
In the case of crash, optional attribute <code>dumpCore</code>
can be used to control whether the guest memory should be
included in the generated coredump or not (values "on", "off").
<span class='since'><code>unit</code> since 0.9.11</span>,
<span class='since'><code>dumpCore</code> since 0.10.2
(QEMU only)</span></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<dt><code>currentMemory</code></dt>
<dd>The actual allocation of memory for the guest. This value can
be less than the maximum allocation, to allow for ballooning
up the guests memory on the fly. If this is omitted, it defaults
xml: allow scaled memory on input Output is still in kibibytes, but input can now be in different scales for ease of typing. * src/conf/domain_conf.c (virDomainParseMemory): New helper. (virDomainDefParseXML): Use it when parsing. * docs/schemas/domaincommon.rng: Expand XML; rename memoryKBElement to memoryElement and update callers. * docs/formatdomain.html.in (elementsMemoryAllocation): Document scaling. * tests/qemuxml2argvdata/qemuxml2argv-memtune.xml: Adjust test. * tests/qemuxml2xmltest.c: Likewise. * tests/qemuxml2xmloutdata/qemuxml2xmlout-memtune.xml: New file.
2012-03-05 21:52:07 +00:00
to the same value as the <code>memory</code> element.
The <code>unit</code> attribute behaves the same as
for <code>memory</code>.</dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
<h3><a name="elementsMemoryBacking">Memory Backing</a></h3>
<pre>
&lt;domain&gt;
...
&lt;memoryBacking&gt;
&lt;hugepages/&gt;
qemu: New XML to disable memory merge at guest startup QEMU introduced command line "-mem-merge=on|off" (defaults to on) to enable/disable the memory merge (KSM) at guest startup. This exposes it by new XML: <memoryBacking> <nosharepages/> </memoryBacking> The XML tag is same with what we used internally for old RHEL.
2013-05-14 05:25:50 +00:00
&lt;nosharepages/&gt;
Add support for locking domain's memory pages The following XML configuration can be used to request all domain's memory pages to be kept locked in host's memory (i.e., domain's memory pages will not be swapped out): <memoryBacking> <locked/> </memoryBacking>
2013-05-16 20:00:03 +00:00
&lt;locked/&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&lt;/memoryBacking&gt;
...
&lt;/domain&gt;
</pre>
Add support for locking domain's memory pages The following XML configuration can be used to request all domain's memory pages to be kept locked in host's memory (i.e., domain's memory pages will not be swapped out): <memoryBacking> <locked/> </memoryBacking>
2013-05-16 20:00:03 +00:00
<p>The optional <code>memoryBacking</code> element may contain several
elements that influence how virtual memory pages are backed by host
pages.</p>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<dl>
Add support for locking domain's memory pages The following XML configuration can be used to request all domain's memory pages to be kept locked in host's memory (i.e., domain's memory pages will not be swapped out): <memoryBacking> <locked/> </memoryBacking>
2013-05-16 20:00:03 +00:00
<dt><code>hugepages</code></dt>
<dd>This tells the hypervisor that the guest should have its memory
allocated using hugepages instead of the normal native page size.</dd>
<dt><code>nosharepages</code></dt>
<dd>Instructs hypervisor to disable shared pages (memory merge, KSM) for
this domain. <span class="since">Since 1.0.6</span></dd>
<dt><code>locked</code></dt>
<dd>When set and supported by the hypervisor, memory pages belonging
to the domain will be locked in host's memory and the host will not
be allowed to swap them out.
<span class="since">Since 1.0.6</span></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
<h3><a name="elementsMemoryTuning">Memory Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;memtune&gt;
xml: allow scaled memory on input Output is still in kibibytes, but input can now be in different scales for ease of typing. * src/conf/domain_conf.c (virDomainParseMemory): New helper. (virDomainDefParseXML): Use it when parsing. * docs/schemas/domaincommon.rng: Expand XML; rename memoryKBElement to memoryElement and update callers. * docs/formatdomain.html.in (elementsMemoryAllocation): Document scaling. * tests/qemuxml2argvdata/qemuxml2argv-memtune.xml: Adjust test. * tests/qemuxml2xmltest.c: Likewise. * tests/qemuxml2xmloutdata/qemuxml2xmlout-memtune.xml: New file.
2012-03-05 21:52:07 +00:00
&lt;hard_limit unit='G'&gt;1&lt;/hard_limit&gt;
&lt;soft_limit unit='M'&gt;128&lt;/soft_limit&gt;
&lt;swap_hard_limit unit='G'&gt;2&lt;/swap_hard_limit&gt;
&lt;min_guarantee unit='bytes'&gt;67108864&lt;/min_guarantee&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&lt;/memtune&gt;
...
&lt;/domain&gt;
</pre>
<dl>
<dt><code>memtune</code></dt>
<dd> The optional <code>memtune</code> element provides details
regarding the memory tunable parameters for the domain. If this is
omitted, it defaults to the OS provided defaults. For QEMU/KVM, the
parameters are applied to the QEMU process as a whole. Thus, when
counting them, one needs to add up guest RAM, guest video RAM, and
some memory overhead of QEMU itself. The last piece is hard to
xml: allow scaled memory on input Output is still in kibibytes, but input can now be in different scales for ease of typing. * src/conf/domain_conf.c (virDomainParseMemory): New helper. (virDomainDefParseXML): Use it when parsing. * docs/schemas/domaincommon.rng: Expand XML; rename memoryKBElement to memoryElement and update callers. * docs/formatdomain.html.in (elementsMemoryAllocation): Document scaling. * tests/qemuxml2argvdata/qemuxml2argv-memtune.xml: Adjust test. * tests/qemuxml2xmltest.c: Likewise. * tests/qemuxml2xmloutdata/qemuxml2xmlout-memtune.xml: New file.
2012-03-05 21:52:07 +00:00
determine so one needs guess and try. For each tunable, it
is possible to designate which unit the number is in on
input, using the same values as
for <code>&lt;memory&gt;</code>. For backwards
compatibility, output is always in
KiB. <span class='since'><code>unit</code>
since 0.9.11</span></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<dt><code>hard_limit</code></dt>
<dd> The optional <code>hard_limit</code> element is the maximum memory
docs: use correct terminology for 1024 bytes Yes, I like kilobytes better than kibibytes (when I say kilobytes, I generally mean 1024). But since the term is ambiguous, it can't hurt to say what we mean, by using both the correct name and calling out the numeric equivalent. * src/libvirt.c (virDomainGetMaxMemory, virDomainSetMaxMemory) (virDomainSetMemory, virDomainSetMemoryFlags) (virNodeGetFreeMemory): Tweak wording. * docs/formatdomain.html.in: Likewise. * docs/formatstorage.html.in: Likewise.
2012-03-02 15:23:07 +00:00
the guest can use. The units for this value are kibibytes (i.e. blocks
docs: Discourage users to set hard_limit In one of my previous patches I am removing the hard_limit heuristic to guess the correct value if none set. However, it turned out, this limit is hard to guess even for users. We should advise them to not set the limit as their domains may be OOM killed. Sigh.
2013-08-19 09:54:05 +00:00
of 1024 bytes). <strong>However, users of QEMU and KVM are strongly
docs: Clean 09adfdc62de2b up
2013-08-19 14:51:12 +00:00
advised not to set this limit as domain may get killed by the kernel
if the guess is too low. To determine the memory needed for a process
to run is an
docs: Discourage users to set hard_limit In one of my previous patches I am removing the hard_limit heuristic to guess the correct value if none set. However, it turned out, this limit is hard to guess even for users. We should advise them to not set the limit as their domains may be OOM killed. Sigh.
2013-08-19 09:54:05 +00:00
<a href="http://en.wikipedia.org/wiki/Undecidable_problem">
undecidable problem</a>.</strong></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<dt><code>soft_limit</code></dt>
<dd> The optional <code>soft_limit</code> element is the memory limit to
enforce during memory contention. The units for this value are
docs: use correct terminology for 1024 bytes Yes, I like kilobytes better than kibibytes (when I say kilobytes, I generally mean 1024). But since the term is ambiguous, it can't hurt to say what we mean, by using both the correct name and calling out the numeric equivalent. * src/libvirt.c (virDomainGetMaxMemory, virDomainSetMaxMemory) (virDomainSetMemory, virDomainSetMemoryFlags) (virNodeGetFreeMemory): Tweak wording. * docs/formatdomain.html.in: Likewise. * docs/formatstorage.html.in: Likewise.
2012-03-02 15:23:07 +00:00
kibibytes (i.e. blocks of 1024 bytes)</dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<dt><code>swap_hard_limit</code></dt>
<dd> The optional <code>swap_hard_limit</code> element is the maximum
memory plus swap the guest can use. The units for this value are
docs: use correct terminology for 1024 bytes Yes, I like kilobytes better than kibibytes (when I say kilobytes, I generally mean 1024). But since the term is ambiguous, it can't hurt to say what we mean, by using both the correct name and calling out the numeric equivalent. * src/libvirt.c (virDomainGetMaxMemory, virDomainSetMaxMemory) (virDomainSetMemory, virDomainSetMemoryFlags) (virNodeGetFreeMemory): Tweak wording. * docs/formatdomain.html.in: Likewise. * docs/formatstorage.html.in: Likewise.
2012-03-02 15:23:07 +00:00
kibibytes (i.e. blocks of 1024 bytes). This has to be more than
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
hard_limit value provided</dd>
<dt><code>min_guarantee</code></dt>
<dd> The optional <code>min_guarantee</code> element is the guaranteed
minimum memory allocation for the guest. The units for this value are
docs: use correct terminology for 1024 bytes Yes, I like kilobytes better than kibibytes (when I say kilobytes, I generally mean 1024). But since the term is ambiguous, it can't hurt to say what we mean, by using both the correct name and calling out the numeric equivalent. * src/libvirt.c (virDomainGetMaxMemory, virDomainSetMaxMemory) (virDomainSetMemory, virDomainSetMemoryFlags) (virNodeGetFreeMemory): Tweak wording. * docs/formatdomain.html.in: Likewise. * docs/formatstorage.html.in: Likewise.
2012-03-02 15:23:07 +00:00
kibibytes (i.e. blocks of 1024 bytes)</dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
<h3><a name="elementsNUMATuning">NUMA Node Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;numatune&gt;
&lt;memory mode="strict" nodeset="1-4,^3"/&gt;
&lt;/numatune&gt;
...
&lt;/domain&gt;
</pre>
<dl>
numatune: Add doc for new numatune XML
2011-06-20 07:15:05 +00:00
<dt><code>numatune</code></dt>
<dd>
The optional <code>numatune</code> element provides details of
how to tune the performance of a NUMA host via controlling NUMA policy
for domain process. NB, only supported by QEMU driver.
<span class='since'>Since 0.9.3</span>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
numatune: Add doc for new numatune XML
2011-06-20 07:15:05 +00:00
<dt><code>memory</code></dt>
<dd>
qemu: Support numad numad is an user-level daemon that monitors NUMA topology and processes resource consumption to facilitate good NUMA resource alignment of applications/virtual machines to improve performance and minimize cost of remote memory latencies. It provides a pre-placement advisory interface, so significant processes can be pre-bound to nodes with sufficient available resources. More details: http://fedoraproject.org/wiki/Features/numad "numad -w ncpus:memory_amount" is the advisory interface numad provides currently. This patch add the support by introducing a new XML attribute for <vcpu>. e.g. <vcpu placement="auto">4</vcpu> <vcpu placement="static" cpuset="1-10^6">4</vcpu> The returned advisory nodeset from numad will be printed in domain's dumped XML. e.g. <vcpu placement="auto" cpuset="1-10^6">4</vcpu> If placement is "auto", the number of vcpus and the current memory amount specified in domain XML will be used for numad command line (numad uses MB for memory amount): numad -w $num_of_vcpus:$current_memory_amount / 1024 The advisory nodeset returned from numad will be used to set domain process CPU affinity then. (e.g. qemuProcessInitCpuAffinity). If the user specifies both CPU affinity policy (e.g. (<vcpu cpuset="1-10,^7,^8">4</vcpu>) and placement == "auto" the specified CPU affinity will be overridden. Only QEMU/KVM drivers support it now. See docs update in patch for more details.
2012-03-08 13:36:26 +00:00
The optional <code>memory</code> element specifies how to allocate memory
numad: Set memory policy from numad advisory nodeset Though numad will manage the memory allocation of task dynamically, it wants management application (libvirt) to pre-set the memory policy according to the advisory nodeset returned from querying numad, (just like pre-bind CPU nodeset for domain process), and thus the performance could benefit much more from it. This patch introduces new XML tag 'placement', value 'auto' indicates whether to set the memory policy with the advisory nodeset from numad, and its value defaults to the value of <vcpu> placement, or 'static' if 'nodeset' is specified. Example of the new XML tag's usage: <numatune> <memory placement='auto' mode='interleave'/> </numatune> Just like what current "numatune" does, the 'auto' numa memory policy setting uses libnuma's API too. If <vcpu> "placement" is "auto", and <numatune> is not specified explicitly, a default <numatume> will be added with "placement" set as "auto", and "mode" set as "strict". The following XML can now fully drive numad: 1) <vcpu> placement is 'auto', no <numatune> is specified. <vcpu placement='auto'>10</vcpu> 2) <vcpu> placement is 'auto', no 'placement' is specified for <numatune>. <vcpu placement='auto'>10</vcpu> <numatune> <memory mode='interleave'/> </numatune> And it's also able to control the CPU placement and memory policy independently. e.g. 1) <vcpu> placement is 'auto', and <numatune> placement is 'static' <vcpu placement='auto'>10</vcpu> <numatune> <memory mode='strict' nodeset='0-10,^7'/> </numatune> 2) <vcpu> placement is 'static', and <numatune> placement is 'auto' <vcpu placement='static' cpuset='0-24,^12'>10</vcpu> <numatune> <memory mode='interleave' placement='auto'/> </numatume> A follow up patch will change the XML formatting codes to always output 'placement' for <vcpu>, even it's 'static'.
2012-05-08 16:04:34 +00:00
for the domain process on a NUMA host. It contains several optional
attributes. Attribute <code>mode</code> is either 'interleave',
'strict', or 'preferred', defaults to 'strict'. Attribute
<code>nodeset</code> specifies the NUMA nodes, using the same syntax as
attribute <code>cpuset</code> of element <code>vcpu</code>. Attribute
<code>placement</code> (<span class='since'>since 0.9.12</span>) can be
used to indicate the memory placement mode for domain process, its value
can be either "static" or "auto", defaults to <code>placement</code> of
<code>vcpu</code>, or "static" if <code>nodeset</code> is specified.
"auto" indicates the domain process will only allocate memory from the
advisory nodeset returned from querying numad, and the value of attribute
<code>nodeset</code> will be ignored if it's specified.
If <code>placement</code> of <code>vcpu</code> is 'auto', and
<code>numatune</code> is not specified, a default <code>numatune</code>
with <code>placement</code> 'auto' and <code>mode</code> 'strict' will
be added implicitly.
numatune: Add doc for new numatune XML
2011-06-20 07:15:05 +00:00
<span class='since'>Since 0.9.3</span>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<h3><a name="elementsBlockTuning">Block I/O Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;blkiotune&gt;
&lt;weight&gt;800&lt;/weight&gt;
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
&lt;device&gt;
&lt;path&gt;/dev/sda&lt;/path&gt;
&lt;weight&gt;1000&lt;/weight&gt;
&lt;/device&gt;
&lt;device&gt;
&lt;path&gt;/dev/sdb&lt;/path&gt;
&lt;weight&gt;500&lt;/weight&gt;
&lt;/device&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&lt;/blkiotune&gt;
...
&lt;/domain&gt;
</pre>
<dl>
<dt><code>blkiotune</code></dt>
<dd> The optional <code>blkiotune</code> element provides the ability
to tune Blkio cgroup tunable parameters for the domain. If this is
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
omitted, it defaults to the OS provided
defaults. <span class="since">Since 0.8.8</span></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<dt><code>weight</code></dt>
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
<dd> The optional <code>weight</code> element is the overall I/O
weight of the guest. The value should be in the range [100,
1000].</dd>
<dt><code>device</code></dt>
<dd>The domain may have multiple <code>device</code> elements
that further tune the weights for each host block device in
use by the domain. Note that
multiple <a href="#elementsDisks">guest disks</a> can share a
single host block device, if they are backed by files within
the same host file system, which is why this tuning parameter
is at the global domain level rather than associated with each
Support block I/O throttle in XML Enable block I/O throttle for per-disk in XML, as the first per-disk IO tuning parameter. Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-15 09:02:46 +00:00
guest disk device (contrast this to
the <a href="#elementsDisks"><code>&lt;iotune&gt;</code></a>
element which can apply to an
individual <code>&lt;disk&gt;</code>).
Each <code>device</code> element has two
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
mandatory sub-elements, <code>path</code> describing the
absolute path of the device, and <code>weight</code> giving
the relative weight of that device, in the range [100,
1000]. <span class="since">Since 0.9.8</span></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
Add XML config for resource partitions Allow VMs to be placed into resource groups using the following syntax <resource> <partition>/virtualmachines/production</partition> </resource> A resource cgroup will be backed by some hypervisor specific functionality, such as cgroups with KVM/LXC. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-03-21 11:28:10 +00:00
<h3><a name="resPartition">Resource partitioning</a></h3>
<p>
Hypervisors may allow for virtual machines to be placed into
resource partitions, potentially with nesting of said partitions.
The <code>resource</code> element groups together configuration
related to resource partitioning. It currently supports a child
element <code>partition</code> whose content defines the path
of the resource partition in which to place the domain. If no
partition is listed, then the domain will be placed in a default
partition. It is the responsibility of the app/admin to ensure
that the partition exists prior to starting the guest. Only the
(hypervisor specific) default partition can be assumed to exist
by default.
</p>
<pre>
...
&lt;resource&gt;
&lt;partition&gt;/virtualmachines/production&lt;/partition&gt;
&lt;/resource&gt;
...
</pre>
<p>
Resource partitions are currently supported by the QEMU and
docs: fix usage of 'onto' http://www.uhv.edu/ac/newsletters/writing/grammartip2009.07.01.htm (and several other sites) give hints that 'onto' is best used if you can also add 'up' just before it and still make sense. In many cases in the code base, we really want the two-word form, or even a simplification to just 'on' or 'to'. * docs/hacking.html.in: Use correct 'on to'. * python/libvirt-override.c: Likewise. * src/lxc/lxc_controller.c: Likewise. * src/util/virpci.c: Likewise. * daemon/THREADS.txt: Use simpler 'on'. * docs/formatdomain.html.in: Better usage. * docs/internals/rpc.html.in: Likewise. * src/conf/domain_event.c: Likewise. * src/rpc/virnetclient.c: Likewise. * tests/qemumonitortestutils.c: Likewise. * HACKING: Regenerate. Signed-off-by: Eric Blake <eblake@redhat.com>
2013-04-19 20:18:14 +00:00
LXC drivers, which map partition paths to cgroups directories,
Add XML config for resource partitions Allow VMs to be placed into resource groups using the following syntax <resource> <partition>/virtualmachines/production</partition> </resource> A resource cgroup will be backed by some hypervisor specific functionality, such as cgroups with KVM/LXC. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-03-21 11:28:10 +00:00
in all mounted controllers. <span class="since">Since 1.0.5</span>
</p>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<h3><a name="elementsCPU">CPU model and topology</a></h3>
<p>
Requirements for CPU model, its features and topology can be specified
using the following collection of elements.
<span class="since">Since 0.7.5</span>
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;cpu match='exact'&gt;
cpu: Optionally forbid fallback CPU models In case a hypervisor doesn't support the exact CPU model requested by a domain XML, we automatically fallback to a closest CPU model the hypervisor supports (and make sure we add/remove any additional features if needed). This patch adds 'fallback' attribute to model element, which can be used to disable this automatic fallback.
2011-12-21 13:27:16 +00:00
&lt;model fallback='allow'&gt;core2duo&lt;/model&gt;
cpu: Add support for CPU vendor By specifying <vendor> element in CPU requirements a guest can be restricted to run only on CPUs by a given vendor. Host CPU vendor is also specified in capabilities XML. The vendor is checked when migrating a guest but it's not forced, i.e., guests configured without <vendor> element can be freely migrated.
2010-07-02 15:51:59 +00:00
&lt;vendor&gt;Intel&lt;/vendor&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;topology sockets='1' cores='2' threads='1'/&gt;
&lt;feature policy='disable' name='lahf_lm'/&gt;
&lt;/cpu&gt;
...</pre>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
Add support for cpu mode attribute The mode can be either of "custom" (default), "host-model", "host-passthrough". The semantics of each mode is described in the following examples: - guest CPU is a default model with specified topology: <cpu> <topology sockets='1' cores='2' threads='1'/> </cpu> - guest CPU matches selected model: <cpu mode='custom' match='exact'> <model>core2duo</model> </cpu> - guest CPU should be a copy of host CPU as advertised by capabilities XML (this is a short cut for manually copying host CPU specification from capabilities to domain XML): <cpu mode='host-model'/> In case a hypervisor does not support the exact host model, libvirt automatically falls back to a closest supported CPU model and removes/adds features to match host. This behavior can be disabled by <cpu mode='host-model'> <model fallback='forbid'/> </cpu> - the same as previous returned by virDomainGetXMLDesc with VIR_DOMAIN_XML_UPDATE_CPU flag: <cpu mode='host-model' match='exact'> <model fallback='allow'>Penryn</model> --+ <vendor>Intel</vendor> | <topology sockets='2' cores='4' threads='1'/> + copied from <feature policy='require' name='dca'/> | capabilities XML <feature policy='require' name='xtpr'/> | ... --+ </cpu> - guest CPU should be exactly the same as host CPU even in the aspects libvirt doesn't model (such domain cannot be migrated unless both hosts contain exactly the same CPUs): <cpu mode='host-passthrough'/> - the same as previous returned by virDomainGetXMLDesc with VIR_DOMAIN_XML_UPDATE_CPU flag: <cpu mode='host-passthrough' match='minimal'> <model>Penryn</model> --+ copied from caps <vendor>Intel</vendor> | XML but doesn't <topology sockets='2' cores='4' threads='1'/> | describe all <feature policy='require' name='dca'/> | aspects of the <feature policy='require' name='xtpr'/> | actual guest CPU ... --+ </cpu>
2011-08-18 10:14:36 +00:00
<pre>
&lt;cpu mode='host-model'&gt;
&lt;model fallback='forbid'/&gt;
&lt;topology sockets='1' cores='2' threads='1'/&gt;
&lt;/cpu&gt;
...</pre>
<pre>
&lt;cpu mode='host-passthrough'/&gt;
...</pre>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<p>
In case no restrictions need to be put on CPU model and its features, a
simpler <code>cpu</code> element can be used.
<span class="since">Since 0.7.6</span>
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;cpu&gt;
&lt;topology sockets='1' cores='2' threads='1'/&gt;
&lt;/cpu&gt;
...</pre>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<dl>
<dt><code>cpu</code></dt>
<dd>The <code>cpu</code> element is the main container for describing
guest CPU requirements. Its <code>match</code> attribute specified how
strictly has the virtual CPU provided to the guest match these
requirements. <span class="since">Since 0.7.6</span> the
<code>match</code> attribute can be omitted if <code>topology</code>
is the only element within <code>cpu</code>. Possible values for the
<code>match</code> attribute are:
<dl>
<dt><code>minimum</code></dt>
<dd>The specified CPU model and features describes the minimum
requested CPU.</dd>
<dt><code>exact</code></dt>
<dd>The virtual CPU provided to the guest will exactly match the
specification</dd>
<dt><code>strict</code></dt>
<dd>The guest will not be created unless the host CPU does exactly
match the specification.</dd>
</dl>
Set sensible defaults for cpu match and feature policy To enable the CPU XML from the capabilities to be pasted directly into the guest XML with no editing, pick a sensible default for match and feature policy. The CPU match will be exact and the feature policy will be require. This should ensure safety for migration and give DWIM semantics for users * src/conf/cpu_conf.c: Default to exact match and require policy * docs/formatdomain.html.in: Document new defaults
2010-09-22 11:47:48 +00:00
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<span class="since">Since 0.8.5</span> the <code>match</code>
attribute can be omitted and will default to <code>exact</code>.
Add support for cpu mode attribute The mode can be either of "custom" (default), "host-model", "host-passthrough". The semantics of each mode is described in the following examples: - guest CPU is a default model with specified topology: <cpu> <topology sockets='1' cores='2' threads='1'/> </cpu> - guest CPU matches selected model: <cpu mode='custom' match='exact'> <model>core2duo</model> </cpu> - guest CPU should be a copy of host CPU as advertised by capabilities XML (this is a short cut for manually copying host CPU specification from capabilities to domain XML): <cpu mode='host-model'/> In case a hypervisor does not support the exact host model, libvirt automatically falls back to a closest supported CPU model and removes/adds features to match host. This behavior can be disabled by <cpu mode='host-model'> <model fallback='forbid'/> </cpu> - the same as previous returned by virDomainGetXMLDesc with VIR_DOMAIN_XML_UPDATE_CPU flag: <cpu mode='host-model' match='exact'> <model fallback='allow'>Penryn</model> --+ <vendor>Intel</vendor> | <topology sockets='2' cores='4' threads='1'/> + copied from <feature policy='require' name='dca'/> | capabilities XML <feature policy='require' name='xtpr'/> | ... --+ </cpu> - guest CPU should be exactly the same as host CPU even in the aspects libvirt doesn't model (such domain cannot be migrated unless both hosts contain exactly the same CPUs): <cpu mode='host-passthrough'/> - the same as previous returned by virDomainGetXMLDesc with VIR_DOMAIN_XML_UPDATE_CPU flag: <cpu mode='host-passthrough' match='minimal'> <model>Penryn</model> --+ copied from caps <vendor>Intel</vendor> | XML but doesn't <topology sockets='2' cores='4' threads='1'/> | describe all <feature policy='require' name='dca'/> | aspects of the <feature policy='require' name='xtpr'/> | actual guest CPU ... --+ </cpu>
2011-08-18 10:14:36 +00:00
<span class="since">Since 0.9.10</span>, an optional <code>mode</code>
attribute may be used to make it easier to configure a guest CPU to be
as close to host CPU as possible. Possible values for the
<code>mode</code> attribute are:
<dl>
<dt><code>custom</code></dt>
<dd>In this mode, the <code>cpu</code> element describes the CPU
that should be presented to the guest. This is the default when no
<code>mode</code> attribute is specified. This mode makes it so that
a persistent guest will see the same hardware no matter what host
the guest is booted on.</dd>
<dt><code>host-model</code></dt>
<dd>The <code>host-model</code> mode is essentially a shortcut to
copying host CPU definition from capabilities XML into domain XML.
Since the CPU definition is copied just before starting a domain,
exactly the same XML can be used on different hosts while still
cpu: Allow fine tuning of "host-model" cpu https://bugzilla.redhat.com/show_bug.cgi?id=799354 Until now, the "host-model" cpu mode couldn't be influenced. This patch allows to use the <feature> elements to either enable or disable specific CPU flags. This can be used to force flags that can be emulated even if the host CPU doesn't support them.
2013-07-15 15:38:55 +00:00
providing the best guest CPU each host supports. The
<code>match</code> attribute can't be used in this mode. Specifying
CPU model is not supported either, but <code>model</code>'s
<code>fallback</code> attribute may still be used. Using the
<code>feature</code> element, specific flags may be enabled or
disabled specifically in addition to the host model. This may be
used to fine tune features that can be emulated.
<span class="since">(Since 1.1.1)</span>.
Libvirt does not model every aspect of each CPU so
Add support for cpu mode attribute The mode can be either of "custom" (default), "host-model", "host-passthrough". The semantics of each mode is described in the following examples: - guest CPU is a default model with specified topology: <cpu> <topology sockets='1' cores='2' threads='1'/> </cpu> - guest CPU matches selected model: <cpu mode='custom' match='exact'> <model>core2duo</model> </cpu> - guest CPU should be a copy of host CPU as advertised by capabilities XML (this is a short cut for manually copying host CPU specification from capabilities to domain XML): <cpu mode='host-model'/> In case a hypervisor does not support the exact host model, libvirt automatically falls back to a closest supported CPU model and removes/adds features to match host. This behavior can be disabled by <cpu mode='host-model'> <model fallback='forbid'/> </cpu> - the same as previous returned by virDomainGetXMLDesc with VIR_DOMAIN_XML_UPDATE_CPU flag: <cpu mode='host-model' match='exact'> <model fallback='allow'>Penryn</model> --+ <vendor>Intel</vendor> | <topology sockets='2' cores='4' threads='1'/> + copied from <feature policy='require' name='dca'/> | capabilities XML <feature policy='require' name='xtpr'/> | ... --+ </cpu> - guest CPU should be exactly the same as host CPU even in the aspects libvirt doesn't model (such domain cannot be migrated unless both hosts contain exactly the same CPUs): <cpu mode='host-passthrough'/> - the same as previous returned by virDomainGetXMLDesc with VIR_DOMAIN_XML_UPDATE_CPU flag: <cpu mode='host-passthrough' match='minimal'> <model>Penryn</model> --+ copied from caps <vendor>Intel</vendor> | XML but doesn't <topology sockets='2' cores='4' threads='1'/> | describe all <feature policy='require' name='dca'/> | aspects of the <feature policy='require' name='xtpr'/> | actual guest CPU ... --+ </cpu>
2011-08-18 10:14:36 +00:00
the guest CPU will not match the host CPU exactly. On the other
hand, the ABI provided to the guest is reproducible. During
migration, complete CPU model definition is transferred to the
destination host so the migrated guest will see exactly the same CPU
model even if the destination host contains more capable CPUs for
the running instance of the guest; but shutting down and restarting
the guest may present different hardware to the guest according to
the capabilities of the new host.</dd>
<dt><code>host-passthrough</code></dt>
<dd>With this mode, the CPU visible to the guest should be exactly
the same as the host CPU even in the aspects that libvirt does not
understand. Though the downside of this mode is that the guest
environment cannot be reproduced on different hardware. Thus, if you
hit any bugs, you are on your own. Neither <code>model</code> nor
<code>feature</code> elements are allowed in this mode.</dd>
</dl>
In both <code>host-model</code> and <code>host-passthrough</code>
mode, the real (approximate in <code>host-passthrough</code> mode) CPU
definition which would be used on current host can be determined by
specifying <code>VIR_DOMAIN_XML_UPDATE_CPU</code> flag when calling
<code>virDomainGetXMLDesc</code> API. When running a guest that might
be prone to operating system reactivation when presented with
different hardware, and which will be migrated between hosts with
different capabilities, you can use this output to rewrite XML to the
<code>custom</code> mode for more robust migration.
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
</dd>
<dt><code>model</code></dt>
<dd>The content of the <code>model</code> element specifies CPU model
requested by the guest. The list of available CPU models and their
definition can be found in <code>cpu_map.xml</code> file installed
cpu: Optionally forbid fallback CPU models In case a hypervisor doesn't support the exact CPU model requested by a domain XML, we automatically fallback to a closest CPU model the hypervisor supports (and make sure we add/remove any additional features if needed). This patch adds 'fallback' attribute to model element, which can be used to disable this automatic fallback.
2011-12-21 13:27:16 +00:00
in libvirt's data directory. If a hypervisor is not able to use the
exact CPU model, libvirt automatically falls back to a closest model
supported by the hypervisor while maintaining the list of CPU
features. <span class="since">Since 0.9.10</span>, an optional
<code>fallback</code> attribute can be used to forbid this behavior,
in which case an attempt to start a domain requesting an unsupported
CPU model will fail. Supported values for <code>fallback</code>
attribute are: <code>allow</code> (this is the default), and
docs: added description of the vendor_id attribute
2012-07-10 08:01:03 +00:00
<code>forbid</code>. The optional <code>vendor_id</code> attribute
build: commit to 0.10.0 release naming With 0.10.0-rc0 out the door, we are committed to the next version number. * src/libvirt_public.syms (LIBVIRT_0.9.14): Rename... (LIBVIRT_0.10.0): ...to this. * docs/formatdomain.html.in: Fix fallout. * src/openvz/openvz_driver.c (openvzDriver): Likewise. * src/remote/remote_driver.c (remote_driver): Likewise.
2012-08-01 17:00:35 +00:00
(<span class="since">Since 0.10.0</span>) can be used to set the
docs: added description of the vendor_id attribute
2012-07-10 08:01:03 +00:00
vendor id seen by the guest. It must be exactly 12 characters long.
If not set the vendor id of the host is used. Typical possible
values are "AuthenticAMD" and "GenuineIntel".</dd>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
cpu: Add support for CPU vendor By specifying <vendor> element in CPU requirements a guest can be restricted to run only on CPUs by a given vendor. Host CPU vendor is also specified in capabilities XML. The vendor is checked when migrating a guest but it's not forced, i.e., guests configured without <vendor> element can be freely migrated.
2010-07-02 15:51:59 +00:00
<dt><code>vendor</code></dt>
<dd><span class="since">Since 0.8.3</span> the content of the
<code>vendor</code> element specifies CPU vendor requested by the
guest. If this element is missing, the guest can be run on a CPU
matching given features regardless on its vendor. The list of
supported vendors can be found in <code>cpu_map.xml</code>.</dd>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<dt><code>topology</code></dt>
<dd>The <code>topology</code> element specifies requested topology of
virtual CPU provided to the guest. Three non-zero values have to be
given for <code>sockets</code>, <code>cores</code>, and
<code>threads</code>: total number of CPU sockets, number of cores per
socket, and number of threads per core, respectively.</dd>
<dt><code>feature</code></dt>
<dd>The <code>cpu</code> element can contain zero or more
<code>elements</code> used to fine-tune features provided by the
selected CPU model. The list of known feature names can be found in
the same file as CPU models. The meaning of each <code>feature</code>
element depends on its <code>policy</code> attribute, which has to be
set to one of the following values:
<dl>
<dt><code>force</code></dt>
<dd>The virtual CPU will claim the feature is supported regardless
of it being supported by host CPU.</dd>
<dt><code>require</code></dt>
<dd>Guest creation will fail unless the feature is supported by host
CPU.</dd>
<dt><code>optional</code></dt>
<dd>The feature will be supported by virtual CPU if and only if it
is supported by host CPU.</dd>
<dt><code>disable</code></dt>
<dd>The feature will not be supported by virtual CPU.</dd>
<dt><code>forbid</code></dt>
<dd>Guest creation will fail if the feature is supported by host
CPU.</dd>
</dl>
Set sensible defaults for cpu match and feature policy To enable the CPU XML from the capabilities to be pasted directly into the guest XML with no editing, pick a sensible default for match and feature policy. The CPU match will be exact and the feature policy will be require. This should ensure safety for migration and give DWIM semantics for users * src/conf/cpu_conf.c: Default to exact match and require policy * docs/formatdomain.html.in: Document new defaults
2010-09-22 11:47:48 +00:00
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<span class="since">Since 0.8.5</span> the <code>policy</code>
attribute can be omitted and will default to <code>require</code>.
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
</dd>
</dl>
XML definitions for guest NUMA and parsing routines This patch adds XML definitions for guest NUMA specification and contains routines to parse the same. The guest NUMA specification looks like this: <cpu> ... <topology sockets='2' cores='4' threads='2'/> <numa> <cell cpus='0-7' memory='512000'/> <cell cpus='8-15' memory='512000'/> </numa> ... </cpu> Signed-off-by: Bharata B Rao <bharata@linux.vnet.ibm.com>
2011-11-11 12:51:45 +00:00
<p>
Fix minor typos in messages and docs Signed-off-by: Eric Blake <eblake@redhat.com>
2013-07-30 08:21:11 +00:00
Guest NUMA topology can be specified using the <code>numa</code> element.
XML definitions for guest NUMA and parsing routines This patch adds XML definitions for guest NUMA specification and contains routines to parse the same. The guest NUMA specification looks like this: <cpu> ... <topology sockets='2' cores='4' threads='2'/> <numa> <cell cpus='0-7' memory='512000'/> <cell cpus='8-15' memory='512000'/> </numa> ... </cpu> Signed-off-by: Bharata B Rao <bharata@linux.vnet.ibm.com>
2011-11-11 12:51:45 +00:00
<span class="since">Since 0.9.8</span>
</p>
<pre>
...
&lt;cpu&gt;
...
&lt;numa&gt;
&lt;cell cpus='0-3' memory='512000'/&gt;
&lt;cell cpus='4-7' memory='512000'/&gt;
&lt;/numa&gt;
...
&lt;/cpu&gt;
...</pre>
<p>
Each <code>cell</code> element specifies a NUMA cell or a NUMA node.
<code>cpus</code> specifies the CPU or range of CPUs that are part of
docs: use correct terminology for 1024 bytes Yes, I like kilobytes better than kibibytes (when I say kilobytes, I generally mean 1024). But since the term is ambiguous, it can't hurt to say what we mean, by using both the correct name and calling out the numeric equivalent. * src/libvirt.c (virDomainGetMaxMemory, virDomainSetMaxMemory) (virDomainSetMemory, virDomainSetMemoryFlags) (virNodeGetFreeMemory): Tweak wording. * docs/formatdomain.html.in: Likewise. * docs/formatstorage.html.in: Likewise.
2012-03-02 15:23:07 +00:00
the node. <code>memory</code> specifies the node memory in kibibytes
XML definitions for guest NUMA and parsing routines This patch adds XML definitions for guest NUMA specification and contains routines to parse the same. The guest NUMA specification looks like this: <cpu> ... <topology sockets='2' cores='4' threads='2'/> <numa> <cell cpus='0-7' memory='512000'/> <cell cpus='8-15' memory='512000'/> </numa> ... </cpu> Signed-off-by: Bharata B Rao <bharata@linux.vnet.ibm.com>
2011-11-11 12:51:45 +00:00
(i.e. blocks of 1024 bytes). Each cell or node is assigned cellid
or nodeid in the increasing order starting from 0.
</p>
<p>
This guest NUMA specification is currently available only for QEMU/KVM.
</p>
conf: Rename life cycle actions to event actions While current on_{poweroff,reboot,crash} action configuration is about configuring life cycle actions, they can all be considered events and actions that need to be done on a particular event. Let's generalize the code by renaming life cycle actions to event actions so that it can be reused later for non-lifecycle events.
2012-09-06 19:56:49 +00:00
<h3><a name="elementsEvents">Events configuration</a></h3>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
It is sometimes necessary to override the default actions taken
docs: Update formatdomain for lifecycle events
2013-04-23 21:51:08 +00:00
on various events. Not all hypervisors support all events and actions.
The actions may be taken as a result of calls to libvirt APIs
<code class='docref'>virDomainReboot</code>,
<code class='docref'>virDomainShutdown</code>, or
<code class='docref'>virDomainShutdownFlags</code>.
Using <code>virsh reboot</code> or <code>virsh shutdown</code> would
also trigger the event.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
&lt;on_reboot&gt;restart&lt;/on_reboot&gt;
&lt;on_crash&gt;restart&lt;/on_crash&gt;
conf: Add on_lockfailure event configuration Using this new element, one can configure an action that should be performed when resource locks are lost.
2012-09-06 20:17:01 +00:00
&lt;on_lockfailure&gt;poweroff&lt;/on_lockfailure&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
conf: Rename life cycle actions to event actions While current on_{poweroff,reboot,crash} action configuration is about configuring life cycle actions, they can all be considered events and actions that need to be done on a particular event. Let's generalize the code by renaming life cycle actions to event actions so that it can be reused later for non-lifecycle events.
2012-09-06 19:56:49 +00:00
<p>
The following collections of elements allow the actions to be
specified when a guest OS triggers a lifecycle operation. A
common use case is to force a reboot to be treated as a poweroff
when doing the initial OS installation. This allows the VM to be
re-configured for the first post-install bootup.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>on_poweroff</code></dt>
<dd>The content of this element specifies the action to take when
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the guest requests a poweroff.</dd>
"copy-paste" errors * docs/formatdomain.html docs/formatdomain.html.in: Anton Protopopov pointed out a few "copy-paste" errors daniel
2008-05-22 14:57:32 +00:00
<dt><code>on_reboot</code></dt>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dd>The content of this element specifies the action to take when
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the guest requests a reboot.</dd>
"copy-paste" errors * docs/formatdomain.html docs/formatdomain.html.in: Anton Protopopov pointed out a few "copy-paste" errors daniel
2008-05-22 14:57:32 +00:00
<dt><code>on_crash</code></dt>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dd>The content of this element specifies the action to take when
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the guest crashes.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
<p>
Each of these states allow for the same four possible actions.
</p>
<dl>
<dt><code>destroy</code></dt>
<dd>The domain will be terminated completely and all resources
docs: Update formatdomain for lifecycle events
2013-04-23 21:51:08 +00:00
released.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>restart</code></dt>
docs: Update formatdomain for lifecycle events
2013-04-23 21:51:08 +00:00
<dd>The domain will be terminated and then restarted with
the same configuration.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>preserve</code></dt>
docs: Update formatdomain for lifecycle events
2013-04-23 21:51:08 +00:00
<dd>The domain will be terminated and its resource preserved
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to allow analysis.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>rename-restart</code></dt>
docs: Update formatdomain for lifecycle events
2013-04-23 21:51:08 +00:00
<dd>The domain will be terminated and then restarted with
a new name.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
Add actions to virDomainLifecycle enum Xen supports on_crash actions coredump-{destroy,restart}. libvirt cannot parse config returned by xend that contains either of these actions xen52 # xm li -l test | grep on_crash (on_crash coredump-restart) xen52 # virsh dumpxml test error: internal error unknown lifecycle type coredump-restart This patch adds a new virDomainLifecycleCrash enum and appends the new options to existing destroy, restart, preserve, and rename-restart options.
2010-08-12 17:15:44 +00:00
<p>
docs: Update formatdomain for lifecycle events
2013-04-23 21:51:08 +00:00
QEMU/KVM supports the <code>on_poweroff</code> and <code>on_reboot</code>
events handling the <code>destroy</code> and <code>restart</code> actions.
The <code>preserve</code> action for an <code>on_reboot</code> event
is treated as a <code>destroy</code> and the <code>rename-restart</code>
action for an <code>on_poweroff</code> event is treated as a
<code>restart</code> event.
</p>
<p>
The <code>on_crash</code> event supports these additional
Add actions to virDomainLifecycle enum Xen supports on_crash actions coredump-{destroy,restart}. libvirt cannot parse config returned by xend that contains either of these actions xen52 # xm li -l test | grep on_crash (on_crash coredump-restart) xen52 # virsh dumpxml test error: internal error unknown lifecycle type coredump-restart This patch adds a new virDomainLifecycleCrash enum and appends the new options to existing destroy, restart, preserve, and rename-restart options.
2010-08-12 17:15:44 +00:00
actions <span class="since">since 0.8.4</span>.
</p>
<dl>
<dt><code>coredump-destroy</code></dt>
<dd>The crashed domain's core will be dumped, and then the
domain will be terminated completely and all resources
released</dd>
<dt><code>coredump-restart</code></dt>
<dd>The crashed domain's core will be dumped, and then the
domain will be restarted with the same configuration</dd>
</dl>
conf: Add on_lockfailure event configuration Using this new element, one can configure an action that should be performed when resource locks are lost.
2012-09-06 20:17:01 +00:00
<p>
The <code>on_lockfailure</code> element (<span class="since">since
maint: prepare for next release number Given Daniel's announcement[1], code targetting the next release will be in 1.0.0, not 0.10.3. Changed mechanically with: for f in $(git grep -l '0\(.\)10\13\b') ; do sed -i -e 's/0\(.\)10\13/1\10\10/g' $f done [1]https://www.redhat.com/archives/libvir-list/2012-October/msg00403.html * docs/formatdomain.html.in: Use 1.0.0 for next release. * src/interface/interface_backend_udev.c: Likewise.
2012-10-15 21:17:34 +00:00
1.0.0</span>) may be used to configure what action should be
conf: Add on_lockfailure event configuration Using this new element, one can configure an action that should be performed when resource locks are lost.
2012-09-06 20:17:01 +00:00
taken when a lock manager loses resource locks. The following
actions are recognized by libvirt, although not all of them need
to be supported by individual lock managers. When no action is
specified, each lock manager will take its default action.
</p>
<dl>
<dt><code>poweroff</code></dt>
<dd>The domain will be forcefully powered off.</dd>
<dt><code>restart</code></dt>
<dd>The domain will be powered off and started up again to
reacquire its locks.</dd>
<dt><code>pause</code></dt>
<dd>The domain will be paused so that it can be manually resumed
when lock issues are solved.</dd>
<dt><code>ignore</code></dt>
<dd>Keep the domain running as if nothing happened.</dd>
</dl>
Add per-guest S3/S4 state configuration There is a new <pm/> element implemented that can control what ACPI sleeping states will be advertised by BIOS and allowed to be switched to by libvirt. The default keeps defaults on hypervisor, otherwise forces chosen setting. The documentation of the pm element is added as well.
2012-08-02 10:12:50 +00:00
<h3><a name="elementsPowerManagement">Power Management</a></h3>
<p>
<span class="since">Since 0.10.2</span> it is possible to
forcibly enable or disable BIOS advertisements to the guest
OS. (NB: Only qemu driver support)
</p>
<pre>
...
&lt;pm&gt;
&lt;suspend-to-disk enabled='no'/&gt;
Correct name of domain/pm/suspend-to-mem in docs
2012-10-10 19:44:35 +00:00
&lt;suspend-to-mem enabled='yes'/&gt;
Add per-guest S3/S4 state configuration There is a new <pm/> element implemented that can control what ACPI sleeping states will be advertised by BIOS and allowed to be switched to by libvirt. The default keeps defaults on hypervisor, otherwise forces chosen setting. The documentation of the pm element is added as well.
2012-08-02 10:12:50 +00:00
&lt;/pm&gt;
...</pre>
<dl>
<dt><code>pm</code></dt>
<dd>These elements enable ('yes') or disable ('no') BIOS support
for S3 (suspend-to-disk) and S4 (suspend-to-mem) ACPI sleep
states. If nothing is specified, then the hypervisor will be
left with its default value.</dd>
</dl>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h3><a name="elementsFeatures">Hypervisor features</a></h3>
<p>
Hypervisors may allow certain CPU / machine features to be
toggled on/off.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;features&gt;
&lt;pae/&gt;
&lt;acpi/&gt;
&lt;apic/&gt;
Document HAP domain feature Add HAP feature to schema and documentation.
2011-01-05 23:07:54 +00:00
&lt;hap/&gt;
Add support for forcing a private network namespace for LXC guests If no <interface> elements are included in an LXC guest XML description, then the LXC guest will just see the host's network interfaces. It is desirable to be able to hide the host interfaces, without having to define any guest interfaces. This patch introduces a new feature flag <privnet/> to allow forcing of a private network namespace for LXC. In the future I also anticipate that we will add <privuser/> to force a private user ID namespace. * src/conf/domain_conf.c, src/conf/domain_conf.h: Add support for <privnet/> feature. Auto-set <privnet> if any <interface> devices are defined * src/lxc/lxc_container.c: Honour request for private network namespace
2012-01-18 11:38:49 +00:00
&lt;privnet/&gt;
conf: Add support for HyperV Enlightenment features Hypervisors are starting to support HyperV Enlightenment features that improve behavior of guests running Microsoft Windows operating systems. This patch adds support for the "relaxed" feature that improves timer behavior and also establishes a framework to add these features in future.
2012-10-16 16:25:56 +00:00
&lt;hyperv&gt;
docs: fix some typos in examples As detected in https://bugzilla.redhat.com/show_bug.cgi?id=887187 * docs/formatdomain.html.in: Fix XML typos.
2012-12-14 15:28:57 +00:00
&lt;relaxed state='on'/&gt;
conf: add vapic and spinlocks to hyperv features Add new CPU features for HyperV: vapic for virtual APIC support spinlocks for setting spinlock support <features> <hyperv> <vapic state='on'/> <spinlocks state='on' retries='4096'/> </hyperv> </features> https://bugzilla.redhat.com/show_bug.cgi?id=784836
2013-06-21 10:20:12 +00:00
&lt;vapic state='on'/&gt;
Remove leftovers from hyperv spinlocks documentation Somehow I managed to leave this monstrosity in. Introduced by 800b51d.
2013-08-12 12:06:46 +00:00
&lt;spinlocks state='on' retries='4096'/&gt;
conf: Add support for HyperV Enlightenment features Hypervisors are starting to support HyperV Enlightenment features that improve behavior of guests running Microsoft Windows operating systems. This patch adds support for the "relaxed" feature that improves timer behavior and also establishes a framework to add these features in future.
2012-10-16 16:25:56 +00:00
&lt;/hyperv&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/features&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
All features are listed within the <code>features</code>
element, omitting a togglable feature tag turns it off.
The available features can be found by asking
for the <a href="formatcaps.html">capabilities XML</a>,
but a common set for fully virtualized domains are:
</p>
<dl>
<dt><code>pae</code></dt>
<dd>Physical address extension mode allows 32-bit guests
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to address more than 4 GB of memory.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>acpi</code></dt>
<dd>ACPI is useful for power management, for example, with
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
KVM guests it is required for graceful shutdown to work.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
Add support for EOI with APIC New options is added to support EOI (End of Interrupt) exposure for guests. As it makes sense only when APIC is enabled, I added this into the <apic> element in <features> because this should be tri-state option (cannot be handled as standalone feature).
2012-09-12 22:10:56 +00:00
<dt><code>apic</code></dt>
<dd>APIC allows the use of programmable IRQ
Fix minor details not only in apic eoi The introduction of APIC EOI patches had a few little details that could look better, so this patch fixes that and one more place in the file as well (same problem).
2012-09-18 09:40:52 +00:00
management. <span class="since">Since 0.10.2 (QEMU only)</span> there is
an optional attribute <code>eoi</code> with values <code>on</code>
and <code>off</code> which toggles the availability of EOI (End of
Add support for EOI with APIC New options is added to support EOI (End of Interrupt) exposure for guests. As it makes sense only when APIC is enabled, I added this into the <apic> element in <features> because this should be tri-state option (cannot be handled as standalone feature).
2012-09-12 22:10:56 +00:00
Interrupt) for the guest.
</dd>
Document HAP domain feature Add HAP feature to schema and documentation.
2011-01-05 23:07:54 +00:00
<dt><code>hap</code></dt>
<dd>Enable use of Hardware Assisted Paging if available in
the hardware.
</dd>
Add missing docs for <viridian/> feature flag
2012-01-25 14:34:12 +00:00
<dt><code>viridian</code></dt>
<dd>Enable Viridian hypervisor extensions for paravirtualizing
guest operating systems
</dd>
Add support for forcing a private network namespace for LXC guests If no <interface> elements are included in an LXC guest XML description, then the LXC guest will just see the host's network interfaces. It is desirable to be able to hide the host interfaces, without having to define any guest interfaces. This patch introduces a new feature flag <privnet/> to allow forcing of a private network namespace for LXC. In the future I also anticipate that we will add <privuser/> to force a private user ID namespace. * src/conf/domain_conf.c, src/conf/domain_conf.h: Add support for <privnet/> feature. Auto-set <privnet> if any <interface> devices are defined * src/lxc/lxc_container.c: Honour request for private network namespace
2012-01-18 11:38:49 +00:00
<dt><code>privnet</code></dt>
<dd>Always create a private network namespace. This is
automatically set if any interface devices are defined.
This feature is only relevant for container based
virtualization drivers, such as LXC.
</dd>
conf: Add support for HyperV Enlightenment features Hypervisors are starting to support HyperV Enlightenment features that improve behavior of guests running Microsoft Windows operating systems. This patch adds support for the "relaxed" feature that improves timer behavior and also establishes a framework to add these features in future.
2012-10-16 16:25:56 +00:00
<dt><code>hyperv</code></dt>
<dd>Enable various features improving behavior of guests
running Microsoft Windows.
<table class="top_table">
<tr>
<th>Feature</th>
<th>Description</th>
<th>Value</th>
conf: add vapic and spinlocks to hyperv features Add new CPU features for HyperV: vapic for virtual APIC support spinlocks for setting spinlock support <features> <hyperv> <vapic state='on'/> <spinlocks state='on' retries='4096'/> </hyperv> </features> https://bugzilla.redhat.com/show_bug.cgi?id=784836
2013-06-21 10:20:12 +00:00
<th>Since</th>
conf: Add support for HyperV Enlightenment features Hypervisors are starting to support HyperV Enlightenment features that improve behavior of guests running Microsoft Windows operating systems. This patch adds support for the "relaxed" feature that improves timer behavior and also establishes a framework to add these features in future.
2012-10-16 16:25:56 +00:00
</tr>
<tr>
<td>relaxed</td>
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
<td>Relax constraints on timers</td>
conf: Add support for HyperV Enlightenment features Hypervisors are starting to support HyperV Enlightenment features that improve behavior of guests running Microsoft Windows operating systems. This patch adds support for the "relaxed" feature that improves timer behavior and also establishes a framework to add these features in future.
2012-10-16 16:25:56 +00:00
<td> on, off</td>
conf: add vapic and spinlocks to hyperv features Add new CPU features for HyperV: vapic for virtual APIC support spinlocks for setting spinlock support <features> <hyperv> <vapic state='on'/> <spinlocks state='on' retries='4096'/> </hyperv> </features> https://bugzilla.redhat.com/show_bug.cgi?id=784836
2013-06-21 10:20:12 +00:00
<td><span class="since">1.0.0 (QEMU only)</span></td>
</tr>
<tr>
<td>vapic</td>
<td>Enable virtual APIC</td>
<td>on, off</td>
<td><span class="since">1.1.0 (QEMU only)</span></td>
</tr>
<tr>
<td>spinlocks</td>
<td>Enable spinlock support</td>
<td>on, off; retries - at least 4095</td>
<td><span class="since">1.1.0 (QEMU only)</span></td>
conf: Add support for HyperV Enlightenment features Hypervisors are starting to support HyperV Enlightenment features that improve behavior of guests running Microsoft Windows operating systems. This patch adds support for the "relaxed" feature that improves timer behavior and also establishes a framework to add these features in future.
2012-10-16 16:25:56 +00:00
</tr>
</table>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
<h3><a name="elementsTime">Time keeping</a></h3>
<p>
The guest clock is typically initialized from the host clock.
Most operating systems expect the hardware clock to be kept
in UTC, and this is the default. Windows, however, expects
it to be in so called 'localtime'.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
doc: Fix time keeping example for the guest clock The time keeping example was missing quotes which resulted in an error if you copied and pasted the example into a domain's XML. Additionally the rest of the examples use single quotes (') instead of double quotes (") so standardized that.
2012-07-21 13:14:44 +00:00
&lt;clock offset='localtime'&gt;
&lt;timer name='rtc' tickpolicy='catchup' track='guest'&gt;
&lt;catchup threshold='123' slew='120' limit='10000'/&gt;
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
&lt;/timer&gt;
doc: Fix time keeping example for the guest clock The time keeping example was missing quotes which resulted in an error if you copied and pasted the example into a domain's XML. Additionally the rest of the examples use single quotes (') instead of double quotes (") so standardized that.
2012-07-21 13:14:44 +00:00
&lt;timer name='pit' tickpolicy='delay'/&gt;
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
&lt;/clock&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>clock</code></dt>
Expand docs about clock modes * formatdomain.html.in: Document new clock options
2010-02-02 18:46:52 +00:00
<dd>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<p>The <code>offset</code> attribute takes four possible
values, allowing fine grained control over how the guest
clock is synchronized to the host. NB, not all hypervisors
support all modes.</p>
<dl>
<dt><code>utc</code></dt>
<dd>
The guest clock will always be synchronized to UTC when
Support clock=variable relative to localtime Since Xen 3.1 the clock=variable semantic is supported. In addition to qemu/kvm Xen also knows about a variant where the offset is relative to 'localtime' instead of 'utc'. Extends the libvirt structure with a flag 'basis' to specify, if the offset is relative to 'localtime' or 'utc'. Extends the libvirt structure with a flag 'reset' to force the reset behaviour of 'localtime' and 'utc'; this is needed for backward compatibility with previous versions of libvirt, since they report incorrect XML. Adapt the only user 'qemu' to the new name. Extend the RelaxNG schema accordingly. Document the new 'basis' attribute in the HTML documentation. Adapt test for the new attribute. Signed-off-by: Philipp Hahn <hahn@univention.de>
2012-02-06 13:59:16 +00:00
booted.
<span class="since">Since 0.9.11</span> 'utc' mode can be converted
to 'variable' mode, which can be controlled by using the
<code>adjustment</code> attribute. If the value is 'reset', the
conversion is never done (not all hypervisors can
synchronize to UTC on each boot; use of 'reset' will cause
an error on those hypervisors). A numeric value
forces the conversion to 'variable' mode using the value as the
initial adjustment. The default <code>adjustment</code> is
hypervisor specific.
</dd>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<dt><code>localtime</code></dt>
<dd>
The guest clock will be synchronized to the host's configured
timezone when booted, if any.
Support clock=variable relative to localtime Since Xen 3.1 the clock=variable semantic is supported. In addition to qemu/kvm Xen also knows about a variant where the offset is relative to 'localtime' instead of 'utc'. Extends the libvirt structure with a flag 'basis' to specify, if the offset is relative to 'localtime' or 'utc'. Extends the libvirt structure with a flag 'reset' to force the reset behaviour of 'localtime' and 'utc'; this is needed for backward compatibility with previous versions of libvirt, since they report incorrect XML. Adapt the only user 'qemu' to the new name. Extend the RelaxNG schema accordingly. Document the new 'basis' attribute in the HTML documentation. Adapt test for the new attribute. Signed-off-by: Philipp Hahn <hahn@univention.de>
2012-02-06 13:59:16 +00:00
<span class="since">Since 0.9.11,</span> the <code>adjustment</code>
attribute behaves the same as in 'utc' mode.
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</dd>
<dt><code>timezone</code></dt>
<dd>
The guest clock will be synchronized to the requested timezone
using the <code>timezone</code> attribute.
<span class="since">Since 0.7.7</span>
</dd>
<dt><code>variable</code></dt>
<dd>
The guest clock will have an arbitrary offset applied
Support clock=variable relative to localtime Since Xen 3.1 the clock=variable semantic is supported. In addition to qemu/kvm Xen also knows about a variant where the offset is relative to 'localtime' instead of 'utc'. Extends the libvirt structure with a flag 'basis' to specify, if the offset is relative to 'localtime' or 'utc'. Extends the libvirt structure with a flag 'reset' to force the reset behaviour of 'localtime' and 'utc'; this is needed for backward compatibility with previous versions of libvirt, since they report incorrect XML. Adapt the only user 'qemu' to the new name. Extend the RelaxNG schema accordingly. Document the new 'basis' attribute in the HTML documentation. Adapt test for the new attribute. Signed-off-by: Philipp Hahn <hahn@univention.de>
2012-02-06 13:59:16 +00:00
relative to UTC or localtime, depending on the <code>basis</code>
attribute. The delta relative to UTC (or localtime) is specified
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
in seconds, using the <code>adjustment</code> attribute.
documentation: trivial spelling fix Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-10-18 14:53:55 +00:00
The guest is free to adjust the RTC over time and expect
Support clock=variable relative to localtime Since Xen 3.1 the clock=variable semantic is supported. In addition to qemu/kvm Xen also knows about a variant where the offset is relative to 'localtime' instead of 'utc'. Extends the libvirt structure with a flag 'basis' to specify, if the offset is relative to 'localtime' or 'utc'. Extends the libvirt structure with a flag 'reset' to force the reset behaviour of 'localtime' and 'utc'; this is needed for backward compatibility with previous versions of libvirt, since they report incorrect XML. Adapt the only user 'qemu' to the new name. Extend the RelaxNG schema accordingly. Document the new 'basis' attribute in the HTML documentation. Adapt test for the new attribute. Signed-off-by: Philipp Hahn <hahn@univention.de>
2012-02-06 13:59:16 +00:00
that it will be honored at next reboot. This is in
contrast to 'utc' and 'localtime' mode (with the optional
attribute adjustment='reset'), where the RTC adjustments are
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
lost at each reboot. <span class="since">Since 0.7.7</span>
Support clock=variable relative to localtime Since Xen 3.1 the clock=variable semantic is supported. In addition to qemu/kvm Xen also knows about a variant where the offset is relative to 'localtime' instead of 'utc'. Extends the libvirt structure with a flag 'basis' to specify, if the offset is relative to 'localtime' or 'utc'. Extends the libvirt structure with a flag 'reset' to force the reset behaviour of 'localtime' and 'utc'; this is needed for backward compatibility with previous versions of libvirt, since they report incorrect XML. Adapt the only user 'qemu' to the new name. Extend the RelaxNG schema accordingly. Document the new 'basis' attribute in the HTML documentation. Adapt test for the new attribute. Signed-off-by: Philipp Hahn <hahn@univention.de>
2012-02-06 13:59:16 +00:00
<span class="since">Since 0.9.11</span> the <code>basis</code>
attribute can be either 'utc' (default) or 'localtime'.
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</dd>
</dl>
<p>
A <code>clock</code> may have zero or more
<code>timer</code>sub-elements. <span class="since">Since
0.8.0</span>
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
<dt><code>timer</code></dt>
<dd>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<p>
Each timer element requires a <code>name</code> attribute,
and has other optional attributes that depend on
the <code>name</code> specified. Various hypervisors
support different combinations of attributes.
</p>
<dl>
<dt><code>name</code></dt>
<dd>
The <code>name</code> attribute selects which timer is
docs: Document hypervisor drivers that support certain timer models Not every timer model is supported with each hypervisor. Explicitly mention the driver supporting each timer model.
2013-06-24 14:03:37 +00:00
being modified, and can be one of
"platform" (currently unsupported),
"hpet" (libxl, xen, qemu), "kvmclock" (qemu),
"pit" (qemu), "rtc" (qemu), or "tsc" (libxl).
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</dd>
<dt><code>track</code></dt>
<dd>
The <code>track</code> attribute specifies what the timer
tracks, and can be "boot", "guest", or "wall".
Only valid for <code>name="rtc"</code>
or <code>name="platform"</code>.
</dd>
<dt><code>tickpolicy</code></dt>
<dd>
Expand docs for timer tick policy
2012-03-26 12:29:41 +00:00
<p>
The <code>tickpolicy</code> attribute determines what
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
happens when QEMU misses a deadline for injecting a
Expand docs for timer tick policy
2012-03-26 12:29:41 +00:00
tick to the guest:
</p>
<dl>
<dt><code>delay</code></dt>
<dd>Continue to deliver ticks at the normal rate.
The guest time will be delayed due to the late
tick</dd>
<dt><code>catchup</code></dt>
<dd>Deliver ticks at a higher rate to catch up
with the missed tick. The guest time should
not be delayed once catchup is complete.</dd>
<dt><code>merge</code></dt>
<dd>Merge the missed tick(s) into one tick and
inject. The guest time may be delayed, depending
on how the OS reacts to the merging of ticks</dd>
<dt><code>discard</code></dt>
<dd>Throw away the missed tick(s) and continue
with future injection normally. The guest time
may be delayed, unless the OS has explicit
handling of lost ticks</dd>
</dl>
<p>If the policy is "catchup", there can be further details in
the <code>catchup</code> sub-element.</p>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<dl>
<dt><code>catchup</code></dt>
<dd>
The <code>catchup</code> element has three optional
attributes, each a positive integer. The attributes
are <code>threshold</code>, <code>slew</code>,
and <code>limit</code>.
</dd>
</dl>
Expand docs for timer tick policy
2012-03-26 12:29:41 +00:00
<p>
Note that hypervisors are not required to support all policies across all time sources
</p>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</dd>
<dt><code>frequency</code></dt>
<dd>
The <code>frequency</code> attribute is an unsigned
integer specifying the frequency at
which <code>name="tsc"</code> runs.
</dd>
<dt><code>mode</code></dt>
<dd>
The <code>mode</code> attribute controls how
the <code>name="tsc"</code> timer is managed, and can be
"auto", "native", "emulate", "paravirt", or "smpsafe".
Other timers are always emulated.
</dd>
<dt><code>present</code></dt>
<dd>
The <code>present</code> attribute can be "yes" or "no" to
specify whether a particular timer is available to the guest.
</dd>
</dl>
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
<h3><a name="elementsDevices">Devices</a></h3>
<p>
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
The final set of XML elements are all used to describe devices
Update domain XML docs
2008-05-08 14:20:07 +00:00
provided to the guest domain. All devices occur as children
of the main <code>devices</code> element.
<span class="since">Since 0.1.3</span>
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>emulator</code></dt>
<dd>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
The contents of the <code>emulator</code> element specify
the fully qualified path to the device model emulator binary.
The <a href="formatcaps.html">capabilities XML</a> specifies
the recommended default emulator to use for each particular
domain type / architecture combination.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
</dl>
<h4><a name="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>
<p>
Any device that looks like a disk, be it a floppy, harddisk,
cdrom, or paravirtualized driver is specified via the <code>disk</code>
element.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;disk type='file' snapshot='external'&gt;
Add docs on drive <serial> element * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
&lt;driver name="tap" type="aio" cache="default"/&gt;
docs: re-fix stray / Commit 6cb4acc reintroduced the bug fixed in commit d145fe3. * docs/formatdomain.html.in (elementsDisks): Fix again.
2011-12-31 13:42:01 +00:00
&lt;source file='/var/lib/xen/images/fv0' startupPolicy='optional'&gt;
seclabel: extend XML to allow per-disk label overrides When doing security relabeling, there are cases where a per-file override might be appropriate. For example, with a static label and relabeling, it might be appropriate to skip relabeling on a particular disk, where the backing file lives on NFS that lacks the ability to track labeling. Or with dynamic labeling, it might be appropriate to use a custom (non-dynamic) label for a disk specifically intended to be shared across domains. The new XML resembles the top-level <seclabel>, but with fewer options (basically relabel='no', or <label>text</label>): <domain ...> ... <devices> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='no'/> <!-- override for just this disk --> </source> ... </disk> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='yes'> <!-- override for just this disk --> <label>system_u:object_r:shared_content_t:s0</label> </seclabel> </source> ... </disk> ... </devices> <seclabel type='dynamic' model='selinux'> <baselabel>text</baselabel> <!-- used for all devices without override --> </seclabel> </domain> This patch only introduces the XML and documentation; future patches will actually parse and make use of it. The intent is that we can further extend things as needed, adding a per-device <seclabel> in more places (such as the source of a console device), and possibly allowing a <baselabel> instead of <label> for labeling where we want to reuse the cNNN,cNNN pair of a dynamically labeled domain but a different base label. First suggested by Daniel P. Berrange here: https://www.redhat.com/archives/libvir-list/2011-December/msg00258.html * docs/schemas/domaincommon.rng (devSeclabel): New define. (disk): Use it. * docs/formatdomain.html.in (elementsDisks, seclabel): Document the new XML. * tests/qemuxml2argvdata/qemuxml2argv-seclabel-dynamic-override.xml: New test, to validate RNG.
2011-12-23 00:47:49 +00:00
&lt;seclabel relabel='no'/&gt;
&lt;/source&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;target dev='hda' bus='ide'/&gt;
Support block I/O throttle in XML Enable block I/O throttle for per-disk in XML, as the first per-disk IO tuning parameter. Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-15 09:02:46 +00:00
&lt;iotune&gt;
&lt;total_bytes_sec&gt;10000000&lt;/total_bytes_sec&gt;
&lt;read_iops_sec&gt;400000&lt;/read_iops_sec&gt;
&lt;write_iops_sec&gt;100000&lt;/write_iops_sec&gt;
&lt;/iotune&gt;
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
&lt;boot order='2'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;encryption type='...'&gt;
...
&lt;/encryption&gt;
&lt;shareable/&gt;
Add docs on drive <serial> element * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
&lt;serial&gt;
...
&lt;/serial&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/disk&gt;
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
...
&lt;disk type='network'&gt;
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
&lt;driver name="qemu" type="raw" io="threads" ioeventfd="on" event_idx="off"/&gt;
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
&lt;source protocol="sheepdog" name="image_name"&gt;
&lt;host name="hostname" port="7000"/&gt;
&lt;/source&gt;
&lt;target dev="hdb" bus="ide"/&gt;
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
&lt;boot order='1'/&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;transient/&gt;
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
&lt;address type='drive' controller='0' bus='1' unit='0'/&gt;
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
&lt;/disk&gt;
storage: add auth to virDomainDiskDef Add additional fields to let you specify the how to authenticate with a disk. The secret to use may be referenced by a usage string or a UUID, i.e.: <auth username='myuser'> <secret type='ceph' usage='secretname'/> </auth> or <auth username='myuser'> <secret type='ceph' uuid='0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f'/> </auth> Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-10-28 18:29:39 +00:00
&lt;disk type='network'&gt;
&lt;driver name="qemu" type="raw"/&gt;
&lt;source protocol="rbd" name="image_name2"&gt;
&lt;host name="hostname" port="7000"/&gt;
&lt;/source&gt;
&lt;target dev="hdd" bus="ide"/&gt;
&lt;auth username='myuser'&gt;
&lt;secret type='ceph' usage='mypassid'/&gt;
&lt;/auth&gt;
&lt;/disk&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;disk type='block' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
docs: Add documentation for new attribute tray of disk target Example XML: <disk type='file' device='cdrom'> <driver name='qemu' type='raw'/> <source file='/tmp/cdrom.img'/> <target dev='hdd' bus='ide' tray='open'/> </disk>
2012-03-14 15:26:46 +00:00
&lt;target dev='hdc' bus='ide' tray='open'/&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;readonly/&gt;
&lt;/disk&gt;
Add http protocol support for cdrom disk QEMU/KVM already allows a HTTP URL for the cdrom ISO image so add this support to libvirt as well. The xml should be as following: <disk type='network' device='cdrom'> <source protocol='http' name='/url/path'> <host name='host.name' port='80'/> </source> </disk> Signed-off-by: Aline Manera <alinefm@br.ibm.com>
2013-08-22 19:03:07 +00:00
&lt;disk type='network' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source protocol="http" name="url_path"&gt;
&lt;host name="hostname" port="80"/&gt;
&lt;/source&gt;
&lt;target dev='hdc' bus='ide' tray='open'/&gt;
&lt;readonly/&gt;
&lt;/disk&gt;
Add https protocol support for cdrom disk The https protocol is also accepted by qemu/KVM when specifying the cdrom ISO image. The xml should be as following: <disk type='network' device='cdrom'> <source protocol='https' name='/url/path'> <host name='host.name' port='443'/> </source> </disk> Signed-off-by: Aline Manera <alinefm@br.ibm.com>
2013-09-16 17:12:51 +00:00
&lt;disk type='network' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source protocol="https" name="url_path"&gt;
&lt;host name="hostname" port="443"/&gt;
&lt;/source&gt;
&lt;target dev='hdc' bus='ide' tray='open'/&gt;
&lt;readonly/&gt;
&lt;/disk&gt;
Add ftp protocol support for cdrom disk The ftp protocol is already recognized by qemu/KVM so add this support to libvirt as well. The xml should be as following: <disk type='network' device='cdrom'> <source protocol='ftp' name='/url/path'> <host name='host.name' port='21'/> </source> </disk> Signed-off-by: Aline Manera <alinefm@br.ibm.com>
2013-08-22 19:03:08 +00:00
&lt;disk type='network' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source protocol="ftp" name="url_path"&gt;
&lt;host name="hostname" port="21"/&gt;
&lt;/source&gt;
&lt;target dev='hdc' bus='ide' tray='open'/&gt;
&lt;readonly/&gt;
&lt;/disk&gt;
Add ftps protocol support for cdrom disk The ftps protocol is another protocol supported by qemu/KVM while specifying the cdrom ISO image. The xml should be as following: <disk type='network' device='cdrom'> <source protocol='ftps' name='/url/path'> <host name='host.name' port='990'/> </source> </disk> Signed-off-by: Aline Manera <alinefm@br.ibm.com>
2013-09-16 17:12:52 +00:00
&lt;disk type='network' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source protocol="ftps" name="url_path"&gt;
&lt;host name="hostname" port="990"/&gt;
&lt;/source&gt;
&lt;target dev='hdc' bus='ide' tray='open'/&gt;
&lt;readonly/&gt;
&lt;/disk&gt;
Add tftp protocol support for cdrom disk qemu/KVM also supports a tftp URL while specifying the cdrom ISO image. The xml should be as following: <disk type='network' device='cdrom'> <source protocol='tftp' name='/url/path'> <host name='host.name' port='69'/> </source> </disk> Signed-off-by: Aline Manera <alinefm@br.ibm.com>
2013-09-16 17:12:53 +00:00
&lt;disk type='network' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source protocol="tftp" name="url_path"&gt;
&lt;host name="hostname" port="69"/&gt;
&lt;/source&gt;
&lt;target dev='hdc' bus='ide' tray='open'/&gt;
&lt;readonly/&gt;
&lt;/disk&gt;
conf: Introduce new attribute for device address format * src/conf/domain_conf.h: Add new member "target" to struct _virDomainDeviceDriveAddress. * src/conf/domain_conf.c: Parse and format "target" * Lots of tests (.xml) in tests/domainsnapshotxml2xmlout, tests/qemuxml2argvdata, tests/qemuxml2xmloutdata, and tests/vmx2xmldata/ are modified for newly introduced attribute "target" for address of "drive" type.
2012-02-27 10:19:54 +00:00
&lt;disk type='block' device='lun'&gt;
&lt;driver name='qemu' type='raw'/&gt;
docs: Fix typo It used "&lt" for ">", reported by Kyla Zhang <weizhan@redhat.com>
2012-03-07 04:01:33 +00:00
&lt;source dev='/dev/sda'/&gt;
&lt;target dev='sda' bus='scsi'/&gt;
&lt;address type='drive' controller='0' bus='0' target='3' unit='0'/&gt;
conf: Introduce new attribute for device address format * src/conf/domain_conf.h: Add new member "target" to struct _virDomainDeviceDriveAddress. * src/conf/domain_conf.c: Parse and format "target" * Lots of tests (.xml) in tests/domainsnapshotxml2xmlout, tests/qemuxml2argvdata, tests/qemuxml2xmloutdata, and tests/vmx2xmldata/ are modified for newly introduced attribute "target" for address of "drive" type.
2012-02-27 10:19:54 +00:00
&lt;/disk&gt;
Support for Disk Geometry Override A hypervisor may allow to override the disk geometry of drives. Qemu, as an example with cyls=,heads=,secs=[,trans=]. This patch extends the domain config to allow the specification of disk geometry with libvirt. Signed-off-by: J.B. Joret <jb@linux.vnet.ibm.com> Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-08-20 13:58:50 +00:00
&lt;disk type='block' device='disk'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source dev='/dev/sda'/&gt;
&lt;geometry cyls='16383' heads='16' secs='63' trans='lba'/&gt;
Rename iolimit to blockio. After discussion with DB we decided to rename the new iolimit element as it creates the impression it would be there to limit (i.e. throttle) I/O instead of specifying immutable characteristics of a block device. This is also backed by the fact that the term I/O Limits has vanished from newer storage admin documentation. Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-09-04 14:30:55 +00:00
&lt;blockio logical_block_size='512' physical_block_size='4096'/&gt;
Support for Disk Geometry Override A hypervisor may allow to override the disk geometry of drives. Qemu, as an example with cyls=,heads=,secs=[,trans=]. This patch extends the domain config to allow the specification of disk geometry with libvirt. Signed-off-by: J.B. Joret <jb@linux.vnet.ibm.com> Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-08-20 13:58:50 +00:00
&lt;target dev='hda' bus='ide'/&gt;
&lt;/disk&gt;
Introduce new XMLs to specify disk source using libvirt storage With this patch, one can specify the disk source using libvirt storage like: <disk type='volume' device='disk'> <driver name='qemu' type='raw' cache='none'/> <source pool='default' volume='fc18.img'/> <target dev='vdb' bus='virtio'/> </disk> "seclabels" and "startupPolicy" are not supported for this new disk type ("volume"). They will be supported in later patches. docs/formatdomain.html.in: * Add documents for new XMLs docs/schemas/domaincommon.rng: * Add rng for new XMLs; src/conf/domain_conf.h: * New struct for 'volume' type disk source (virDomainDiskSourcePoolDef) * Add VIR_DOMAIN_DISK_TYPE_VOLUME for enum virDomainDiskType src/conf/domain_conf.c: * New helper virDomainDiskSourcePoolDefParse to parse the 'volume' type disk source. * New helper virDomainDiskSourcePoolDefFree to free the source def if 'volume' type disk. tests/qemuxml2argvdata/qemuxml2argv-disk-source-pool.xml: tests/qemuxml2xmltest.c: * New test
2013-04-04 19:37:56 +00:00
&lt;disk type='volume' device='disk'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source pool='blk-pool0' volume='blk-pool0-vol0'/&gt;
&lt;target dev='hda' bus='ide'/&gt;
&lt;/disk&gt;
docs: Update the formatdomain disk examples Add more iSCSI examples including having a secret attached. There are 4 new examples; one for each way to have an iSCSI - a network disk using virtio, a passthrough network lun using scsi, a volume disk using "mode='host'", and a volume disk using "mode='direct'"
2013-08-07 13:05:43 +00:00
&lt;disk type='network' device='disk'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source protocol='iscsi' name='iqn.2013-07.com.example:iscsi-nopool/2'&gt;
&lt;host name='example.com' port='3260'/&gt;
&lt;/source&gt;
&lt;auth username='myuser'&gt;
&lt;secret type='chap' usage='libvirtiscsi'/&gt;
&lt;/auth&gt;
&lt;target dev='vda' bus='virtio'/&gt;
&lt;/disk&gt;
&lt;disk type='network' device='lun'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source protocol='iscsi' name='iqn.2013-07.com.example:iscsi-nopool/1'&gt;
iqn.2013-07.com.example:iscsi-pool
&lt;host name='example.com' port='3260'/&gt;
&lt;/source&gt;
&lt;auth username='myuser'&gt;
&lt;secret type='chap' usage='libvirtiscsi'/&gt;
&lt;/auth&gt;
&lt;target dev='sda' bus='scsi'/&gt;
&lt;/disk&gt;
&lt;disk type='volume' device='disk'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source pool='iscsi-pool' volume='unit:0:0:1' mode='host'/&gt;
&lt;auth username='myuser'&gt;
&lt;secret type='chap' usage='libvirtiscsi'/&gt;
&lt;/auth&gt;
&lt;target dev='vda' bus='virtio'/&gt;
&lt;/disk&gt;
&lt;disk type='volume' device='disk'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source pool='iscsi-pool' volume='unit:0:0:2' mode='direct'/&gt;
&lt;auth username='myuser'&gt;
&lt;secret type='chap' usage='libvirtiscsi'/&gt;
&lt;/auth&gt;
&lt;target dev='vda' bus='virtio'/&gt;
&lt;/disk&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>disk</code></dt>
<dd>The <code>disk</code> element is the main container for describing
docs: Reformat <disk> attribute description in formatdomain Reformat the description to more cleanly delineate the attributes for a <disk> element.
2013-08-20 19:37:00 +00:00
disks (<span class="since">since 0.0.3</span>).
<dl>
<dt><code>type</code> attribute
<span class="since">since 0.0.3</span></dt>
<dd>
Valid values are "file", "block",
"dir" (<span class="since">since 0.7.5</span>),
"network" (<span class="since">since 0.8.7</span>), or
"volume" (<span class="since">since 1.0.5</span>)
and refer to the underlying source for the disk.
</dd>
<dt><code>device</code> attribute
<span class="since">since 0.1.4</span></dt>
<dd>
Indicates how the disk is to be exposed to the guest OS. Possible
values for this attribute are "floppy", "disk", "cdrom", and "lun",
defaulting to "disk".
<p>
Using "lun" (<span class="since">since 0.9.10</span>) is only
VMX: Add cdrom-raw dev type from VMWare Fusion According to VMWare's documentation 'cdrom-raw' is an acceptable value for deviceType for a CD-ROM drive. The documentation states that the VMX configuration for a CD-ROM deviceType is as follows: ide|scsi(n):(n).deviceType = "cdrom-raw|atapi-cdrom|cdrom-image" From the documentation it appears the following is true: - cdrom-image = Provides the ISO to the VM - atapi-cdrom = Provides a NEC emulated ATAPI CD-ROM on top of the host CD-ROM - cdrom-raw = Passthru for a host CD-ROM drive. Allows CD-R burning from within the guest. A CD-ROM prior to this patch would always provide an 'atapi-cdrom' is modeled as: <disk type='block' device='cdrom'> <source dev='/dev/scd0'/> <target dev='hda' bus='ide'/> <address type='drive' controller='0' bus='0' target='0' unit='0'/> </disk> This patch allows the 'device' attribute to be set to 'lun' for a raw acccess CD-ROM such as: <disk type='block' device='lun'> <source dev='/dev/scd0'/> <target dev='hda' bus='ide'/> <address type='drive' controller='0' bus='0' target='0' unit='0'/> </disk>
2013-08-13 01:55:57 +00:00
valid when type is "block", and behaves identically to "disk",
docs: Reformat <disk> attribute description in formatdomain Reformat the description to more cleanly delineate the attributes for a <disk> element.
2013-08-20 19:37:00 +00:00
except that generic SCSI commands from the guest are accepted
and passed through to the physical device. Also note that
device='lun' will only be recognized for actual raw devices,
but never for individual partitions or LVM partitions (in those
cases, the kernel will reject the generic SCSI commands, making
it identical to device='disk').
</p>
</dd>
<dt><code>rawio</code> attribute
<span class="since">since 0.9.10</span></dt>
<dd>
Indicates whether the disk is needs rawio capability; valid
settings are "yes" or "no" (default is "no"). If any one disk
in a domain has rawio='yes', rawio capability will be enabled
for all disks in the domain (because, in the case of QEMU, this
capability can only be set on a per-process basis). This attribute
is only valid when device is "lun". NB, <code>rawio</code> intends
to confine the capability per-device, however, current QEMU
implementation gives the domain process broader capability
than that (per-process basis, affects all the domain disks).
To confine the capability as much as possible for QEMU driver
as this stage, <code>sgio</code> is recommended, it's more
secure than <code>rawio</code>.
</dd>
<dt><code>sgio</code> attribute
<span class="since">since 1.0.2</span></dt>
<dd>
Indicates whether the kernel will filter unprivileged
SG_IO commands for the disk, valid settings are "filtered" or
"unfiltered". Defaults to "filtered". Similar to <code>rawio</code>,
<code>sgio</code> is only valid for device 'lun'.
</dd>
<dt><code>snapshot</code> attribute
<span class="since">since 0.9.5</span></dt>
<dd>
Indicates the default behavior of the disk during disk snapshots:
"internal" requires a file format such as qcow2 that can store
both the snapshot and the data changes since the snapshot;
"external" will separate the snapshot from the live data; and
"no" means the disk will not participate in snapshots. Read-only
disks default to "no", while the default for other disks depends
on the hypervisor's capabilities. Some hypervisors allow a
per-snapshot choice as well, during
<a href="formatsnapshot.html">domain snapshot creation</a>.
Not all snapshot modes are supported; for example,
<code>snapshot='yes'</code> with a transient disk generally
does not make sense.
</dd>
</dl>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>source</code></dt>
docs: Update the formatdomain disk examples Add more iSCSI examples including having a secret attached. There are 4 new examples; one for each way to have an iSCSI - a network disk using virtio, a passthrough network lun using scsi, a volume disk using "mode='host'", and a volume disk using "mode='direct'"
2013-08-07 13:05:43 +00:00
<dd>Representation of the disk <code>source</code> depends on the
disk <code>type</code> attribute value as follows:
<dl>
<dt><code>type='file'</code>
<span class="since">since 0.0.3</span></dt>
<dd>
The <code>file</code> attribute specifies the fully-qualified
path to the file holding the disk.
</dd>
<dt><code>type='block'</code>
<span class="since">since 0.0.3</span></dt>
<dd>
The <code>dev</code> attribute specifies the path to the
host device to serve as the disk.
</dd>
<dt><code>type='dir'</code>
<span class="since">since 0.7.5</span></dt>
<dd>
The <code>dir</code> attribute specifies the fully-qualified path
to the directory to use as the disk.
</dd>
<dt><code>type='network'</code>
<span class="since">since 0.8.7</span></dt>
<dd>
The <code>protocol</code> attribute specifies the protocol to
access to the requested image. Possible values are "nbd",
"iscsi", "rbd", "sheepdog" or "gluster". If the
<code>protocol</code> attribute is "rbd", "sheepdog" or
"gluster", an additional attribute <code>name</code> is
mandatory to specify which volume/image will be used. For "nbd",
the <code>name</code> attribute is optional. For "iscsi"
(<span class="since">since 1.0.4</span>), the <code>name</code>
attribute may include a logical unit number, separated from the
target's name by a slash (e.g.,
<code>iqn.2013-07.com.example:iscsi-pool/1</code>). If not
specified, the default LUN is zero.
</dd>
<dt><code>type='volume'</code>
<span class="since">since 1.0.5</span></dt>
<dd>
The underlying disk source is represented by attributes
<code>pool</code> and <code>volume</code>. Attribute
<code>pool</code> specifies the name of the
<a href="formatstorage.html">storage pool</a> (managed
by libvirt) where the disk source resides. Attribute
<code>volume</code> specifies the name of storage volume (managed
by libvirt) used as the disk source. The value for the
<code>volume</code> attribute will be the output from the "Name"
column of a <code>virsh vol-list [pool-name]</code> command.
<p>
Use the attribute <code>mode</code>
(<span class="since">since 1.1.1</span>) to indicate how to
represent the LUN as the disk source. Valid values are
"direct" and "host". If <code>mode</code> is not specified,
the default is to use "host".
Using "direct" as the <code>mode</code> value indicates to use
the <a href="formatstorage.html">storage pool's</a>
<code>source</code> element <code>host</code> attribute as
the disk source to generate the libiscsi URI (e.g.
'file=iscsi://example.com:3260/iqn.2013-07.com.example:iscsi-pool/1').
Using "host" as the <code>mode</code> value indicates to use the
LUN's path as it shows up on host (e.g.
'file=/dev/disk/by-path/ip-example.com:3260-iscsi-iqn.2013-07.com.example:iscsi-pool-lun-1').
</p>
</dd>
</dl>
With "file", "block", and "volume", one or more optional
Multiple security drivers in XML data This patch updates the domain and capability XML parser and formatter to support more than one "seclabel" element for each domain and device. The RNG schema and the tests related to this are also updated by this patch. Signed-off-by: Marcelo Cerri <mhcerri@linux.vnet.ibm.com>
2012-08-15 22:10:36 +00:00
sub-elements <code>seclabel</code>, <a href="#seclabel">described
seclabel: extend XML to allow per-disk label overrides When doing security relabeling, there are cases where a per-file override might be appropriate. For example, with a static label and relabeling, it might be appropriate to skip relabeling on a particular disk, where the backing file lives on NFS that lacks the ability to track labeling. Or with dynamic labeling, it might be appropriate to use a custom (non-dynamic) label for a disk specifically intended to be shared across domains. The new XML resembles the top-level <seclabel>, but with fewer options (basically relabel='no', or <label>text</label>): <domain ...> ... <devices> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='no'/> <!-- override for just this disk --> </source> ... </disk> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='yes'> <!-- override for just this disk --> <label>system_u:object_r:shared_content_t:s0</label> </seclabel> </source> ... </disk> ... </devices> <seclabel type='dynamic' model='selinux'> <baselabel>text</baselabel> <!-- used for all devices without override --> </seclabel> </domain> This patch only introduces the XML and documentation; future patches will actually parse and make use of it. The intent is that we can further extend things as needed, adding a per-device <seclabel> in more places (such as the source of a console device), and possibly allowing a <baselabel> instead of <label> for labeling where we want to reuse the cNNN,cNNN pair of a dynamically labeled domain but a different base label. First suggested by Daniel P. Berrange here: https://www.redhat.com/archives/libvir-list/2011-December/msg00258.html * docs/schemas/domaincommon.rng (devSeclabel): New define. (disk): Use it. * docs/formatdomain.html.in (elementsDisks, seclabel): Document the new XML. * tests/qemuxml2argvdata/qemuxml2argv-seclabel-dynamic-override.xml: New test, to validate RNG.
2011-12-23 00:47:49 +00:00
below</a> (and <span class="since">since 0.9.9</span>), can be
used to override the domain security labeling policy for just
Support seclabels for volume type disk "seclabels" is only valid for 'file' or 'block' type storage volume.
2013-04-04 19:37:59 +00:00
that source file. (NB, for "volume" type disk, <code>seclabel</code>
is only valid when the specified storage volume is of 'file' or
docs: Update the formatdomain disk examples Add more iSCSI examples including having a secret attached. There are 4 new examples; one for each way to have an iSCSI - a network disk using virtio, a passthrough network lun using scsi, a volume disk using "mode='host'", and a volume disk using "mode='direct'"
2013-08-07 13:05:43 +00:00
'block' type).
<p>
qemu: add support for libiscsi libiscsi provides a userspace iSCSI initiator. The main advantage over the kernel initiator is that it is very easy to provide different initiator names for VMs on the same host. Thus libiscsi supports usage of persistent reservations in the VM, which otherwise would only be possible with NPIV. libiscsi uses "iscsi" as the scheme, not "iscsi+tcp". We can change this in the tests (while remaining backwards-compatible manner, because QEMU uses TCP as the default transport for both Gluster and NBD). Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:49 +00:00
When the disk <code>type</code> is "network", the <code>source</code>
may have zero or more <code>host</code> sub-elements used to
docs: Update the formatdomain disk examples Add more iSCSI examples including having a secret attached. There are 4 new examples; one for each way to have an iSCSI - a network disk using virtio, a passthrough network lun using scsi, a volume disk using "mode='host'", and a volume disk using "mode='direct'"
2013-08-07 13:05:43 +00:00
specify the hosts to connect.
</p>
<p>
Support startupPolicy for 'volume' disk "startupPolicy" is only valid for file type storage volume, otherwise it fails on starting the domain.
2013-04-04 19:37:58 +00:00
For a "file" or "volume" disk type which represents a cdrom or floppy
Add documentation for <disk><source type="dir">
2011-12-07 16:55:41 +00:00
(the <code>device</code> attribute), it is possible to define
policy what to do with the disk if the source file is not accessible.
Support startupPolicy for 'volume' disk "startupPolicy" is only valid for file type storage volume, otherwise it fails on starting the domain.
2013-04-04 19:37:58 +00:00
(NB, <code>startupPolicy</code> is not valid for "volume" disk unless
the specified storage volume is of "file" type). This is done by the
docs: Update the formatdomain disk examples Add more iSCSI examples including having a secret attached. There are 4 new examples; one for each way to have an iSCSI - a network disk using virtio, a passthrough network lun using scsi, a volume disk using "mode='host'", and a volume disk using "mode='direct'"
2013-08-07 13:05:43 +00:00
<code>startupPolicy</code> attribute
(<span class="since">since 0.9.7</span>),
conf: add startupPolicy attribute for harddisk Add startupPolicy attribute for harddisk with type "file", "block" and "dir". 'requisite' is not supported currently for harddisk.
2013-07-31 07:51:44 +00:00
accepting these values:
docs: Update the formatdomain disk examples Add more iSCSI examples including having a secret attached. There are 4 new examples; one for each way to have an iSCSI - a network disk using virtio, a passthrough network lun using scsi, a volume disk using "mode='host'", and a volume disk using "mode='direct'"
2013-08-07 13:05:43 +00:00
</p>
conf: Introduce optional startupPolicy attribute for cdrom and floppy This attribute says what to do with cdrom (or floppy) if the source is missing. It accepts: - mandatory - fail if missing for any reason (the default) - requisite - fail if missing on boot up, drop if missing on migrate/restore/revert - optional - drop if missing at any start attempt. However, this patch introduces only XML part of this new functionality.
2011-10-17 14:54:03 +00:00
<table class="top_table">
<tr>
<td> mandatory </td>
<td> fail if missing for any reason (the default) </td>
</tr>
<tr>
<td> requisite </td>
<td> fail if missing on boot up,
drop if missing on migrate/restore/revert </td>
</tr>
<tr>
<td> optional </td>
<td> drop if missing at any start attempt </td>
</tr>
</table>
docs: Update the formatdomain disk examples Add more iSCSI examples including having a secret attached. There are 4 new examples; one for each way to have an iSCSI - a network disk using virtio, a passthrough network lun using scsi, a volume disk using "mode='host'", and a volume disk using "mode='direct'"
2013-08-07 13:05:43 +00:00
<p>
<span class="since">Since 1.1.2</span> the <code>startupPolicy</code>
is extended to support hard disks besides cdrom and floppy. On guest
cold bootup, if a certain disk is not accessible or its disk chain is
broken, with startupPolicy 'optional' the guest will drop this disk.
This feature doesn't support migration currently.
</p>
conf: Introduce optional startupPolicy attribute for cdrom and floppy This attribute says what to do with cdrom (or floppy) if the source is missing. It accepts: - mandatory - fail if missing for any reason (the default) - requisite - fail if missing on boot up, drop if missing on migrate/restore/revert - optional - drop if missing at any start attempt. However, this patch introduces only XML part of this new functionality.
2011-10-17 14:54:03 +00:00
</dd>
blockjob: enhance xml to track mirrors across libvirtd restart In order to track a block copy job across libvirtd restarts, we need to save internal XML that tracks the name of the file holding the mirror. Displaying this name in dumpxml might also be useful to the user, even if we don't yet have a way to (re-) start a domain with mirroring enabled up front. This is done with a new <mirror> sub-element to <disk>, as in: <disk type='file' device='disk'> <driver name='qemu' type='raw'/> <source file='/var/lib/libvirt/images/original.img'/> <mirror file='/var/lib/libvirt/images/copy.img' format='qcow2' ready='yes'/> ... </disk> For now, the element is output-only, in live domains; it is ignored when defining a domain or hot-plugging a disk (since those contexts use VIR_DOMAIN_XML_INACTIVE in parsing). The 'ready' attribute appears when libvirt knows that the job has changed from the initial pulling phase over to the mirroring phase, although absence of the attribute is not a sure indicator of the current phase. If we come up with a way to make qemu start with mirroring enabled, we can relax the xml restriction, and allow <mirror> (but not attribute 'ready') on input. Testing active-only XML meant tweaking the testsuite slightly, but it was worth it. * docs/schemas/domaincommon.rng (diskspec): Add diskMirror. * docs/formatdomain.html.in (elementsDisks): Document it. * src/conf/domain_conf.h (_virDomainDiskDef): New members. * src/conf/domain_conf.c (virDomainDiskDefFree): Clean them. (virDomainDiskDefParseXML): Parse them, but only internally. (virDomainDiskDefFormat): Output them. * tests/qemuxml2argvdata/qemuxml2argv-disk-mirror.xml: New test file. * tests/qemuxml2xmloutdata/qemuxml2xmlout-disk-mirror.xml: Likewise. * tests/qemuxml2xmltest.c (testInfo): Alter members. (testCompareXMLToXMLHelper): Allow more test control. (mymain): Run new test.
2012-03-29 00:10:18 +00:00
<dt><code>mirror</code></dt>
<dd>
This element is present if the hypervisor has started a block
copy operation (via the <code>virDomainBlockCopy</code> API),
where the mirror location in attribute <code>file</code> will
eventually have the same contents as the source, and with the
file format in attribute <code>format</code> (which might
differ from the format of the source). If
attribute <code>ready</code> is present, then it is known the
disk is ready to pivot; otherwise, the disk is probably still
copying. For now, this element only valid in output; it is
ignored on input. <span class="since">Since 0.9.12</span>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>target</code></dt>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
<dd>The <code>target</code> element controls the bus / device
under which the disk is exposed to the guest
OS. The <code>dev</code> attribute indicates the "logical"
device name. The actual device name specified is not
guaranteed to map to the device name in the guest OS. Treat it
as a device ordering hint. The optional <code>bus</code>
attribute specifies the type of disk device to emulate;
possible values are driver specific, with typical values being
domain_conf: Add disk bus=sd, wire it up for qemu This corresponds to '-sd' and '-drive if=sd' on the qemu command line. Needed for many ARM boards which don't provide any other way to pass in storage.
2013-07-31 13:00:26 +00:00
"ide", "scsi", "virtio", "xen", "usb", "sata", or
"sd" <span class="since">"sd" since 1.1.2</span>. If omitted, the bus
docs: aesthetical cleanups Adding dots inside "exempli gratia" where missing. While on that, I took the liberty of changing it where found with simple grep.
2012-12-17 15:03:23 +00:00
type is inferred from the style of the device name (e.g. a device named
'sda' will typically be exported using a SCSI bus). The optional
docs: Add documentation for new attribute tray of disk target Example XML: <disk type='file' device='cdrom'> <driver name='qemu' type='raw'/> <source file='/tmp/cdrom.img'/> <target dev='hdd' bus='ide' tray='open'/> </disk>
2012-03-14 15:26:46 +00:00
attribute <code>tray</code> indicates the tray status of the
removable disks (i.e. CDROM or Floppy disk), the value can be either
"open" or "closed", defaults to "closed". NB, the value of
<code>tray</code> could be updated while the domain is running.
qemu: Support setting the 'removable' flag for USB disks Add an attribute named 'removable' to the 'target' element of disks, which controls the removable flag. For instance, on a Linux guest it controls the value of /sys/block/$dev/removable. This option is only valid for USB disks (i.e. bus='usb'), and its default value is 'off', which is the same behaviour as before. To achieve this, 'removable=on' (or 'off') is appended to the '-device usb-storage' parameter sent to qemu when adding a USB disk via '-disk'. A capability flag QEMU_CAPS_USB_STORAGE_REMOVABLE was added to keep track if this option is supported by the qemu version used. Bug: https://bugzilla.redhat.com/show_bug.cgi?id=922495 Signed-off-by: Peter Krempa <pkrempa@redhat.com>
2013-08-23 10:38:11 +00:00
The optional attribute <code>removable</code> sets the
removable flag for USB disks, and its value can be either "on"
or "off", defaulting to "off". <span class="since">Since
0.0.3; <code>bus</code> attribute since 0.4.3;
docs: Add documentation for new attribute tray of disk target Example XML: <disk type='file' device='cdrom'> <driver name='qemu' type='raw'/> <source file='/tmp/cdrom.img'/> <target dev='hdd' bus='ide' tray='open'/> </disk>
2012-03-14 15:26:46 +00:00
<code>tray</code> attribute since 0.9.11; "usb" attribute value since
qemu: Support setting the 'removable' flag for USB disks Add an attribute named 'removable' to the 'target' element of disks, which controls the removable flag. For instance, on a Linux guest it controls the value of /sys/block/$dev/removable. This option is only valid for USB disks (i.e. bus='usb'), and its default value is 'off', which is the same behaviour as before. To achieve this, 'removable=on' (or 'off') is appended to the '-device usb-storage' parameter sent to qemu when adding a USB disk via '-disk'. A capability flag QEMU_CAPS_USB_STORAGE_REMOVABLE was added to keep track if this option is supported by the qemu version used. Bug: https://bugzilla.redhat.com/show_bug.cgi?id=922495 Signed-off-by: Peter Krempa <pkrempa@redhat.com>
2013-08-23 10:38:11 +00:00
after 0.4.4; "sata" attribute value since 0.9.7; "removable" attribute
value since 1.1.3</span>
docs: Add documentation for new attribute tray of disk target Example XML: <disk type='file' device='cdrom'> <driver name='qemu' type='raw'/> <source file='/tmp/cdrom.img'/> <target dev='hdd' bus='ide' tray='open'/> </disk>
2012-03-14 15:26:46 +00:00
</dd>
Support block I/O throttle in XML Enable block I/O throttle for per-disk in XML, as the first per-disk IO tuning parameter. Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-15 09:02:46 +00:00
<dt><code>iotune</code></dt>
<dd>The optional <code>iotune</code> element provides the
ability to provide additional per-device I/O tuning, with
values that can vary for each device (contrast this to
the <a href="#elementsBlockTuning"><code>&lt;blkiotune&gt;</code></a>
element, which applies globally to the domain). Currently,
the only tuning available is Block I/O throttling for qemu.
This element has optional sub-elements; any sub-element not
specified or given with a value of 0 implies no
limit. <span class="since">Since 0.9.8</span>
<dl>
<dt><code>total_bytes_sec</code></dt>
<dd>The optional <code>total_bytes_sec</code> element is the
total throughput limit in bytes per second. This cannot
appear with <code>read_bytes_sec</code>
or <code>write_bytes_sec</code>.</dd>
<dt><code>read_bytes_sec</code></dt>
<dd>The optional <code>read_bytes_sec</code> element is the
read throughput limit in bytes per second.</dd>
<dt><code>write_bytes_sec</code></dt>
<dd>The optional <code>write_bytes_sec</code> element is the
write throughput limit in bytes per second.</dd>
<dt><code>total_iops_sec</code></dt>
<dd>The optional <code>total_iops_sec</code> element is the
total I/O operations per second. This cannot
appear with <code>read_iops_sec</code>
or <code>write_iops_sec</code>.</dd>
<dt><code>read_iops_sec</code></dt>
<dd>The optional <code>read_iops_sec</code> element is the
read I/O operations per second.</dd>
<dt><code>write_iops_sec</code></dt>
<dd>The optional <code>write_iops_sec</code> element is the
write I/O operations per second.</dd>
</dl>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>driver</code></dt>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
<dd>
The optional driver element allows specifying further details
related to the hypervisor driver used to provide the disk.
docs/formatdomain: Add release info for disk <driver> attributes
2011-03-08 18:02:43 +00:00
<span class="since">Since 0.1.8</span>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
<ul>
<li>
If the hypervisor supports multiple backend drivers, then
the <code>name</code> attribute selects the primary
backend driver name, while the optional <code>type</code>
attribute provides the sub-type. For example, xen
supports a name of "tap", "tap2", "phy", or "file", with a
type of "aio", while qemu only supports a name of "qemu",
but multiple types including "raw", "bochs", "qcow2", and
"qed".
</li>
<li>
The optional <code>cache</code> attribute controls the
cache mechanism, possible values are "default", "none",
Add unsafe cache mode support for disk driver QEMU 0.13 introduced cache=unsafe for -drive, this patch exposes it in the libvirt layer. * Introduced a new QEMU capability flag ($prefix_CACHE_UNSAFE), as even if $prefix_CACHE_V2 is set, we can't know if unsafe is supported. * Improved the reliability of qemu cache type detection.
2011-09-22 19:33:47 +00:00
"writethrough", "writeback", "directsync" (like
"writethrough", but it bypasses the host page cache) and
"unsafe" (host may cache all disk io, and sync requests from
guest are ignored).
<span class="since">
Since 0.6.0,
"directsync" since 0.9.5,
"unsafe" since 0.9.7
</span>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</li>
<li>
The optional <code>error_policy</code> attribute controls
qemu: add separate rerror_policy for disk errors Previously libvirt's disk device XML only had a single attribute, error_policy, to control both read and write error policy, but qemu has separate options for controlling read and write. In one case (enospc) a policy is allowed for write errors but not read errors. This patch adds a separate attribute that sets only the read error policy. If just error_policy is set, it will apply to both read and write error policy (previous behavior), but if the new rerror_policy attribute is set, it will override error_policy for read errors only. Possible values for rerror_policy are "stop", "report", and "ignore" ("report" is the qemu-controlled default for rerror_policy when error_policy isn't specified). For consistency, the value "report" has been added to the possible values for error_policy as well.
2011-10-04 18:17:06 +00:00
how the hypervisor will behave on a disk read or write
error, possible values are "stop", "report", "ignore", and
"enospace".<span class="since">Since 0.8.0, "report" since
0.9.7</span> The default setting of error_policy is "report".
There is also an
optional <code>rerror_policy</code> that controls behavior
for read errors only. <span class="since">Since
docs: fix html bug </space> doesn't exist. Introduced in commit 4bb4109f. * docs/formatdomain.html.in: Use correct end tag.
2011-10-10 22:32:45 +00:00
0.9.7</span>. If no rerror_policy is given, error_policy
qemu: add separate rerror_policy for disk errors Previously libvirt's disk device XML only had a single attribute, error_policy, to control both read and write error policy, but qemu has separate options for controlling read and write. In one case (enospc) a policy is allowed for write errors but not read errors. This patch adds a separate attribute that sets only the read error policy. If just error_policy is set, it will apply to both read and write error policy (previous behavior), but if the new rerror_policy attribute is set, it will override error_policy for read errors only. Possible values for rerror_policy are "stop", "report", and "ignore" ("report" is the qemu-controlled default for rerror_policy when error_policy isn't specified). For consistency, the value "report" has been added to the possible values for error_policy as well.
2011-10-04 18:17:06 +00:00
is used for both read and write errors. If rerror_policy
is given, it overrides the <code>error_policy</code> for
read errors. Also note that "enospace" is not a valid
policy for read errors, so if <code>error_policy</code> is
set to "enospace" and no <code>rerror_policy</code> is
given, the read error policy will be left at its default,
which is "report".
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</li>
<li>
The optional <code>io</code> attribute controls specific
policies on I/O; qemu guests support "threads" and
docs/formatdomain: Add release info for disk <driver> attributes
2011-03-08 18:02:43 +00:00
"native". <span class="since">Since 0.8.8</span>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</li>
qemu: domain I/O asynchronous handling For virtio disks and interfaces, qemu allows users to enable or disable ioeventfd feature. This means, qemu can execute domain code, while another thread waits for I/O event. Basically, in some cases it is win, in some loss. This feature is available via 'ioeventfd' attribute in disk and interface <driver> element. It accepts 'on' and 'off'. Leaving this attribute out defaults to hypervisor decision.
2011-06-20 08:26:47 +00:00
<li>
The optional <code>ioeventfd</code> attribute allows users to
set <a href='https://patchwork.kernel.org/patch/43390/'>
domain I/O asynchronous handling</a> for disk device.
The default is left to the discretion of the hypervisor.
Accepted values are "on" and "off". Enabling this allows
qemu to execute VM while a separate thread handles I/O.
Typically guests experiencing high system CPU utilization
during I/O will benefit from this. On the other hand,
on overloaded host it could increase guest I/O latency.
<span class="since">Since 0.9.3 (QEMU and KVM only)</span>
<b>In general you should leave this option alone, unless you
are very certain you know what you are doing.</b>
</li>
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
<li>
The optional <code>event_idx</code> attribute controls
some aspects of device event processing. The value can be
either 'on' or 'off' - if it is on, it will reduce the
Fix some typos in messages, docs and comments.
2012-08-22 18:29:18 +00:00
number of interrupts and exits for the guest. The default
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
is determined by QEMU; usually if the feature is
supported, default is on. In case there is a situation
where this behavior is suboptimal, this attribute provides
a way to force the feature off.
<span class="since">Since 0.9.5 (QEMU and KVM only)</span>
<b>In general you should leave this option alone, unless you
are very certain you know what you are doing.</b>
</li>
qemu: Support copy on read for disk The new introduced optional attribute "copy_on_read</code> controls whether to copy read backing file into the image file. The value can be either "on" or "off". Copy-on-read avoids accessing the same backing file sectors repeatedly and is useful when the backing file is over a slow network. By default copy-on-read is off.
2012-01-12 09:31:14 +00:00
<li>
The optional <code>copy_on_read</code> attribute controls
Fix some typos in messages, docs and comments.
2012-08-22 18:29:18 +00:00
whether to copy read backing file into the image file. The
qemu: Support copy on read for disk The new introduced optional attribute "copy_on_read</code> controls whether to copy read backing file into the image file. The value can be either "on" or "off". Copy-on-read avoids accessing the same backing file sectors repeatedly and is useful when the backing file is over a slow network. By default copy-on-read is off.
2012-01-12 09:31:14 +00:00
value can be either "on" or "off".
Copy-on-read avoids accessing the same backing file sectors
repeatedly and is useful when the backing file is over a slow
network. By default copy-on-read is off.
<span class='since'>Since 0.9.10 (QEMU and KVM only)</span>
</li>
qemu: Support discard for disk QEMU introduced "discard" option for drive since commit a9384aff53, <...> @var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests. </...> This patch exposes the support in libvirt. QEMU supported "discard" for "-drive" since v1.5.0-rc0: % git tag --contains a9384aff53 contains v1.5.0-rc0 v1.5.0-rc1 So this only detects the capability bit using virQEMUCapsProbeQMPCommandLine.
2013-05-14 12:44:54 +00:00
<li>
The optional <code>discard</code> attribute controls whether
to discard (also known as "trim" or "unmap") requests are
ignored or passed to the filesystem. The value can be either
qemu: Change values of disk discard QEMU might support more values for "-drive discard", so using Bi-state values (on/off) for it doesn't make sense. "on" maps to "unmap", "off" maps to "ignore": <...> @var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests. </...>
2013-05-17 02:35:02 +00:00
"unmap" (allow the discard request to be passed) or "ignore"
(ignore the discard request).
qemu: Support discard for disk QEMU introduced "discard" option for drive since commit a9384aff53, <...> @var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests. </...> This patch exposes the support in libvirt. QEMU supported "discard" for "-drive" since v1.5.0-rc0: % git tag --contains a9384aff53 contains v1.5.0-rc0 v1.5.0-rc1 So this only detects the capability bit using virQEMUCapsProbeQMPCommandLine.
2013-05-14 12:44:54 +00:00
<span class='since'>Since 1.0.6 (QEMU and KVM only)</span>
</li>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</ul>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
<dt><code>boot</code></dt>
<dd>Specifies that the disk is bootable. The <code>order</code>
attribute determines the order in which devices will be tried during
boot sequence. The per-device <code>boot</code> elements cannot be
used together with general boot elements in
<a href="#elementsOSBIOS">BIOS bootloader</a> section.
<span class="since">Since 0.8.8</span>
</dd>
Attach encryption information to virDomainDiskDef. The XML allows <encryption format='unencrypted'/>, this implementation canonicalizes the internal representation so that "disk->encryption" is non-NULL iff encryption information is available. A domain with partial encryption information can be defined, completeness of the information is not verified. The domain won't start until the remaining information is added, of course. * docs/formatdomain.html, docs/formatdomain.html.in: Document new encryption options for disks * docs/schemas/domain.rng: Pull in storage encryption schema rules * src/domain_conf.h, src/domain_conf.c: Wire up storage encryption XML parsing/formatting APIs
2009-07-21 05:23:03 +00:00
<dt><code>encryption</code></dt>
<dd>If present, specifies how the volume is encrypted. See
the <a href="formatstorageencryption.html">Storage Encryption</a> page
for more information.
</dd>
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
<dt><code>readonly</code></dt>
<dd>If present, this indicates the device cannot be modified by
the guest. For now, this is the default for disks with
docs: Fix documentation for readonly element
2012-12-18 13:06:16 +00:00
attribute <code>device='cdrom'</code>.
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
</dd>
add missing doc for device <shareable/> option
2009-12-14 15:20:55 +00:00
<dt><code>shareable</code></dt>
<dd>If present, this indicates the device is expected to be shared
between domains (assuming the hypervisor and OS support this),
which means that caching should be deactivated for that device.
</dd>
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
<dt><code>transient</code></dt>
<dd>If present, this indicates that changes to the device
contents should be reverted automatically when the guest
exits. With some hypervisors, marking a disk transient
prevents the domain from participating in migration or
snapshots. <span class="since">Since 0.9.5</span>
</dd>
Add docs on drive <serial> element * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
<dt><code>serial</code></dt>
<dd>If present, this specify serial number of virtual hard drive.
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
For example, it may look
like <code>&lt;serial&gt;WD-WMAP9A966149&lt;/serial&gt;</code>.
Add docs on drive <serial> element * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
<span class="since">Since 0.7.1</span>
</dd>
schema: Add schema for disk <wwn> * docs/formatdomain.html.in: Add document. * docs/schemas/nodedev.rng: Move definition of "wwn" to ... * docs/schemas/basictypes.rng: ...Here * docs/schemas/domaincommon.rng: Add schema for disk <wwn>
2012-09-11 08:57:01 +00:00
<dt><code>wwn</code></dt>
<dd>If present, this element specifies the WWN (World Wide Name)
of a virtual hard disk or CD-ROM drive. It must be composed
of 16 hexadecimal digits.
<span class='since'>Since 0.10.1</span>
</dd>
qemu: Allow the user to specify vendor and product for disk QEMU supports setting vendor and product strings for disk since 1.2.0 (only scsi-disk, scsi-hd, scsi-cd support it), this patch exposes it with new XML elements <vendor> and <product> of disk device.
2012-12-06 10:23:02 +00:00
<dt><code>vendor</code></dt>
<dd>If present, this element specifies the vendor of a virtual hard
disk or CD-ROM device. It must not be longer than 8 printable
characters.
<span class='since'>Since 1.0.1</span>
</dd>
<dt><code>product</code></dt>
<dd>If present, this element specifies the product of a virtual hard
disk or CD-ROM device. It must not be longer than 16 printable
characters.
<span class='since'>Since 1.0.1</span>
</dd>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
<dt><code>host</code></dt>
Add Gluster protocol as supported network disk backend This patch introduces the RNG schema and updates necessary data strucutures to allow various hypervisors to make use of Gluster protocol as one of the supported network disk backend. Next patch will add support to make use of this feature in Qemu since it now supports Gluster protocol as one of the network based storage backend. Two new optional attributes for <host> element are introduced - 'transport' and 'socket'. Valid transport values are tcp, unix or rdma. If none specified, tcp is assumed. If transport is unix, socket specifies path to unix socket. This patch allows users to specify disks on gluster backends like this: <disk type='network' device='disk'> <driver name='qemu' type='raw'/> <source protocol='gluster' name='Volume1/image'> <host name='example.org' port='6000' transport='tcp'/> </source> <target dev='vda' bus='virtio'/> </disk> <disk type='network' device='disk'> <driver name='qemu' type='raw'/> <source protocol='gluster' name='Volume2/image'> <host transport='unix' socket='/path/to/sock'/> </source> <target dev='vdb' bus='virtio'/> </disk> Signed-off-by: Harsh Prateek Bora <harsh@linux.vnet.ibm.com>
2012-11-22 18:10:38 +00:00
<dd>The <code>host</code> element supports 4 attributes, viz. "name",
"port", "transport" and "socket", which specify the hostname, the port
number, transport type and path to socket, respectively. The meaning
of this element and the number of the elements depend on the protocol
attribute.
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
<table class="top_table">
<tr>
<th> Protocol </th>
<th> Meaning </th>
<th> Number of hosts </th>
domain: make port optional for network disks Only sheepdog actually required it in the code, and we can use 7000 as the default---the same value that QEMU uses for the simple "sheepdog:VOLUME" syntax. With this change, the schema can be fixed to allow no port. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:51 +00:00
<th> Default port </th>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
</tr>
<tr>
<td> nbd </td>
<td> a server running nbd-server </td>
<td> only one </td>
domain: make port optional for network disks Only sheepdog actually required it in the code, and we can use 7000 as the default---the same value that QEMU uses for the simple "sheepdog:VOLUME" syntax. With this change, the schema can be fixed to allow no port. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:51 +00:00
<td> 10809 </td>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
</tr>
domain: add support for iscsi network disks This plumbs in the XML description of iSCSI shares. The next patches will add support for the libiscsi userspace initiator. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-02-25 17:44:26 +00:00
<tr>
<td> iscsi </td>
<td> an iSCSI server </td>
<td> only one </td>
domain: make port optional for network disks Only sheepdog actually required it in the code, and we can use 7000 as the default---the same value that QEMU uses for the simple "sheepdog:VOLUME" syntax. With this change, the schema can be fixed to allow no port. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:51 +00:00
<td> 3260 </td>
domain: add support for iscsi network disks This plumbs in the XML description of iSCSI shares. The next patches will add support for the libiscsi userspace initiator. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-02-25 17:44:26 +00:00
</tr>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
<tr>
<td> rbd </td>
<td> monitor servers of RBD </td>
<td> one or more </td>
domain: make port optional for network disks Only sheepdog actually required it in the code, and we can use 7000 as the default---the same value that QEMU uses for the simple "sheepdog:VOLUME" syntax. With this change, the schema can be fixed to allow no port. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:51 +00:00
<td> 6789 </td>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
</tr>
<tr>
<td> sheepdog </td>
<td> one of the sheepdog servers (default is localhost:7000) </td>
<td> zero or one </td>
domain: make port optional for network disks Only sheepdog actually required it in the code, and we can use 7000 as the default---the same value that QEMU uses for the simple "sheepdog:VOLUME" syntax. With this change, the schema can be fixed to allow no port. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:51 +00:00
<td> 7000 </td>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
</tr>
Add Gluster protocol as supported network disk backend This patch introduces the RNG schema and updates necessary data strucutures to allow various hypervisors to make use of Gluster protocol as one of the supported network disk backend. Next patch will add support to make use of this feature in Qemu since it now supports Gluster protocol as one of the network based storage backend. Two new optional attributes for <host> element are introduced - 'transport' and 'socket'. Valid transport values are tcp, unix or rdma. If none specified, tcp is assumed. If transport is unix, socket specifies path to unix socket. This patch allows users to specify disks on gluster backends like this: <disk type='network' device='disk'> <driver name='qemu' type='raw'/> <source protocol='gluster' name='Volume1/image'> <host name='example.org' port='6000' transport='tcp'/> </source> <target dev='vda' bus='virtio'/> </disk> <disk type='network' device='disk'> <driver name='qemu' type='raw'/> <source protocol='gluster' name='Volume2/image'> <host transport='unix' socket='/path/to/sock'/> </source> <target dev='vdb' bus='virtio'/> </disk> Signed-off-by: Harsh Prateek Bora <harsh@linux.vnet.ibm.com>
2012-11-22 18:10:38 +00:00
<tr>
<td> gluster </td>
<td> a server running glusterd daemon </td>
<td> only one </td>
domain: make port optional for network disks Only sheepdog actually required it in the code, and we can use 7000 as the default---the same value that QEMU uses for the simple "sheepdog:VOLUME" syntax. With this change, the schema can be fixed to allow no port. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:51 +00:00
<td> 24007 </td>
Add Gluster protocol as supported network disk backend This patch introduces the RNG schema and updates necessary data strucutures to allow various hypervisors to make use of Gluster protocol as one of the supported network disk backend. Next patch will add support to make use of this feature in Qemu since it now supports Gluster protocol as one of the network based storage backend. Two new optional attributes for <host> element are introduced - 'transport' and 'socket'. Valid transport values are tcp, unix or rdma. If none specified, tcp is assumed. If transport is unix, socket specifies path to unix socket. This patch allows users to specify disks on gluster backends like this: <disk type='network' device='disk'> <driver name='qemu' type='raw'/> <source protocol='gluster' name='Volume1/image'> <host name='example.org' port='6000' transport='tcp'/> </source> <target dev='vda' bus='virtio'/> </disk> <disk type='network' device='disk'> <driver name='qemu' type='raw'/> <source protocol='gluster' name='Volume2/image'> <host transport='unix' socket='/path/to/sock'/> </source> <target dev='vdb' bus='virtio'/> </disk> Signed-off-by: Harsh Prateek Bora <harsh@linux.vnet.ibm.com>
2012-11-22 18:10:38 +00:00
</tr>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
</table>
qemu: support NBD with Unix sockets This reuses the XML format that was introduced for Gluster. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-02-25 17:44:24 +00:00
gluster supports "tcp", "rdma", "unix" as valid values for the
transport attribute. nbd supports "tcp" and "unix". Others only
support "tcp". If nothing is specified, "tcp" is assumed. If the
transport is "unix", the socket attribute specifies the path to an
AF_UNIX socket.
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
</dd>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<dt><code>address</code></dt>
<dd>If present, the <code>address</code> element ties the disk
to a given slot of a controller (the
actual <code>&lt;controller&gt;</code> device can often be
inferred by libvirt, although it can
be <a href="#elementsControllers">explicitly specified</a>).
The <code>type</code> attribute is mandatory, and is typically
"pci" or "drive". For a "pci" controller, additional
attributes for <code>bus</code>, <code>slot</code>,
qemu: make PCI multifunction support more manual When support for was added for PCI multifunction cards (in commit 9f8baf, first included in libvirt 0.9.3), it was done by always turning on the multifunction bit for all PCI devices. Since that time it has been realized that this is not an ideal solution, and that the multifunction bit must be selectively turned on. For example, see https://bugzilla.redhat.com/show_bug.cgi?id=728174 and the discussion before and after https://www.redhat.com/archives/libvir-list/2011-September/msg01036.html This patch modifies multifunction support so that the multifunction=on option is only added to the qemu commandline for a device if its PCI <address> definition has the attribute "multifunction='on'", e.g.: <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0' multifunction='on'/> In practice, the multifunction bit should only be turned on if function='0' AND other functions will be used in the same slot - it usually isn't needed for functions 1-7 (although there are apparently some exceptions, e.g. the Intel X53 according to the QEMU source code), and should never be set if only function 0 will be used in the slot. The test cases have been changed accordingly to illustrate. With this patch in place, if a user attempts to assign multiple functions in a slot without setting the multifunction bit for function 0, libvirt will issue an error when the domain is defined, and the define operation will fail. In the future, we may decide to detect this situation and automatically add multifunction=on to avoid the error; even then it will still be useful to have a manual method of turning on multifunction since, as stated above, there are some devices that excpect it to be turned on for all functions in a slot. A side effect of this patch is that attempts to use the same PCI address for two different devices will now log an error (previously this would cause the domain define operation to fail, but there would be no log message generated). Because the function doing this log was almost completely rewritten, I didn't think it worthwhile to make a separate patch for that fix (the entire patch would immediately be obsoleted).
2011-09-29 17:00:32 +00:00
and <code>function</code> must be present, as well as
optional <code>domain</code> and <code>multifunction</code>.
Multifunction defaults to 'off'; any other value requires
QEMU 0.1.3 and <span class="since">libvirt 0.9.7</span>. For a
"drive" controller, additional attributes
conf: Introduce new attribute for device address format * src/conf/domain_conf.h: Add new member "target" to struct _virDomainDeviceDriveAddress. * src/conf/domain_conf.c: Parse and format "target" * Lots of tests (.xml) in tests/domainsnapshotxml2xmlout, tests/qemuxml2argvdata, tests/qemuxml2xmloutdata, and tests/vmx2xmldata/ are modified for newly introduced attribute "target" for address of "drive" type.
2012-02-27 10:19:54 +00:00
<code>controller</code>, <code>bus</code>, <code>target</code>
(<span class="since">libvirt 0.9.11</span>), and <code>unit</code>
are available, each defaulting to 0.
storage: add auth to virDomainDiskDef Add additional fields to let you specify the how to authenticate with a disk. The secret to use may be referenced by a usage string or a UUID, i.e.: <auth username='myuser'> <secret type='ceph' usage='secretname'/> </auth> or <auth username='myuser'> <secret type='ceph' uuid='0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f'/> </auth> Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-10-28 18:29:39 +00:00
</dd>
<dt><code>auth</code></dt>
<dd>If present, the <code>auth</code> element provides the
authentication credentials needed to access the source. It
includes a mandatory attribute <code>username</code>, which
identifies the username to use during authentication, as well
as a sub-element <code>secret</code> with mandatory
attribute <code>type</code>, to tie back to
a <a href="formatsecret.html">libvirt secret object</a> that
holds the actual password or other credentials (the domain XML
intentionally does not expose the password, only the reference
to the object that does manage the password). For now, the
domain: parse XML for iscsi authorization credentials Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 11:53:53 +00:00
known secret <code>type</code>s are "ceph", for Ceph RBD
network sources, and "iscsi", for CHAP authentication of iSCSI
targets. Both require either a <code>uuid</code> attribute
with the UUID of the secret object, or a <code>usage</code>
attribute matching the key that was specified in the
secret object. <span class="since">libvirt 0.9.7</span>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</dd>
Support for Disk Geometry Override A hypervisor may allow to override the disk geometry of drives. Qemu, as an example with cyls=,heads=,secs=[,trans=]. This patch extends the domain config to allow the specification of disk geometry with libvirt. Signed-off-by: J.B. Joret <jb@linux.vnet.ibm.com> Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-08-20 13:58:50 +00:00
<dt><code>geometry</code></dt>
<dd>The optional <code>geometry</code> element provides the
ability to override geometry settings. This mostly useful for
S390 DASD-disks or older DOS-disks. <span class="since">0.10.0</span>
<dl>
<dt><code>cyls</code></dt>
<dd>The <code>cyls</code> attribute is the
number of cylinders. </dd>
<dt><code>heads</code></dt>
<dd>The <code>heads</code> attribute is the
number of heads. </dd>
<dt><code>secs</code></dt>
<dd>The <code>secs</code> attribute is the
number of sectors per track. </dd>
<dt><code>trans</code></dt>
<dd>The optional <code>trans</code> attribute is the
BIOS-Translation-Modus (none, lba or auto)</dd>
</dl>
</dd>
Rename iolimit to blockio. After discussion with DB we decided to rename the new iolimit element as it creates the impression it would be there to limit (i.e. throttle) I/O instead of specifying immutable characteristics of a block device. This is also backed by the fact that the term I/O Limits has vanished from newer storage admin documentation. Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-09-04 14:30:55 +00:00
<dt><code>blockio</code></dt>
<dd>If present, the <code>blockio</code> element allows
conf: Support for Block Device IO Limits Introducing a new iolimits element allowing to override certain properties of a guest block device like the physical and logical block size. This can be useful for platforms with 'non-standard' disk formats like S390 DASD with its 4K block size. Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-08-29 15:48:30 +00:00
to override any of the block device properties listed below.
<span class="since">Since 0.10.2 (QEMU and KVM)</span>
<dl>
<dt><code>logical_block_size</code></dt>
<dd>The logical block size the disk will report to the guest
OS. For Linux this would be the value returned by the
BLKSSZGET ioctl and describes the smallest units for disk
I/O.
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
conf: Support for Block Device IO Limits Introducing a new iolimits element allowing to override certain properties of a guest block device like the physical and logical block size. This can be useful for platforms with 'non-standard' disk formats like S390 DASD with its 4K block size. Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-08-29 15:48:30 +00:00
<dt><code>physical_block_size</code></dt>
<dd>The physical block size the disk will report to the guest
OS. For Linux this would be the value returned by the
BLKPBSZGET ioctl and describes the disk's hardware sector
size which can be relevant for the alignment of disk data.
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
conf: Support for Block Device IO Limits Introducing a new iolimits element allowing to override certain properties of a guest block device like the physical and logical block size. This can be useful for platforms with 'non-standard' disk formats like S390 DASD with its 4K block size. Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2012-08-29 15:48:30 +00:00
</dl>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<h4><a name="elementsFilesystems">Filesystems</a></h4>
<p>
A directory on the host that can be accessed directly from the guest.
<span class="since">since 0.3.3, since 0.8.5 for QEMU/KVM</span>
</p>
<pre>
...
&lt;devices&gt;
&lt;filesystem type='template'&gt;
&lt;source name='my-vm-template'/&gt;
&lt;target dir='/'/&gt;
&lt;/filesystem&gt;
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
&lt;filesystem type='mount' accessmode='passthrough'&gt;
Add new attribute wrpolicy to <driver> element This introduces new attribute wrpolicy with only supported value as immediate. This will be an optional attribute with no defaults. This helps specify whether to skip the host page cache. When wrpolicy is specified, meaning when wrpolicy=immediate a writeback is explicitly initiated for the dirty pages in the host page cache as part of the guest file write operation. Usage: <filesystem type='mount' accessmode='passthrough'> <driver type='path' wrpolicy='immediate'/> <source dir='/export/to/guest'/> <target dir='mount_tag'/> </filesystem> Currently this only works with type='mount' for the QEMU/KVM driver. Signed-off-by: Deepak C Shetty <deepakcs@linux.vnet.ibm.com>
2012-01-17 12:44:18 +00:00
&lt;driver type='path' wrpolicy='immediate'/&gt;
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
&lt;source dir='/export/to/guest'/&gt;
&lt;target dir='/import/from/host'/&gt;
&lt;readonly/&gt;
&lt;/filesystem&gt;
Add support for storage format in FS <driver> Extend the <driver> element in filesystem devices to allow a storage format to be set. The new attribute uses 'format' to reflect the storage format. This is different from the <driver> element in disk devices which use 'type' to reflect the storage format. This is because the 'type' attribute on filesystem devices is already used for the driver backend, for which the disk devices use the 'name' attribute. Arggggh. Anyway for disks we have <driver name="qemu" type="raw"/> And for filesystems this change means we now have <driver type="loop" format="raw"/> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-04-22 14:06:14 +00:00
&lt;filesystem type='file' accessmode='passthrough'&gt;
&lt;driver name='loop' type='raw'/&gt;
&lt;driver type='path' wrpolicy='immediate'/&gt;
&lt;source file='/export/to/guest.img'/&gt;
&lt;target dir='/import/from/host'/&gt;
&lt;readonly/&gt;
&lt;/filesystem&gt;
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
...
&lt;/devices&gt;
...</pre>
<dl>
<dt><code>filesystem</code></dt>
<dd>
The filesystem attribute <code>type</code> specifies the type of the
<code>source</code>. The possible values are:
<dl>
<dt><code>type='mount'</code></dt>
<dd>
A host directory to mount in the guest. Used by LXC,
OpenVZ <span class="since">(since 0.6.2)</span>
and QEMU/KVM <span class="since">(since 0.8.5)</span>.
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
This is the default <code>type</code> if one is not specified.
Introduce <driver> under <filesystem> to support open-by-handle VirtFS allows the user to choose between path/handle based fs driver. As of now, libvirt hardcoded path based driver only. This patch provides a solution to allow user to choose between path/handle based fs driver. Sample: <filesystem type='mount'> <driver type='handle'/> <source dir='/folder/to/share1'/> <target dir='mount_tag1'/> </filesystem> <filesystem type='mount'> <driver type='path'/> <source dir='/folder/to/share2'/> <target dir='mount_tag2'/> </filesystem> Signed-off-by: Harsh Prateek Bora <harsh@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-10-11 11:30:40 +00:00
This mode also has an optional
sub-element <code>driver</code>, with an
attribute <code>type='path'</code>
or <code>type='handle'</code> <span class="since">(since
Add new attribute wrpolicy to <driver> element This introduces new attribute wrpolicy with only supported value as immediate. This will be an optional attribute with no defaults. This helps specify whether to skip the host page cache. When wrpolicy is specified, meaning when wrpolicy=immediate a writeback is explicitly initiated for the dirty pages in the host page cache as part of the guest file write operation. Usage: <filesystem type='mount' accessmode='passthrough'> <driver type='path' wrpolicy='immediate'/> <source dir='/export/to/guest'/> <target dir='mount_tag'/> </filesystem> Currently this only works with type='mount' for the QEMU/KVM driver. Signed-off-by: Deepak C Shetty <deepakcs@linux.vnet.ibm.com>
2012-01-17 12:44:18 +00:00
0.9.7)</span>. The driver block has an optional attribute
<code>wrpolicy</code> that further controls interaction with
the host page cache; omitting the attribute gives default behavior,
while the value <code>immediate</code> means that a host writeback
is immediately triggered for all pages touched during a guest file
write operation <span class="since">(since 0.9.10)</span>.
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dd>
<dt><code>type='template'</code></dt>
<dd>
OpenVZ filesystem template. Only used by OpenVZ driver.
</dd>
<dt><code>type='file'</code></dt>
<dd>
Add support for RAM filesystems for LXC Introduce a new syntax for filesystems to allow use of a RAM filesystem <filesystem type='ram'> <source usage='10' units='MiB'/> <target dir='/mnt'/> </filesystem> The usage units default to KiB to limit consumption of host memory. * docs/formatdomain.html.in: Document new syntax * docs/schemas/domaincommon.rng: Add new attributes * src/conf/domain_conf.c: Parsing/formatting of RAM filesystems * src/lxc/lxc_container.c: Mounting of RAM filesystems Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-05-08 16:50:48 +00:00
A host file will be treated as an image and mounted in
the guest. The filesystem format will be autodetected.
Only used by LXC driver.
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dd>
<dt><code>type='block'</code></dt>
<dd>
docs: Document filesystem type='block' for LXC Commit 77791dc0e allows LXC to use a host block device as a guest filesystem, but it isn't documented yet.
2011-10-21 14:26:29 +00:00
A host block device to mount in the guest. The filesystem
format will be autodetected. Only used by LXC driver
<span class="since">(since 0.9.5)</span>.
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dd>
Add support for RAM filesystems for LXC Introduce a new syntax for filesystems to allow use of a RAM filesystem <filesystem type='ram'> <source usage='10' units='MiB'/> <target dir='/mnt'/> </filesystem> The usage units default to KiB to limit consumption of host memory. * docs/formatdomain.html.in: Document new syntax * docs/schemas/domaincommon.rng: Add new attributes * src/conf/domain_conf.c: Parsing/formatting of RAM filesystems * src/lxc/lxc_container.c: Mounting of RAM filesystems Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-05-08 16:50:48 +00:00
<dt><code>type='ram'</code></dt>
<dd>
An in-memory filesystem, using memory from the host OS.
The source element has a single attribute <code>usage</code>
LXC: Fix handling of RAM filesystem size units Since 76b644c when the support for RAM filesystems was introduced, libvirt accepted the following XML: <source usage='1024' unit='KiB'/> This was parsed correctly and internally stored in bytes, but it was formatted as (with an extra 's'): <source usage='1024' units='KiB'/> When read again, this was treated as if the units were missing, meaning libvirt was unable to parse its own XML correctly. The usage attribute was documented as being in KiB, but it was not scaled if the unit was missing. Transient domains still worked, because this was balanced by an extra 'k' in the mount options. This patch: Changes the parser to use 'units' instead of 'unit', as the latter was never documented (fixing persistent domains) and some programs (libvirt-glib, libvirt-sandbox) already parse the 'units' attribute. Removes the extra 'k' from the tmpfs mount options, which is needed because now we parse our own XML correctly. Changes the default input unit to KiB to match documentation, fixing: https://bugzilla.redhat.com/show_bug.cgi?id=1015689
2013-10-09 12:17:13 +00:00
which gives the memory usage limit in KiB, unless units
are specified by the <code>units</code> attribute. Only used
Add support for RAM filesystems for LXC Introduce a new syntax for filesystems to allow use of a RAM filesystem <filesystem type='ram'> <source usage='10' units='MiB'/> <target dir='/mnt'/> </filesystem> The usage units default to KiB to limit consumption of host memory. * docs/formatdomain.html.in: Document new syntax * docs/schemas/domaincommon.rng: Add new attributes * src/conf/domain_conf.c: Parsing/formatting of RAM filesystems * src/lxc/lxc_container.c: Mounting of RAM filesystems Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-05-08 16:50:48 +00:00
by LXC driver.
<span class="since"> (since 0.9.13)</span></dd>
docs: fix typo in filesystem docs Noticed this by reading the page. It would be so much nicer if our tools could automatically flag things like this as part of 'make'. * docs/formatdomain.html.in: Remove extra '>'.
2012-09-21 01:41:13 +00:00
<dt><code>type='bind'</code></dt>
Add support for guest bind mounts with LXC Currently you can configure LXC to bind a host directory to a guest directory, but not to bind a guest directory to a guest directory. While the guest container init could do this itself, allowing it in the libvirt XML means a stricter SELinux policy can be written
2012-06-20 14:03:30 +00:00
<dd>
A directory inside the guest will be bound to another
directory inside the guest. Only used by LXC driver
<span class="since"> (since 0.9.13)</span></dd>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dl>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
The filesystem block has an optional attribute <code>accessmode</code>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
which specifies the security mode for accessing the source
<span class="since">(since 0.8.5)</span>. Currently this only works
with <code>type='mount'</code> for the QEMU/KVM driver. The possible
values are:
<dl>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
<dt><code>accessmode='passthrough'</code></dt>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<dd>
The <code>source</code> is accessed with the permissions of the
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
user inside the guest. This is the default <code>accessmode</code> if
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
one is not specified.
<a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
</dd>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
<dt><code>accessmode='mapped'</code></dt>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<dd>
The <code>source</code> is accessed with the permissions of the
hypervisor (QEMU process).
<a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
</dd>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
<dt><code>accessmode='squash'</code></dt>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<dd>
Similar to 'passthrough', the exception is that failure of
privileged operations like 'chown' are ignored. This makes a
passthrough-like mode usable for people who run the hypervisor
as non-root.
<a href="http://lists.gnu.org/archive/html/qemu-devel/2010-09/msg00121.html">More info</a>
</dd>
</dl>
</dd>
Add support for storage format in FS <driver> Extend the <driver> element in filesystem devices to allow a storage format to be set. The new attribute uses 'format' to reflect the storage format. This is different from the <driver> element in disk devices which use 'type' to reflect the storage format. This is because the 'type' attribute on filesystem devices is already used for the driver backend, for which the disk devices use the 'name' attribute. Arggggh. Anyway for disks we have <driver name="qemu" type="raw"/> And for filesystems this change means we now have <driver type="loop" format="raw"/> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-04-22 14:06:14 +00:00
<dt><code>driver</code></dt>
<dd>
The optional driver element allows specifying further details
related to the hypervisor driver used to provide the filesystem.
<span class="since">Since 1.0.6</span>
<ul>
<li>
If the hypervisor supports multiple backend drivers, then
the <code>type</code> attribute selects the primary
backend driver name, while the <code>format</code>
attribute provides the format type. For example, LXC
Add 'nbd' as a valid filesystem driver type The <filesystem> element can now accept a <driver type='nbd'/> as an alternative to 'loop'. The benefit of NBD is support for non-raw disk image formats. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-04-22 14:06:17 +00:00
supports a type of "loop", with a format of "raw" or
"nbd" with any format. QEMU supports a type of "path"
or "handle", but no formats.
Add support for storage format in FS <driver> Extend the <driver> element in filesystem devices to allow a storage format to be set. The new attribute uses 'format' to reflect the storage format. This is different from the <driver> element in disk devices which use 'type' to reflect the storage format. This is because the 'type' attribute on filesystem devices is already used for the driver backend, for which the disk devices use the 'name' attribute. Arggggh. Anyway for disks we have <driver name="qemu" type="raw"/> And for filesystems this change means we now have <driver type="loop" format="raw"/> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-04-22 14:06:14 +00:00
</li>
</ul>
</dd>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<dt><code>source</code></dt>
<dd>
The resource on the host that is being accessed in the guest. The
<code>name</code> attribute must be used with
<code>type='template'</code>, and the <code>dir</code> attribute must
Add support for RAM filesystems for LXC Introduce a new syntax for filesystems to allow use of a RAM filesystem <filesystem type='ram'> <source usage='10' units='MiB'/> <target dir='/mnt'/> </filesystem> The usage units default to KiB to limit consumption of host memory. * docs/formatdomain.html.in: Document new syntax * docs/schemas/domaincommon.rng: Add new attributes * src/conf/domain_conf.c: Parsing/formatting of RAM filesystems * src/lxc/lxc_container.c: Mounting of RAM filesystems Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-05-08 16:50:48 +00:00
be used with <code>type='mount'</code>. The <code>usage</code> attribute
LXC: Fix handling of RAM filesystem size units Since 76b644c when the support for RAM filesystems was introduced, libvirt accepted the following XML: <source usage='1024' unit='KiB'/> This was parsed correctly and internally stored in bytes, but it was formatted as (with an extra 's'): <source usage='1024' units='KiB'/> When read again, this was treated as if the units were missing, meaning libvirt was unable to parse its own XML correctly. The usage attribute was documented as being in KiB, but it was not scaled if the unit was missing. Transient domains still worked, because this was balanced by an extra 'k' in the mount options. This patch: Changes the parser to use 'units' instead of 'unit', as the latter was never documented (fixing persistent domains) and some programs (libvirt-glib, libvirt-sandbox) already parse the 'units' attribute. Removes the extra 'k' from the tmpfs mount options, which is needed because now we parse our own XML correctly. Changes the default input unit to KiB to match documentation, fixing: https://bugzilla.redhat.com/show_bug.cgi?id=1015689
2013-10-09 12:17:13 +00:00
is used with <code>type='ram'</code> to set the memory limit in KiB,
unless units are specified by the <code>units</code> attribute.
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dd>
<dt><code>target</code></dt>
<dd>
Where the <code>source</code> can be accessed in the guest. For
most drivers this is an automatic mount point, but for QEMU/KVM
this is merely an arbitrary string tag that is exported to the
guest as a hint for where to mount.
</dd>
<dt><code>readonly</code></dt>
<dd>
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
Enables exporting filesystem as a readonly mount for guest, by
qemu: Support readonly filesystem passthrough Upstream QEMU starts to support it from commit 2c74c2cb.
2011-12-21 15:51:29 +00:00
default read-write access is given (currently only works for
QEMU/KVM driver).
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dd>
Introduce filesystem limits to virDomainFSDef
2012-05-23 12:38:55 +00:00
<dt><code>space_hard_limit</code></dt>
<dd>
Maximum space available to this guest's filesystem.
<span class="since">Since 0.9.13</span>
</dd>
<dt><code>space_soft_limit</code></dt>
<dd>
Maximum space available to this guest's filesystem. The container is
permitted to exceed its soft limits for a grace period of time. Afterwards the
hard limit is enforced.
<span class="since">Since 0.9.13</span>
</dd>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dl>
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
<h4><a name="elementsAddress">Device Addresses</a></h4>
<p>
Many devices have an optional <code>&lt;address&gt;</code>
sub-element to describe where the device is placed on the
virtual bus presented to the guest. If an address (or any
optional attribute within an address) is omitted on
input, libvirt will generate an appropriate address; but an
explicit address is required if more control over layout is
required. See below for device examples including an address
element.
</p>
<p>
Every address has a mandatory attribute <code>type</code> that
describes which bus the device is on. The choice of which
address to use for a given device is constrained in part by the
device and the architecture of the guest. For example,
a <code>&lt;disk&gt;</code> device
uses <code>type='disk'</code>, while
a <code>&lt;console&gt;</code> device would
use <code>type='pci'</code> on i686 or x86_64 guests,
or <code>type='spapr-vio'</code> on PowerPC64 pseries guests.
Each address type has further optional attributes that control
where on the bus the device will be placed:
</p>
<dl>
<dt><code>type='pci'</code></dt>
<dd>PCI addresses have the following additional
attributes: <code>domain</code> (a 2-byte hex integer, not
currently used by qemu), <code>bus</code> (a hex value between
0 and 0xff, inclusive), <code>slot</code> (a hex value between
0x0 and 0x1f, inclusive), and <code>function</code> (a value
between 0 and 7, inclusive). Also available is
the <code>multifunction</code> attribute, which controls
turning on the multifunction bit for a particular
slot/function in the PCI control register
(<span class="since">since 0.9.7, requires QEMU
0.13</span>). <code>multifunction</code> defaults to 'off',
but should be set to 'on' for function 0 of a slot that will
have multiple functions used.
</dd>
<dt><code>type='drive'</code></dt>
<dd>Drive addresses have the following additional
attributes: <code>controller</code> (a 2-digit controller
number), <code>bus</code> (a 2-digit bus number),
conf: Introduce new attribute for device address format * src/conf/domain_conf.h: Add new member "target" to struct _virDomainDeviceDriveAddress. * src/conf/domain_conf.c: Parse and format "target" * Lots of tests (.xml) in tests/domainsnapshotxml2xmlout, tests/qemuxml2argvdata, tests/qemuxml2xmloutdata, and tests/vmx2xmldata/ are modified for newly introduced attribute "target" for address of "drive" type.
2012-02-27 10:19:54 +00:00
<code>target</code> (a 2-digit bus number),
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
and <code>unit</code> (a 2-digit unit number on the bus).
</dd>
<dt><code>type='virtio-serial'</code></dt>
<dd>Each virtio-serial address has the following additional
attributes: <code>controller</code> (a 2-digit controller
number), <code>bus</code> (a 2-digit bus number),
and <code>slot</code> (a 2-digit slot within the bus).
</dd>
<dt><code>type='ccid'</code></dt>
<dd>A CCID address, for smart-cards, has the following
additional attributes: <code>bus</code> (a 2-digit bus
number), and <code>slot</code> attribute (a 2-digit slot
within the bus). <span class="since">Since 0.8.8.</span>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
<dt><code>type='usb'</code></dt>
<dd>USB addresses have the following additional
attributes: <code>bus</code> (a hex value between 0 and 0xfff,
inclusive), and <code>port</code> (a dotted notation of up to
four octets, such as 1.2 or 2.1.3.1).
</dd>
<dt><code>type='spapr-vio'</code></dt>
<dd>On PowerPC pseries guests, devices can be assigned to the
SPAPR-VIO bus. It has a flat 64-bit address space; by
convention, devices are generally assigned at a non-zero
multiple of 0x1000, but other addresses are valid and
permitted by libvirt. Each address has the following
additional attribute: <code>reg</code> (the hex value address
of the starting register). <span class="since">Since
0.9.9.</span>
S390: Documentation for CCW address type The native bus for s390 I/O is called CCW (channel command word). As QEMU has added basic support for the CCW bus, i.e. the ability to assign CCW devnos (bus addresses) to devices. Domains with the new machine type s390-ccw-virtio can use the CCW bus. Currently QEMU will only allow to define virtio devices on the CCW bus. Here we add the new machine type and the new device address to the schema definition and add a new paragraph to the domain XML documentation. Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2013-03-05 15:44:19 +00:00
</dd>
<dt><code>type='ccw'</code></dt>
<dd>s390 guests with a <code>machine</code> value of
s390-ccw-virtio use the native CCW bus for I/O devices.
CCW bus addresses have the following additional attributes:
<code>cssid</code> (a hex value between 0 and 0xfe, inclusive),
<code>ssid</code> (a value between 0 and 3, inclusive) and
<code>devno</code> (a hex value between 0 and 0xffff, inclusive).
Partially specified bus addresses are not allowed.
If omitted, libvirt will assign a free bus address with
cssid=0xfe and ssid=0. Virtio devices for s390 must have their
cssid set to 0xfe in order to be recognized by the guest
operating system.
<span class="since">Since 1.0.4</span>
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
</dd>
</dl>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<h4><a name="elementsControllers">Controllers</a></h4>
<p>
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
Depending on the guest architecture, some device buses can
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
appear more than once, with a group of virtual devices tied to a
virtual controller. Normally, libvirt can automatically infer such
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
controllers without requiring explicit XML markup, but sometimes
it is necessary to provide an explicit controller element.
</p>
<pre>
...
&lt;devices&gt;
&lt;controller type='ide' index='0'/&gt;
&lt;controller type='virtio-serial' index='0' ports='16' vectors='4'/&gt;
&lt;controller type='virtio-serial' index='1'&gt;
&lt;address type='pci' domain='0x0000' bus='0x00' slot='0x0a' function='0x0'/&gt;
&lt;/controller&gt;
...
&lt;/devices&gt;
...</pre>
<p>
Each controller has a mandatory attribute <code>type</code>,
Add a new controller type 'usb' with optionnal 'model' The model by default is piix3-uchi. Example: <controller type='usb' index='0' model='ich9-ehci'/>
2011-09-02 13:21:23 +00:00
which must be one of "ide", "fdc", "scsi", "sata", "usb",
conf: add PCI controllers Add new controller type 'pci' with models 'pci-root' and 'pci-bridge'.
2013-04-17 15:05:15 +00:00
"ccid", "virtio-serial" or "pci", and a mandatory
Add a new controller type 'usb' with optionnal 'model' The model by default is piix3-uchi. Example: <controller type='usb' index='0' model='ich9-ehci'/>
2011-09-02 13:21:23 +00:00
attribute <code>index</code> which is the decimal integer
describing in which order the bus controller is encountered (for
use in <code>controller</code> attributes
of <code>&lt;address&gt;</code> elements). The "virtio-serial"
controller has two additional optional
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
attributes <code>ports</code> and <code>vectors</code>, which
control how many devices can be connected through the
controller. A "scsi" controller has an optional
qemu: add ibmvscsi controller model KVM will be able to use a PCI SCSI controller even on POWER. Let the user specify the vSCSI controller by other means than a default. After this patch, the QEMU driver will actually look at the model and reject anything but auto, lsilogic and ibmvscsi. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Signed-off-by: Osier Yang <jyang@redhat.com>
2012-02-27 09:08:23 +00:00
attribute <code>model</code>, which is one of "auto", "buslogic",
qemu: add support for LSI MegaRAID SAS1078 (aka megasas) SCSI controller This does nothing more than adding the new device and capability. The device is present since QEMU 1.2.0. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2013-03-21 14:11:39 +00:00
"ibmvscsi", "lsilogic", "lsisas1068", "lsisas1078", "virtio-scsi" or
Introduce a sub-element <driver> for controller Like what we did for "disk", "filesystem" and "interface", this introduces sub-element <driver> for "controller", and put the "queues" into it.
2013-04-24 09:24:38 +00:00
"vmpvscsi". A "usb" controller has an optional attribute
<code>model</code>, which is one of "piix3-uhci", "piix4-uhci", "ehci",
"ich9-ehci1", "ich9-uhci1", "ich9-uhci2", "ich9-uhci3", "vt82c686b-uhci",
"pci-ohci" or "nec-xhci". Additionally,
<span class="since">since 0.10.0</span>, if the USB bus needs to be
explicitly disabled for the guest, <code>model='none'</code> may be
S390: Mention changed USB behavior Add a line saying that no USB controllers are generated by default on s390.
2013-04-29 16:11:28 +00:00
used. <span class="since">Since 1.0.5</span>, no default USB controller
will be built on s390. The PowerPC64 "spapr-vio" addresses do not have an
associated controller.
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</p>
<p>
For controllers that are themselves devices on a PCI or USB bus,
an optional sub-element <code>&lt;address&gt;</code> can specify
the exact relationship of the controller to its master bus, with
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
semantics <a href="#elementsAddress">given above</a>.
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</p>
Introduce a sub-element <driver> for controller Like what we did for "disk", "filesystem" and "interface", this introduces sub-element <driver> for "controller", and put the "queues" into it.
2013-04-24 09:24:38 +00:00
<p>
An optional sub-element <code>driver</code> can specify the driver
specific options. Currently it only supports attribute <code>queues</code>
(<span class="since">1.0.5</span>, QEMU and KVM only), which specifies the
number of queues for the controller. For best performance, it's recommended
to specify a value matching the number of vCPUs.
</p>
Add USB companion controllers support Companion controllers take an extra 'master' attribute to associate them. Also add tests for this
2011-09-02 14:03:51 +00:00
<p>
USB companion controllers have an optional
sub-element <code>&lt;master&gt;</code> to specify the exact
relationship of the companion to its master controller.
A companion controller is on the same bus as its master, so
the companion <code>index</code> value should be equal.
</p>
<pre>
...
&lt;devices&gt;
&lt;controller type='usb' index='0' model='ich9-ehci1'&gt;
&lt;address type='pci' domain='0' bus='0' slot='4' function='7'/&gt;
&lt;/controller&gt;
&lt;controller type='usb' index='0' model='ich9-uhci1'&gt;
&lt;master startport='0'/&gt;
qemu: make PCI multifunction support more manual When support for was added for PCI multifunction cards (in commit 9f8baf, first included in libvirt 0.9.3), it was done by always turning on the multifunction bit for all PCI devices. Since that time it has been realized that this is not an ideal solution, and that the multifunction bit must be selectively turned on. For example, see https://bugzilla.redhat.com/show_bug.cgi?id=728174 and the discussion before and after https://www.redhat.com/archives/libvir-list/2011-September/msg01036.html This patch modifies multifunction support so that the multifunction=on option is only added to the qemu commandline for a device if its PCI <address> definition has the attribute "multifunction='on'", e.g.: <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0' multifunction='on'/> In practice, the multifunction bit should only be turned on if function='0' AND other functions will be used in the same slot - it usually isn't needed for functions 1-7 (although there are apparently some exceptions, e.g. the Intel X53 according to the QEMU source code), and should never be set if only function 0 will be used in the slot. The test cases have been changed accordingly to illustrate. With this patch in place, if a user attempts to assign multiple functions in a slot without setting the multifunction bit for function 0, libvirt will issue an error when the domain is defined, and the define operation will fail. In the future, we may decide to detect this situation and automatically add multifunction=on to avoid the error; even then it will still be useful to have a manual method of turning on multifunction since, as stated above, there are some devices that excpect it to be turned on for all functions in a slot. A side effect of this patch is that attempts to use the same PCI address for two different devices will now log an error (previously this would cause the domain define operation to fail, but there would be no log message generated). Because the function doing this log was almost completely rewritten, I didn't think it worthwhile to make a separate patch for that fix (the entire patch would immediately be obsoleted).
2011-09-29 17:00:32 +00:00
&lt;address type='pci' domain='0' bus='0' slot='4' function='0' multifunction='on'/&gt;
Add USB companion controllers support Companion controllers take an extra 'master' attribute to associate them. Also add tests for this
2011-09-02 14:03:51 +00:00
&lt;/controller&gt;
...
&lt;/devices&gt;
conf: add PCI controllers Add new controller type 'pci' with models 'pci-root' and 'pci-bridge'.
2013-04-17 15:05:15 +00:00
...</pre>
<p>
PCI controllers have an optional <code>model</code> attribute with
qemu: add dmi-to-pci-bridge controller This PCI controller, named "dmi-to-pci-bridge" in the libvirt config, and implemented with qemu's "i82801b11-bridge" device, connects to a PCI Express slot (e.g. one of the slots provided by the pcie-root controller, aka "pcie.0" on the qemu commandline), and provides 31 *non-hot-pluggable* PCI (*not* PCIe) slots, numbered 1-31. Any time a machine is defined which has a pcie-root controller (i.e. any q35-based machinetype), libvirt will automatically add a dmi-to-pci-bridge controller if one doesn't exist, and also add a pci-bridge controller. The reasoning here is that any useful domain will have either an immediate (startup time) or eventual (subsequent hot-plug) need for a standard PCI slot; since the pcie-root controller only provides PCIe slots, we need to connect a dmi-to-pci-bridge controller to it in order to get a non-hot-plug PCI slot that we can then use to connect a pci-bridge - the slots provided by the pci-bridge will be both standard PCI and hot-pluggable. Since pci-bridge devices themselves can not be hot-plugged into a running system (although you can hot-plug other devices into a pci-bridge's slots), any new pci-bridge controller that is added can (and will) be plugged into the dmi-to-pci-bridge as long as it has empty slots available. This patch is also changing the qemuxml2xml-pcie test from a "DO_TEST" to a "DO_DIFFERENT_TEST". This is so that the "before" xml can omit the automatically added dmi-to-pci-bridge and pci-bridge devices, and the "after" xml can include it - this way we are testing if libvirt is properly adding these devices.
2013-07-31 01:37:32 +00:00
possible values <code>pci-root</code>, <code>pcie-root</code>,
<code>pci-bridge</code>, or <code>dmi-to-pci-bridge</code>.
Add pcihole64 element to root PCI controllers <controller type='pci' index='0' model='pci-root'> <pcihole64 unit='KiB'>1048576</pcihole64> </controller> It can be used to adjust (or disable) the size of the 64-bit PCI hole. The size attribute is in kilobytes (different unit can be specified on input), but it gets rounded up to the nearest GB by QEMU. Disabling it will be needed for guests that crash with the 64-bit PCI hole (like Windows XP), see: https://bugzilla.redhat.com/show_bug.cgi?id=990418
2013-08-12 11:39:04 +00:00
The root controllers (<code>pci-root</code> and <code>pcie-root</code>)
have an optional <code>pcihole64</code> element specifying how big
(in kilobytes, or in the unit specified by <code>pcihole64</code>'s
<code>unit</code> attribute) the 64-bit PCI hole should be. Some guests (like
Windows XP or Windows Server 2003) might crash when QEMU and Seabios
are recent enough to support 64-bit PCI holes, unless this is disabled
(set to 0). <span class="since">Since 1.1.2 (QEMU only)</span>
</p>
<p>
qemu: add pcie-root controller This controller is implicit on q35 machinetypes. It provides 31 PCIe (*not* PCI) slots as controller 0. Currently there are no devices that can connect to pcie-root, and no implicit pci controller on a q35 machine, so q35 is still unusable. For a usable q35 system, we need to add a "dmi-to-pci-bridge" pci controller, which can connect to pcie-root, and provides standard pci slots that can be used to connect other devices.
2013-07-10 19:19:32 +00:00
For machine types which provide an implicit PCI bus, the pci-root
conf: add PCI controllers Add new controller type 'pci' with models 'pci-root' and 'pci-bridge'.
2013-04-17 15:05:15 +00:00
controller with index=0 is auto-added and required to use PCI devices.
qemu: add pcie-root controller This controller is implicit on q35 machinetypes. It provides 31 PCIe (*not* PCI) slots as controller 0. Currently there are no devices that can connect to pcie-root, and no implicit pci controller on a q35 machine, so q35 is still unusable. For a usable q35 system, we need to add a "dmi-to-pci-bridge" pci controller, which can connect to pcie-root, and provides standard pci slots that can be used to connect other devices.
2013-07-10 19:19:32 +00:00
pci-root has no address.
qemu: add dmi-to-pci-bridge controller This PCI controller, named "dmi-to-pci-bridge" in the libvirt config, and implemented with qemu's "i82801b11-bridge" device, connects to a PCI Express slot (e.g. one of the slots provided by the pcie-root controller, aka "pcie.0" on the qemu commandline), and provides 31 *non-hot-pluggable* PCI (*not* PCIe) slots, numbered 1-31. Any time a machine is defined which has a pcie-root controller (i.e. any q35-based machinetype), libvirt will automatically add a dmi-to-pci-bridge controller if one doesn't exist, and also add a pci-bridge controller. The reasoning here is that any useful domain will have either an immediate (startup time) or eventual (subsequent hot-plug) need for a standard PCI slot; since the pcie-root controller only provides PCIe slots, we need to connect a dmi-to-pci-bridge controller to it in order to get a non-hot-plug PCI slot that we can then use to connect a pci-bridge - the slots provided by the pci-bridge will be both standard PCI and hot-pluggable. Since pci-bridge devices themselves can not be hot-plugged into a running system (although you can hot-plug other devices into a pci-bridge's slots), any new pci-bridge controller that is added can (and will) be plugged into the dmi-to-pci-bridge as long as it has empty slots available. This patch is also changing the qemuxml2xml-pcie test from a "DO_TEST" to a "DO_DIFFERENT_TEST". This is so that the "before" xml can omit the automatically added dmi-to-pci-bridge and pci-bridge devices, and the "after" xml can include it - this way we are testing if libvirt is properly adding these devices.
2013-07-31 01:37:32 +00:00
PCI bridges are auto-added if there are too many devices to fit on
the one bus provided by pci-root, or a PCI bus number greater than zero
was specified.
conf: add PCI controllers Add new controller type 'pci' with models 'pci-root' and 'pci-bridge'.
2013-04-17 15:05:15 +00:00
PCI bridges can also be specified manually, but their addresses should
only refer to PCI buses provided by already specified PCI controllers.
Leaving gaps in the PCI controller indexes might lead to an invalid
configuration.
qemu: add pcie-root controller This controller is implicit on q35 machinetypes. It provides 31 PCIe (*not* PCI) slots as controller 0. Currently there are no devices that can connect to pcie-root, and no implicit pci controller on a q35 machine, so q35 is still unusable. For a usable q35 system, we need to add a "dmi-to-pci-bridge" pci controller, which can connect to pcie-root, and provides standard pci slots that can be used to connect other devices.
2013-07-10 19:19:32 +00:00
(pci-root and pci-bridge <span class="since">since 1.0.5</span>)
conf: add PCI controllers Add new controller type 'pci' with models 'pci-root' and 'pci-bridge'.
2013-04-17 15:05:15 +00:00
</p>
<pre>
...
&lt;devices&gt;
&lt;controller type='pci' index='0' model='pci-root'/&gt;
&lt;controller type='pci' index='1' model='pci-bridge'&gt;
qemu: add pcie-root controller This controller is implicit on q35 machinetypes. It provides 31 PCIe (*not* PCI) slots as controller 0. Currently there are no devices that can connect to pcie-root, and no implicit pci controller on a q35 machine, so q35 is still unusable. For a usable q35 system, we need to add a "dmi-to-pci-bridge" pci controller, which can connect to pcie-root, and provides standard pci slots that can be used to connect other devices.
2013-07-10 19:19:32 +00:00
&lt;address type='pci' domain='0' bus='0' slot='5' function='0' multifunction='off'/&gt;
conf: add PCI controllers Add new controller type 'pci' with models 'pci-root' and 'pci-bridge'.
2013-04-17 15:05:15 +00:00
&lt;/controller&gt;
&lt;/devices&gt;
qemu: add pcie-root controller This controller is implicit on q35 machinetypes. It provides 31 PCIe (*not* PCI) slots as controller 0. Currently there are no devices that can connect to pcie-root, and no implicit pci controller on a q35 machine, so q35 is still unusable. For a usable q35 system, we need to add a "dmi-to-pci-bridge" pci controller, which can connect to pcie-root, and provides standard pci slots that can be used to connect other devices.
2013-07-10 19:19:32 +00:00
...</pre>
<p>
For machine types which provide an implicit PCI Express (PCIe)
bus (for example, the machine types based on the Q35 chipset),
the pcie-root controller with index=0 is auto-added to the
domain's configuration. pcie-root has also no address, provides
31 slots (numbered 1-31) and can only be used to attach PCIe
qemu: add dmi-to-pci-bridge controller This PCI controller, named "dmi-to-pci-bridge" in the libvirt config, and implemented with qemu's "i82801b11-bridge" device, connects to a PCI Express slot (e.g. one of the slots provided by the pcie-root controller, aka "pcie.0" on the qemu commandline), and provides 31 *non-hot-pluggable* PCI (*not* PCIe) slots, numbered 1-31. Any time a machine is defined which has a pcie-root controller (i.e. any q35-based machinetype), libvirt will automatically add a dmi-to-pci-bridge controller if one doesn't exist, and also add a pci-bridge controller. The reasoning here is that any useful domain will have either an immediate (startup time) or eventual (subsequent hot-plug) need for a standard PCI slot; since the pcie-root controller only provides PCIe slots, we need to connect a dmi-to-pci-bridge controller to it in order to get a non-hot-plug PCI slot that we can then use to connect a pci-bridge - the slots provided by the pci-bridge will be both standard PCI and hot-pluggable. Since pci-bridge devices themselves can not be hot-plugged into a running system (although you can hot-plug other devices into a pci-bridge's slots), any new pci-bridge controller that is added can (and will) be plugged into the dmi-to-pci-bridge as long as it has empty slots available. This patch is also changing the qemuxml2xml-pcie test from a "DO_TEST" to a "DO_DIFFERENT_TEST". This is so that the "before" xml can omit the automatically added dmi-to-pci-bridge and pci-bridge devices, and the "after" xml can include it - this way we are testing if libvirt is properly adding these devices.
2013-07-31 01:37:32 +00:00
devices. In order to connect standard PCI devices on a system
which has a pcie-root controller, a pci controller
with <code>model='dmi-to-pci-bridge'</code> is automatically
added. A dmi-to-pci-bridge controller plugs into a PCIe slot (as
provided by pcie-root), and itself provides 31 standard PCI
slots (which are not hot-pluggable). In order to have
hot-pluggable PCI slots in the guest system, a pci-bridge
controller will also be automatically created and connected to
one of the slots of the auto-created dmi-to-pci-bridge
controller; all guest devices with PCI addresses that are
auto-determined by libvirt will be placed on this pci-bridge
device. (<span class="since">since 1.1.2</span>).
qemu: add pcie-root controller This controller is implicit on q35 machinetypes. It provides 31 PCIe (*not* PCI) slots as controller 0. Currently there are no devices that can connect to pcie-root, and no implicit pci controller on a q35 machine, so q35 is still unusable. For a usable q35 system, we need to add a "dmi-to-pci-bridge" pci controller, which can connect to pcie-root, and provides standard pci slots that can be used to connect other devices.
2013-07-10 19:19:32 +00:00
</p>
<pre>
...
&lt;devices&gt;
&lt;controller type='pci' index='0' model='pcie-root'/&gt;
qemu: add dmi-to-pci-bridge controller This PCI controller, named "dmi-to-pci-bridge" in the libvirt config, and implemented with qemu's "i82801b11-bridge" device, connects to a PCI Express slot (e.g. one of the slots provided by the pcie-root controller, aka "pcie.0" on the qemu commandline), and provides 31 *non-hot-pluggable* PCI (*not* PCIe) slots, numbered 1-31. Any time a machine is defined which has a pcie-root controller (i.e. any q35-based machinetype), libvirt will automatically add a dmi-to-pci-bridge controller if one doesn't exist, and also add a pci-bridge controller. The reasoning here is that any useful domain will have either an immediate (startup time) or eventual (subsequent hot-plug) need for a standard PCI slot; since the pcie-root controller only provides PCIe slots, we need to connect a dmi-to-pci-bridge controller to it in order to get a non-hot-plug PCI slot that we can then use to connect a pci-bridge - the slots provided by the pci-bridge will be both standard PCI and hot-pluggable. Since pci-bridge devices themselves can not be hot-plugged into a running system (although you can hot-plug other devices into a pci-bridge's slots), any new pci-bridge controller that is added can (and will) be plugged into the dmi-to-pci-bridge as long as it has empty slots available. This patch is also changing the qemuxml2xml-pcie test from a "DO_TEST" to a "DO_DIFFERENT_TEST". This is so that the "before" xml can omit the automatically added dmi-to-pci-bridge and pci-bridge devices, and the "after" xml can include it - this way we are testing if libvirt is properly adding these devices.
2013-07-31 01:37:32 +00:00
&lt;controller type='pci' index='1' model='dmi-to-pci-bridge'&gt;
&lt;address type='pci' domain='0' bus='0' slot='0xe' function='0'/&gt;
&lt;/controller&gt;
&lt;controller type='pci' index='2' model='pci-bridge'&gt;
&lt;address type='pci' domain='0' bus='1' slot='1' function='0'/&gt;
&lt;/controller&gt;
qemu: add pcie-root controller This controller is implicit on q35 machinetypes. It provides 31 PCIe (*not* PCI) slots as controller 0. Currently there are no devices that can connect to pcie-root, and no implicit pci controller on a q35 machine, so q35 is still unusable. For a usable q35 system, we need to add a "dmi-to-pci-bridge" pci controller, which can connect to pcie-root, and provides standard pci slots that can be used to connect other devices.
2013-07-10 19:19:32 +00:00
&lt;/devices&gt;
Add USB companion controllers support Companion controllers take an extra 'master' attribute to associate them. Also add tests for this
2011-09-02 14:03:51 +00:00
...</pre>
Support leases in guest XML and lock manager A lock manager may operate in various modes. The direct mode of operation is to obtain locks based on the resources associated with devices in the XML. The indirect mode is where the app creating the domain provides explicit leases for each resource that needs to be locked. This XML extension allows for listing resources in the XML <devices> ... <lease> <lockspace>somearea</lockspace> <key>thequickbrownfoxjumpsoverthelazydog</key> <target path='/some/lease/path' offset='23432'/> </lease> ... </devices> The 'lockspace' is a unique identifier for the lockspace which the lease is associated The 'key' is a unique identifier for the resource associated with the lease. The 'target' is the file on disk where the leases are held. * docs/schemas/domain.rng: Add lease schema * src/conf/domain_conf.c, src/conf/domain_conf.h: parsing and formatting for leases * tests/qemuxml2argvdata/qemuxml2argv-lease.args, tests/qemuxml2argvdata/qemuxml2argv-lease.xml, tests/qemuxml2xmltest.c: Test XML handling for leases
2010-12-09 18:25:11 +00:00
<h4><a name="elementsLease">Device leases</a></h4>
<p>
When using a lock manager, it may be desirable to record device leases
against a VM. The lock manager will ensure the VM won't start unless
the leases can be acquired.
</p>
<pre>
...
&lt;devices&gt;
...
&lt;lease&gt;
&lt;lockspace&gt;somearea&lt;/lockspace&gt;
&lt;key&gt;somekey&lt;/key&gt;
&lt;target path='/some/lease/path' offset='1024'/&gt;
&lt;/lease&gt;
...
&lt;/devices&gt;
...</pre>
<dl>
<dt>lockspace</dt>
<dd>This is an arbitrary string, identifying the lockspace
within which the key is held. Lock managers may impose
extra restrictions on the format, or length of the lockspace
name.</dd>
<dt>key</dt>
<dd>This is an arbitrary string, uniquely identifying the
lease to be acquired. Lock managers may impose extra
restrictions on the format, or length of the key.
</dd>
<dt>target</dt>
<dd>This is the fully qualified path of the file associated
with the lockspace. The offset specifies where the lease
is stored within the file. If the lock manager does not
require a offset, just pass 0.
</dd>
</dl>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
Add support for <hostdev mode="capabilities"> The <hostdev> device type has long had a redundant "mode" attribute, which has always been "subsys". This finally introduces a new mode "capabilities", which will be used by the LXC driver for device assignment. Since container based virtualization uses a single kernel, the idea of assigning physical PCI devices doesn't make sense. It is still reasonable to assign USB devices, but for assigning arbitrary nodes in /dev, the new 'capabilities' mode is to be used. The first capability support is 'storage', which is for assignment of block devices. Functionally this is really pretty similar to the <disk> support. The only difference is the device node name is identical in both host and container namespaces. <hostdev mode='capabilities' type='storage'> <source> <block>/dev/sdf1</block> </source> </hostdev> The second capability support is 'misc', which is for assignment of character devices. There is no existing parallel to this. Again the device node is the same inside & outside the container. <hostdev mode='capabilities' type='misc'> <source> <char>/dev/input/event3</char> </source> </hostdev> The reason for keeping the char & storage devices separate in the domain XML, is to mirror the split in the node device XML. NB the node device XML does not yet report character devices, but that's another new patch to come Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-11-23 13:50:29 +00:00
<h4><a name="elementsHostDev">Host device assignment</a></h4>
docs: formatdomain: fix links in the table of contents
2013-05-21 08:55:42 +00:00
<h5><a name="elementsHostDevSubsys">USB / PCI / SCSI devices</a></h5>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<p>
conf: Generic XMLs for scsi hostdev An example of the scsi hostdev XML: <hostdev mode='subsystem' type='scsi'> <source> <adapter name='scsi_host0'/> <address bus='0' target='0' unit='0'/> </source> <address type='drive' controller='0' bus='0' target='4' unit='8'/> </hostdev> Controller is implicitly added for scsi hostdev, though the scsi controller's model defaults to "lsilogic", which might be not what the user wants (same problem exists for virtio-scsi disk). It's the existing problem, will be addressed later. The device address must be specified manually. Later patch will let libvirt generate it automatically. This only introduces the generic XMLs for scsi hostdev, later patches will add other elements, e.g. <readonly>, <shareable>. Signed-off-by: Han Cheng <hanc.fnst@cn.fujitsu.com> Signed-off-by: Osier Yang <jyang@redhat.com>
2013-05-03 18:07:20 +00:00
USB, PCI and SCSI devices attached to the host can be passed through
Add support for <hostdev mode="capabilities"> The <hostdev> device type has long had a redundant "mode" attribute, which has always been "subsys". This finally introduces a new mode "capabilities", which will be used by the LXC driver for device assignment. Since container based virtualization uses a single kernel, the idea of assigning physical PCI devices doesn't make sense. It is still reasonable to assign USB devices, but for assigning arbitrary nodes in /dev, the new 'capabilities' mode is to be used. The first capability support is 'storage', which is for assignment of block devices. Functionally this is really pretty similar to the <disk> support. The only difference is the device node name is identical in both host and container namespaces. <hostdev mode='capabilities' type='storage'> <source> <block>/dev/sdf1</block> </source> </hostdev> The second capability support is 'misc', which is for assignment of character devices. There is no existing parallel to this. Again the device node is the same inside & outside the container. <hostdev mode='capabilities' type='misc'> <source> <char>/dev/input/event3</char> </source> </hostdev> The reason for keeping the char & storage devices separate in the domain XML, is to mirror the split in the node device XML. NB the node device XML does not yet report character devices, but that's another new patch to come Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-11-23 13:50:29 +00:00
to the guest using the <code>hostdev</code> element.
conf: Generic XMLs for scsi hostdev An example of the scsi hostdev XML: <hostdev mode='subsystem' type='scsi'> <source> <adapter name='scsi_host0'/> <address bus='0' target='0' unit='0'/> </source> <address type='drive' controller='0' bus='0' target='4' unit='8'/> </hostdev> Controller is implicitly added for scsi hostdev, though the scsi controller's model defaults to "lsilogic", which might be not what the user wants (same problem exists for virtio-scsi disk). It's the existing problem, will be addressed later. The device address must be specified manually. Later patch will let libvirt generate it automatically. This only introduces the generic XMLs for scsi hostdev, later patches will add other elements, e.g. <readonly>, <shareable>. Signed-off-by: Han Cheng <hanc.fnst@cn.fujitsu.com> Signed-off-by: Osier Yang <jyang@redhat.com>
2013-05-03 18:07:20 +00:00
<span class="since">since after 0.4.4 for USB, 0.6.0 for PCI(KVM only)
and 1.0.6 for SCSI(KVM only)</span>:
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;hostdev mode='subsystem' type='usb'&gt;
conf: Add support for startupPolicy for USB devices USB devices can disappear without OS being mad about it, which makes them ideal for startupPolicy. With this attribute, USB devices can be configured to be mandatory (the default), requisite (will disappear during migration if they cannot be found), or completely optional.
2012-10-02 13:14:02 +00:00
&lt;source startupPolicy='optional'&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;vendor id='0x1234'/&gt;
&lt;product id='0xbeef'/&gt;
&lt;/source&gt;
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
&lt;boot order='2'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/hostdev&gt;
&lt;/devices&gt;
...</pre>
Add tests and docs for the new PCI passthrough format * docs/formatdomain.html.in docs/libvirt.rng docs/formatdomain.html: document the new PCI passthrough format * tests/qemuxml2argvtest.c tests/qemuxml2xmltest.c tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.args tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.xml: and add a regression test for it. Daniel
2009-01-12 15:09:19 +00:00
<p>or:</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
domain.rng vs. formatdomain.html#elementsUSB The Relax-NG schema for domains regarding <hostdev> doesn't match what's implemented in src/conf/domain_conf.c#virDomainHostdevDefFormat(): The implementation only requires @type, but the schema currently either required none or all three attributes (@mode, @type, and @managed) to be defined together, because they are declared in the same <optional)-section. (@managed is currently even undocumented on <http://libvirt.org/formatdomain.html#elementsUSB>). Thus the following minimal <hostdev>-example fails to validate: <domain type='test'> <name>N</name> <memory>4096</memory> <bootloader>/bin/false</bootloader> <os> <type arch='x86_64' machine='xenpv'>linux</type> </os> <devices> <hostdev type='pci'> <source> <address bus='0x06' slot='0x00' function='0x0'/> </source> </hostdev> </devices> </domain> The schema is changed to match the current implementation: 1. @mode is optional (which defaults to 'subsystem') 2. @type is required 3. @managed is optional (which defaults to 'no') The documentation is updated to mention @managed. Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-03-01 10:23:20 +00:00
&lt;hostdev mode='subsystem' type='pci' managed='yes'&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;source&gt;
&lt;address bus='0x06' slot='0x02' function='0x0'/&gt;
&lt;/source&gt;
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
&lt;boot order='1'/&gt;
qemu: add "romfile" support to specify device boot ROM This patch addresses: https://bugzilla.redhat.com/show_bug.cgi?id=781562 Along with the "rombar" option that controls whether or not a boot rom is made visible to the guest, qemu also has a "romfile" option that allows specifying a binary file to present as the ROM BIOS of any emulated or passthrough PCI device. This patch adds support for specifying romfile to both passthrough PCI devices, and emulated network devices that attach to the guest's PCI bus (just about everything other than ne2k_isa). One example of the usefulness of this option is described in the bugzilla report: 82576 sriov network adapters don't provide a ROM BIOS for the cards virtual functions (VF), but an image of such a ROM is available, and with this ROM visible to the guest, it can PXE boot. In libvirt's xml, the new option is configured like this: <hostdev> ... <rom file='/etc/fake/boot.bin'/> ... </hostdev (similarly for <interface>).
2012-01-25 16:20:49 +00:00
&lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/hostdev&gt;
&lt;/devices&gt;
conf: Generic XMLs for scsi hostdev An example of the scsi hostdev XML: <hostdev mode='subsystem' type='scsi'> <source> <adapter name='scsi_host0'/> <address bus='0' target='0' unit='0'/> </source> <address type='drive' controller='0' bus='0' target='4' unit='8'/> </hostdev> Controller is implicitly added for scsi hostdev, though the scsi controller's model defaults to "lsilogic", which might be not what the user wants (same problem exists for virtio-scsi disk). It's the existing problem, will be addressed later. The device address must be specified manually. Later patch will let libvirt generate it automatically. This only introduces the generic XMLs for scsi hostdev, later patches will add other elements, e.g. <readonly>, <shareable>. Signed-off-by: Han Cheng <hanc.fnst@cn.fujitsu.com> Signed-off-by: Osier Yang <jyang@redhat.com>
2013-05-03 18:07:20 +00:00
...</pre>
<p>or:</p>
<pre>
...
&lt;devices&gt;
&lt;hostdev mode='subsystem' type='scsi'&gt;
&lt;source&gt;
&lt;adapter name='scsi_host0'/&gt;
&lt;address type='scsi' bus='0' target='0' unit='0'/&gt;
&lt;/source&gt;
&lt;readonly/&gt;
&lt;address type='drive' controller='0' bus='0' target='0' unit='0'/&gt;
&lt;/hostdev&gt;
&lt;/devices&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...</pre>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<dl>
<dt><code>hostdev</code></dt>
<dd>The <code>hostdev</code> element is the main container for describing
domain.rng vs. formatdomain.html#elementsUSB The Relax-NG schema for domains regarding <hostdev> doesn't match what's implemented in src/conf/domain_conf.c#virDomainHostdevDefFormat(): The implementation only requires @type, but the schema currently either required none or all three attributes (@mode, @type, and @managed) to be defined together, because they are declared in the same <optional)-section. (@managed is currently even undocumented on <http://libvirt.org/formatdomain.html#elementsUSB>). Thus the following minimal <hostdev>-example fails to validate: <domain type='test'> <name>N</name> <memory>4096</memory> <bootloader>/bin/false</bootloader> <os> <type arch='x86_64' machine='xenpv'>linux</type> </os> <devices> <hostdev type='pci'> <source> <address bus='0x06' slot='0x00' function='0x0'/> </source> </hostdev> </devices> </domain> The schema is changed to match the current implementation: 1. @mode is optional (which defaults to 'subsystem') 2. @type is required 3. @managed is optional (which defaults to 'no') The documentation is updated to mention @managed. Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-03-01 10:23:20 +00:00
host devices. For usb device passthrough <code>mode</code> is always
conf: Generic XMLs for scsi hostdev An example of the scsi hostdev XML: <hostdev mode='subsystem' type='scsi'> <source> <adapter name='scsi_host0'/> <address bus='0' target='0' unit='0'/> </source> <address type='drive' controller='0' bus='0' target='4' unit='8'/> </hostdev> Controller is implicitly added for scsi hostdev, though the scsi controller's model defaults to "lsilogic", which might be not what the user wants (same problem exists for virtio-scsi disk). It's the existing problem, will be addressed later. The device address must be specified manually. Later patch will let libvirt generate it automatically. This only introduces the generic XMLs for scsi hostdev, later patches will add other elements, e.g. <readonly>, <shareable>. Signed-off-by: Han Cheng <hanc.fnst@cn.fujitsu.com> Signed-off-by: Osier Yang <jyang@redhat.com>
2013-05-03 18:07:20 +00:00
"subsystem" and <code>type</code> is "usb" for a USB device, "pci"
for a PCI device and "scsi" for a SCSI device. When
<code>managed</code> is "yes" for a PCI
domain.rng vs. formatdomain.html#elementsUSB The Relax-NG schema for domains regarding <hostdev> doesn't match what's implemented in src/conf/domain_conf.c#virDomainHostdevDefFormat(): The implementation only requires @type, but the schema currently either required none or all three attributes (@mode, @type, and @managed) to be defined together, because they are declared in the same <optional)-section. (@managed is currently even undocumented on <http://libvirt.org/formatdomain.html#elementsUSB>). Thus the following minimal <hostdev>-example fails to validate: <domain type='test'> <name>N</name> <memory>4096</memory> <bootloader>/bin/false</bootloader> <os> <type arch='x86_64' machine='xenpv'>linux</type> </os> <devices> <hostdev type='pci'> <source> <address bus='0x06' slot='0x00' function='0x0'/> </source> </hostdev> </devices> </domain> The schema is changed to match the current implementation: 1. @mode is optional (which defaults to 'subsystem') 2. @type is required 3. @managed is optional (which defaults to 'no') The documentation is updated to mention @managed. Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-03-01 10:23:20 +00:00
device, it is detached from the host before being passed on to
docs: document managed=yes of hostdev passthrough Clarify some of the effects of managed passthrough <hostdev> devices; with recent changes (commit d093547), a nodedev-reattach is only needed to pair up to an explicit nodedev-dettach (but beware that older virt-manager has a bug where it uses explicit nodedev-dettach under the hood when using the gui to hotplug a hostdev device). * docs/formatdomain.html.in: Mention reattach. * tools/virsh.pod (nodedev): Mention managed mode.
2011-10-14 22:59:16 +00:00
the guest, and reattached to the host after the guest exits.
If <code>managed</code> is omitted or "no", and for USB
devices, the user is responsible to
call <code>virNodeDeviceDettach</code> (or <code>virsh
nodedev-dettach</code>) before starting the guest or
hot-plugging the device,
and <code>virNodeDeviceReAttach</code> (or <code>virsh
nodedev-reattach</code>) after hot-unplug or stopping the
conf: Generic XMLs for scsi hostdev An example of the scsi hostdev XML: <hostdev mode='subsystem' type='scsi'> <source> <adapter name='scsi_host0'/> <address bus='0' target='0' unit='0'/> </source> <address type='drive' controller='0' bus='0' target='4' unit='8'/> </hostdev> Controller is implicitly added for scsi hostdev, though the scsi controller's model defaults to "lsilogic", which might be not what the user wants (same problem exists for virtio-scsi disk). It's the existing problem, will be addressed later. The device address must be specified manually. Later patch will let libvirt generate it automatically. This only introduces the generic XMLs for scsi hostdev, later patches will add other elements, e.g. <readonly>, <shareable>. Signed-off-by: Han Cheng <hanc.fnst@cn.fujitsu.com> Signed-off-by: Osier Yang <jyang@redhat.com>
2013-05-03 18:07:20 +00:00
guest. For SCSI device, user is responsible to make sure the device
conf: Introduce sgio for hostdev "sgio" is only valid for scsi host device.
2013-05-03 18:07:40 +00:00
is not used by host.
The optional <code>sgio</code> (<span class="since">since 1.0.6</span>)
attribute indicates whether the kernel will filter unprivileged
SG_IO commands for the disk, valid settings are "filtered" or
"unfiltered". Defaults to "filtered".
</dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<dt><code>source</code></dt>
<dd>The source element describes the device as seen from the host.
The USB device can either be addressed by vendor / product id using the
<code>vendor</code> and <code>product</code> elements or by the device's
conf: Add support for startupPolicy for USB devices USB devices can disappear without OS being mad about it, which makes them ideal for startupPolicy. With this attribute, USB devices can be configured to be mandatory (the default), requisite (will disappear during migration if they cannot be found), or completely optional.
2012-10-02 13:14:02 +00:00
address on the hosts using the <code>address</code> element. PCI devices
on the other hand can only be described by their <code>address</code>.
conf: Generic XMLs for scsi hostdev An example of the scsi hostdev XML: <hostdev mode='subsystem' type='scsi'> <source> <adapter name='scsi_host0'/> <address bus='0' target='0' unit='0'/> </source> <address type='drive' controller='0' bus='0' target='4' unit='8'/> </hostdev> Controller is implicitly added for scsi hostdev, though the scsi controller's model defaults to "lsilogic", which might be not what the user wants (same problem exists for virtio-scsi disk). It's the existing problem, will be addressed later. The device address must be specified manually. Later patch will let libvirt generate it automatically. This only introduces the generic XMLs for scsi hostdev, later patches will add other elements, e.g. <readonly>, <shareable>. Signed-off-by: Han Cheng <hanc.fnst@cn.fujitsu.com> Signed-off-by: Osier Yang <jyang@redhat.com>
2013-05-03 18:07:20 +00:00
SCSI devices are described by both the <code>adapter</code> and
<code>address</code> elements.
conf: Add support for startupPolicy for USB devices USB devices can disappear without OS being mad about it, which makes them ideal for startupPolicy. With this attribute, USB devices can be configured to be mandatory (the default), requisite (will disappear during migration if they cannot be found), or completely optional.
2012-10-02 13:14:02 +00:00
maint: prepare for next release number Given Daniel's announcement[1], code targetting the next release will be in 1.0.0, not 0.10.3. Changed mechanically with: for f in $(git grep -l '0\(.\)10\13\b') ; do sed -i -e 's/0\(.\)10\13/1\10\10/g' $f done [1]https://www.redhat.com/archives/libvir-list/2012-October/msg00403.html * docs/formatdomain.html.in: Use 1.0.0 for next release. * src/interface/interface_backend_udev.c: Likewise.
2012-10-15 21:17:34 +00:00
<span class="since">Since 1.0.0</span>, the <code>source</code> element
conf: Add support for startupPolicy for USB devices USB devices can disappear without OS being mad about it, which makes them ideal for startupPolicy. With this attribute, USB devices can be configured to be mandatory (the default), requisite (will disappear during migration if they cannot be found), or completely optional.
2012-10-02 13:14:02 +00:00
of USB devices may contain <code>startupPolicy</code> attribute which can
be used to define policy what to do if the specified host USB device is
not found. The attribute accepts the following values:
<table class="top_table">
<tr>
<td> mandatory </td>
<td> fail if missing for any reason (the default) </td>
</tr>
<tr>
<td> requisite </td>
<td> fail if missing on boot up,
drop if missing on migrate/restore/revert </td>
</tr>
<tr>
<td> optional </td>
<td> drop if missing at any start attempt </td>
</tr>
</table>
</dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<dt><code>vendor</code>, <code>product</code></dt>
<dd>The <code>vendor</code> and <code>product</code> elements each have an
<code>id</code> attribute that specifies the USB vendor and product id.
The ids can be given in decimal, hexadecimal (starting with 0x) or
octal (starting with 0) form.</dd>
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
<dt><code>boot</code></dt>
<dd>Specifies that the device is bootable. The <code>order</code>
attribute determines the order in which devices will be tried during
boot sequence. The per-device <code>boot</code> elements cannot be
used together with general boot elements in
<a href="#elementsOSBIOS">BIOS bootloader</a> section.
docs: boot order for host and redirected USB devices
2012-11-21 17:21:09 +00:00
<span class="since">Since 0.8.8</span> for PCI devices,
<span class="since">Since 1.0.1</span> for USB devices.
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
qemu: add ability to set PCI device "rombar" on or off This patch was made in response to: https://bugzilla.redhat.com/show_bug.cgi?id=738095 In short, qemu's default for the rombar setting (which makes the firmware ROM of a PCI device visible/not on the guest) was previously 0 (not visible), but they recently changed the default to 1 (visible). Unfortunately, there are some PCI devices that fail in the guest when rombar is 1, so the setting must be exposed in libvirt to prevent a regression in behavior (it will still require explicitly setting <rom bar='off'/> in the guest XML). rombar is forced on/off by adding: <rom bar='on|off'/> inside a <hostdev> element that defines a PCI device. It is currently ignored for all other types of devices. At the moment there is no clean method to determine whether or not the rombar option is supported by QEMU - this patch uses the advice of a QEMU developer to assume support for qemu-0.12+. There is currently a patch in the works to put this information in the output of "qemu-kvm -device pci-assign,?", but of course if we switch to keying off that, we would lose support for setting rombar on all the versions of qemu between 0.12 and whatever version gets that patch.
2011-09-20 17:31:52 +00:00
<dt><code>rom</code></dt>
<dd>The <code>rom</code> element is used to change how a PCI
qemu: add "romfile" support to specify device boot ROM This patch addresses: https://bugzilla.redhat.com/show_bug.cgi?id=781562 Along with the "rombar" option that controls whether or not a boot rom is made visible to the guest, qemu also has a "romfile" option that allows specifying a binary file to present as the ROM BIOS of any emulated or passthrough PCI device. This patch adds support for specifying romfile to both passthrough PCI devices, and emulated network devices that attach to the guest's PCI bus (just about everything other than ne2k_isa). One example of the usefulness of this option is described in the bugzilla report: 82576 sriov network adapters don't provide a ROM BIOS for the cards virtual functions (VF), but an image of such a ROM is available, and with this ROM visible to the guest, it can PXE boot. In libvirt's xml, the new option is configured like this: <hostdev> ... <rom file='/etc/fake/boot.bin'/> ... </hostdev (similarly for <interface>).
2012-01-25 16:20:49 +00:00
device's ROM is presented to the guest. The optional <code>bar</code>
qemu: add ability to set PCI device "rombar" on or off This patch was made in response to: https://bugzilla.redhat.com/show_bug.cgi?id=738095 In short, qemu's default for the rombar setting (which makes the firmware ROM of a PCI device visible/not on the guest) was previously 0 (not visible), but they recently changed the default to 1 (visible). Unfortunately, there are some PCI devices that fail in the guest when rombar is 1, so the setting must be exposed in libvirt to prevent a regression in behavior (it will still require explicitly setting <rom bar='off'/> in the guest XML). rombar is forced on/off by adding: <rom bar='on|off'/> inside a <hostdev> element that defines a PCI device. It is currently ignored for all other types of devices. At the moment there is no clean method to determine whether or not the rombar option is supported by QEMU - this patch uses the advice of a QEMU developer to assume support for qemu-0.12+. There is currently a patch in the works to put this information in the output of "qemu-kvm -device pci-assign,?", but of course if we switch to keying off that, we would lose support for setting rombar on all the versions of qemu between 0.12 and whatever version gets that patch.
2011-09-20 17:31:52 +00:00
attribute can be set to "on" or "off", and determines whether
or not the device's ROM will be visible in the guest's memory
map. (In PCI documentation, the "rombar" setting controls the
presence of the Base Address Register for the ROM). If no rom
bar is specified, the qemu default will be used (older
versions of qemu used a default of "off", while newer qemus
have a default of "on"). <span class="since">Since
qemu: add "romfile" support to specify device boot ROM This patch addresses: https://bugzilla.redhat.com/show_bug.cgi?id=781562 Along with the "rombar" option that controls whether or not a boot rom is made visible to the guest, qemu also has a "romfile" option that allows specifying a binary file to present as the ROM BIOS of any emulated or passthrough PCI device. This patch adds support for specifying romfile to both passthrough PCI devices, and emulated network devices that attach to the guest's PCI bus (just about everything other than ne2k_isa). One example of the usefulness of this option is described in the bugzilla report: 82576 sriov network adapters don't provide a ROM BIOS for the cards virtual functions (VF), but an image of such a ROM is available, and with this ROM visible to the guest, it can PXE boot. In libvirt's xml, the new option is configured like this: <hostdev> ... <rom file='/etc/fake/boot.bin'/> ... </hostdev (similarly for <interface>).
2012-01-25 16:20:49 +00:00
0.9.7 (QEMU and KVM only)</span>. The optional
<code>file</code> attribute is used to point to a binary file
to be presented to the guest as the device's ROM BIOS. This
can be useful, for example, to provide a PXE boot ROM for a
virtual function of an sr-iov capable ethernet device (which
has no boot ROMs for the VFs).
<span class="since">Since 0.9.10 (QEMU and KVM only)</span>.
qemu: add ability to set PCI device "rombar" on or off This patch was made in response to: https://bugzilla.redhat.com/show_bug.cgi?id=738095 In short, qemu's default for the rombar setting (which makes the firmware ROM of a PCI device visible/not on the guest) was previously 0 (not visible), but they recently changed the default to 1 (visible). Unfortunately, there are some PCI devices that fail in the guest when rombar is 1, so the setting must be exposed in libvirt to prevent a regression in behavior (it will still require explicitly setting <rom bar='off'/> in the guest XML). rombar is forced on/off by adding: <rom bar='on|off'/> inside a <hostdev> element that defines a PCI device. It is currently ignored for all other types of devices. At the moment there is no clean method to determine whether or not the rombar option is supported by QEMU - this patch uses the advice of a QEMU developer to assume support for qemu-0.12+. There is currently a patch in the works to put this information in the output of "qemu-kvm -device pci-assign,?", but of course if we switch to keying off that, we would lose support for setting rombar on all the versions of qemu between 0.12 and whatever version gets that patch.
2011-09-20 17:31:52 +00:00
</dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<dt><code>address</code></dt>
Add tests and docs for the new PCI passthrough format * docs/formatdomain.html.in docs/libvirt.rng docs/formatdomain.html: document the new PCI passthrough format * tests/qemuxml2argvtest.c tests/qemuxml2xmltest.c tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.args tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.xml: and add a regression test for it. Daniel
2009-01-12 15:09:19 +00:00
<dd>The <code>address</code> element for USB devices has a
<code>bus</code> and <code>device</code> attribute to specify the
USB bus and device number the device appears at on the host.
The values of these attributes can be given in decimal, hexadecimal
(starting with 0x) or octal (starting with 0) form.
For PCI devices the element carries 3 attributes allowing to designate
the device as can be found with the <code>lspci</code> or
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
with <code>virsh
nodedev-list</code>. <a href="#elementsAddress">See above</a> for
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/> A domain's <interface> or <hostdev>, as well as a <network>'s <forward>, can now have an optional <driver name='kvm|vfio'/> element. As of this patch, there is no functionality behind this new knob - this patch adds support to the domain and network formatter/parser, and to the RNG and documentation. When the backend is added, legacy KVM PCI device assignment will continue to be used when no driver name is specified (or if <driver name='kvm'/> is specified), but if driver name is 'vfio', the new UEFI Secure Boot compatible VFIO device assignment will be used. Note that the parser doesn't automatically insert the current default value of this setting. This is done on purpose because the two possibilities are functionally equivalent from the guest's point of view, and we want to be able to automatically start using vfio as the default (even for existing domains) at some time in the future. This is similar to what was done with the "vhost" driver option in <interface>.
2013-03-15 19:15:14 +00:00
more details on the address element.</dd>
<dt><code>driver</code></dt>
<dd>
PCI devices can have an optional <code>driver</code>
subelement that specifies which backend driver to use for PCI
device assignment. Use the <code>name</code> attribute to
select either "vfio" (for the new VFIO device assignment
backend, which is compatible with UEFI SecureBoot) or "kvm"
(for the legacy device assignment handled directly by the KVM
kernel module)<span class="since">Since 1.0.5 (QEMU and KVM
only, requires kernel 3.6 or newer)</span>. Currently, "kvm"
is the default used by libvirt when not explicitly provided,
but since the two are functionally equivalent, this default
could be changed in the future with no impact to domains that
don't specify anything.
</dd>
Introduce <readonly> for hostdev Since it's generic enough to be used by other types in future, I put it in <hostdev> as sub-element, though now it's only used by scsi host device.
2013-05-03 18:07:25 +00:00
<dt><code>readonly</code></dt>
<dd>Indicates that the device is readonly, only supported by SCSI host
device now. <span class="since">Since 1.0.6 (QEMU and KVM only)</span>
</dd>
conf: Introduce <shareable> for hostdev Unlike disk device, the scsi-generic always writethrough the data, so no need to introduce a "cache" tag, and set "cache=off".
2013-05-03 18:07:33 +00:00
<dt><code>shareable</code></dt>
<dd>If present, this indicates the device is expected to be shared
between domains (assuming the hypervisor and OS support this).
Only supported by SCSI host device.
<span class="since">Since 1.0.6</span>
</dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
</dl>
Add support for <hostdev mode="capabilities"> The <hostdev> device type has long had a redundant "mode" attribute, which has always been "subsys". This finally introduces a new mode "capabilities", which will be used by the LXC driver for device assignment. Since container based virtualization uses a single kernel, the idea of assigning physical PCI devices doesn't make sense. It is still reasonable to assign USB devices, but for assigning arbitrary nodes in /dev, the new 'capabilities' mode is to be used. The first capability support is 'storage', which is for assignment of block devices. Functionally this is really pretty similar to the <disk> support. The only difference is the device node name is identical in both host and container namespaces. <hostdev mode='capabilities' type='storage'> <source> <block>/dev/sdf1</block> </source> </hostdev> The second capability support is 'misc', which is for assignment of character devices. There is no existing parallel to this. Again the device node is the same inside & outside the container. <hostdev mode='capabilities' type='misc'> <source> <char>/dev/input/event3</char> </source> </hostdev> The reason for keeping the char & storage devices separate in the domain XML, is to mirror the split in the node device XML. NB the node device XML does not yet report character devices, but that's another new patch to come Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-11-23 13:50:29 +00:00
docs: formatdomain: fix links in the table of contents
2013-05-21 08:55:42 +00:00
<h5><a name="elementsHostDevCaps">Block / character devices</a></h5>
Add support for <hostdev mode="capabilities"> The <hostdev> device type has long had a redundant "mode" attribute, which has always been "subsys". This finally introduces a new mode "capabilities", which will be used by the LXC driver for device assignment. Since container based virtualization uses a single kernel, the idea of assigning physical PCI devices doesn't make sense. It is still reasonable to assign USB devices, but for assigning arbitrary nodes in /dev, the new 'capabilities' mode is to be used. The first capability support is 'storage', which is for assignment of block devices. Functionally this is really pretty similar to the <disk> support. The only difference is the device node name is identical in both host and container namespaces. <hostdev mode='capabilities' type='storage'> <source> <block>/dev/sdf1</block> </source> </hostdev> The second capability support is 'misc', which is for assignment of character devices. There is no existing parallel to this. Again the device node is the same inside & outside the container. <hostdev mode='capabilities' type='misc'> <source> <char>/dev/input/event3</char> </source> </hostdev> The reason for keeping the char & storage devices separate in the domain XML, is to mirror the split in the node device XML. NB the node device XML does not yet report character devices, but that's another new patch to come Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-11-23 13:50:29 +00:00
<p>
Block / character devices from the host can be passed through
to the guest using the <code>hostdev</code> element. This is
only possible with container based virtualization.
<span class="since">since after 1.0.1 for LXC</span>:
</p>
<pre>
...
&lt;hostdev mode='capabilities' type='storage'&gt;
&lt;source&gt;
&lt;block&gt;/dev/sdf1&lt;/block&gt;
&lt;/source&gt;
&lt;/hostdev&gt;
...
</pre>
<pre>
...
&lt;hostdev mode='capabilities' type='misc'&gt;
&lt;source&gt;
&lt;char&gt;/dev/input/event3&lt;/char&gt;
&lt;/source&gt;
&lt;/hostdev&gt;
Update structure & XML definitions to support <hostdev caps=net> This updates the definitions and supporting structures in the XML schema and domain configuration files. Signed-off-by: Bogdan Purcareata <bogdan.purcareata@freescale.com>
2013-04-05 12:26:39 +00:00
...
</pre>
docs: Add the missed <pre> tag
2013-04-09 14:29:39 +00:00
<pre>
Update structure & XML definitions to support <hostdev caps=net> This updates the definitions and supporting structures in the XML schema and domain configuration files. Signed-off-by: Bogdan Purcareata <bogdan.purcareata@freescale.com>
2013-04-05 12:26:39 +00:00
...
&lt;hostdev mode='capabilities' type='net'&gt;
&lt;source&gt;
&lt;interface&gt;eth0&lt;/interface&gt;
&lt;/source&gt;
&lt;/hostdev&gt;
Add support for <hostdev mode="capabilities"> The <hostdev> device type has long had a redundant "mode" attribute, which has always been "subsys". This finally introduces a new mode "capabilities", which will be used by the LXC driver for device assignment. Since container based virtualization uses a single kernel, the idea of assigning physical PCI devices doesn't make sense. It is still reasonable to assign USB devices, but for assigning arbitrary nodes in /dev, the new 'capabilities' mode is to be used. The first capability support is 'storage', which is for assignment of block devices. Functionally this is really pretty similar to the <disk> support. The only difference is the device node name is identical in both host and container namespaces. <hostdev mode='capabilities' type='storage'> <source> <block>/dev/sdf1</block> </source> </hostdev> The second capability support is 'misc', which is for assignment of character devices. There is no existing parallel to this. Again the device node is the same inside & outside the container. <hostdev mode='capabilities' type='misc'> <source> <char>/dev/input/event3</char> </source> </hostdev> The reason for keeping the char & storage devices separate in the domain XML, is to mirror the split in the node device XML. NB the node device XML does not yet report character devices, but that's another new patch to come Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-11-23 13:50:29 +00:00
...
</pre>
<dl>
<dt><code>hostdev</code></dt>
<dd>The <code>hostdev</code> element is the main container for describing
host devices. For block/character device passthrough <code>mode</code> is
always "capabilities" and <code>type</code> is "block" for a block
Update structure & XML definitions to support <hostdev caps=net> This updates the definitions and supporting structures in the XML schema and domain configuration files. Signed-off-by: Bogdan Purcareata <bogdan.purcareata@freescale.com>
2013-04-05 12:26:39 +00:00
device, "char" for a character device and "net" for a host network
interface.
Add support for <hostdev mode="capabilities"> The <hostdev> device type has long had a redundant "mode" attribute, which has always been "subsys". This finally introduces a new mode "capabilities", which will be used by the LXC driver for device assignment. Since container based virtualization uses a single kernel, the idea of assigning physical PCI devices doesn't make sense. It is still reasonable to assign USB devices, but for assigning arbitrary nodes in /dev, the new 'capabilities' mode is to be used. The first capability support is 'storage', which is for assignment of block devices. Functionally this is really pretty similar to the <disk> support. The only difference is the device node name is identical in both host and container namespaces. <hostdev mode='capabilities' type='storage'> <source> <block>/dev/sdf1</block> </source> </hostdev> The second capability support is 'misc', which is for assignment of character devices. There is no existing parallel to this. Again the device node is the same inside & outside the container. <hostdev mode='capabilities' type='misc'> <source> <char>/dev/input/event3</char> </source> </hostdev> The reason for keeping the char & storage devices separate in the domain XML, is to mirror the split in the node device XML. NB the node device XML does not yet report character devices, but that's another new patch to come Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-11-23 13:50:29 +00:00
</dd>
<dt><code>source</code></dt>
<dd>The source element describes the device as seen from the host.
For block devices, the path to the block device in the host
OS is provided in the nested "block" element, while for character
Update structure & XML definitions to support <hostdev caps=net> This updates the definitions and supporting structures in the XML schema and domain configuration files. Signed-off-by: Bogdan Purcareata <bogdan.purcareata@freescale.com>
2013-04-05 12:26:39 +00:00
devices the "char" element is used. For network interfaces, the
name of the interface is provided in the "interface" element.
Add support for <hostdev mode="capabilities"> The <hostdev> device type has long had a redundant "mode" attribute, which has always been "subsys". This finally introduces a new mode "capabilities", which will be used by the LXC driver for device assignment. Since container based virtualization uses a single kernel, the idea of assigning physical PCI devices doesn't make sense. It is still reasonable to assign USB devices, but for assigning arbitrary nodes in /dev, the new 'capabilities' mode is to be used. The first capability support is 'storage', which is for assignment of block devices. Functionally this is really pretty similar to the <disk> support. The only difference is the device node name is identical in both host and container namespaces. <hostdev mode='capabilities' type='storage'> <source> <block>/dev/sdf1</block> </source> </hostdev> The second capability support is 'misc', which is for assignment of character devices. There is no existing parallel to this. Again the device node is the same inside & outside the container. <hostdev mode='capabilities' type='misc'> <source> <char>/dev/input/event3</char> </source> </hostdev> The reason for keeping the char & storage devices separate in the domain XML, is to mirror the split in the node device XML. NB the node device XML does not yet report character devices, but that's another new patch to come Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2012-11-23 13:50:29 +00:00
</dd>
</dl>
Add "redirdev" redirection device - create a new "redirdev" element for this purpose
2011-09-02 15:09:14 +00:00
<h4><a name="elementsRedir">Redirected devices</a></h4>
<p>
USB device redirection through a character device is
supported <span class="since">since after 0.9.5 (KVM
only)</span>:
</p>
<pre>
...
&lt;devices&gt;
&lt;redirdev bus='usb' type='tcp'&gt;
&lt;source mode='connect' host='localhost' service='4000'/&gt;
docs: boot order for host and redirected USB devices
2012-11-21 17:21:09 +00:00
&lt;boot order='1'/&gt;
Add "redirdev" redirection device - create a new "redirdev" element for this purpose
2011-09-02 15:09:14 +00:00
&lt;/redirdev&gt;
doc: update usb redirection filter infomation on formatdomain.html
2012-09-13 07:25:48 +00:00
&lt;redirfilter&gt;
&lt;usbdev class='0x08' vendor='0x1234' product='0xbeef' version='2.00' allow='yes'/&gt;
&lt;usbdev allow='no'/&gt;
&lt;/redirfilter&gt;
Add "redirdev" redirection device - create a new "redirdev" element for this purpose
2011-09-02 15:09:14 +00:00
&lt;/devices&gt;
...</pre>
<dl>
<dt><code>redirdev</code></dt>
<dd>The <code>redirdev</code> element is the main container for
describing redirected devices. <code>bus</code> must be "usb"
for a USB device.
An additional attribute <code>type</code> is required,
matching one of the
supported <a href="#elementsConsole">serial device</a> types,
to describe the host side of the
tunnel; <code>type='tcp'</code>
or <code>type='spicevmc'</code> (which uses the usbredir
channel of a <a href="#elementsGraphics">SPICE graphics
docs: Fix a few spaces Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
2012-11-21 17:22:37 +00:00
device</a>) are typical. The redirdev element has an optional
sub-element <code>&lt;address&gt;</code> which can tie the
doc: update usb redirection filter infomation on formatdomain.html
2012-09-13 07:25:48 +00:00
device to a particular controller. Further sub-elements,
such as <code>&lt;source&gt;</code>, may be required according
to the given type, although a <code>&lt;target&gt;</code> sub-element
is not required (since the consumer of the character device is
docs: boot order for host and redirected USB devices
2012-11-21 17:21:09 +00:00
the hypervisor itself, rather than a device visible in the guest).
</dd>
<dt><code>boot</code></dt>
<dd>Specifies that the device is bootable.
The <code>order</code> attribute determines the order in which
devices will be tried during boot sequence. The per-device
<code>boot</code> elements cannot be used together with general
boot elements in <a href="#elementsOSBIOS">BIOS bootloader</a> section.
(<span class="since">Since 1.0.1</span>)
doc: update usb redirection filter infomation on formatdomain.html
2012-09-13 07:25:48 +00:00
</dd>
<dt><code>redirfilter</code></dt>
<dd>The<code> redirfilter </code>element is used for creating the
filter rule to filter out certain devices from redirection.
docs: Fix a few spaces Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
2012-11-21 17:22:37 +00:00
It uses sub-element <code>&lt;usbdev&gt;</code> to define each filter rule.
<code>class</code> attribute is the USB Class code, for example,
doc: update usb redirection filter infomation on formatdomain.html
2012-09-13 07:25:48 +00:00
0x08 represents mass storage devices. The USB device can be addressed by
docs: Fix a few spaces Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
2012-11-21 17:22:37 +00:00
vendor / product id using the <code>vendor</code> and <code>product</code> attributes.
doc: update usb redirection filter infomation on formatdomain.html
2012-09-13 07:25:48 +00:00
<code>version</code> is the bcdDevice value of USB device, such as 1.00, 1.10 and 2.00.
These four attributes are optional and <code>-1</code> can be used to allow
docs: Fix a few spaces Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
2012-11-21 17:22:37 +00:00
any value for them. <code>allow</code> attribute is mandatory,
doc: update usb redirection filter infomation on formatdomain.html
2012-09-13 07:25:48 +00:00
'yes' means allow, 'no' for deny.
</dd>
Add "redirdev" redirection device - create a new "redirdev" element for this purpose
2011-09-02 15:09:14 +00:00
</dl>
smartcard: add XML support for <smartcard> device Assuming a hypervisor that supports multiple smartcard devices in the guest, this would be a valid XML description: <devices> <smartcard mode='host'/> <smartcard mode='host-certificates'> <certificate>/path/to/cert1</certificate> <certificate>/path/to/cert2</certificate> <certificate>/path/to/cert3</certificate> </smartcard> <smartcard mode='passthrough' type='tcp'> <source mode='bind' host='127.0.0.1' service='2001'/> <protocol type='raw'/> </smartcard> </devices> (As of this commit, the qemu hypervisor will be the first implementation, but it only supports one smartcard.) * docs/formatdomain.html.in (Smartcard devices): New section. * docs/schemas/domain.rng (smartcard): New define, used in devices. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host.xml: New file to test schema. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host-certificates.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-tcp.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-controller.xml: Likewise.
2011-01-06 01:02:20 +00:00
<h4><a name="elementsSmartcard">Smartcard devices</a></h4>
<p>
A virtual smartcard device can be supplied to the guest via the
<code>smartcard</code> element. A USB smartcard reader device on
the host cannot be used on a guest with simple device
passthrough, since it will then not be available on the host,
possibly locking the host computer when it is "removed".
Therefore, some hypervisors provide a specialized virtual device
that can present a smartcard interface to the guest, with
several modes for describing how credentials are obtained from
the host or even a from a channel created to a third-party
smartcard provider. <span class="since">Since 0.8.8</span>
</p>
<pre>
...
&lt;devices&gt;
&lt;smartcard mode='host'/&gt;
&lt;smartcard mode='host-certificates'&gt;
&lt;certificate&gt;cert1&lt;/certificate&gt;
&lt;certificate&gt;cert2&lt;/certificate&gt;
&lt;certificate&gt;cert3&lt;/certificate&gt;
&lt;database&gt;/etc/pki/nssdb/&lt;/database&gt;
&lt;/smartcard&gt;
&lt;smartcard mode='passthrough' type='tcp'&gt;
&lt;source mode='bind' host='127.0.0.1' service='2001'/&gt;
&lt;protocol type='raw'/&gt;
&lt;address type='ccid' controller='0' slot='0'/&gt;
&lt;/smartcard&gt;
smartcard: add spicevmc support Adds <smartcard mode='passthrough' type='spicevmc'/>, which uses the new <channel name='smartcard'/> of <graphics type='spice'>. * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainGraphicsSpiceChannelName): New enum value. (virDomainChrSpicevmcName): New enum. (virDomainChrSourceDef): Distinguish spicevmc types. * src/conf/domain_conf.c (virDomainGraphicsSpiceChannelName): Add smartcard. (virDomainSmartcardDefParseXML): Parse it. (virDomainChrDefParseXML, virDomainSmartcardDefParseXML): Set spicevmc name. (virDomainChrSpicevmc): New enum conversion functions. * src/libvirt_private.syms: Export new functions. * src/qemu/qemu_command.c (qemuBuildChrChardevStr): Conditionalize name. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.args: New file. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.xml: Likewise.
2011-02-04 02:23:31 +00:00
&lt;smartcard mode='passthrough' type='spicevmc'/&gt;
smartcard: add XML support for <smartcard> device Assuming a hypervisor that supports multiple smartcard devices in the guest, this would be a valid XML description: <devices> <smartcard mode='host'/> <smartcard mode='host-certificates'> <certificate>/path/to/cert1</certificate> <certificate>/path/to/cert2</certificate> <certificate>/path/to/cert3</certificate> </smartcard> <smartcard mode='passthrough' type='tcp'> <source mode='bind' host='127.0.0.1' service='2001'/> <protocol type='raw'/> </smartcard> </devices> (As of this commit, the qemu hypervisor will be the first implementation, but it only supports one smartcard.) * docs/formatdomain.html.in (Smartcard devices): New section. * docs/schemas/domain.rng (smartcard): New define, used in devices. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host.xml: New file to test schema. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host-certificates.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-tcp.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-controller.xml: Likewise.
2011-01-06 01:02:20 +00:00
&lt;/devices&gt;
...
</pre>
<p>
The <code>&lt;smartcard&gt;</code> element has a mandatory
attribute <code>mode</code>. The following modes are supported;
in each mode, the guest sees a device on its USB bus that
behaves like a physical USB CCID (Chip/Smart Card Interface
Device) card.
</p>
<dl>
<dt><code>mode='host'</code></dt>
<dd>The simplest operation, where the hypervisor relays all
requests from the guest into direct access to the host's
smartcard via NSS. No other attributes or sub-elements are
required. See below about the use of an
optional <code>&lt;address&gt;</code> sub-element.</dd>
<dt><code>mode='host-certificates'</code></dt>
<dd>Rather than requiring a smartcard to be plugged into the
host, it is possible to provide three NSS certificate names
residing in a database on the host. These certificates can be
generated via the command <code>certutil -d /etc/pki/nssdb -x -t
CT,CT,CT -S -s CN=cert1 -n cert1</code>, and the resulting three
certificate names must be supplied as the content of each of
three <code>&lt;certificate&gt;</code> sub-elements. An
additional sub-element <code>&lt;database&gt;</code> can specify
the absolute path to an alternate directory (matching
the <code>-d</code> option of the <code>certutil</code> command
when creating the certificates); if not present, it defaults to
/etc/pki/nssdb.</dd>
<dt><code>mode='passthrough'</code></dt>
<dd>Rather than having the hypervisor directly communicate with
the host, it is possible to tunnel all requests through a
secondary character device to a third-party provider (which may
in turn be talking to a smartcard or using three certificate
files). In this mode of operation, an additional
attribute <code>type</code> is required, matching one of the
supported <a href="#elementsConsole">serial device</a> types, to
smartcard: add spicevmc support Adds <smartcard mode='passthrough' type='spicevmc'/>, which uses the new <channel name='smartcard'/> of <graphics type='spice'>. * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainGraphicsSpiceChannelName): New enum value. (virDomainChrSpicevmcName): New enum. (virDomainChrSourceDef): Distinguish spicevmc types. * src/conf/domain_conf.c (virDomainGraphicsSpiceChannelName): Add smartcard. (virDomainSmartcardDefParseXML): Parse it. (virDomainChrDefParseXML, virDomainSmartcardDefParseXML): Set spicevmc name. (virDomainChrSpicevmc): New enum conversion functions. * src/libvirt_private.syms: Export new functions. * src/qemu/qemu_command.c (qemuBuildChrChardevStr): Conditionalize name. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.args: New file. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.xml: Likewise.
2011-02-04 02:23:31 +00:00
describe the host side of the tunnel; <code>type='tcp'</code>
or <code>type='spicevmc'</code> (which uses the smartcard
channel of a <a href="#elementsGraphics">SPICE graphics
device</a>) are typical. Further sub-elements, such
as <code>&lt;source&gt;</code>, may be required according to the
smartcard: add XML support for <smartcard> device Assuming a hypervisor that supports multiple smartcard devices in the guest, this would be a valid XML description: <devices> <smartcard mode='host'/> <smartcard mode='host-certificates'> <certificate>/path/to/cert1</certificate> <certificate>/path/to/cert2</certificate> <certificate>/path/to/cert3</certificate> </smartcard> <smartcard mode='passthrough' type='tcp'> <source mode='bind' host='127.0.0.1' service='2001'/> <protocol type='raw'/> </smartcard> </devices> (As of this commit, the qemu hypervisor will be the first implementation, but it only supports one smartcard.) * docs/formatdomain.html.in (Smartcard devices): New section. * docs/schemas/domain.rng (smartcard): New define, used in devices. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host.xml: New file to test schema. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host-certificates.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-tcp.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-controller.xml: Likewise.
2011-01-06 01:02:20 +00:00
given type, although a <code>&lt;target&gt;</code> sub-element
is not required (since the consumer of the character device is
the hypervisor itself, rather than a device visible in the
guest).</dd>
</dl>
<p>
Each mode supports an optional
sub-element <code>&lt;address&gt;</code>, which fine-tunes the
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
correlation between the smartcard and a ccid bus
controller, <a href="#elementsAddress">documented above</a>.
For now, qemu only supports at most one
smartcard: add XML support for <smartcard> device Assuming a hypervisor that supports multiple smartcard devices in the guest, this would be a valid XML description: <devices> <smartcard mode='host'/> <smartcard mode='host-certificates'> <certificate>/path/to/cert1</certificate> <certificate>/path/to/cert2</certificate> <certificate>/path/to/cert3</certificate> </smartcard> <smartcard mode='passthrough' type='tcp'> <source mode='bind' host='127.0.0.1' service='2001'/> <protocol type='raw'/> </smartcard> </devices> (As of this commit, the qemu hypervisor will be the first implementation, but it only supports one smartcard.) * docs/formatdomain.html.in (Smartcard devices): New section. * docs/schemas/domain.rng (smartcard): New define, used in devices. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host.xml: New file to test schema. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host-certificates.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-tcp.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-controller.xml: Likewise.
2011-01-06 01:02:20 +00:00
smartcard, with an address of bus=0 slot=0.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h4><a name="elementsNICS">Network interfaces</a></h4>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='bridge'&gt;
&lt;source bridge='xenbr0'/&gt;
&lt;mac address='00:16:3e:5d:c7:9e'/&gt;
&lt;script path='vif-bridge'/&gt;
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
&lt;boot order='1'/&gt;
qemu: (and conf) support rombar for network devices When support for the rombar option was added, it was only added for PCI passthrough devices, configured with <hostdev>. The same option is available for any network device that is attached to the guest's PCI bus. This patch allows setting rombar for any PCI network device type. After adding cases to test this to qemuxml2argv-hostdev-pci-rombar.*, I decided to rename those files (to qemuxml2argv-pci-rom.*) to more accurately reflect the additional tests, and also noticed that up to now we've only been performing a domainschematest for that case, so I added the "pci-rom" test to both qemuxml2argv and qemuxml2xml (and in the process found some bugs whose fixes I squashed into previous commits of this series).
2012-01-25 00:54:12 +00:00
&lt;rom bar='off'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<p>
There are several possibilities for specifying a network
interface visible to the guest. Each subsection below provides
more details about common setup options. Additionally,
each <code>&lt;interface&gt;</code> element has an
optional <code>&lt;address&gt;</code> sub-element that can tie
the interface to a particular pci slot, with
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
attribute <code>type='pci'</code>
as <a href="#elementsAddress">documented above</a>.
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h5><a name="elementsNICSVirtual">Virtual network</a></h5>
<p>
<strong><em>
This is the recommended config for general guest connectivity on
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
hosts with dynamic / wireless networking configs (or multi-host
environments where the host hardware details are described
separately in a <code>&lt;network&gt;</code>
definition <span class="since">Since 0.9.4</span>).
Update domain XML docs
2008-05-08 14:20:07 +00:00
</em></strong>
</p>
<p>
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
Provides a connection whose details are described by the named
network definition. Depending on the virtual network's "forward
mode" configuration, the network may be totally isolated
(no <code>&lt;forward&gt;</code> element given), NAT'ing to an
explicit network device or to the default route
(<code>&lt;forward mode='nat'&gt;</code>), routed with no NAT
(<code>&lt;forward mode='route'/&gt;</code>), or connected
directly to one of the host's network interfaces (via macvtap)
or bridge devices ((<code>&lt;forward
mode='bridge|private|vepa|passthrough'/&gt;</code> <span class="since">Since
0.9.4</span>)
</p>
<p>
For networks with a forward mode of bridge, private, vepa, and
passthrough, it is assumed that the host has any necessary DNS
and DHCP services already setup outside the scope of libvirt. In
the case of isolated, nat, and routed networks, DHCP and DNS are
provided on the virtual network by libvirt, and the IP range can
be determined by examining the virtual network config with
'<code>virsh net-dumpxml [networkname]</code>'. There is one
virtual network called 'default' setup out of the box which does
NAT'ing to the default route and has an IP range
of <code>192.168.122.0/255.255.255.0</code>. Each guest will
have an associated tun device created with a name of vnetN,
which can also be overridden with the &lt;target&gt; element
(see
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
<a href="#elementsNICSTargetOverride">overriding the target element</a>).
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
<p>
When the source of an interface is a network,
a <code>portgroup</code> can be specified along with the name of
the network; one network may have multiple portgroups defined,
with each portgroup containing slightly different configuration
information for different classes of network
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
connections. <span class="since">Since 0.9.4</span>.
</p>
<p>
Also, similar to <code>direct</code> network connections
(described below), a connection of type <code>network</code> may
specify a <code>virtualport</code> element, with configuration
data to be forwarded to a vepa (802.1Qbg) or 802.1Qbh compliant
switch (<span class="since">Since 0.8.2</span>), or to an
Open vSwitch virtual switch (<span class="since">Since
0.9.11</span>).
</p>
<p>
Since the actual type of switch may vary depending on the
configuration in the <code>&lt;network&gt;</code> on the host,
it is acceptable to omit the virtualport <code>type</code>
attribute, and specify attributes from multiple different
virtualport types (and also to leave out certain attributes); at
domain startup time, a complete <code>&lt;virtualport&gt;</code>
element will be constructed by merging together the type and
network: fix typos and docs
2013-01-03 07:13:04 +00:00
attributes defined in the network and the portgroup referenced
by the interface. The newly-constructed virtualport is a combination
of them. The attributes from lower virtualport can't make change
on the ones defined in higher virtualport.
Interface takes the highest priority, portgroup is lowest priority.
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
(<span class="since">Since 0.10.0</span>). For example, in order
to work properly with both an 802.1Qbh switch and an Open vSwitch
switch, you may choose to specify no type, but both
network: fix typos and docs
2013-01-03 07:13:04 +00:00
an <code>profileid</code> (in case the switch is 802.1Qbh) and
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
an <code>interfaceid</code> (in case the switch is Open vSwitch)
(you may also omit the other attributes, such as managerid,
typeid, or profileid, to be filled in from the
network's <code>&lt;virtualport&gt;</code>). If you want to
limit a guest to connecting only to certain types of switches,
you can specify the virtualport type, but still omit some/all of
the parameters - in this case if the host's network has a
different type of virtualport, connection of the interface will
fail.
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;/interface&gt;
...
&lt;interface type='network'&gt;
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
&lt;source network='default' portgroup='engineering'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;target dev='vnet7'/&gt;
Avoid using multicast addresses for Ethernet MAC examples * docs/formatdomain.html.in: use '00:11:22:33:44:55' instead of '11:22:33:44:55:66'
2010-04-09 12:38:12 +00:00
&lt;mac address="00:11:22:33:44:55"/&gt;
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
&lt;virtualport&gt;
&lt;parameters instanceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
&lt;/virtualport&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Fix a number of small typos
2009-09-22 10:54:57 +00:00
<h5><a name="elementsNICSBridge">Bridge to LAN</a></h5>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
<strong><em>
This is the recommended config for general guest connectivity on
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
hosts with static wired networking configs.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</em></strong>
</p>
<p>
docs: fix usage of 'onto' http://www.uhv.edu/ac/newsletters/writing/grammartip2009.07.01.htm (and several other sites) give hints that 'onto' is best used if you can also add 'up' just before it and still make sense. In many cases in the code base, we really want the two-word form, or even a simplification to just 'on' or 'to'. * docs/hacking.html.in: Use correct 'on to'. * python/libvirt-override.c: Likewise. * src/lxc/lxc_controller.c: Likewise. * src/util/virpci.c: Likewise. * daemon/THREADS.txt: Use simpler 'on'. * docs/formatdomain.html.in: Better usage. * docs/internals/rpc.html.in: Likewise. * src/conf/domain_event.c: Likewise. * src/rpc/virnetclient.c: Likewise. * tests/qemumonitortestutils.c: Likewise. * HACKING: Regenerate. Signed-off-by: Eric Blake <eblake@redhat.com>
2013-04-19 20:18:14 +00:00
Provides a bridge from the VM directly to the LAN. This assumes
Update domain XML docs
2008-05-08 14:20:07 +00:00
there is a bridge device on the host which has one or more of the hosts
physical NICs enslaved. The guest VM will have an associated tun device
created with a name of vnetN, which can also be overridden with the
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
&lt;target&gt; element (see
<a href="#elementsNICSTargetOverride">overriding the target element</a>).
The tun device will be enslaved to the bridge. The IP range / network
configuration is whatever is used on the LAN. This provides the guest VM
full incoming &amp; outgoing net access just like a physical machine.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
<p>
On Linux systems, the bridge device is normally a standard Linux
host bridge. On hosts that support Open vSwitch, it is also
possible to connect to an open vSwitch bridge device by adding
a <code>&lt;virtualport type='openvswitch'/&gt;</code> to the
interface definition. (<span class="since">Since
0.9.11</span>). The Open vSwitch type virtualport accepts two
parameters in its <code>&lt;parameters&gt;</code> element -
an <code>interfaceid</code> which is a standard uuid used to
uniquely identify this particular interface to Open vSwitch (if
you do no specify one, a random interfaceid will be generated
for you when you first define the interface), and an
optional <code>profileid</code> which is sent to Open vSwitch as
the interfaces "port-profile".
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
...
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;interface type='bridge'&gt;
&lt;source bridge='br0'/&gt;
&lt;/interface&gt;
&lt;interface type='bridge'&gt;
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
&lt;source bridge='br1'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;target dev='vnet7'/&gt;
Avoid using multicast addresses for Ethernet MAC examples * docs/formatdomain.html.in: use '00:11:22:33:44:55' instead of '11:22:33:44:55:66'
2010-04-09 12:38:12 +00:00
&lt;mac address="00:11:22:33:44:55"/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
&lt;interface type='bridge'&gt;
&lt;source bridge='ovsbr'/&gt;
docs: fix some typos in examples As detected in https://bugzilla.redhat.com/show_bug.cgi?id=887187 * docs/formatdomain.html.in: Fix XML typos.
2012-12-14 15:28:57 +00:00
&lt;virtualport type='openvswitch'&gt;
network: merge relevant virtualports rather than choosing one One of the original ideas behind allowing a <virtualport> in an interface definition as well as in the <network> definition *and*one or more <portgroup>s within the network, was that guest-specific parameteres (like instanceid and interfaceid) could be given in the interface's virtualport, and more general things (portid, managerid, etc) could be given in the network and/or portgroup, with all the bits brought together at guest startup time and combined into a single virtualport to be used by the guest. This was somehow overlooked in the implementation, though - it simply picks the "most specific" virtualport, and uses the entire thing, with no attempt to merge in details from the others. This patch uses virNetDevVPortProfileMerge3() to combine the three possible virtualports into one, then uses virNetDevVPortProfileCheck*() to verify that the resulting virtualport type is appropriate for the type of network, and that all the required attributes for that type are present. An example of usage is this: assuming a <network> definitions on host ABC of: <network> <name>testA</name> ... <virtualport type='openvswitch'/> ... <portgroup name='engineering'> <virtualport> <parameters profileid='eng'/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters profileid='sales'/> </virtualport> </portgroup> </network> and the same <network> on host DEF of: <network> <name>testA</name> ... <virtualport type='802.1Qbg'> <parameters typeid="1193047" typeidversion="2"/> </virtualport> ... <portgroup name='engineering'> <virtualport> <parameters managerid="11"/> </virtualport> </portgroup> <portgroup name='sales'> <virtualport> <parameters managerid="55"/> </virtualport> </portgroup> </network> and a guest <interface> definition of: <interface type='network'> <source network='testA' portgroup='sales'/> <virtualport> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\> </virtualport> ... </interface> If the guest was started on host ABC, the <virtualport> used would be: <virtualport type='openvswitch'> <parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f' profileid='sales'/> </virtualport> but if that guest was started on host DEF, the <virtualport> would be: <virtualport type='802.1Qbg'> <parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f" typeid="1193047" typeidversion="2" managerid="55"/> </virtualport> Additionally, if none of the involved <virtualport>s had a specified type (this includes cases where no virtualport is given at all),
2012-08-02 18:10:00 +00:00
&lt;parameters profileid='menial' interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
&lt;/virtualport&gt;
&lt;/interface&gt;
...
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h5><a name="elementsNICSSlirp">Userspace SLIRP stack</a></h5>
<p>
Provides a virtual LAN with NAT to the outside world. The virtual
network has DHCP &amp; DNS services and will give the guest VM addresses
starting from <code>10.0.2.15</code>. The default router will be
<code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
This networking is the only option for unprivileged users who need their
VMs to have outgoing access.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='user'/&gt;
...
&lt;interface type='user'&gt;
Avoid using multicast addresses for Ethernet MAC examples * docs/formatdomain.html.in: use '00:11:22:33:44:55' instead of '11:22:33:44:55:66'
2010-04-09 12:38:12 +00:00
&lt;mac address="00:11:22:33:44:55"/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h5><a name="elementsNICSEthernet">Generic ethernet connection</a></h5>
<p>
Provides a means for the administrator to execute an arbitrary script
to connect the guest's network to the LAN. The guest will have a tun
device created with a name of vnetN, which can also be overridden with the
&lt;target&gt; element. After creating the tun device a shell script will
be run which is expected to do whatever host network integration is
required. By default this script is called /etc/qemu-ifup but can be
overridden.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='ethernet'/&gt;
...
&lt;interface type='ethernet'&gt;
&lt;target dev='vnet7'/&gt;
&lt;script path='/etc/qemu-ifup-mynet'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
<h5><a name="elementsNICSDirect">Direct attachment to physical interface</a></h5>
<p>
Provides direct attachment of the virtual machine's NIC to the given
Fix minor typos in messages and docs Signed-off-by: Eric Blake <eblake@redhat.com>
2013-07-30 08:21:11 +00:00
physical interface of the host.
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
<span class="since">Since 0.7.7 (QEMU and KVM only)</span><br/>
Mention direct device support since 0.7.7 in docs In the documentation mention that the direct device support is there since libvirt 0.7.7. A Linux kernel 2.6.34 is required for macvtap to be available as standard device.
2010-03-26 15:53:32 +00:00
This setup requires the Linux macvtap
driver to be available. <span class="since">(Since Linux 2.6.34.)</span>
One of the modes 'vepa'
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
( <a href="http://www.ieee802.org/1/files/public/docs2009/new-evb-congdon-vepa-modular-0709-v01.pdf">
docs: correct range of default NAT subnet * docs/formatdomain.html.in: Fix typo.
2011-03-08 23:15:47 +00:00
'Virtual Ethernet Port Aggregator'</a>), 'bridge' or 'private'
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
can be chosen for the operation mode of the macvtap device, 'vepa'
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
being the default mode. The individual modes cause the delivery of
packets to behave as follows:
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
</p>
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
<dl>
<dt><code>vepa</code></dt>
<dd>All VMs' packets are sent to the external bridge. Packets
whose destination is a VM on the same host as where the
packet originates from are sent back to the host by the VEPA
capable bridge (today's bridges are typically not VEPA capable).</dd>
<dt><code>bridge</code></dt>
<dd>Packets whose destination is on the same host as where they
originate from are directly delivered to the target macvtap device.
Both origin and destination devices need to be in bridge mode
for direct delivery. If either one of them is in <code>vepa</code> mode,
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
a VEPA capable bridge is required.</dd>
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
<dt><code>private</code></dt>
<dd>All packets are sent to the external bridge and will only be
delivered to a target VM on the same host if they are sent through an
external router or gateway and that device sends them back to the
host. This procedure is followed if either the source or destination
device is in <code>private</code> mode.</dd>
Add support for 'passthru' mode for direct network interfaces starting with kernel 2.6.38 macvtap supports a 'passthru' mode for attaching virtual functions of a SRIOV capable network card directly to a VM. This patch adds the capability to configure such a device. Signed-off-by: Dirk Herrendoerfer <d.herrendoerfer@herrendoerfer.name>
2011-05-17 11:26:09 +00:00
<dt><code>passthrough</code></dt>
<dd>This feature attaches a virtual function of a SRIOV capable
NIC directly to a VM without losing the migration capability.
All packets are sent to the VF/IF of the configured network device.
Depending on the capabilities of the device additional prerequisites or
limitations may apply; for example, on Linux this requires
kernel 2.6.38 or newer. <span class="since">Since 0.9.2</span></dd>
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
</dl>
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
<pre>
...
&lt;devices&gt;
...
&lt;interface type='direct'&gt;
&lt;source dev='eth0' mode='vepa'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
<p>
The network access of direct attached virtual machines can be
managed by the hardware switch to which the physical interface
of the host machine is connected to.
docs: fix missing </p> * docs/formatdomain.html.in: Fix typo in last patch. Reported by Matthias Bolte.
2011-03-11 17:08:24 +00:00
</p>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
<p>
The interface can have additional parameters as shown below,
if the switch is conforming to the IEEE 802.1Qbg standard.
The parameters of the virtualport element are documented in more detail
in the IEEE 802.1Qbg standard. The values are network specific and
should be provided by the network administrator. In 802.1Qbg terms,
the Virtual Station Interface (VSI) represents the virtual interface
documenting the 802.1Qbh parameters of a 'direct' interface This patch adds documentation about the 802.1Qbh related parameters of the virtualport element for 'direct' interfaces. Signed-off-by: David S. Wang <dwang2@cisco.com> Signed-off-by: Roopa Prabhu <roprabhu@cisco.com> Signed-off-by: Christian Benvenuti <benve@cisco.com> Signed-off-by: Vasanthy Kolluri <vkolluri@cisco.com>
2011-06-23 16:35:30 +00:00
of a virtual machine. <span class="since">Since 0.8.2</span>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
</p>
fix missing VLAN id for Qbg example For IEEE 802.1Qbg, it is necessary to use a VLAN interface. vepa itself does not require a VLAN interface. Signed-off-by: Gerhard Stenzel <stenzel at de.ibm.com>
2011-05-02 14:49:03 +00:00
<p>
Please note that IEEE 802.1Qbg requires a non-zero value for the
VLAN ID.
</p>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
<dl>
<dt><code>managerid</code></dt>
<dd>The VSI Manager ID identifies the database containing the VSI type
and instance definitions. This is an integer value and the
value 0 is reserved.</dd>
<dt><code>typeid</code></dt>
<dd>The VSI Type ID identifies a VSI type characterizing the network
access. VSI types are typically managed by network administrator.
This is an integer value.
</dd>
<dt><code>typeidversion</code></dt>
<dd>The VSI Type Version allows multiple versions of a VSI Type.
This is an integer value.
</dd>
<dt><code>instanceid</code></dt>
<dd>The VSI Instance ID Identifier is generated when a VSI instance
(i.e. a virtual interface of a virtual machine) is created.
This is a globally unique identifier.
</dd>
</dl>
<pre>
...
&lt;devices&gt;
...
&lt;interface type='direct'&gt;
fix missing VLAN id for Qbg example For IEEE 802.1Qbg, it is necessary to use a VLAN interface. vepa itself does not require a VLAN interface. Signed-off-by: Gerhard Stenzel <stenzel at de.ibm.com>
2011-05-02 14:49:03 +00:00
&lt;source dev='eth0.2' mode='vepa'/&gt;
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
&lt;virtualport type="802.1Qbg"&gt;
&lt;parameters managerid="11" typeid="1193047" typeidversion="2" instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"/&gt;
&lt;/virtualport&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
documenting the 802.1Qbh parameters of a 'direct' interface This patch adds documentation about the 802.1Qbh related parameters of the virtualport element for 'direct' interfaces. Signed-off-by: David S. Wang <dwang2@cisco.com> Signed-off-by: Roopa Prabhu <roprabhu@cisco.com> Signed-off-by: Christian Benvenuti <benve@cisco.com> Signed-off-by: Vasanthy Kolluri <vkolluri@cisco.com>
2011-06-23 16:35:30 +00:00
<p>
The interface can have additional parameters as shown below
if the switch is conforming to the IEEE 802.1Qbh standard.
The values are network specific and should be provided by the
network administrator. <span class="since">Since 0.8.2</span>
</p>
<dl>
<dt><code>profileid</code></dt>
<dd>The profile ID contains the name of the port profile that is to
docs: fix usage of 'onto' http://www.uhv.edu/ac/newsletters/writing/grammartip2009.07.01.htm (and several other sites) give hints that 'onto' is best used if you can also add 'up' just before it and still make sense. In many cases in the code base, we really want the two-word form, or even a simplification to just 'on' or 'to'. * docs/hacking.html.in: Use correct 'on to'. * python/libvirt-override.c: Likewise. * src/lxc/lxc_controller.c: Likewise. * src/util/virpci.c: Likewise. * daemon/THREADS.txt: Use simpler 'on'. * docs/formatdomain.html.in: Better usage. * docs/internals/rpc.html.in: Likewise. * src/conf/domain_event.c: Likewise. * src/rpc/virnetclient.c: Likewise. * tests/qemumonitortestutils.c: Likewise. * HACKING: Regenerate. Signed-off-by: Eric Blake <eblake@redhat.com>
2013-04-19 20:18:14 +00:00
be applied to this interface. This name is resolved by the port
documenting the 802.1Qbh parameters of a 'direct' interface This patch adds documentation about the 802.1Qbh related parameters of the virtualport element for 'direct' interfaces. Signed-off-by: David S. Wang <dwang2@cisco.com> Signed-off-by: Roopa Prabhu <roprabhu@cisco.com> Signed-off-by: Christian Benvenuti <benve@cisco.com> Signed-off-by: Vasanthy Kolluri <vkolluri@cisco.com>
2011-06-23 16:35:30 +00:00
profile database into the network parameters from the port profile,
and those network parameters will be applied to this interface.
</dd>
</dl>
<pre>
...
&lt;devices&gt;
...
&lt;interface type='direct'&gt;
&lt;source dev='eth0' mode='private'/&gt;
&lt;virtualport type='802.1Qbh'&gt;
&lt;parameters profileid='finance'/&gt;
&lt;/virtualport&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...
</pre>
conf: parse/format type='hostdev' network interfaces This is the new interface type that sets up an SR-IOV PCI network device to be assigned to the guest with PCI passthrough after initializing some network device-specific things from the config (e.g. MAC address, virtualport profile parameters). Here is an example of the syntax: <interface type='hostdev' managed='yes'> <source> <address type='pci' domain='0' bus='0' slot='4' function='3'/> </source> <mac address='00:11:22:33:44:55'/> <address type='pci' domain='0' bus='0' slot='7' function='0'/> </interface> This would assign the PCI card from bus 0 slot 4 function 3 on the host, to bus 0 slot 7 function 0 on the guest, but would first set the MAC address of the card to 00:11:22:33:44:55. NB: The parser and formatter don't care if the PCI card being specified is a standard single function network adapter, or a virtual function (VF) of an SR-IOV capable network adapter, but the upcoming code that implements the back end of this config will work *only* with SR-IOV VFs. This is because modifying the mac address of a standard network adapter prior to assigning it to a guest is pointless - part of the device reset that occurs during that process will reset the MAC address to the value programmed into the card's firmware. Although it's not supported by any of libvirt's hypervisor drivers, usb network hostdevs are also supported in the parser and formatter for completeness and consistency. <source> syntax is identical to that for plain <hostdev> devices, except that the <address> element should have "type='usb'" added if bus/device are specified: <interface type='hostdev'> <source> <address type='usb' bus='0' device='4'/> </source> <mac address='00:11:22:33:44:55'/> </interface> If the vendor/product form of usb specification is used, type='usb' is implied: <interface type='hostdev'> <source> <vendor id='0x0012'/> <product id='0x24dd'/> </source> <mac address='00:11:22:33:44:55'/> </interface> Again, the upcoming patch to fill in the backend of this functionality will log an error and fail with "Unsupported Config" if you actually try to assign a USB network adapter to a guest using <interface type='hostdev'> - just use a standard <hostdev> entry in that case (and also for single-port PCI adapters).
2012-02-15 17:37:15 +00:00
<h5><a name="elementsNICSHostdev">PCI Passthrough</a></h5>
<p>
A PCI network device (specified by the &lt;source&gt; element)
is directly assigned to the guest using generic device
passthrough, after first optionally setting the device's MAC
address to the configured value, and associating the device with
docs: small typo in formatdomain.html
2012-06-14 17:26:19 +00:00
an 802.1Qbh capable switch using an optionally specified
docs: minor fixes to domain interface documentation A few examples for <interface> had a type='direct' interface with no sub-elements. This is not allowed - a type='direct' interface must have at least a source element. (Most likely the example was copied from the type='user' or type='ethernet' examples - they *do* allow an instance with no sub-elements). There was also one place that mistakenly used %lt; ... %gt; instead of &lt; ... &gt; (for some reason, I make that typo all the time).
2012-06-11 21:16:17 +00:00
&lt;virtualport&gt; element (see the examples of virtualport
conf: parse/format type='hostdev' network interfaces This is the new interface type that sets up an SR-IOV PCI network device to be assigned to the guest with PCI passthrough after initializing some network device-specific things from the config (e.g. MAC address, virtualport profile parameters). Here is an example of the syntax: <interface type='hostdev' managed='yes'> <source> <address type='pci' domain='0' bus='0' slot='4' function='3'/> </source> <mac address='00:11:22:33:44:55'/> <address type='pci' domain='0' bus='0' slot='7' function='0'/> </interface> This would assign the PCI card from bus 0 slot 4 function 3 on the host, to bus 0 slot 7 function 0 on the guest, but would first set the MAC address of the card to 00:11:22:33:44:55. NB: The parser and formatter don't care if the PCI card being specified is a standard single function network adapter, or a virtual function (VF) of an SR-IOV capable network adapter, but the upcoming code that implements the back end of this config will work *only* with SR-IOV VFs. This is because modifying the mac address of a standard network adapter prior to assigning it to a guest is pointless - part of the device reset that occurs during that process will reset the MAC address to the value programmed into the card's firmware. Although it's not supported by any of libvirt's hypervisor drivers, usb network hostdevs are also supported in the parser and formatter for completeness and consistency. <source> syntax is identical to that for plain <hostdev> devices, except that the <address> element should have "type='usb'" added if bus/device are specified: <interface type='hostdev'> <source> <address type='usb' bus='0' device='4'/> </source> <mac address='00:11:22:33:44:55'/> </interface> If the vendor/product form of usb specification is used, type='usb' is implied: <interface type='hostdev'> <source> <vendor id='0x0012'/> <product id='0x24dd'/> </source> <mac address='00:11:22:33:44:55'/> </interface> Again, the upcoming patch to fill in the backend of this functionality will log an error and fail with "Unsupported Config" if you actually try to assign a USB network adapter to a guest using <interface type='hostdev'> - just use a standard <hostdev> entry in that case (and also for single-port PCI adapters).
2012-02-15 17:37:15 +00:00
given above for type='direct' network devices). Note that - due
to limitations in standard single-port PCI ethernet card driver
design - only SR-IOV (Single Root I/O Virtualization) virtual
function (VF) devices can be assigned in this manner; to assign
a standard single-port PCI or PCIe ethernet card to a guest, use
the traditional &lt;hostdev&gt; device definition and
<span class="since">Since 0.9.11</span>
</p>
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/> A domain's <interface> or <hostdev>, as well as a <network>'s <forward>, can now have an optional <driver name='kvm|vfio'/> element. As of this patch, there is no functionality behind this new knob - this patch adds support to the domain and network formatter/parser, and to the RNG and documentation. When the backend is added, legacy KVM PCI device assignment will continue to be used when no driver name is specified (or if <driver name='kvm'/> is specified), but if driver name is 'vfio', the new UEFI Secure Boot compatible VFIO device assignment will be used. Note that the parser doesn't automatically insert the current default value of this setting. This is done on purpose because the two possibilities are functionally equivalent from the guest's point of view, and we want to be able to automatically start using vfio as the default (even for existing domains) at some time in the future. This is similar to what was done with the "vhost" driver option in <interface>.
2013-03-15 19:15:14 +00:00
<p>
To use VFIO device assignment rather than traditional/legacy KVM
device assignment (VFIO is a new method of device assignment
that is compatible with UEFI Secure Boot), a type='hostdev'
interface can have an optional <code>driver</code> sub-element
with a <code>name</code> attribute set to "vfio". To use legacy
KVM device assignment you can set <code>name</code> to "kvm" (or
simply omit the <code>&lt;driver&gt;</code> element, since "kvm"
is currently the default).
<span class="since">Since 1.0.5 (QEMU and KVM only, requires kernel 3.6 or newer)</span>
</p>
conf: parse/format type='hostdev' network interfaces This is the new interface type that sets up an SR-IOV PCI network device to be assigned to the guest with PCI passthrough after initializing some network device-specific things from the config (e.g. MAC address, virtualport profile parameters). Here is an example of the syntax: <interface type='hostdev' managed='yes'> <source> <address type='pci' domain='0' bus='0' slot='4' function='3'/> </source> <mac address='00:11:22:33:44:55'/> <address type='pci' domain='0' bus='0' slot='7' function='0'/> </interface> This would assign the PCI card from bus 0 slot 4 function 3 on the host, to bus 0 slot 7 function 0 on the guest, but would first set the MAC address of the card to 00:11:22:33:44:55. NB: The parser and formatter don't care if the PCI card being specified is a standard single function network adapter, or a virtual function (VF) of an SR-IOV capable network adapter, but the upcoming code that implements the back end of this config will work *only* with SR-IOV VFs. This is because modifying the mac address of a standard network adapter prior to assigning it to a guest is pointless - part of the device reset that occurs during that process will reset the MAC address to the value programmed into the card's firmware. Although it's not supported by any of libvirt's hypervisor drivers, usb network hostdevs are also supported in the parser and formatter for completeness and consistency. <source> syntax is identical to that for plain <hostdev> devices, except that the <address> element should have "type='usb'" added if bus/device are specified: <interface type='hostdev'> <source> <address type='usb' bus='0' device='4'/> </source> <mac address='00:11:22:33:44:55'/> </interface> If the vendor/product form of usb specification is used, type='usb' is implied: <interface type='hostdev'> <source> <vendor id='0x0012'/> <product id='0x24dd'/> </source> <mac address='00:11:22:33:44:55'/> </interface> Again, the upcoming patch to fill in the backend of this functionality will log an error and fail with "Unsupported Config" if you actually try to assign a USB network adapter to a guest using <interface type='hostdev'> - just use a standard <hostdev> entry in that case (and also for single-port PCI adapters).
2012-02-15 17:37:15 +00:00
<p>
Note that this "intelligent passthrough" of network devices is
very similar to the functionality of a standard &lt;hostdev&gt;
device, the difference being that this method allows specifying
a MAC address and &lt;virtualport&gt; for the passed-through
device. If these capabilities are not required, if you have a
standard single-port PCI, PCIe, or USB network card that doesn't
support SR-IOV (and hence would anyway lose the configured MAC
address during reset after being assigned to the guest domain),
or if you are using a version of libvirt older than 0.9.11, you
should use standard &lt;hostdev&gt; to assign the device to the
guest instead of &lt;interface type='hostdev'/&gt;.
</p>
<pre>
...
&lt;devices&gt;
&lt;interface type='hostdev'&gt;
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/> A domain's <interface> or <hostdev>, as well as a <network>'s <forward>, can now have an optional <driver name='kvm|vfio'/> element. As of this patch, there is no functionality behind this new knob - this patch adds support to the domain and network formatter/parser, and to the RNG and documentation. When the backend is added, legacy KVM PCI device assignment will continue to be used when no driver name is specified (or if <driver name='kvm'/> is specified), but if driver name is 'vfio', the new UEFI Secure Boot compatible VFIO device assignment will be used. Note that the parser doesn't automatically insert the current default value of this setting. This is done on purpose because the two possibilities are functionally equivalent from the guest's point of view, and we want to be able to automatically start using vfio as the default (even for existing domains) at some time in the future. This is similar to what was done with the "vhost" driver option in <interface>.
2013-03-15 19:15:14 +00:00
&lt;driver name='vfio'/&gt;
conf: parse/format type='hostdev' network interfaces This is the new interface type that sets up an SR-IOV PCI network device to be assigned to the guest with PCI passthrough after initializing some network device-specific things from the config (e.g. MAC address, virtualport profile parameters). Here is an example of the syntax: <interface type='hostdev' managed='yes'> <source> <address type='pci' domain='0' bus='0' slot='4' function='3'/> </source> <mac address='00:11:22:33:44:55'/> <address type='pci' domain='0' bus='0' slot='7' function='0'/> </interface> This would assign the PCI card from bus 0 slot 4 function 3 on the host, to bus 0 slot 7 function 0 on the guest, but would first set the MAC address of the card to 00:11:22:33:44:55. NB: The parser and formatter don't care if the PCI card being specified is a standard single function network adapter, or a virtual function (VF) of an SR-IOV capable network adapter, but the upcoming code that implements the back end of this config will work *only* with SR-IOV VFs. This is because modifying the mac address of a standard network adapter prior to assigning it to a guest is pointless - part of the device reset that occurs during that process will reset the MAC address to the value programmed into the card's firmware. Although it's not supported by any of libvirt's hypervisor drivers, usb network hostdevs are also supported in the parser and formatter for completeness and consistency. <source> syntax is identical to that for plain <hostdev> devices, except that the <address> element should have "type='usb'" added if bus/device are specified: <interface type='hostdev'> <source> <address type='usb' bus='0' device='4'/> </source> <mac address='00:11:22:33:44:55'/> </interface> If the vendor/product form of usb specification is used, type='usb' is implied: <interface type='hostdev'> <source> <vendor id='0x0012'/> <product id='0x24dd'/> </source> <mac address='00:11:22:33:44:55'/> </interface> Again, the upcoming patch to fill in the backend of this functionality will log an error and fail with "Unsupported Config" if you actually try to assign a USB network adapter to a guest using <interface type='hostdev'> - just use a standard <hostdev> entry in that case (and also for single-port PCI adapters).
2012-02-15 17:37:15 +00:00
&lt;source&gt;
&lt;address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/&gt;
&lt;/source&gt;
&lt;mac address='52:54:00:6d:90:02'&gt;
&lt;virtualport type='802.1Qbh'&gt;
&lt;parameters profileid='finance'/&gt;
&lt;/virtualport&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>
<p>
A multicast group is setup to represent a virtual network. Any VMs
whose network devices are in the same multicast group can talk to each
other even across hosts. This mode is also available to unprivileged
users. There is no default DNS or DHCP support and no outgoing network
access. To provide outgoing network access, one of the VMs should have a
2nd NIC which is connected to one of the first 4 network types and do the
appropriate routing. The multicast protocol is compatible with that used
by user mode linux guests too. The source address used must be from the
multicast address block.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='mcast'&gt;
docs: fix a few small typos in formatdomain.html.in
2012-01-25 01:09:20 +00:00
&lt;mac address='52:54:00:6d:90:01'&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;source address='230.0.0.1' port='5558'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h5><a name="elementsNICSTCP">TCP tunnel</a></h5>
<p>
A TCP client/server architecture provides a virtual network. One VM
provides the server end of the network, all other VMS are configured as
clients. All network traffic is routed between the VMs via the server.
This mode is also available to unprivileged users. There is no default
DNS or DHCP support and no outgoing network access. To provide outgoing
network access, one of the VMs should have a 2nd NIC which is connected
to one of the first 4 network types and do the appropriate routing.</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='server'&gt;
docs: fix a few small typos in formatdomain.html.in
2012-01-25 01:09:20 +00:00
&lt;mac address='52:54:00:22:c9:42'&gt;
Update domain XML docs
2008-05-08 14:20:07 +00:00
&lt;source address='192.168.0.1' port='5558'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
...
&lt;interface type='client'&gt;
docs: fix a few small typos in formatdomain.html.in
2012-01-25 01:09:20 +00:00
&lt;mac address='52:54:00:8b:c9:51'&gt;
&lt;source address='192.168.0.1' port='5558'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Documentation for NIC model selection. * docs/formatdomain.html.in, docs/formatdomain.html: Add the documentation for NIC model selection.
2008-10-13 15:25:38 +00:00
<h5><a name="elementsNICSModel">Setting the NIC model</a></h5>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet1'/&gt;
<b>&lt;model type='ne2k_pci'/&gt;</b>
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Documentation for NIC model selection. * docs/formatdomain.html.in, docs/formatdomain.html: Add the documentation for NIC model selection.
2008-10-13 15:25:38 +00:00
<p>
For hypervisors which support this, you can set the model of
emulated network interface card.
</p>
<p>
The values for <code>type</code> aren't defined specifically by
libvirt, but by what the underlying hypervisor supports (if
any). For QEMU and KVM you can get a list of supported models
with these commands:
</p>
<pre>
qemu -net nic,model=? /dev/null
qemu-kvm -net nic,model=? /dev/null
</pre>
<p>
Typical values for QEMU and KVM include:
ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
<h5><a name="elementsDriverBackendOptions">Setting NIC driver-specific options</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet1'/&gt;
&lt;model type='virtio'/&gt;
Introduce /domain/devices/interface/driver/@queues attribute This attribute is going to represent number of queues for multique vhost network interface. This commit implements XML extension part of the feature and add one test as well. For now, we can only do xml2xml test as qemu command line generation code is not adapted yet.
2013-04-10 10:19:37 +00:00
<b>&lt;driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off' queues='5'/&gt;</b>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
<p>
Some NICs may have tunable driver-specific options. These are
set as attributes of the <code>driver</code> sub-element of the
interface definition. Currently the following attributes are
available for the <code>"virtio"</code> NIC driver:
</p>
<dl>
docs: document <driver name='vhost'/> for interfaces * docs/formatdomain.html.in: Document virtio backend selection.
2011-03-08 23:35:17 +00:00
<dt><code>name</code></dt>
<dd>
The optional <code>name</code> attribute forces which type of
backend driver to use. The value can be either 'qemu' (a
user-space backend) or 'vhost' (a kernel backend, which
requires the vhost module to be provided by the kernel); an
attempt to require the vhost driver without kernel support
will be rejected. If this attribute is not present, then the
domain defaults to 'vhost' if present, but silently falls back
to 'qemu' without error.
<span class="since">Since 0.8.8 (QEMU and KVM only)</span>
</dd>
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/> A domain's <interface> or <hostdev>, as well as a <network>'s <forward>, can now have an optional <driver name='kvm|vfio'/> element. As of this patch, there is no functionality behind this new knob - this patch adds support to the domain and network formatter/parser, and to the RNG and documentation. When the backend is added, legacy KVM PCI device assignment will continue to be used when no driver name is specified (or if <driver name='kvm'/> is specified), but if driver name is 'vfio', the new UEFI Secure Boot compatible VFIO device assignment will be used. Note that the parser doesn't automatically insert the current default value of this setting. This is done on purpose because the two possibilities are functionally equivalent from the guest's point of view, and we want to be able to automatically start using vfio as the default (even for existing domains) at some time in the future. This is similar to what was done with the "vhost" driver option in <interface>.
2013-03-15 19:15:14 +00:00
<dd>
For interfaces of type='hostdev' (PCI passthrough devices)
the <code>name</code> attribute can optionally be set to
"vfio" or "kvm". "vfio" tells libvirt to use VFIO device
assignment rather than traditional KVM device assignment (VFIO
is a new method of device assignment that is compatible with
UEFI Secure Boot), and "kvm" tells libvirt to use the legacy
device assignment performed directly by the kvm kernel module
(the default is currently "kvm", but is subject to change).
<span class="since">Since 1.0.5 (QEMU and KVM only, requires
kernel 3.6 or newer)</span>
</dd>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
<dt><code>txmode</code></dt>
<dd>
The <code>txmode</code> attribute specifies how to handle
transmission of packets when the transmit buffer is full. The
value can be either 'iothread' or 'timer'.
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
<span class="since">Since 0.8.8 (QEMU and KVM only)</span><br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
If set to 'iothread', packet tx is all done in an iothread in
the bottom half of the driver (this option translates into
adding "tx=bh" to the qemu commandline -device virtio-net-pci
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
option).<br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
If set to 'timer', tx work is done in qemu, and if there is
more tx data than can be sent at the present time, a timer is
set before qemu moves on to do other things; when the timer
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
fires, another attempt is made to send more data.<br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
The resulting difference, according to the qemu developer who
added the option is: "bh makes tx more asynchronous and reduces
latency, but potentially causes more processor bandwidth
contention since the cpu doing the tx isn't necessarily the
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
cpu where the guest generated the packets."<br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
qemu: domain I/O asynchronous handling For virtio disks and interfaces, qemu allows users to enable or disable ioeventfd feature. This means, qemu can execute domain code, while another thread waits for I/O event. Basically, in some cases it is win, in some loss. This feature is available via 'ioeventfd' attribute in disk and interface <driver> element. It accepts 'on' and 'off'. Leaving this attribute out defaults to hypervisor decision.
2011-06-20 08:26:47 +00:00
<b>In general you should leave this option alone, unless you
are very certain you know what you are doing.</b>
</dd>
<dt><code>ioeventfd</code></dt>
<dd>
This optional attribute allows users to set
<a href='https://patchwork.kernel.org/patch/43390/'>
domain I/O asynchronous handling</a> for interface device.
The default is left to the discretion of the hypervisor.
Accepted values are "on" and "off". Enabling this allows
qemu to execute VM while a separate thread handles I/O.
Typically guests experiencing high system CPU utilization
during I/O will benefit from this. On the other hand,
on overloaded host it could increase guest I/O latency.
<span class="since">Since 0.9.3 (QEMU and KVM only)</span><br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
<b>In general you should leave this option alone, unless you
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
are very certain you know what you are doing.</b>
</dd>
<dt><code>event_idx</code></dt>
<dd>
The <code>event_idx</code> attribute controls some aspects of
device event processing. The value can be either 'on' or 'off'
Fix some typos in messages, docs and comments.
2012-08-22 18:29:18 +00:00
- if it is on, it will reduce the number of interrupts and
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
exits for the guest. The default is determined by QEMU;
usually if the feature is supported, default is on. In case
there is a situation where this behavior is suboptimal, this
attribute provides a way to force the feature off.
<span class="since">Since 0.9.5 (QEMU and KVM only)</span><br/><br/>
<b>In general you should leave this option alone, unless you
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
are very certain you know what you are doing.</b>
</dd>
Introduce /domain/devices/interface/driver/@queues attribute This attribute is going to represent number of queues for multique vhost network interface. This commit implements XML extension part of the feature and add one test as well. For now, we can only do xml2xml test as qemu command line generation code is not adapted yet.
2013-04-10 10:19:37 +00:00
<dt><code>queues</code></dt>
<dd>
The optional <code>queues</code> attribute controls the number of
queues to be used for the<a href="http://www.linux-kvm.org/page/Multiqueue">
Multiqueue virtio-net</a> feature. If the interface has <code>&lt;model
type='virtio'/&gt;</code>, multiple packet processing queues can be
created; each queue will potentially be handled by a different
processor, resulting in much higher throughput.
<span class="since">Since 1.0.6 (QEMU and KVM only)</span>
</dd>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that tx work is done in qemu, and if there is more tx data than can be sent at the present time, a timer is set before qemu moves on to do other things; when the timer fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) The resulting difference, according to the qemu developer who added the option is: bh makes tx more asynchronous and reduces latency, but potentially causes more processor bandwidth contention since the cpu doing the tx isn't necessarily the cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
</dl>
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
<h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
<b>&lt;target dev='vnet1'/&gt;</b>
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
If no target is specified, certain hypervisors will
automatically generate a name for the created tun device. This
Fix minor typos in messages and docs Signed-off-by: Eric Blake <eblake@redhat.com>
2013-07-30 08:21:11 +00:00
name can be manually specified, however the name <i>must not
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
start with either 'vnet' or 'vif'</i>, which are prefixes
reserved by libvirt and certain hypervisors. Manually specified
targets using these prefixes will be ignored.
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
</p>
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
<h5><a name="elementsNICSBoot">Specifying boot order</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet1'/&gt;
<b>&lt;boot order='1'/&gt;</b>
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
<p>
docs: fix a few small typos in formatdomain.html.in
2012-01-25 01:09:20 +00:00
For hypervisors which support this, you can set a specific NIC to
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
be used for network boot. The <code>order</code> attribute determines
the order in which devices will be tried during boot sequence. The
per-device <code>boot</code> elements cannot be used together with
general boot elements in
<a href="#elementsOSBIOS">BIOS bootloader</a> section.
<span class="since">Since 0.8.8</span>
</p>
qemu: (and conf) support rombar for network devices When support for the rombar option was added, it was only added for PCI passthrough devices, configured with <hostdev>. The same option is available for any network device that is attached to the guest's PCI bus. This patch allows setting rombar for any PCI network device type. After adding cases to test this to qemuxml2argv-hostdev-pci-rombar.*, I decided to rename those files (to qemuxml2argv-pci-rom.*) to more accurately reflect the additional tests, and also noticed that up to now we've only been performing a domainschematest for that case, so I added the "pci-rom" test to both qemuxml2argv and qemuxml2xml (and in the process found some bugs whose fixes I squashed into previous commits of this series).
2012-01-25 00:54:12 +00:00
<h5><a name="elementsNICSROM">Interface ROM BIOS configuration</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet1'/&gt;
qemu: add "romfile" support to specify device boot ROM This patch addresses: https://bugzilla.redhat.com/show_bug.cgi?id=781562 Along with the "rombar" option that controls whether or not a boot rom is made visible to the guest, qemu also has a "romfile" option that allows specifying a binary file to present as the ROM BIOS of any emulated or passthrough PCI device. This patch adds support for specifying romfile to both passthrough PCI devices, and emulated network devices that attach to the guest's PCI bus (just about everything other than ne2k_isa). One example of the usefulness of this option is described in the bugzilla report: 82576 sriov network adapters don't provide a ROM BIOS for the cards virtual functions (VF), but an image of such a ROM is available, and with this ROM visible to the guest, it can PXE boot. In libvirt's xml, the new option is configured like this: <hostdev> ... <rom file='/etc/fake/boot.bin'/> ... </hostdev (similarly for <interface>).
2012-01-25 16:20:49 +00:00
<b>&lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;</b>
qemu: (and conf) support rombar for network devices When support for the rombar option was added, it was only added for PCI passthrough devices, configured with <hostdev>. The same option is available for any network device that is attached to the guest's PCI bus. This patch allows setting rombar for any PCI network device type. After adding cases to test this to qemuxml2argv-hostdev-pci-rombar.*, I decided to rename those files (to qemuxml2argv-pci-rom.*) to more accurately reflect the additional tests, and also noticed that up to now we've only been performing a domainschematest for that case, so I added the "pci-rom" test to both qemuxml2argv and qemuxml2xml (and in the process found some bugs whose fixes I squashed into previous commits of this series).
2012-01-25 00:54:12 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
<p>
For hypervisors which support this, you can change how a PCI Network
device's ROM is presented to the guest. The <code>bar</code>
attribute can be set to "on" or "off", and determines whether
or not the device's ROM will be visible in the guest's memory
map. (In PCI documentation, the "rombar" setting controls the
presence of the Base Address Register for the ROM). If no rom
bar is specified, the qemu default will be used (older
versions of qemu used a default of "off", while newer qemus
qemu: add "romfile" support to specify device boot ROM This patch addresses: https://bugzilla.redhat.com/show_bug.cgi?id=781562 Along with the "rombar" option that controls whether or not a boot rom is made visible to the guest, qemu also has a "romfile" option that allows specifying a binary file to present as the ROM BIOS of any emulated or passthrough PCI device. This patch adds support for specifying romfile to both passthrough PCI devices, and emulated network devices that attach to the guest's PCI bus (just about everything other than ne2k_isa). One example of the usefulness of this option is described in the bugzilla report: 82576 sriov network adapters don't provide a ROM BIOS for the cards virtual functions (VF), but an image of such a ROM is available, and with this ROM visible to the guest, it can PXE boot. In libvirt's xml, the new option is configured like this: <hostdev> ... <rom file='/etc/fake/boot.bin'/> ... </hostdev (similarly for <interface>).
2012-01-25 16:20:49 +00:00
have a default of "on").
The optional <code>file</code> attribute is used to point to a
binary file to be presented to the guest as the device's ROM
BIOS. This can be useful to provide an alternative boot ROM for a
network device.
<span class="since">Since 0.9.10 (QEMU and KVM only)</span>.
qemu: (and conf) support rombar for network devices When support for the rombar option was added, it was only added for PCI passthrough devices, configured with <hostdev>. The same option is available for any network device that is attached to the guest's PCI bus. This patch allows setting rombar for any PCI network device type. After adding cases to test this to qemuxml2argv-hostdev-pci-rombar.*, I decided to rename those files (to qemuxml2argv-pci-rom.*) to more accurately reflect the additional tests, and also noticed that up to now we've only been performing a domainschematest for that case, so I added the "pci-rom" test to both qemuxml2argv and qemuxml2xml (and in the process found some bugs whose fixes I squashed into previous commits of this series).
2012-01-25 00:54:12 +00:00
</p>
bandwidth: Define schema and create documentation Define new 'bandwidth' element with possible child element 'inbound' and 'outbound' addressing incoming and outgoing traffic respectively: <bandwidth> <inbound average='1000' peak='2000' burst='5120'/> <outbound average='500'/> </bandwidth> Leaving any element out means not to shape traffic in that direction. The units for average and peak (rate) are in kilobytes per second, for burst (size) are just in kilobytes. This element can be inserted into domain's 'interface' and 'network'.
2011-07-22 14:07:23 +00:00
<h5><a name="elementQoS">Quality of service</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet0'/&gt;
<b>&lt;bandwidth&gt;
bandwidth: add new 'floor' attribute This is however supported only on domain interfaces with type='network'. Moreover, target network needs to have at least inbound QoS set. This is required by hierarchical traffic shaping. From now on, the required attribute for <inbound/> is either 'average' (old) or 'floor' (new). This new attribute can be used just for interfaces type of network (<interface type='network'/>) currently.
2012-11-16 09:37:15 +00:00
&lt;inbound average='1000' peak='5000' floor='200' burst='1024'/&gt;
bandwidth: Define schema and create documentation Define new 'bandwidth' element with possible child element 'inbound' and 'outbound' addressing incoming and outgoing traffic respectively: <bandwidth> <inbound average='1000' peak='2000' burst='5120'/> <outbound average='500'/> </bandwidth> Leaving any element out means not to shape traffic in that direction. The units for average and peak (rate) are in kilobytes per second, for burst (size) are just in kilobytes. This element can be inserted into domain's 'interface' and 'network'.
2011-07-22 14:07:23 +00:00
&lt;outbound average='128' peak='256' burst='256'/&gt;
&lt;/bandwidth&gt;</b>
&lt;/interface&gt;
&lt;devices&gt;
...</pre>
<p>
This part of interface XML provides setting quality of service. Incoming
and outgoing traffic can be shaped independently. The
<code>bandwidth</code> element can have at most one <code>inbound</code>
and at most one <code>outbound</code> child elements. Leaving any of these
children element out result in no QoS applied on that traffic direction.
So, when you want to shape only domain's incoming traffic, use
<code>inbound</code> only, and vice versa. Each of these elements have one
bandwidth: add new 'floor' attribute This is however supported only on domain interfaces with type='network'. Moreover, target network needs to have at least inbound QoS set. This is required by hierarchical traffic shaping. From now on, the required attribute for <inbound/> is either 'average' (old) or 'floor' (new). This new attribute can be used just for interfaces type of network (<interface type='network'/>) currently.
2012-11-16 09:37:15 +00:00
mandatory attribute <code>average</code> (or <code>floor</code> as
described below). <code>average</code> specifies average bit rate on
the interface being shaped. Then there are two optional attributes:
bandwidth: Define schema and create documentation Define new 'bandwidth' element with possible child element 'inbound' and 'outbound' addressing incoming and outgoing traffic respectively: <bandwidth> <inbound average='1000' peak='2000' burst='5120'/> <outbound average='500'/> </bandwidth> Leaving any element out means not to shape traffic in that direction. The units for average and peak (rate) are in kilobytes per second, for burst (size) are just in kilobytes. This element can be inserted into domain's 'interface' and 'network'.
2011-07-22 14:07:23 +00:00
<code>peak</code>, which specifies maximum rate at which interface can send
data, and <code>burst</code>, amount of bytes that can be burst at
<code>peak</code> speed. Accepted values for attributes are integer
numbers. The units for <code>average</code> and <code>peak</code> attributes
are kilobytes per second, and for the <code>burst</code> just kilobytes.
formatdomain.html.in: Document implementation limitation of QoS The outbound/@peak is ignored (since QoS was introduced). This is due to kernel limitation of know allowing ingress filters to have peak just average rate. However, we should document this limitation to not confuse users.
2013-07-26 09:42:53 +00:00
Note the limitation of implementation: the <code>peak</code> attribute in
<code>outbound</code> element is ignored (as linux ingress filters don't
know it yet). <span class="since">Since 0.9.4</span> The <code>inbound</code> can
bandwidth: add new 'floor' attribute This is however supported only on domain interfaces with type='network'. Moreover, target network needs to have at least inbound QoS set. This is required by hierarchical traffic shaping. From now on, the required attribute for <inbound/> is either 'average' (old) or 'floor' (new). This new attribute can be used just for interfaces type of network (<interface type='network'/>) currently.
2012-11-16 09:37:15 +00:00
optionally have <code>floor</code> attribute. This is there for
guaranteeing minimal throughput for shaped interfaces. This, however,
requires that all traffic goes through one point where QoS decisions can
take place. That's why this attribute works only for virtual networks for
now (that is <code>&lt;interface type='network'/&gt;</code> with a
forward type of route, nat, or no forward at all). Moreover, the
virtual network the interface is connected to is required to have at least
inbound QoS set (<code>average</code> at least). Moreover, with
formatdomain.html.in: Correctly use <code/> in #elementQoS Interestingly, we had <code>floor<code> ... </code>outbound</code> which results in much larger block of text to be written in code style that intended.
2013-07-26 09:40:52 +00:00
<code>floor</code> attribute users don't need to specify
bandwidth: add new 'floor' attribute This is however supported only on domain interfaces with type='network'. Moreover, target network needs to have at least inbound QoS set. This is required by hierarchical traffic shaping. From now on, the required attribute for <inbound/> is either 'average' (old) or 'floor' (new). This new attribute can be used just for interfaces type of network (<interface type='network'/>) currently.
2012-11-16 09:37:15 +00:00
<code>average</code>. However, <code>peak</code> and <code>burst</code>
attributes still require <code>average</code>. Currently, linux kernel
doesn't allow ingress qdiscs to have any classes therefore
<code>floor</code> can be applied only on <code>inbound</code> and not
formatdomain.html.in: Correctly use <code/> in #elementQoS Interestingly, we had <code>floor<code> ... </code>outbound</code> which results in much larger block of text to be written in code style that intended.
2013-07-26 09:40:52 +00:00
<code>outbound</code>. <span class="since">Since 1.0.1</span>
bandwidth: Define schema and create documentation Define new 'bandwidth' element with possible child element 'inbound' and 'outbound' addressing incoming and outgoing traffic respectively: <bandwidth> <inbound average='1000' peak='2000' burst='5120'/> <outbound average='500'/> </bandwidth> Leaving any element out means not to shape traffic in that direction. The units for average and peak (rate) are in kilobytes per second, for burst (size) are just in kilobytes. This element can be inserted into domain's 'interface' and 'network'.
2011-07-22 14:07:23 +00:00
</p>
conf: add <vlan> element to network and domain interface elements The following config elements now support a <vlan> subelements: within a domain: <interface>, and the <actual> subelement of <interface> within a network: the toplevel, as well as any <portgroup> Each vlan element must have one or more <tag id='n'/> subelements. If there is more than one tag, it is assumed that vlan trunking is being requested. If trunking is required with only a single tag, the attribute "trunk='yes'" should be added to the toplevel <vlan> element. Some examples: <interface type='hostdev'/> <vlan> <tag id='42'/> </vlan> <mac address='52:54:00:12:34:56'/> ... </interface> <network> <name>vlan-net</name> <vlan trunk='yes'> <tag id='30'/> </vlan> <virtualport type='openvswitch'/> </network> <interface type='network'/> <source network='vlan-net'/> ... </interface> <network> <name>trunk-vlan</name> <vlan> <tag id='42'/> <tag id='43'/> </vlan> ... </network> <network> <name>multi</name> ... <portgroup name='production'/> <vlan> <tag id='42'/> </vlan> </portgroup> <portgroup name='test'/> <vlan> <tag id='666'/> </vlan> </portgroup> </network> <interface type='network'/> <source network='multi' portgroup='test'/> ... </interface> IMPORTANT NOTE: As of this patch there is no backend support for the vlan element for *any* network device type. When support is added in later patches, it will only be for those select network types that support setting up a vlan on the host side, without the guest's involvement. (For example, it will be possible to configure a vlan for a guest connected to an openvswitch bridge, but it won't be possible to do that for one that is connected to a standard Linux host bridge.)
2012-08-12 07:51:30 +00:00
<h5><a name="elementVlanTag">Setting VLAN tag (on supported network types only)</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='bridge'&gt;
<b>&lt;vlan&gt;</b>
<b>&lt;tag id='42'/&gt;</b>
<b>&lt;/vlan&gt;</b>
&lt;source bridge='ovsbr0'/&gt;
&lt;virtualport type='openvswitch'&gt;
&lt;parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
&lt;/virtualport&gt;
&lt;/interface&gt;
Configure native vlan modes on Open vSwitch ports This patch adds functionality to allow libvirt to configure the 'native-tagged' and 'native-untagged' modes on openvswitch networks. Signed-off-by: Laine Stump <laine@redhat.com>
2013-05-23 17:12:10 +00:00
&lt;interface type='bridge'&gt;
<b>&lt;vlan trunk='yes'&gt;</b>
<b>&lt;tag id='42'/&gt;</b>
<b>&lt;tag id='123' nativeMode='untagged'/&gt;</b>
<b>&lt;/vlan&gt;</b>
...
&lt;/interface&gt;
conf: add <vlan> element to network and domain interface elements The following config elements now support a <vlan> subelements: within a domain: <interface>, and the <actual> subelement of <interface> within a network: the toplevel, as well as any <portgroup> Each vlan element must have one or more <tag id='n'/> subelements. If there is more than one tag, it is assumed that vlan trunking is being requested. If trunking is required with only a single tag, the attribute "trunk='yes'" should be added to the toplevel <vlan> element. Some examples: <interface type='hostdev'/> <vlan> <tag id='42'/> </vlan> <mac address='52:54:00:12:34:56'/> ... </interface> <network> <name>vlan-net</name> <vlan trunk='yes'> <tag id='30'/> </vlan> <virtualport type='openvswitch'/> </network> <interface type='network'/> <source network='vlan-net'/> ... </interface> <network> <name>trunk-vlan</name> <vlan> <tag id='42'/> <tag id='43'/> </vlan> ... </network> <network> <name>multi</name> ... <portgroup name='production'/> <vlan> <tag id='42'/> </vlan> </portgroup> <portgroup name='test'/> <vlan> <tag id='666'/> </vlan> </portgroup> </network> <interface type='network'/> <source network='multi' portgroup='test'/> ... </interface> IMPORTANT NOTE: As of this patch there is no backend support for the vlan element for *any* network device type. When support is added in later patches, it will only be for those select network types that support setting up a vlan on the host side, without the guest's involvement. (For example, it will be possible to configure a vlan for a guest connected to an openvswitch bridge, but it won't be possible to do that for one that is connected to a standard Linux host bridge.)
2012-08-12 07:51:30 +00:00
&lt;devices&gt;
...</pre>
<p>
If (and only if) the network connection used by the guest
supports vlan tagging transparent to the guest, an
optional <code>&lt;vlan&gt;</code> element can specify one or
more vlan tags to apply to the guest's network
traffic <span class="since">Since 0.10.0</span>. (openvswitch
and type='hostdev' SR-IOV interfaces do support transparent vlan
tagging of guest traffic; everything else, including standard
linux bridges and libvirt's own virtual networks, <b>do not</b>
support it. 802.1Qbh (vn-link) and 802.1Qbg (VEPA) switches
provide their own way (outside of libvirt) to tag guest traffic
onto specific vlans.) To allow for specification of multiple
tags (in the case of vlan trunking), a
documentation: HTML tag fix Replace '%' by '&' for correct escaping of '>' in Domain specification. Signed-off-by: Philipp Hahn <hahn@univention.de>
2012-10-26 08:38:02 +00:00
subelement, <code>&lt;tag&gt;</code>, specifies which vlan tag
conf: add <vlan> element to network and domain interface elements The following config elements now support a <vlan> subelements: within a domain: <interface>, and the <actual> subelement of <interface> within a network: the toplevel, as well as any <portgroup> Each vlan element must have one or more <tag id='n'/> subelements. If there is more than one tag, it is assumed that vlan trunking is being requested. If trunking is required with only a single tag, the attribute "trunk='yes'" should be added to the toplevel <vlan> element. Some examples: <interface type='hostdev'/> <vlan> <tag id='42'/> </vlan> <mac address='52:54:00:12:34:56'/> ... </interface> <network> <name>vlan-net</name> <vlan trunk='yes'> <tag id='30'/> </vlan> <virtualport type='openvswitch'/> </network> <interface type='network'/> <source network='vlan-net'/> ... </interface> <network> <name>trunk-vlan</name> <vlan> <tag id='42'/> <tag id='43'/> </vlan> ... </network> <network> <name>multi</name> ... <portgroup name='production'/> <vlan> <tag id='42'/> </vlan> </portgroup> <portgroup name='test'/> <vlan> <tag id='666'/> </vlan> </portgroup> </network> <interface type='network'/> <source network='multi' portgroup='test'/> ... </interface> IMPORTANT NOTE: As of this patch there is no backend support for the vlan element for *any* network device type. When support is added in later patches, it will only be for those select network types that support setting up a vlan on the host side, without the guest's involvement. (For example, it will be possible to configure a vlan for a guest connected to an openvswitch bridge, but it won't be possible to do that for one that is connected to a standard Linux host bridge.)
2012-08-12 07:51:30 +00:00
to use (for example: <code>&lt;tag id='42'/&gt;</code>. If an
interface has more than one <code>&lt;vlan&gt;</code> element
defined, it is assumed that the user wants to do VLAN trunking
using all the specified tags. In the case that vlan trunking
with a single tag is desired, the optional
attribute <code>trunk='yes'</code> can be added to the toplevel
vlan element.
</p>
Configure native vlan modes on Open vSwitch ports This patch adds functionality to allow libvirt to configure the 'native-tagged' and 'native-untagged' modes on openvswitch networks. Signed-off-by: Laine Stump <laine@redhat.com>
2013-05-23 17:12:10 +00:00
<p>
For network connections using openvswitch it is possible to
configure the 'native-tagged' and 'native-untagged' vlan modes
Use 1.1.0 everywhere in the documentation Since we already have the v1.1.0-rc1 tag in git.
2013-06-25 13:25:29 +00:00
<span class="since">Since 1.1.0.</span> This uses the optional
Configure native vlan modes on Open vSwitch ports This patch adds functionality to allow libvirt to configure the 'native-tagged' and 'native-untagged' modes on openvswitch networks. Signed-off-by: Laine Stump <laine@redhat.com>
2013-05-23 17:12:10 +00:00
<code>nativeMode</code> attribute on the <code>&lt;tag&gt;</code>
element: <code>nativeMode</code> may be set to 'tagged' or
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
'untagged'. The id attribute of the element sets the native vlan.
Configure native vlan modes on Open vSwitch ports This patch adds functionality to allow libvirt to configure the 'native-tagged' and 'native-untagged' modes on openvswitch networks. Signed-off-by: Laine Stump <laine@redhat.com>
2013-05-23 17:12:10 +00:00
</p>
Fix typo in domain XML documentation s/Modyfing/Modifying
2012-02-29 12:47:06 +00:00
<h5><a name="elementLink">Modifying virtual link state</a></h5>
link-state: conf: Add element to XML for controling link state A new element is introduced to XML that allows to control state of virtual network interfaces in hypervisors. Live modification of the link state allows networking tools propagate topology changes to guest OS or testing of scenarios in complex (virtual) networks. This patch adds elements to XML grammars and parsing and generating code.
2011-09-06 08:08:15 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet0'/&gt;
<b>&lt;link state='down'/&gt;</b>
&lt;/interface&gt;
&lt;devices&gt;
...</pre>
<p>
This element provides means of setting state of the virtual network link.
Possible values for attribute <code>state</code> are <code>up</code> and
<code>down</code>. If <code>down</code> is specified as the value, the interface
behaves as if it had the network cable disconnected. Default behavior if this
element is unspecified is to have the link state <code>up</code>.
<span class="since">Since 0.9.5</span>
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h4><a name="elementsInput">Input devices</a></h4>
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
Input devices allow interaction with the graphical framebuffer
in the guest virtual machine. When enabling the framebuffer, an
input device is automatically provided. It may be possible to
add additional devices explicitly, for example,
Update domain XML docs
2008-05-08 14:20:07 +00:00
to provide a graphics tablet for absolute cursor movement.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;input type='mouse' bus='usb'/&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>input</code></dt>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
<dd>The <code>input</code> element has one mandatory attribute,
the <code>type</code> whose value can be either 'mouse' or
'tablet'. The latter provides absolute
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
cursor movement, while the former uses relative movement. The optional
<code>bus</code> attribute can be used to refine the exact device type.
It takes values "xen" (paravirtualized), "ps2" and "usb".</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<p>
The <code>input</code> element has an optional
sub-element <code>&lt;address&gt;</code> which can tie the
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
device to a particular PCI
slot, <a href="#elementsAddress">documented above</a>.
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add USB hub device domain parsing and serialization code, qemu driver backend and a couple of test
2011-09-02 14:20:40 +00:00
<h4><a name="elementsHub">Hub devices</a></h4>
<p>
A hub is a device that expands a single port into several so
that there are more ports available to connect devices to a host
system.
</p>
<pre>
...
&lt;devices&gt;
&lt;hub type='usb'/&gt;
&lt;/devices&gt;
...</pre>
<dl>
<dt><code>hub</code></dt>
<dd>The <code>hub</code> element has one mandatory attribute,
the <code>type</code> whose value can only be 'usb'.</dd>
</dl>
<p>
The <code>hub</code> element has an optional
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
sub-element <code>&lt;address&gt;</code>
with <code>type='usb'</code>which can tie the device to a
particular controller, <a href="#elementsAddress">documented
above</a>.
Add USB hub device domain parsing and serialization code, qemu driver backend and a couple of test
2011-09-02 14:20:40 +00:00
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h4><a name="elementsGraphics">Graphical framebuffers</a></h4>
<p>
A graphics device allows for graphical interaction with the
guest OS. A guest will typically have either a framebuffer
or a text console configured to allow interaction with the
admin.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;graphics type='sdl' display=':0.0'/&gt;
conf: add 'sharePolicy' attribute to graphics element for vnc -vnc :5900,share=allow-exclusive allows clients to ask for exclusive access which is implemented by dropping other connections Connecting multiple clients in parallel requires all clients asking for a shared session (vncviewer: -shared switch) -vnc :5900,share=force-shared disables exclusive client access. Useful for shared desktop sessions, where you don't want someone forgetting specify -shared disconnect everybody else. -vnc :5900,share=ignore completely ignores the shared flag and allows everybody connect unconditionally
2013-05-21 14:31:48 +00:00
&lt;graphics type='vnc' port='5904' sharePolicy='allow-exclusive'&gt;
conf: add <listen> subelement to domain <graphics> element Once it's plugged in, the <listen> element will be an optional replacement for the "listen" attribute that graphics elements already have. If the <listen> element is type='address', it will have an attribute called 'address' which will contain an IP address or dns name that the guest's display server should listen on. If, however, type='network', the <listen> element should have an attribute called 'network' that will be set to the name of a network configuration to get the IP address from. * docs/schemas/domain.rng: updated to allow the <listen> element * docs/formatdomain.html.in: document the <listen> element and its attributes. * src/conf/domain_conf.[hc]: 1) The domain parser, formatter, and data structure are modified to support 0 or more <listen> subelements to each <graphics> element. The old style "legacy" listen attribute is also still accepted, and will be stored internally just as if it were a separate <listen> element. On output (i.e. format), the address attribute of the first <listen> element of type 'address' will be duplicated in the legacy "listen" attribute of the <graphic> element. 2) The "listenAddr" attribute has been removed from the unions in virDomainGRaphicsDef for graphics types vnc, rdp, and spice. This attribute is now in the <listen> subelement (aka virDomainGraphicsListenDef) 3) Helper functions were written to provide simple access (both Get and Set) to the listen elements and their attributes. * src/libvirt_private.syms: export the listen helper functions * src/qemu/qemu_command.c, src/qemu/qemu_hotplug.c, src/qemu/qemu_migration.c, src/vbox/vbox_tmpl.c, src/vmx/vmx.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c Modify all these files to use the listen helper functions rather than directly referencing the (now missing) listenAddr attribute. There can be multiple <listen> elements to a single <graphics>, but the drivers all currently only support one, so all replacements of direct access with a helper function indicate index "0". * tests/* - only 3 of these are new files added explicitly to test the new <listen> element. All the others have been modified to reflect the fact that any legacy "listen" attributes passed in to the domain parse will be saved in a <listen> element (i.e. one of the virDomainGraphicsListenDefs), and during the domain format function, both the <listen> element as well as the legacy attributes will be output.
2011-07-07 04:20:28 +00:00
&lt;listen type='address' address='1.2.3.4'/&gt;
&lt;/graphics&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
&lt;graphics type='desktop' fullscreen='yes'/&gt;
conf: add <listen> subelement to domain <graphics> element Once it's plugged in, the <listen> element will be an optional replacement for the "listen" attribute that graphics elements already have. If the <listen> element is type='address', it will have an attribute called 'address' which will contain an IP address or dns name that the guest's display server should listen on. If, however, type='network', the <listen> element should have an attribute called 'network' that will be set to the name of a network configuration to get the IP address from. * docs/schemas/domain.rng: updated to allow the <listen> element * docs/formatdomain.html.in: document the <listen> element and its attributes. * src/conf/domain_conf.[hc]: 1) The domain parser, formatter, and data structure are modified to support 0 or more <listen> subelements to each <graphics> element. The old style "legacy" listen attribute is also still accepted, and will be stored internally just as if it were a separate <listen> element. On output (i.e. format), the address attribute of the first <listen> element of type 'address' will be duplicated in the legacy "listen" attribute of the <graphic> element. 2) The "listenAddr" attribute has been removed from the unions in virDomainGRaphicsDef for graphics types vnc, rdp, and spice. This attribute is now in the <listen> subelement (aka virDomainGraphicsListenDef) 3) Helper functions were written to provide simple access (both Get and Set) to the listen elements and their attributes. * src/libvirt_private.syms: export the listen helper functions * src/qemu/qemu_command.c, src/qemu/qemu_hotplug.c, src/qemu/qemu_migration.c, src/vbox/vbox_tmpl.c, src/vmx/vmx.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c Modify all these files to use the listen helper functions rather than directly referencing the (now missing) listenAddr attribute. There can be multiple <listen> elements to a single <graphics>, but the drivers all currently only support one, so all replacements of direct access with a helper function indicate index "0". * tests/* - only 3 of these are new files added explicitly to test the new <listen> element. All the others have been modified to reflect the fact that any legacy "listen" attributes passed in to the domain parse will be saved in a <listen> element (i.e. one of the virDomainGraphicsListenDefs), and during the domain format function, both the <listen> element as well as the legacy attributes will be output.
2011-07-07 04:20:28 +00:00
&lt;graphics type='spice'&gt;
&lt;listen type='network' network='rednet'/&gt;
&lt;/graphics&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>graphics</code></dt>
<dd>The <code>graphics</code> element has a mandatory <code>type</code>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
<dl>
<dt><code>"sdl"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
This displays a window on the host desktop, it can take 3
optional arguments: a <code>display</code> attribute for
the display to use, an <code>xauth</code> attribute for
the authentication identifier, and an
optional <code>fullscreen</code> attribute accepting
values 'yes' or 'no'.
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
<dt><code>"vnc"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
Starts a VNC server. The <code>port</code> attribute
specifies the TCP port number (with -1 as legacy syntax
indicating that it should be
auto-allocated). The <code>autoport</code> attribute is
the new preferred syntax for indicating autoallocation of
the TCP port to use. The <code>listen</code> attribute is
an IP address for the server to listen
on. The <code>passwd</code> attribute provides a VNC
password in clear text. The <code>keymap</code> attribute
specifies the keymap to use. It is possible to set a limit
on the validity of the password be giving an
timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
graphics: add support for action_if_connected in qemu This option accepts 3 values: -keep, to keep current client connected (Spice+VNC) -disconnect, to disconnect client (Spice) -fail, to fail setting password if there is a client connected (Spice)
2011-05-26 14:15:54 +00:00
assumed to be in UTC. The <code>connected</code> attribute
allows control of connected client during password changes.
VNC accepts <code>keep</code> value only.
<span class="since">since 0.9.3</span>
conf: add 'sharePolicy' attribute to graphics element for vnc -vnc :5900,share=allow-exclusive allows clients to ask for exclusive access which is implemented by dropping other connections Connecting multiple clients in parallel requires all clients asking for a shared session (vncviewer: -shared switch) -vnc :5900,share=force-shared disables exclusive client access. Useful for shared desktop sessions, where you don't want someone forgetting specify -shared disconnect everybody else. -vnc :5900,share=ignore completely ignores the shared flag and allows everybody connect unconditionally
2013-05-21 14:31:48 +00:00
NB, this may not be supported by all hypervisors.<br/>
The optional <code>sharePolicy</code> attribute specifies vnc server
display sharing policy. "allow-exclusive" allows clients to ask
for exclusive access by dropping other connections. Connecting
multiple clients in parallel requires all clients asking for a
shared session (vncviewer: -Shared switch). This is the default
value. "force-shared" disables exclusive client access, every
connection has to specify -Shared switch for vncviewer. "ignore"
welcomes every connection unconditionally
<span class="since">since 1.0.6</span>. <br/> <br/>
graphics: add support for action_if_connected in qemu This option accepts 3 values: -keep, to keep current client connected (Spice+VNC) -disconnect, to disconnect client (Spice) -fail, to fail setting password if there is a client connected (Spice)
2011-05-26 14:15:54 +00:00
Rather than using listen/port, QEMU supports a
<code>socket</code> attribute for listening on a unix
domain socket path.<span class="since">Since 0.8.8</span>
Add VNC WebSocket support Adding support for new attribute 'websocket' in the '<graphics>' element, the attribute value is the port to listen on with '-1' meaning auto-allocation, '0' meaning no websockets.
2013-04-29 12:34:01 +00:00
For VNC WebSocket functionality, <code>websocket</code>
attribute may be used to specify port to listen on (with
-1 meaning auto-allocation and <code>autoport</code>
having no effect due to security reasons).
<span class="since">Since 1.0.6</span>
Add a <graphics> type for SPICE protocol This adds an element <graphics type='spice' port='5903' tlsPort='5904' autoport='yes' listen='127.0.0.1'/> This is the bare minimum that should be exposed in the guest config for SPICE. Other parameters are better handled as per host level configuration tunables * docs/schemas/domain.rng: Define the SPICE <graphics> schema * src/domain_conf.h, src/domain_conf.c: Add parsing and formatting for SPICE graphics config * src/qemu_conf.c: Complain about unsupported graphics types
2009-08-14 09:54:14 +00:00
</dd>
<dt><code>"spice"</code></dt>
<dd>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
Starts a SPICE server. The <code>port</code> attribute
specifies the TCP port number (with -1 as legacy syntax
indicating that it should be auto-allocated),
while <code>tlsPort</code> gives an alternative secure
port number. The <code>autoport</code> attribute is the
new preferred syntax for indicating autoallocation of
qemu: Do sensible auto allocation of SPICE port numbers With this patch, if the autoport attribute is used, the code will sensibly auto allocate the ports only if needed.
2013-04-23 05:01:38 +00:00
needed port numbers. The <code>listen</code> attribute is
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
an IP address for the server to listen
on. The <code>passwd</code> attribute provides a SPICE
password in clear text. The <code>keymap</code>
attribute specifies the keymap to use. It is possible to
set a limit on the validity of the password be giving an
timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
graphics: add support for action_if_connected in qemu This option accepts 3 values: -keep, to keep current client connected (Spice+VNC) -disconnect, to disconnect client (Spice) -fail, to fail setting password if there is a client connected (Spice)
2011-05-26 14:15:54 +00:00
assumed to be in UTC. The <code>connected</code> attribute
allows control of connected client during password changes.
SPICE accepts <code>keep</code> to keep client connected,
<code>disconnect</code> to disconnect client and
<code>fail</code> to fail changing password.
<span class="since">Since 0.9.3</span>
NB, this may not be supported by all hypervisors.
<span class="since">"spice" since 0.8.6</span>.
domain_conf: add "default" to list of valid spice channels qemu's behavior in this case is to change the spice server behavior to require secure connection to any channel not otherwise specified as being in plaintext mode. libvirt doesn't currently allow requesting this (via plaintext-channel=<channel name>). RHBZ: 819499 Signed-off-by: Alon Levy <alevy@redhat.com>
2012-05-08 17:42:44 +00:00
The <code>defaultMode</code> attribute sets the default channel
security policy, valid values are <code>secure</code>,
<code>insecure</code> and the default <code>any</code>
(which is secure if possible, but falls back to insecure
rather than erroring out if no secure path is
available). <span class="since">"defaultMode" since
0.9.12</span>.
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</p>
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
When SPICE has both a normal and TLS secured TCP port
configured, it can be desirable to restrict what
channels can be run on each port. This is achieved by
adding one or more &lt;channel&gt; elements inside the
main &lt;graphics&gt; element. Valid channel names
include <code>main</code>, <code>display</code>,
<code>inputs</code>, <code>cursor</code>,
domain_conf: add "usbredir" to list of valid spice channels Add "usbredir" channel to list of recognized spice channels. RHBZ: 819498 Signed-off-by: Alon Levy <alevy@redhat.com>
2012-05-08 13:00:28 +00:00
<code>playback</code>, <code>record</code>
(all <span class="since"> since 0.8.6</span>);
<code>smartcard</code> (<span class="since">since
0.8.8</span>); and <code>usbredir</code>
(<span class="since">since 0.9.12</span>).
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</p>
<pre>
Support SPICE channel security options This extends the SPICE XML to allow channel security options <graphics type='spice' port='-1' tlsPort='-1' autoport='yes'> <channel name='main' mode='secure'/> <channel name='record' mode='insecure'/> </graphics> Any non-specified channel uses the default, which allows both secure & insecure usage * src/conf/domain_conf.c, src/conf/domain_conf.h, src/libvirt_private.syms: Add XML syntax for specifying per channel security options for spice. * src/qemu/qemu_conf.c: Configure channel security with spice
2010-04-09 16:56:00 +00:00
&lt;graphics type='spice' port='-1' tlsPort='-1' autoport='yes'&gt;
&lt;channel name='main' mode='secure'/&gt;
&lt;channel name='record' mode='insecure'/&gt;
Spice: support audio, images and stream compression This extends the SPICE XML to allow variable compression settings for audio, images and streaming: <graphics type='spice' port='5901' tlsPort='-1' autoport='yes'> <image compression='auto_glz'/> <jpeg compression='auto'/> <zlib compression='auto'/> <playback compression='on'/> </graphics> All new elements are optional.
2011-04-14 08:44:20 +00:00
&lt;image compression='auto_glz'/&gt;
spice: support streaming-video parameter This adds a streaming-video=filter|all|off attribute. It is used to change the behavior of video stream detection in spice, the default is filter (the default for libvirt is not to specify it - the actual default is defined in libspice-server.so). Usage: <graphics type='spice' autoport='yes'> <streaming mode='off'/> </graphics> Tested with the above and with tests/qemuxml2argvtest. Signed-off-by: Alon Levy <alevy@redhat.com>
2011-05-23 15:16:42 +00:00
&lt;streaming mode='filter'/&gt;
spice: add <clipboard copypaste='yes|no'> option From a security pov copy and paste between the guest and the client is not always desirable. So we need to be able to enable/disable this. The best place to do this from an administration pov is on the hypervisor, so the qemu cmdline is getting a spice disable-copy-paste option, see bug 693645. Example qemu invocation: qemu -spice port=5932,disable-ticketing,disable-copy-paste https://bugzilla.redhat.com/show_bug.cgi?id=693661
2011-06-14 11:35:48 +00:00
&lt;clipboard copypaste='no'/&gt;
qemu: spice agent-mouse support spice agent-mouse support Usage: <graphics type='spice'> <mouse mode='client'|'server'/> <graphics/> Signed-off-by: Osier Yang <jyang@redhat.com>
2012-03-09 07:26:24 +00:00
&lt;mouse mode='client'/&gt;
Support SPICE channel security options This extends the SPICE XML to allow channel security options <graphics type='spice' port='-1' tlsPort='-1' autoport='yes'> <channel name='main' mode='secure'/> <channel name='record' mode='insecure'/> </graphics> Any non-specified channel uses the default, which allows both secure & insecure usage * src/conf/domain_conf.c, src/conf/domain_conf.h, src/libvirt_private.syms: Add XML syntax for specifying per channel security options for spice. * src/qemu/qemu_conf.c: Configure channel security with spice
2010-04-09 16:56:00 +00:00
&lt;/graphics&gt;</pre>
Spice: support audio, images and stream compression This extends the SPICE XML to allow variable compression settings for audio, images and streaming: <graphics type='spice' port='5901' tlsPort='-1' autoport='yes'> <image compression='auto_glz'/> <jpeg compression='auto'/> <zlib compression='auto'/> <playback compression='on'/> </graphics> All new elements are optional.
2011-04-14 08:44:20 +00:00
<p>
Spice supports variable compression settings for audio,
images and streaming, <span class="since">since
0.9.1</span>. These settings are accessible via
the <code>compression</code> attribute in all following
elements: <code>image</code> to set image compression
(accepts <code>auto_glz</code>, <code>auto_lz</code>,
<code>quic</code>, <code>glz</code>, <code>lz</code>,
<code>off</code>), <code>jpeg</code> for JPEG
compression for images over wan
(accepts <code>auto</code>, <code>never</code>,
<code>always</code>), <code>zlib</code> for configuring
wan image compression (accepts <code>auto</code>,
<code>never</code>, <code>always</code>)
and <code>playback</code> for enabling audio stream
compression (accepts <code>on</code> or <code>off</code>).
</p>
spice: support streaming-video parameter This adds a streaming-video=filter|all|off attribute. It is used to change the behavior of video stream detection in spice, the default is filter (the default for libvirt is not to specify it - the actual default is defined in libspice-server.so). Usage: <graphics type='spice' autoport='yes'> <streaming mode='off'/> </graphics> Tested with the above and with tests/qemuxml2argvtest. Signed-off-by: Alon Levy <alevy@redhat.com>
2011-05-23 15:16:42 +00:00
<p>
Streaming mode is set by the <code>streaming</code>
docs: fix typo Bogus <code/>, and incorrect use of it's instead of its.
2012-03-23 02:40:09 +00:00
element, settings its <code>mode</code> attribute to one
spice: support streaming-video parameter This adds a streaming-video=filter|all|off attribute. It is used to change the behavior of video stream detection in spice, the default is filter (the default for libvirt is not to specify it - the actual default is defined in libspice-server.so). Usage: <graphics type='spice' autoport='yes'> <streaming mode='off'/> </graphics> Tested with the above and with tests/qemuxml2argvtest. Signed-off-by: Alon Levy <alevy@redhat.com>
2011-05-23 15:16:42 +00:00
of <code>filter</code>, <code>all</code>
or <code>off</code>, <span class="since">since 0.9.2</span>.
</p>
spice: add <clipboard copypaste='yes|no'> option From a security pov copy and paste between the guest and the client is not always desirable. So we need to be able to enable/disable this. The best place to do this from an administration pov is on the hypervisor, so the qemu cmdline is getting a spice disable-copy-paste option, see bug 693645. Example qemu invocation: qemu -spice port=5932,disable-ticketing,disable-copy-paste https://bugzilla.redhat.com/show_bug.cgi?id=693661
2011-06-14 11:35:48 +00:00
<p>
Copy &amp; Paste functionality (via Spice agent) is set
by the <code>clipboard</code> element. It is enabled by
default, and can be disabled by setting
the <code>copypaste</code> property
to <code>no</code>, <span class="since">since
0.9.3</span>.
docs: Fix spice documentation typo We missed ending tag for paragraph element
2011-07-18 09:28:54 +00:00
</p>
qemu: spice agent-mouse support spice agent-mouse support Usage: <graphics type='spice'> <mouse mode='client'|'server'/> <graphics/> Signed-off-by: Osier Yang <jyang@redhat.com>
2012-03-09 07:26:24 +00:00
<p>
docs: fix typo Bogus <code/>, and incorrect use of it's instead of its.
2012-03-23 02:40:09 +00:00
Mouse mode is set by the <code>mouse</code> element,
setting its <code>mode</code> attribute to one of
qemu: spice agent-mouse support spice agent-mouse support Usage: <graphics type='spice'> <mouse mode='client'|'server'/> <graphics/> Signed-off-by: Osier Yang <jyang@redhat.com>
2012-03-09 07:26:24 +00:00
<code>server</code> or <code>client</code> ,
<span class="since">since 0.9.11</span>. If no mode is
specified, the qemu default will be used (client mode).
</p>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
<dt><code>"rdp"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
Starts a RDP server. The <code>port</code> attribute
specifies the TCP port number (with -1 as legacy syntax
indicating that it should be
auto-allocated). The <code>autoport</code> attribute is
the new preferred syntax for indicating autoallocation of
the TCP port to use. The <code>replaceUser</code>
attribute is a boolean deciding whether multiple
simultaneous connections to the VM are permitted.
docs: Fix truncated sentence in RDP 'multiUser' attribute
2013-03-29 12:52:21 +00:00
The <code>multiUser</code> attribute is a boolean deciding
whether the existing connection must be dropped and a new
connection must be established by the VRDP server, when a
new client connects in single connection mode.
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
<dt><code>"desktop"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
This value is reserved for VirtualBox domains for the
moment. It displays a window on the host desktop,
similarly to "sdl", but using the VirtualBox viewer. Just
like "sdl", it accepts the optional
attributes <code>display</code>
and <code>fullscreen</code>.
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
</dl>
</dd>
</dl>
conf: add <listen> subelement to domain <graphics> element Once it's plugged in, the <listen> element will be an optional replacement for the "listen" attribute that graphics elements already have. If the <listen> element is type='address', it will have an attribute called 'address' which will contain an IP address or dns name that the guest's display server should listen on. If, however, type='network', the <listen> element should have an attribute called 'network' that will be set to the name of a network configuration to get the IP address from. * docs/schemas/domain.rng: updated to allow the <listen> element * docs/formatdomain.html.in: document the <listen> element and its attributes. * src/conf/domain_conf.[hc]: 1) The domain parser, formatter, and data structure are modified to support 0 or more <listen> subelements to each <graphics> element. The old style "legacy" listen attribute is also still accepted, and will be stored internally just as if it were a separate <listen> element. On output (i.e. format), the address attribute of the first <listen> element of type 'address' will be duplicated in the legacy "listen" attribute of the <graphic> element. 2) The "listenAddr" attribute has been removed from the unions in virDomainGRaphicsDef for graphics types vnc, rdp, and spice. This attribute is now in the <listen> subelement (aka virDomainGraphicsListenDef) 3) Helper functions were written to provide simple access (both Get and Set) to the listen elements and their attributes. * src/libvirt_private.syms: export the listen helper functions * src/qemu/qemu_command.c, src/qemu/qemu_hotplug.c, src/qemu/qemu_migration.c, src/vbox/vbox_tmpl.c, src/vmx/vmx.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c Modify all these files to use the listen helper functions rather than directly referencing the (now missing) listenAddr attribute. There can be multiple <listen> elements to a single <graphics>, but the drivers all currently only support one, so all replacements of direct access with a helper function indicate index "0". * tests/* - only 3 of these are new files added explicitly to test the new <listen> element. All the others have been modified to reflect the fact that any legacy "listen" attributes passed in to the domain parse will be saved in a <listen> element (i.e. one of the virDomainGraphicsListenDefs), and during the domain format function, both the <listen> element as well as the legacy attributes will be output.
2011-07-07 04:20:28 +00:00
<p>
Rather than putting the address information used to set up the
listening socket for graphics types <code>vnc</code>
and <code>spice</code> in
the <code>&lt;graphics&gt;</code> <code>listen</code> attribute,
a separate subelement of <code>&lt;graphics&gt;</code>,
called <code>&lt;listen&gt;</code> can be specified (see the
examples above)<span class="since">since
0.9.4</span>. <code>&lt;listen&gt;</code> accepts the following
attributes:
</p>
<dl>
<dt><code>type</code></dt>
<dd>Set to either <code>address</code>
or <code>network</code>. This tells whether this listen
element is specifying the address to be used directly, or by
naming a network (which will then be used to determine an
appropriate address for listening).
</dd>
</dl>
<dl>
<dt><code>address</code></dt>
<dd>if <code>type='address'</code>, the <code>address</code>
attribute will contain either an IP address or hostname (which
will be resolved to an IP address via a DNS query) to listen
on. In the "live" XML of a running domain, this attribute will
be set to the IP address used for listening, even
if <code>type='network'</code>.
</dd>
</dl>
<dl>
<dt><code>network</code></dt>
<dd>if <code>type='network'</code>, the <code>network</code>
attribute will contain the name of a network in libvirt's list
of configured networks. The named network configuration will
be examined to determine an appropriate listen address. For
example, if the network has an IPv4 address in its
configuration (e.g. if it has a forward type
of <code>route</code>, <code>nat</code>, or no forward type
(isolated)), the first IPv4 address listed in the network's
configuration will be used. If the network is describing a
host bridge, the first IPv4 address associated with that
bridge device will be used, and if the network is describing
one of the 'direct' (macvtap) modes, the first IPv4 address of
the first forward dev will be used.
</dd>
</dl>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
<h4><a name="elementsVideo">Video devices</a></h4>
<p>
A video device.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;video&gt;
&lt;model type='vga' vram='8192' heads='1'&gt;
docs: typo in acceleration element "accel3d" was specified twice, the second one is obviously "accel2d" (also from the text down below.
2012-05-28 10:44:32 +00:00
&lt;acceleration accel3d='yes' accel2d='yes'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/model&gt;
&lt;/video&gt;
&lt;/devices&gt;
...</pre>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
<dl>
<dt><code>video</code></dt>
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
<dd>
virterror.c: Fix several spelling mistakes compat{a->i}bility erron{->e}ous nec{c->}essary. Either "the" or "a". Signed-off-by: Philipp Hahn <hahn@univention.de>
2012-02-03 18:20:22 +00:00
The <code>video</code> element is the container for describing
video devices. For backwards compatibility, if no <code>video</code>
docs: Add doc for video element For backwards compatibility, if no <video> is set but there is a <graphics> tag, then we add a default <video> according to the guest type. Add docs to tell the user about this to not make them confused. Especially if they remove the video (such as via "virsh edit"), it will be surprised for them to see the video element is still in domain XML.
2011-06-07 08:56:06 +00:00
is set but there is a <code>graphics</code> in domain xml, then libvirt
will add a default <code>video</code> according to the guest type.
For a guest of type "kvm", the default <code>video</code> for it is:
<code>type</code> with value "cirrus", <code>vram</code> with value
conf: add optional attribte primary to video <model> element If there are multiple video devices primary = 'yes' marks this video device as the primary one. The rest are secondary video devices. No more than one could be mark as primary. If none of them has primary attribute, the first one will be the primary by default like what it was. The reason of this changing is that for qemu, only one primary video device is permitted which can be of any type. For secondary video devices, only qxl is allowd. Primary attribute removes the restriction that the first have to be the primary one. We always put the primary video device into the first position of video device structure array after parsing.
2012-12-17 06:01:20 +00:00
"9216", and <code>heads</code> with value "1". By default, the first
video device in domain xml is the primary one, but the optional
attribute <code>primary</code> (<span class="since">since 1.0.2</span>)
docs, comments: minor typo fixes Signed-off-by: Oskari Saarenmaa <os@ohmu.fi> Signed-off-by: Eric Blake <eblake@redhat.com>
2013-09-10 18:10:55 +00:00
with value 'yes' can be used to mark the primary in cases of multiple
qemu: Support ram bar size for qxl devices Adds a "ram" attribute globally to the video.model element, that changes the resulting qemu command line only if video.type == "qxl". <video> <model type='qxl' ram='65536' vram='65536' heads='1'/> </video> That attribute gets a default value of 64*1024. The schema is unchanged for other video element types. The resulting qemu command line change is the addition of -global qxl-vga.ram_size=<ram>*1024 or -global qxl.ram_size=<ram>*1024 For the main and secondary qxl devices respectively. The default for the qxl ram bar is 64*1024 kilobytes (the same as the default qxl vram bar size).
2013-01-18 18:36:36 +00:00
video device. The non-primary must be type of "qxl". The optional
attribute <code>ram</code> (<span class="since">since
1.0.2</span>) is allowed for "qxl" type only and specifies
the size of the primary bar, while <code>vram</code> specifies the
docs: Add missing 'vram' in QXL video device doc
2013-02-21 14:59:39 +00:00
secondary bar size. If "ram" or "vram" are not supplied a default
value is used.
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
</dd>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
<dt><code>model</code></dt>
<dd>
The <code>model</code> element has a mandatory <code>type</code>
docs: Document first release with spice and qxl
2011-03-17 16:04:35 +00:00
attribute which takes the value "vga", "cirrus", "vmvga", "xen",
"vbox", or "qxl" (<span class="since">since 0.8.6</span>)
depending on the hypervisor features available.
docs: use correct terminology for 1024 bytes Yes, I like kilobytes better than kibibytes (when I say kilobytes, I generally mean 1024). But since the term is ambiguous, it can't hurt to say what we mean, by using both the correct name and calling out the numeric equivalent. * src/libvirt.c (virDomainGetMaxMemory, virDomainSetMaxMemory) (virDomainSetMemory, virDomainSetMemoryFlags) (virNodeGetFreeMemory): Tweak wording. * docs/formatdomain.html.in: Likewise. * docs/formatstorage.html.in: Likewise.
2012-03-02 15:23:07 +00:00
You can also provide the amount of video memory in kibibytes
(blocks of 1024 bytes) using
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
<code>vram</code> and the number of screen with <code>heads</code>.
</dd>
<dt><code>acceleration</code></dt>
<dd>
If acceleration should be enabled (if supported) using the
<code>accel3d</code> and <code>accel2d</code> attributes in the
<code>acceleration</code> element.
</dd>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<dt><code>address</code></dt>
<dd>
The optional <code>address</code> sub-element can be used to
tie the video device to a particular PCI slot.
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
<h4><a name="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
A character device provides a way to interact with the virtual machine.
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
Paravirtualized consoles, serial ports, parallel ports and channels are
all classed as character devices and so represented using the same syntax.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;parallel type='pty'&gt;
&lt;source path='/dev/pts/2'/&gt;
&lt;target port='0'/&gt;
&lt;/parallel&gt;
&lt;serial type='pty'&gt;
&lt;source path='/dev/pts/3'/&gt;
&lt;target port='0'/&gt;
&lt;/serial&gt;
&lt;console type='pty'&gt;
&lt;source path='/dev/pts/4'/&gt;
&lt;target port='0'/&gt;
&lt;/console&gt;
&lt;channel type='unix'&gt;
&lt;source mode='bind' path='/tmp/guestfwd'/&gt;
&lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
&lt;/channel&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<p>
In each of these directives, the top-level element name (parallel, serial,
console, channel) describes how the device is presented to the guest. The
guest interface is configured by the <code>target</code> element.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<p>
The interface presented to the host is given in the <code>type</code>
attribute of the top-level element. The host interface is
configured by the <code>source</code> element.
</p>
Add <seclabel> to character devices. This allows the user to control labelling of each character device separately (the default is to inherit from the VM). Signed-off-by: Richard W.M. Jones <rjones@redhat.com>
2012-09-20 13:16:17 +00:00
<p>
The <code>source</code> element may contain an optional
<code>seclabel</code> to override the way that labelling
is done on the socket path. If this element is not present,
the <a href="#seclabel">security label is inherited from
the per-domain setting</a>.
</p>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<p>
Each character device element has an optional
sub-element <code>&lt;address&gt;</code> which can tie the
device to a
particular <a href="#elementsControllers">controller</a> or PCI
slot.
</p>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h5><a name="elementsCharGuestInterface">Guest interface</a></h5>
<p>
A character device presents itself to the guest as one of the following
types.
</p>
<h6><a name="elementCharParallel">Parallel port</a></h6>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;parallel type='pty'&gt;
&lt;source path='/dev/pts/2'/&gt;
&lt;target port='0'/&gt;
&lt;/parallel&gt;
&lt;/devices&gt;
...</pre>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<p>
<code>target</code> can have a <code>port</code> attribute, which
docs: Serial and parallel device target ports actually start from 0 Reported by Igor Galić
2011-04-10 13:03:42 +00:00
specifies the port number. Ports are numbered starting from 0. There are
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
usually 0, 1 or 2 parallel ports.
</p>
<h6><a name="elementCharSerial">Serial port</a></h6>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type='pty'&gt;
&lt;source path='/dev/pts/3'/&gt;
&lt;target port='0'/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<p>
<code>target</code> can have a <code>port</code> attribute, which
docs: Serial and parallel device target ports actually start from 0 Reported by Igor Galić
2011-04-10 13:03:42 +00:00
specifies the port number. Ports are numbered starting from 0. There are
qemu: add usb-serial support Add an optional 'type' attribute to <target> element of serial port device. There are two choices for its value, 'isa-serial' and 'usb-serial'. For backward compatibility, when attribute 'type' is missing the 'isa-serial' will be chosen as before. Libvirt XML sample <serial type='pty'> <target type='usb-serial' port='0'/> <address type='usb' bus='0' port='1'/> </serial> qemu commandline: qemu ${other_vm_args} \ -chardev pty,id=charserial0 \ -device usb-serial,chardev=charserial0,id=serial0,bus=usb.0,port=1
2013-01-05 05:25:36 +00:00
usually 0, 1 or 2 serial ports. There is also an optional
<code>type</code> attribute <span class="since">since 1.0.2</span>
docs: fix typo in isa-serial additions This was preventing make rpm from completing.
2013-01-10 19:26:11 +00:00
which has two choices for its value, one is <code>isa-serial</code>,
qemu: add usb-serial support Add an optional 'type' attribute to <target> element of serial port device. There are two choices for its value, 'isa-serial' and 'usb-serial'. For backward compatibility, when attribute 'type' is missing the 'isa-serial' will be chosen as before. Libvirt XML sample <serial type='pty'> <target type='usb-serial' port='0'/> <address type='usb' bus='0' port='1'/> </serial> qemu commandline: qemu ${other_vm_args} \ -chardev pty,id=charserial0 \ -device usb-serial,chardev=charserial0,id=serial0,bus=usb.0,port=1
2013-01-05 05:25:36 +00:00
the other is <code>usb-serial</code>. If <code>type</code> is missing,
<code>isa-serial</code> will be used by default. For <code>usb-serial</code>
an optional sub-element <code>&lt;address&gt;</code> with
<code>type='usb'</code> can tie the device to a particular controller,
<a href="#elementsAddress">documented above</a>.
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
</p>
<h6><a name="elementCharConsole">Console</a></h6>
<p>
Allow multiple consoles per virtual guest While Xen only has a single paravirt console, UML, and QEMU both support multiple paravirt consoles. The LXC driver can also be trivially made to support multiple consoles. This patch extends the XML to allow multiple <console> elements in the XML. It also makes the UML and QEMU drivers support this config. * src/conf/domain_conf.c, src/conf/domain_conf.h: Allow multiple <console> devices * src/lxc/lxc_driver.c, src/xen/xen_driver.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c: Update for internal API changes * src/security/security_selinux.c, src/security/virt-aa-helper.c: Only label consoles that aren't a copy of the serial device * src/qemu/qemu_command.c, src/qemu/qemu_driver.c, src/qemu/qemu_process.c, src/uml/uml_conf.c, src/uml/uml_driver.c: Support multiple console devices * tests/qemuxml2xmltest.c, tests/qemuxml2argvtest.c: Extra tests for multiple virtio consoles. Set QEMU_CAPS_CHARDEV for all console /channel tests * tests/qemuxml2argvdata/qemuxml2argv-channel-virtio-auto.args, tests/qemuxml2argvdata/qemuxml2argv-channel-virtio.args tests/qemuxml2argvdata/qemuxml2argv-console-virtio.args: Update for correct chardev syntax * tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.args, tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.xml: New test file
2011-02-23 18:27:23 +00:00
The console element is used to represent interactive consoles. Depending
on the type of guest in use, the consoles might be paravirtualized devices,
or they might be a clone of a serial device, according to the following
rules:
</p>
<ul>
S390: Add SCLP console front end support The SCLP console is the native console type for s390 and is preferred over the virtio console as it doesn't require special drivers and is more efficient. Recent versions of QEMU come with SCLP support which is hereby enabled. The new target types 'sclp' and 'sclplm' can be used to specify a SCLP console. Adding documentation, domain schema and XML processing support. Signed-off-by: J.B. Joret <jb@linux.vnet.ibm.com> Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2013-01-07 17:17:14 +00:00
<li>If no <code>targetType</code> attribute is set, then the default
Allow multiple consoles per virtual guest While Xen only has a single paravirt console, UML, and QEMU both support multiple paravirt consoles. The LXC driver can also be trivially made to support multiple consoles. This patch extends the XML to allow multiple <console> elements in the XML. It also makes the UML and QEMU drivers support this config. * src/conf/domain_conf.c, src/conf/domain_conf.h: Allow multiple <console> devices * src/lxc/lxc_driver.c, src/xen/xen_driver.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c: Update for internal API changes * src/security/security_selinux.c, src/security/virt-aa-helper.c: Only label consoles that aren't a copy of the serial device * src/qemu/qemu_command.c, src/qemu/qemu_driver.c, src/qemu/qemu_process.c, src/uml/uml_conf.c, src/uml/uml_driver.c: Support multiple console devices * tests/qemuxml2xmltest.c, tests/qemuxml2argvtest.c: Extra tests for multiple virtio consoles. Set QEMU_CAPS_CHARDEV for all console /channel tests * tests/qemuxml2argvdata/qemuxml2argv-channel-virtio-auto.args, tests/qemuxml2argvdata/qemuxml2argv-channel-virtio.args tests/qemuxml2argvdata/qemuxml2argv-console-virtio.args: Update for correct chardev syntax * tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.args, tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.xml: New test file
2011-02-23 18:27:23 +00:00
device type is according to the hypervisor's rules. The default
type will be added when re-querying the XML fed into libvirt.
For fully virtualized guests, the default device type will usually
be a serial port.</li>
<li>If the <code>targetType</code> attribute is <code>serial</code>,
then if no <code>&lt;serial&gt;</code> element exists, the console
element will be copied to the serial element. If a <code>&lt;serial&gt;</code>
element does already exist, the console element will be ignored.</li>
<li>If the <code>targetType</code> attribute is not <code>serial</code>,
it will be treated normally.</li>
<li>Only the first <code>console</code> element may use a <code>targetType</code>
of <code>serial</code>. Secondary consoles must all be paravirtualized.
</li>
S390: Add SCLP console front end support The SCLP console is the native console type for s390 and is preferred over the virtio console as it doesn't require special drivers and is more efficient. Recent versions of QEMU come with SCLP support which is hereby enabled. The new target types 'sclp' and 'sclplm' can be used to specify a SCLP console. Adding documentation, domain schema and XML processing support. Signed-off-by: J.B. Joret <jb@linux.vnet.ibm.com> Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2013-01-07 17:17:14 +00:00
<li>On s390, the <code>console</code> element may use a
<code>targetType</code> of <code>sclp</code> or <code>sclplm</code>
(line mode). SCLP is the native console type for s390. There's no
controller associated to SCLP consoles.
<span class="since">Since 1.0.2</span>
</li>
Allow multiple consoles per virtual guest While Xen only has a single paravirt console, UML, and QEMU both support multiple paravirt consoles. The LXC driver can also be trivially made to support multiple consoles. This patch extends the XML to allow multiple <console> elements in the XML. It also makes the UML and QEMU drivers support this config. * src/conf/domain_conf.c, src/conf/domain_conf.h: Allow multiple <console> devices * src/lxc/lxc_driver.c, src/xen/xen_driver.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c: Update for internal API changes * src/security/security_selinux.c, src/security/virt-aa-helper.c: Only label consoles that aren't a copy of the serial device * src/qemu/qemu_command.c, src/qemu/qemu_driver.c, src/qemu/qemu_process.c, src/uml/uml_conf.c, src/uml/uml_driver.c: Support multiple console devices * tests/qemuxml2xmltest.c, tests/qemuxml2argvtest.c: Extra tests for multiple virtio consoles. Set QEMU_CAPS_CHARDEV for all console /channel tests * tests/qemuxml2argvdata/qemuxml2argv-channel-virtio-auto.args, tests/qemuxml2argvdata/qemuxml2argv-channel-virtio.args tests/qemuxml2argvdata/qemuxml2argv-console-virtio.args: Update for correct chardev syntax * tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.args, tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.xml: New test file
2011-02-23 18:27:23 +00:00
</ul>
qemu: virtio console support Enable specifying a virtio console device with: <console type='pty'> <target type='virtio'/> </console>
2010-07-14 17:02:04 +00:00
<p>
A virtio console device is exposed in the
guest as /dev/hvc[0-7] (for more information, see
<a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>)
<span class="since">Since 0.8.3</span>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;console type='pty'&gt;
&lt;source path='/dev/pts/4'/&gt;
&lt;target port='0'/&gt;
&lt;/console&gt;
qemu: virtio console support Enable specifying a virtio console device with: <console type='pty'> <target type='virtio'/> </console>
2010-07-14 17:02:04 +00:00
&lt;!-- KVM virtio console --&gt;
&lt;console type='pty'&gt;
&lt;source path='/dev/pts/5'/&gt;
&lt;target type='virtio' port='0'/&gt;
&lt;/console&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
S390: Add SCLP console front end support The SCLP console is the native console type for s390 and is preferred over the virtio console as it doesn't require special drivers and is more efficient. Recent versions of QEMU come with SCLP support which is hereby enabled. The new target types 'sclp' and 'sclplm' can be used to specify a SCLP console. Adding documentation, domain schema and XML processing support. Signed-off-by: J.B. Joret <jb@linux.vnet.ibm.com> Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
2013-01-07 17:17:14 +00:00
<pre>
...
&lt;devices&gt;
&lt;!-- KVM s390 sclp console --&gt;
&lt;console type='pty'&gt;
&lt;source path='/dev/pts/1'/&gt;
&lt;target type='sclp' port='0'/&gt;
&lt;/console&gt;
&lt;/devices&gt;
...</pre>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<p>
If the console is presented as a serial port, the <code>target</code>
element has the same attributes as for a serial port. There is usually
only 1 console.
</p>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
<h6><a name="elementCharChannel">Channel</a></h6>
<p>
This represents a private communication channel between the host and the
guest.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;channel type='unix'&gt;
&lt;source mode='bind' path='/tmp/guestfwd'/&gt;
&lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
&lt;/channel&gt;
docs: domain: Document virtio <channel> Signed-off-by: Cole Robinson <crobinso@redhat.com>
2010-07-14 19:07:59 +00:00
&lt;!-- KVM virtio channel --&gt;
&lt;channel type='pty'&gt;
&lt;target type='virtio' name='arbitrary.virtio.serial.port.name'/&gt;
&lt;/channel&gt;
QEMU guest agent support There is now a standard QEMU guest agent that can be installed and given a virtio serial channel <channel type='unix'> <source mode='bind' path='/var/lib/libvirt/qemu/f16x86_64.agent'/> <target type='virtio' name='org.qemu.guest_agent.0'/> </channel> The protocol that runs over the guest agent is JSON based and very similar to the JSON monitor. We can't use exactly the same code because there are some odd differences in the way messages and errors are structured. The qemu_agent.c file is based on a combination and simplification of qemu_monitor.c and qemu_monitor_json.c * src/qemu/qemu_agent.c, src/qemu/qemu_agent.h: Support for talking to the agent for shutdown * src/qemu/qemu_domain.c, src/qemu/qemu_domain.h: Add thread helpers for talking to the agent * src/qemu/qemu_process.c: Connect to agent whenever starting a guest * src/qemu/qemu_monitor_json.c: Make variable static
2011-10-05 17:31:54 +00:00
&lt;channel type='unix'&gt;
&lt;source mode='bind' path='/var/lib/libvirt/qemu/f16x86_64.agent'/&gt;
&lt;target type='virtio' name='org.qemu.guest_agent.0'/&gt;
&lt;/channel&gt;
spicevmc: support new qemu chardev Inspired by https://bugzilla.redhat.com/show_bug.cgi?id=615757 Add a new character device backend for virtio serial channels that activates the QEMU spice agent on the main channel using the vdagent spicevmc connection. The <target> must be type='virtio', and supports an optional name that specifies how the guest will see the channel (for now, name must be com.redhat.spice.0). <channel type='spicevmc'> <target type='virtio'/> <address type='virtio-serial' controller='1' bus='0' port='3'/> </channel> * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainChrType): New enum value. * src/conf/domain_conf.c (virDomainChr): Add spicevmc. (virDomainChrDefParseXML, virDomainChrSourceDefParseXML) (virDomainChrDefParseTargetXML): Parse and enforce proper use. (virDomainChrSourceDefFormat, virDomainChrDefFormat): Format. * src/qemu/qemu_command.c (qemuBuildChrChardevStr) (qemuBuildCommandLine): Add qemu support. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.xml: New file. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.args: Likewise. Signed-off-by: Eric Blake <eblake@redhat.com>
2011-02-03 04:09:44 +00:00
&lt;channel type='spicevmc'&gt;
&lt;target type='virtio' name='com.redhat.spice.0'/&gt;
&lt;/channel&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
<p>
This can be implemented in a variety of ways. The specific type of
channel is given in the <code>type</code> attribute of the
<code>target</code> element. Different channel types have different
<code>target</code> attributes.
</p>
<dl>
<dt><code>guestfwd</code></dt>
<dd>TCP traffic sent by the guest to a given IP address and port is
forwarded to the channel device on the host. The <code>target</code>
element must have <code>address</code> and <code>port</code> attributes.
<span class="since">Since 0.7.3</span></dd>
docs: domain: Document virtio <channel> Signed-off-by: Cole Robinson <crobinso@redhat.com>
2010-07-14 19:07:59 +00:00
<dt><code>virtio</code></dt>
<dd>Paravirtualized virtio channel. Channel is exposed in the guest under
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
/dev/vport*, and if the optional element <code>name</code> is specified,
docs: domain: Document virtio <channel> Signed-off-by: Cole Robinson <crobinso@redhat.com>
2010-07-14 19:07:59 +00:00
/dev/virtio-ports/$name (for more info, please see
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>). The
optional element <code>address</code> can tie the channel to a
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
particular <code>type='virtio-serial'</code>
controller, <a href="#elementsAddress">documented above</a>.
QEMU guest agent support There is now a standard QEMU guest agent that can be installed and given a virtio serial channel <channel type='unix'> <source mode='bind' path='/var/lib/libvirt/qemu/f16x86_64.agent'/> <target type='virtio' name='org.qemu.guest_agent.0'/> </channel> The protocol that runs over the guest agent is JSON based and very similar to the JSON monitor. We can't use exactly the same code because there are some odd differences in the way messages and errors are structured. The qemu_agent.c file is based on a combination and simplification of qemu_monitor.c and qemu_monitor_json.c * src/qemu/qemu_agent.c, src/qemu/qemu_agent.h: Support for talking to the agent for shutdown * src/qemu/qemu_domain.c, src/qemu/qemu_domain.h: Add thread helpers for talking to the agent * src/qemu/qemu_process.c: Connect to agent whenever starting a guest * src/qemu/qemu_monitor_json.c: Make variable static
2011-10-05 17:31:54 +00:00
With qemu, if <code>name</code> is "org.qemu.guest_agent.0",
then libvirt can interact with a guest agent installed in the
guest, for actions such as guest shutdown or file system quiescing.
<span class="since">Since 0.7.7, guest agent interaction
docs: fix 'since' for socket path generation Commit 297c99a says it works from 1.0.5 but it only got pushed after the 1.0.5 release.
2013-05-03 07:24:00 +00:00
since 0.9.10</span> Moreover, <span class="since">since 1.0.6</span>
qemu: Generate agent socket path if missing It's not desired to force users imagine path for a socket they are not even supposed to connect to. On the other hand, we already have a release where the qemu agent socket path is exposed to XML, so we cannot silently drop it from there. The new path is generated in form: $LOCALSTATEDIR/lib/libvirt/qemu/channel/target/$domain.$name for qemu system mode, and $XDG_CONFIG_HOME/qemu/lib/channel/target/$domain.$name for qemu session mode.
2013-04-09 17:04:00 +00:00
it is possible to have source path auto generated for virtio unix channels.
This is very useful in case of a qemu guest agent, where users don't
usually care about the source path since it's libvirt who talks to
the guest agent. In case users want to utilize this feature, they should
leave <code>&lt;source&gt;</code> element out.
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
</dd>
spicevmc: support new qemu chardev Inspired by https://bugzilla.redhat.com/show_bug.cgi?id=615757 Add a new character device backend for virtio serial channels that activates the QEMU spice agent on the main channel using the vdagent spicevmc connection. The <target> must be type='virtio', and supports an optional name that specifies how the guest will see the channel (for now, name must be com.redhat.spice.0). <channel type='spicevmc'> <target type='virtio'/> <address type='virtio-serial' controller='1' bus='0' port='3'/> </channel> * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainChrType): New enum value. * src/conf/domain_conf.c (virDomainChr): Add spicevmc. (virDomainChrDefParseXML, virDomainChrSourceDefParseXML) (virDomainChrDefParseTargetXML): Parse and enforce proper use. (virDomainChrSourceDefFormat, virDomainChrDefFormat): Format. * src/qemu/qemu_command.c (qemuBuildChrChardevStr) (qemuBuildCommandLine): Add qemu support. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.xml: New file. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.args: Likewise. Signed-off-by: Eric Blake <eblake@redhat.com>
2011-02-03 04:09:44 +00:00
<dt><code>spicevmc</code></dt>
<dd>Paravirtualized SPICE channel. The domain must also have a
SPICE server as a <a href="#elementsGraphics">graphics
device</a>, at which point the host piggy-backs messages
across the <code>main</code> channel. The <code>target</code>
element must be present, with
attribute <code>type='virtio'</code>; an optional
attribute <code>name</code> controls how the guest will have
access to the channel, and defaults
to <code>name='com.redhat.spice.0'</code>. The
optional <code>address</code> element can tie the channel to a
particular <code>type='virtio-serial'</code> controller.
<span class="since">Since 0.8.8</span></dd>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
</dl>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h5><a name="elementsCharHostInterface">Host interface</a></h5>
<p>
A character device presents itself to the host as one of the following
types.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharSTDIO">Domain logfile</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
This disables all input on the character device, and sends output
into the virtual machine's logfile
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;console type='stdio'&gt;
docs: fix missing / in xml examples * docs/formatdomain.html.in: Fix typos in examples.
2011-12-22 17:48:53 +00:00
&lt;target port='1'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/console&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharFle">Device logfile</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
A file is opened and all data sent to the character
device is written to the file.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="file"&gt;
&lt;source path="/var/log/vm/vm-serial.log"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharVC">Virtual console</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
Connects the character device to the graphical framebuffer in
a virtual console. This is typically accessed via a special
hotkey sequence such as "ctrl+alt+3"
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type='vc'&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharNull">Null device</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
Connects the character device to the void. No data is ever
provided to the input. All data written is discarded.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type='null'&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharPTY">Pseudo TTY</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
A Pseudo TTY is allocated using /dev/ptmx. A suitable client
such as 'virsh console' can connect to interact with the
serial port locally.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="pty"&gt;
&lt;source path="/dev/pts/3"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
NB special case if &lt;console type='pty'&gt;, then the TTY
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
path is also duplicated as an attribute tty='/dev/pts/3'
Update domain XML docs
2008-05-08 14:20:07 +00:00
on the top level &lt;console&gt; tag. This provides compat
with existing syntax for &lt;console&gt; tags.
</p>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharHost">Host device proxy</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
The character device is passed through to the underlying
physical character device. The device types must match,
eg the emulated serial port should only be connected to
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
a host serial port - don't connect a serial port to a parallel
Update domain XML docs
2008-05-08 14:20:07 +00:00
port.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="dev"&gt;
&lt;source path="/dev/ttyS0"/&gt;
&lt;target port="1"/&gt;
docs: fix some typos in examples As detected in https://bugzilla.redhat.com/show_bug.cgi?id=887187 * docs/formatdomain.html.in: Fix XML typos.
2012-12-14 15:28:57 +00:00
&lt;/serial&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharPipe">Named pipe</a></h6>
Fix docs and code disagreements for character devices. The 'pipe' character type wasn't documented. TCP uses a <protocol> element, not <wire> We weren't doing strict validation for protocol and source mode values.
2009-07-08 21:59:23 +00:00
<p>
The character device writes output to a named pipe. See pipe(7) for
more info.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="pipe"&gt;
&lt;source path="/tmp/mypipe"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Fix docs and code disagreements for character devices. The 'pipe' character type wasn't documented. TCP uses a <protocol> element, not <wire> We weren't doing strict validation for protocol and source mode values.
2009-07-08 21:59:23 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharTCP">TCP client/server</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
The character device acts as a TCP client connecting to a
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
remote server.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="tcp"&gt;
&lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
&lt;protocol type="raw"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
<p>
Or as a TCP server waiting for a client connection.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="tcp"&gt;
&lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
&lt;protocol type="raw"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
Alternatively you can use <code>telnet</code> instead
of <code>raw</code> TCP. <span class="since">Since 0.8.5</span>
you can also use <code>telnets</code>
esx: Add support for virtual serial device network backing Since version 4.1 ESX(i) can expose virtual serial devices over TCP. Add support in the VMX handling code for this, add test cases to cover it and add links to some documentation. ESX supports two additional protocols: TELNETS and TLS. Add them to the list of serial-over-TCP protocols.
2010-09-29 21:04:19 +00:00
(secure telnet) and <code>tls</code>.
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
</p>
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="tcp"&gt;
&lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
&lt;protocol type="telnet"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
...
&lt;serial type="tcp"&gt;
&lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
&lt;protocol type="telnet"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharUDP">UDP network console</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
The character device acts as a UDP netconsole service,
sending and receiving packets. This is a lossy service.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="udp"&gt;
&lt;source mode="bind" host="0.0.0.0" service="2445"/&gt;
&lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharUNIX">UNIX domain socket client/server</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
The character device acts as a UNIX domain socket server,
accepting connections from local clients.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="unix"&gt;
&lt;source mode="bind" path="/tmp/foo"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add documentation for <sound> device XML format.
2009-05-19 13:18:00 +00:00
<h4><a name="elementsSound">Sound devices</a></h4>
<p>
A virtual sound card can be attached to the host via the
<code>sound</code> element. <span class="since">Since 0.4.3</span>
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;sound model='es1370'/&gt;
&lt;/devices&gt;
...</pre>
Add documentation for <sound> device XML format.
2009-05-19 13:18:00 +00:00
<dl>
<dt><code>sound</code></dt>
<dd>
The <code>sound</code> element has one mandatory attribute,
<code>model</code>, which specifies what real sound device is emulated.
Valid values are specific to the underlying hypervisor, though typical
qemu: sound: Support intel 'ich6' model In QEMU, the card itself is a PCI device, but it requires a codec (either -device hda-output or -device hda-duplex) to actually output sound. Specifying <sound model='ich6'/> gives us -device intel-hda -device hda-duplex I think it's important that a simple <sound model='ich6'/> sets up a useful codec, to have consistent behavior with all other sound cards. This is basically Dan's proposal of <sound model='ich6'> <codec type='output' slot='0'/> <codec type='duplex' slot='3'/> </sound> without the codec bits implemented. The important thing is to keep a consistent API here, we don't want some <sound> devs require tweaking codecs but not others. Steps I see to accomplishing this: - every <sound> device has a <codec type='default'/> (unless codecs are manually specified) - <codec type='none'/> is required to specify 'no codecs' - new audio settings like mic=on|off could then be exposed in <sound> or <codec> in a consistent manner for all sound models v2: Use model='ich6' v3: Use feature detection, from eblake Set codec id, bus, and cad values v4: intel-hda isn't supported if -device isn't available v5: Comment spelling fixes
2011-01-13 14:15:11 +00:00
choices are 'es1370', 'sb16', 'ac97', and 'ich6'
(<span class="since">
'ac97' only since 0.6.0, 'ich6' only since 0.8.8</span>)
Add documentation for <sound> device XML format.
2009-05-19 13:18:00 +00:00
</dd>
</dl>
domain: add <codec> sound sub-element Allow specifying sound device codecs. See formatdomain.html for more details.
2012-05-15 22:55:09 +00:00
<p>
<span class="since">Since 0.9.13</span>, a sound element
with <code>ich6</code> model can have optional
sub-elements <code>&lt;codec&gt;</code> to attach various audio
codecs to the audio device. If not specified, a default codec
will be attached to allow playback and recording. Valid values
are 'duplex' (advertise a line-in and a line-out) and 'micro'
(advertise a speaker and a microphone).
</p>
<pre>
...
&lt;devices&gt;
&lt;sound model='ich6'&gt;
&lt;codec type='micro'/&gt;
&lt;sound/&gt;
&lt;/devices&gt;
...</pre>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<p>
Each <code>sound</code> element has an optional
sub-element <code>&lt;address&gt;</code> which can tie the
docs: document <address> elements in one place Improve the documentation of what forms a valid <address> element, since these elements appear in numerous devices. * docs/formatdomain.html.in (elementsAddress): New section. (elementsControllers, elementsUSB, elementsNICS, elementsInput) (elementsHub, elementsCharChannel, elementsSound): Refer to it.
2011-12-09 23:33:51 +00:00
device to a particular PCI
slot, <a href="#elementsAddress">documented above</a>.
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</p>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
<h4><a name="elementsWatchdog">Watchdog device</a></h4>
<p>
A virtual hardware watchdog device can be added to the guest via
the <code>watchdog</code> element.
<span class="since">Since 0.7.3, QEMU and KVM only</span>
</p>
<p>
The watchdog device requires an additional driver and management
daemon in the guest. Just enabling the watchdog in the libvirt
configuration does not do anything useful on its own.
</p>
<p>
Currently libvirt does not support notification when the
watchdog fires. This feature is planned for a future version of
libvirt.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;watchdog model='i6300esb'/&gt;
&lt;/devices&gt;
...</pre>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;watchdog model='i6300esb' action='poweroff'/&gt;
&lt;/devices&gt;
&lt;/domain&gt;</pre>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
<dl>
<dt><code>model</code></dt>
<dd>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<p>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
The required <code>model</code> attribute specifies what real
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
watchdog device is emulated. Valid values are specific to the
underlying hypervisor.
</p>
<p>
QEMU and KVM support:
</p>
<ul>
<li> 'i6300esb' &mdash; the recommended device,
emulating a PCI Intel 6300ESB </li>
<li> 'ib700' &mdash; emulating an ISA iBase IB700 </li>
</ul>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
</dd>
<dt><code>action</code></dt>
<dd>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<p>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
The optional <code>action</code> attribute describes what
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
action to take when the watchdog expires. Valid values are
specific to the underlying hypervisor.
</p>
<p>
QEMU and KVM support:
</p>
<ul>
<li>'reset' &mdash; default, forcefully reset the guest</li>
<li>'shutdown' &mdash; gracefully shutdown the guest
(not recommended) </li>
<li>'poweroff' &mdash; forcefully power off the guest</li>
<li>'pause' &mdash; pause the guest</li>
<li>'none' &mdash; do nothing</li>
Update documentation of watchdog dump option and add test data for it The xml watchdog dump option is converted to qemu watchdog pause arg but it is not reasonable to convert it back from qemu watchdog pause arg since there already is a xml watchdog pause option, so a test for the dump option to convert it from arg to xml is not added.
2010-12-10 05:52:11 +00:00
<li>'dump' &mdash; automatically dump the guest
<span class="since">Since 0.8.7</span></li>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
</ul>
<p>
Update documentation of watchdog dump option and add test data for it The xml watchdog dump option is converted to qemu watchdog pause arg but it is not reasonable to convert it back from qemu watchdog pause arg since there already is a xml watchdog pause option, so a test for the dump option to convert it from arg to xml is not added.
2010-12-10 05:52:11 +00:00
Note 1: the 'shutdown' action requires that the guest
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
is responsive to ACPI signals. In the sort of situations
where the watchdog has expired, guests are usually unable
to respond to ACPI signals. Therefore using 'shutdown'
is not recommended.
</p>
Update documentation of watchdog dump option and add test data for it The xml watchdog dump option is converted to qemu watchdog pause arg but it is not reasonable to convert it back from qemu watchdog pause arg since there already is a xml watchdog pause option, so a test for the dump option to convert it from arg to xml is not added.
2010-12-10 05:52:11 +00:00
<p>
Note 2: the directory to save dump files can be configured
by <code>auto_dump_path</code> in file /etc/libvirt/qemu.conf.
</p>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
</dd>
</dl>
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
<h4><a name="elementsMemBalloon">Memory balloon device</a></h4>
<p>
A virtual memory balloon device is added to all Xen and KVM/QEMU
guests. It will be seen as <code>memballoon</code> element.
It will be automatically added when appropriate, so there is no
need to explicitly add this element in the guest XML unless a
specific PCI slot needs to be assigned.
<span class="since">Since 0.8.3, Xen, QEMU and KVM only</span>
docs: document how to disable memballoon https://bugzilla.redhat.com/show_bug.cgi?id=623903 documents a qemu bug that causes libvirt to hang if virt-manager happens to be querying balloon info when a guest is paused. Until the qemu bug is fixed, people need to know how to avoid the issue. * docs/formatdomain.html.in (Memory balloon device): Mention model='none'.
2010-10-15 19:34:24 +00:00
Additionally, <span class="since">since 0.8.4</span>, if the
memballoon device needs to be explicitly disabled,
<code>model='none'</code> may be used.
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
</p>
<p>
docs: fix memballoon examples Use a pair of 'memballoon' tags instead of single 'watchdog' one. Add a few missing colons.
2013-04-25 16:53:07 +00:00
Example: automatically added device with KVM
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
</p>
<pre>
...
&lt;devices&gt;
&lt;memballoon model='virtio'/&gt;
&lt;/devices&gt;
...</pre>
<p>
docs: fix memballoon examples Use a pair of 'memballoon' tags instead of single 'watchdog' one. Add a few missing colons.
2013-04-25 16:53:07 +00:00
Example: manually added device with static PCI slot 2 requested
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
</p>
<pre>
...
&lt;devices&gt;
docs: fix memballoon examples Use a pair of 'memballoon' tags instead of single 'watchdog' one. Add a few missing colons.
2013-04-25 16:53:07 +00:00
&lt;memballoon model='virtio'&gt;
&lt;address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/&gt;
Add 'period' for Memballoon statistics gathering capability Add a period in seconds to allow/enable statistics gathering from the Balloon driver for 'virsh dommemstat <domain>'.
2013-06-26 11:00:00 +00:00
&lt;stats period='10'/&gt;
docs: fix memballoon examples Use a pair of 'memballoon' tags instead of single 'watchdog' one. Add a few missing colons.
2013-04-25 16:53:07 +00:00
&lt;/memballoon&gt;
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
&lt;/devices&gt;
&lt;/domain&gt;</pre>
<dl>
<dt><code>model</code></dt>
<dd>
<p>
The required <code>model</code> attribute specifies what type
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
of balloon device is provided. Valid values are specific to
the virtualization platform
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
</p>
<ul>
<li>'virtio' &mdash; default with QEMU/KVM</li>
<li>'xen' &mdash; default with Xen</li>
</ul>
</dd>
Add 'period' for Memballoon statistics gathering capability Add a period in seconds to allow/enable statistics gathering from the Balloon driver for 'virsh dommemstat <domain>'.
2013-06-26 11:00:00 +00:00
<dt><code>period</code></dt>
<dd>
<p>
The optional <code>period</code> allows the QEMU virtio memory
balloon driver to provide statistics through the <code>virsh
Allow balloon driver collection to be adjusted dynamically Use the virDomainSetMemoryStatsPeriodFlags() to pass a period defined by usage of a new --period option in order to set the collection period for the balloon driver. This may enable or disable the collection based on the value. Add the --current, --live, & --config options to dommemstat.
2013-07-08 17:19:43 +00:00
dommemstat [domain]</code> command. By default, collection is
not enabled. In order to enable, use the <code>virsh dommemstat
[domain] --period [number]</code> command or <code>virsh edit</code>
command to add the option to the XML definition.
The <code>virsh dommemstat</code> will accept the options
<code>--live</code>, <code>--current</code>, or <code>--config</code>.
If an option is not provided, the change for a running domain will
only be made to the active guest.
If the QEMU driver is not at the right
revision, the attempt to set the period will fail.
Add 'period' for Memballoon statistics gathering capability Add a period in seconds to allow/enable statistics gathering from the Balloon driver for 'virsh dommemstat <domain>'.
2013-06-26 11:00:00 +00:00
<span class='since'>Since 1.1.1, requires QEMU 1.5</span>
</p>
</dd>
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
</dl>
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
<h4><a name="elementsRng">Random number generator device</a></h4>
<p>
The virtual random number generator device allows the host to pass
through entropy to guest operating systems.
<span class="since">Since 1.0.3</span>
</p>
<p>
Example: usage of the RNG device:
</p>
<pre>
...
&lt;devices&gt;
&lt;rng model='virtio'&gt;
virtio-rng: Add rate limiting options for virtio-RNG Qemu's implementation of virtio RNG supports rate limiting of the entropy used. This patch exposes the option to tune this functionality. This patch is based on qemu commit 904d6f588063fb5ad2b61998acdf1e73fb4 The rate limiting is exported in the XML as: <devices> ... <rng model='virtio'> <rate bytes='123' period='1234'/> <backend model='random'/> </rng> ...
2013-02-13 14:37:39 +00:00
&lt;rate period="2000" bytes="1234"/&gt;
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
&lt;backend model='random'&gt;/dev/random&lt;/backend&gt;
&lt;!-- OR --&gt;
&lt;backend model='egd' type='udp'&gt;
doc: fix XML for the RNG device example Add a missing '/' to close the "source" element. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2013-09-18 15:12:18 +00:00
&lt;source mode='bind' service='1234'/&gt;
&lt;source mode='connect' host='1.2.3.4' service='1234'/&gt;
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
&lt;/backend&gt;
&lt;/rng&gt;
&lt;/devices&gt;
...
</pre>
<dl>
<dt><code>model</code></dt>
<dd>
<p>
The required <code>model</code> attribute specifies what type
of RNG device is provided. Valid values are specific to
the virtualization platform:
</p>
<ul>
<li>'virtio' &mdash; supported by qemu and virtio-rng kernel module</li>
</ul>
</dd>
virtio-rng: Add rate limiting options for virtio-RNG Qemu's implementation of virtio RNG supports rate limiting of the entropy used. This patch exposes the option to tune this functionality. This patch is based on qemu commit 904d6f588063fb5ad2b61998acdf1e73fb4 The rate limiting is exported in the XML as: <devices> ... <rng model='virtio'> <rate bytes='123' period='1234'/> <backend model='random'/> </rng> ...
2013-02-13 14:37:39 +00:00
<dt><code>rate</code></dt>
<dd>
<p>
The optional <code>rate</code> element allows limiting the rate at
which entropy can be consumed from the source. The mandatory
attribute <code>bytes</code> specifies how many bytes are permitted
to be consumed per period. An optional <code>period</code> attribute
specifies the duration of a period in milliseconds; if omitted, the
period is taken as 1000 milliseconds (1 second).
<span class='since'>Since 1.0.4</span>
</p>
</dd>
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
<dt><code>backend</code></dt>
<dd>
<p>
The <code>backend</code> element specifies the source of entropy
to be used for the domain. The source model is configured using the
<code>model</code> attribute. Supported source models are:
</p>
<ul>
rng: restrict passthrough names to known-good files There is some controversy[1] on the qemu list on whether qemu should have ever allowed arbitrary file name passthrough, or whether it should be restricted to JUST /dev/random and /dev/hwrng. It is always easier to add support for additional filenames than it is to remove support for something once released, so this patch restricts libvirt 1.0.3 (where the virtio-random backend was first supported) to just the two uncontroversial names, letting us defer to a later date any decision on whether supporting arbitrary files makes sense. Additionally, since qemu 1.4 does NOT support /dev/fdset/nnn fd passthrough for the backend, limiting to just two known names means that we don't get tempted to try fd passthrough where it won't work. [1]https://lists.gnu.org/archive/html/qemu-devel/2013-03/threads.html#00023 * src/conf/domain_conf.c (virDomainRNGDefParseXML): Only allow /dev/random and /dev/hwrng. * docs/schemas/domaincommon.rng: Flag invalid files. * docs/formatdomain.html.in (elementsRng): Document this. * tests/qemuxml2argvdata/qemuxml2argv-virtio-rng-random.args: Update test to match. * tests/qemuxml2argvdata/qemuxml2argv-virtio-rng-random.xml: Likewise.
2013-03-04 22:42:07 +00:00
<li>'random' &mdash; /dev/random (default) or /dev/hwrng
device as source (for now, no other sources are permitted)</li>
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
<li>'egd' &mdash; a EGD protocol backend</li>
</ul>
</dd>
docs: Fix attribute name for virtio-rng backend
2013-02-25 22:03:21 +00:00
<dt><code>backend model='random'</code></dt>
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
<dd>
<p>
This backend type expects a non-blocking character device as input.
docs: domain: /dev/urandom isn't a valid rng patch Only /dev/random and /dev/hwrng are accepted, list them explicitly.
2013-05-23 18:37:08 +00:00
The only accepted paths are /dev/random and /dev/hwrng. The file
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
name is specified as contents of the <code>backend</code> element.
When no file name is specified the hypervisor default is used.
</p>
</dd>
docs: Fix attribute name for virtio-rng backend
2013-02-25 22:03:21 +00:00
<dt><code>backend model='egd'</code></dt>
doc: schema: Add basic documentation for the virtual RNG device support This patch documents XML elements used for (basic) support of virtual RNG devices. In the devices section in the domain XML users may specify: For the default 'random' backend: <devices> <rng model='virtio'> <backend model='random'>/dev/urandom</backend> </rng> </devices> For the slightly more advanced EGD backend: <devices> <rng model='virtio'> <backend model='egd' type='udp'> <!-- this is a definition of a character device --> <source mode='bind' service='1234'/> <source mode='connect' host='1.2.3.4' service='1234'/> <!-- or other valid character device configuration --> </backend> </rng> </devices> For the planned random daemon/pool: <devices> <rng model='virtio'> <backend model='pool' pool='poolname'>class</backend> </rng> </devices> to enable the RNG device for guests.
2012-12-20 11:06:52 +00:00
<dd>
<p>
This backend connects to a source using the EGD protocol.
The source is specified as a character device. Refer to
<a href='#elementsCharHostInterface'>character device host interface</a>
for more information.
</p>
</dd>
</dl>
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
Add documentation and schema for TPM passthrough Supported TPM passthrough XML may look as follows: <tpm model='tpm-tis'> <backend type='passthrough'> <device path='/dev/tpm0'/> </backend> </tpm> Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com> Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com> Tested-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
2013-04-12 20:55:45 +00:00
<h4><a name="elementsTpm">TPM device</a></h4>
<p>
The TPM device enables a QEMU guest to have access to TPM
functionality.
</p>
<p>
The TPM passthrough device type provides access to the host's TPM
for one QEMU guest. No other software may be is using the TPM device,
typically /dev/tpm0, at the time the QEMU guest is started.
<span class="since">'passthrough' since 1.0.5</span>
</p>
<p>
Example: usage of the TPM passthrough device
</p>
<pre>
...
&lt;devices&gt;
&lt;tpm model='tpm-tis'&gt;
&lt;backend type='passthrough'&gt;
Fix sample TPM XML Fix an error in the sample TPM XML. Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
2013-06-26 12:29:08 +00:00
&lt;device path='/dev/tpm0'/&gt;
Add documentation and schema for TPM passthrough Supported TPM passthrough XML may look as follows: <tpm model='tpm-tis'> <backend type='passthrough'> <device path='/dev/tpm0'/> </backend> </tpm> Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com> Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com> Tested-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
2013-04-12 20:55:45 +00:00
&lt;/backend&gt;
&lt;/tpm&gt;
&lt;/devices&gt;
...
</pre>
<dl>
<dt><code>model</code></dt>
<dd>
<p>
The <code>model</code> attribute specifies what device
model QEMU provides to the guest. If no model name is provided,
<code>tpm-tis</code> will automatically be chosen.
</p>
</dd>
<dt><code>backend</code></dt>
<dd>
<p>
The <code>backend</code> element specifies the type of
TPM device. The following types are supported:
</p>
<ul>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
<li>'passthrough' &mdash; use the host's TPM device.</li>
Add documentation and schema for TPM passthrough Supported TPM passthrough XML may look as follows: <tpm model='tpm-tis'> <backend type='passthrough'> <device path='/dev/tpm0'/> </backend> </tpm> Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com> Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com> Tested-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
2013-04-12 20:55:45 +00:00
</ul>
</dd>
<dt><code>backend type='passthrough'</code></dt>
<dd>
<p>
This backend type requires exclusive access to a TPM device on
the host.
An example for such a device is /dev/tpm0. The filename is
specified as path attribute of the <code>source</code> element.
If no file name is specified then /dev/tpm0 is automatically used.
</p>
</dd>
</dl>
Add NVRAM device For pSeries guest in QEMU, NVRAM is one kind of spapr-vio device. Users are allowed to specify spapr-vio devices'address. But NVRAM is not supported in libvirt. So this patch is to add NVRAM device to allow users to specify its address. In QEMU, NVRAM device's address is specified by "-global spapr-nvram.reg=xxxxx". In libvirt, XML file is defined as the following: <nvram> <address type='spapr-vio' reg='0x3000'/> </nvram> Signed-off-by: Li Zhang <zhlcindy@linux.vnet.ibm.com>
2013-04-19 08:37:51 +00:00
<h4><a name="elementsNVRAM">NVRAM device</a></h4>
<p>
nvram device is always added to pSeries guest on PPC64, and its address
is allowed to be changed. Element <code>nvram</code> (only valid for
pSeries guest, <span class="since">since 1.0.5</span>) is provided to
enable the address setting.
</p>
<p>
Example: usage of NVRAM configuration
</p>
<pre>
...
&lt;devices&gt;
&lt;nvram&gt;
&lt;address type='spapr-vio' reg='0x3000'/&gt;
&lt;/nvram&gt;
&lt;/devices&gt;
...
</pre>
<dl>
<dt><code>spapr-vio</code></dt>
<dd>
<p>
VIO device address type, only valid for PPC64.
</p>
</dd>
<dt><code>reg</code></dt>
<dd>
<p>
Device address
</p>
</dd>
</dl>
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
<h3><a name="seclabel">Security label</a></h3>
<p>
The <code>seclabel</code> element allows control over the
Add two new security label types Curently security labels can be of type 'dynamic' or 'static'. If no security label is given, then 'dynamic' is assumed. The current code takes advantage of this default, and avoids even saving <seclabel> elements with type='dynamic' to disk. This means if you temporarily change security driver, the guests can all still start. With the introduction of sVirt to LXC though, there needs to be a new default of 'none' to allow unconfined LXC containers. This patch introduces two new security label types - default: the host configuration decides whether to run the guest with type 'none' or 'dynamic' at guest start - none: the guest will run unconfined by security policy The 'none' label type will obviously be undesirable for some deployments, so a new qemu.conf option allows a host admin to mandate confined guests. It is also possible to turn off default confinement security_default_confined = 1|0 (default == 1) security_require_confined = 1|0 (default == 0) * src/conf/domain_conf.c, src/conf/domain_conf.h: Add new seclabel types * src/security/security_manager.c, src/security/security_manager.h: Set default sec label types * src/security/security_selinux.c: Handle 'none' seclabel type * src/qemu/qemu.conf, src/qemu/qemu_conf.c, src/qemu/qemu_conf.h, src/qemu/libvirtd_qemu.aug: New security config options * src/qemu/qemu_driver.c: Tell security driver about default config
2012-01-25 14:12:52 +00:00
operation of the security drivers. There are three basic
modes of operation, 'dynamic' where libvirt automatically
generates a unique security label, 'static' where the
application/administrator chooses the labels, or 'none'
where confinement is disabled. With dynamic
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
label generation, libvirt will always automatically
relabel any resources associated with the virtual machine.
With static label assignment, by default, the administrator
or application must ensure labels are set correctly on any
resources, however, automatic relabeling can be enabled
Add two new security label types Curently security labels can be of type 'dynamic' or 'static'. If no security label is given, then 'dynamic' is assumed. The current code takes advantage of this default, and avoids even saving <seclabel> elements with type='dynamic' to disk. This means if you temporarily change security driver, the guests can all still start. With the introduction of sVirt to LXC though, there needs to be a new default of 'none' to allow unconfined LXC containers. This patch introduces two new security label types - default: the host configuration decides whether to run the guest with type 'none' or 'dynamic' at guest start - none: the guest will run unconfined by security policy The 'none' label type will obviously be undesirable for some deployments, so a new qemu.conf option allows a host admin to mandate confined guests. It is also possible to turn off default confinement security_default_confined = 1|0 (default == 1) security_require_confined = 1|0 (default == 0) * src/conf/domain_conf.c, src/conf/domain_conf.h: Add new seclabel types * src/security/security_manager.c, src/security/security_manager.h: Set default sec label types * src/security/security_selinux.c: Handle 'none' seclabel type * src/qemu/qemu.conf, src/qemu/qemu_conf.c, src/qemu/qemu_conf.h, src/qemu/libvirtd_qemu.aug: New security config options * src/qemu/qemu_driver.c: Tell security driver about default config
2012-01-25 14:12:52 +00:00
if desired. <span class="since">'dynamic' since 0.6.1, 'static'
since 0.6.2, and 'none' since 0.9.10.</span>
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
</p>
Multiple security drivers in XML data This patch updates the domain and capability XML parser and formatter to support more than one "seclabel" element for each domain and device. The RNG schema and the tests related to this are also updated by this patch. Signed-off-by: Marcelo Cerri <mhcerri@linux.vnet.ibm.com>
2012-08-15 22:10:36 +00:00
<p>
If more than one security driver is used by libvirt, multiple
<code>seclabel</code> tags can be used, one for each driver and
the security driver referenced by each tag can be defined using
the attribute <code>model</code>
</p>
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
<p>
seclabel: extend XML to allow per-disk label overrides When doing security relabeling, there are cases where a per-file override might be appropriate. For example, with a static label and relabeling, it might be appropriate to skip relabeling on a particular disk, where the backing file lives on NFS that lacks the ability to track labeling. Or with dynamic labeling, it might be appropriate to use a custom (non-dynamic) label for a disk specifically intended to be shared across domains. The new XML resembles the top-level <seclabel>, but with fewer options (basically relabel='no', or <label>text</label>): <domain ...> ... <devices> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='no'/> <!-- override for just this disk --> </source> ... </disk> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='yes'> <!-- override for just this disk --> <label>system_u:object_r:shared_content_t:s0</label> </seclabel> </source> ... </disk> ... </devices> <seclabel type='dynamic' model='selinux'> <baselabel>text</baselabel> <!-- used for all devices without override --> </seclabel> </domain> This patch only introduces the XML and documentation; future patches will actually parse and make use of it. The intent is that we can further extend things as needed, adding a per-device <seclabel> in more places (such as the source of a console device), and possibly allowing a <baselabel> instead of <label> for labeling where we want to reuse the cNNN,cNNN pair of a dynamically labeled domain but a different base label. First suggested by Daniel P. Berrange here: https://www.redhat.com/archives/libvir-list/2011-December/msg00258.html * docs/schemas/domaincommon.rng (devSeclabel): New define. (disk): Use it. * docs/formatdomain.html.in (elementsDisks, seclabel): Document the new XML. * tests/qemuxml2argvdata/qemuxml2argv-seclabel-dynamic-override.xml: New test, to validate RNG.
2011-12-23 00:47:49 +00:00
Valid input XML configurations for the top-level security label
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
are:
</p>
<pre>
&lt;seclabel type='dynamic' model='selinux'/&gt;
&lt;seclabel type='dynamic' model='selinux'&gt;
&lt;baselabel&gt;system_u:system_r:my_svirt_t:s0&lt;/baselabel&gt;
&lt;/seclabel&gt;
&lt;seclabel type='static' model='selinux' relabel='no'&gt;
&lt;label&gt;system_u:system_r:svirt_t:s0:c392,c662&lt;/label&gt;
&lt;/seclabel&gt;
&lt;seclabel type='static' model='selinux' relabel='yes'&gt;
&lt;label&gt;system_u:system_r:svirt_t:s0:c392,c662&lt;/label&gt;
&lt;/seclabel&gt;
Add two new security label types Curently security labels can be of type 'dynamic' or 'static'. If no security label is given, then 'dynamic' is assumed. The current code takes advantage of this default, and avoids even saving <seclabel> elements with type='dynamic' to disk. This means if you temporarily change security driver, the guests can all still start. With the introduction of sVirt to LXC though, there needs to be a new default of 'none' to allow unconfined LXC containers. This patch introduces two new security label types - default: the host configuration decides whether to run the guest with type 'none' or 'dynamic' at guest start - none: the guest will run unconfined by security policy The 'none' label type will obviously be undesirable for some deployments, so a new qemu.conf option allows a host admin to mandate confined guests. It is also possible to turn off default confinement security_default_confined = 1|0 (default == 1) security_require_confined = 1|0 (default == 0) * src/conf/domain_conf.c, src/conf/domain_conf.h: Add new seclabel types * src/security/security_manager.c, src/security/security_manager.h: Set default sec label types * src/security/security_selinux.c: Handle 'none' seclabel type * src/qemu/qemu.conf, src/qemu/qemu_conf.c, src/qemu/qemu_conf.h, src/qemu/libvirtd_qemu.aug: New security config options * src/qemu/qemu_driver.c: Tell security driver about default config
2012-01-25 14:12:52 +00:00
&lt;seclabel type='none'/&gt;
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
</pre>
Add two new security label types Curently security labels can be of type 'dynamic' or 'static'. If no security label is given, then 'dynamic' is assumed. The current code takes advantage of this default, and avoids even saving <seclabel> elements with type='dynamic' to disk. This means if you temporarily change security driver, the guests can all still start. With the introduction of sVirt to LXC though, there needs to be a new default of 'none' to allow unconfined LXC containers. This patch introduces two new security label types - default: the host configuration decides whether to run the guest with type 'none' or 'dynamic' at guest start - none: the guest will run unconfined by security policy The 'none' label type will obviously be undesirable for some deployments, so a new qemu.conf option allows a host admin to mandate confined guests. It is also possible to turn off default confinement security_default_confined = 1|0 (default == 1) security_require_confined = 1|0 (default == 0) * src/conf/domain_conf.c, src/conf/domain_conf.h: Add new seclabel types * src/security/security_manager.c, src/security/security_manager.h: Set default sec label types * src/security/security_selinux.c: Handle 'none' seclabel type * src/qemu/qemu.conf, src/qemu/qemu_conf.c, src/qemu/qemu_conf.h, src/qemu/libvirtd_qemu.aug: New security config options * src/qemu/qemu_driver.c: Tell security driver about default config
2012-01-25 14:12:52 +00:00
<p>
If no 'type' attribute is provided in the input XML, then
the security driver default setting will be used, which
may be either 'none' or 'dynamic'. If a 'baselabel' is set
but no 'type' is set, then the type is presumed to be 'dynamic'
</p>
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
<p>
When viewing the XML for a running guest with automatic
resource relabeling active, an additional XML element,
<code>imagelabel</code>, will be included. This is an
output-only element, so will be ignored in user supplied
XML documents
</p>
<dl>
<dt><code>type</code></dt>
Add two new security label types Curently security labels can be of type 'dynamic' or 'static'. If no security label is given, then 'dynamic' is assumed. The current code takes advantage of this default, and avoids even saving <seclabel> elements with type='dynamic' to disk. This means if you temporarily change security driver, the guests can all still start. With the introduction of sVirt to LXC though, there needs to be a new default of 'none' to allow unconfined LXC containers. This patch introduces two new security label types - default: the host configuration decides whether to run the guest with type 'none' or 'dynamic' at guest start - none: the guest will run unconfined by security policy The 'none' label type will obviously be undesirable for some deployments, so a new qemu.conf option allows a host admin to mandate confined guests. It is also possible to turn off default confinement security_default_confined = 1|0 (default == 1) security_require_confined = 1|0 (default == 0) * src/conf/domain_conf.c, src/conf/domain_conf.h: Add new seclabel types * src/security/security_manager.c, src/security/security_manager.h: Set default sec label types * src/security/security_selinux.c: Handle 'none' seclabel type * src/qemu/qemu.conf, src/qemu/qemu_conf.c, src/qemu/qemu_conf.h, src/qemu/libvirtd_qemu.aug: New security config options * src/qemu/qemu_driver.c: Tell security driver about default config
2012-01-25 14:12:52 +00:00
<dd>Either <code>static</code>, <code>dynamic</code> or <code>none</code>
to determine whether libvirt automatically generates a unique security
label or not.
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
</dd>
<dt><code>model</code></dt>
<dd>A valid security model name, matching the currently
activated security model
</dd>
<dt><code>relabel</code></dt>
<dd>Either <code>yes</code> or <code>no</code>. This must always
be <code>yes</code> if dynamic label assignment is used. With
static label assignment it will default to <code>no</code>.
</dd>
<dt><code>label</code></dt>
<dd>If static labelling is used, this must specify the full
security label to assign to the virtual domain. The format
doc: update description about security labels on formatdomain.html This patch adds a brief description about labels for each security driver.
2012-10-02 17:57:37 +00:00
of the content depends on the security driver in use:
<ul>
<li>SELinux: a SELinux context.</li>
<li>AppArmor: an AppArmor profile.</li>
<li>
DAC: owner and group separated by colon. They can be
defined both as user/group names or uid/gid. The driver will first
try to parse these values as names, but a leading plus sign can
used to force the driver to parse them as uid or gid.
</li>
</ul>
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
</dd>
<dt><code>baselabel</code></dt>
<dd>If dynamic labelling is used, this can optionally be
doc: Clarify usage of SELinux baselabel State what fields are used when generating SELinux labels from a baselabel.
2013-04-24 13:25:06 +00:00
used to specify the base security label that will be used to generate
the actual label. The format of the content depends on the security
driver in use.
The SELinux driver uses only the <code>type</code> field of the
baselabel in the generated label. Other fields are inherited from
the parent process when using SELinux baselabels.
(The example above demonstrates the use of <code>my_svirt_t</code>
as the value for the <code>type</code> field.)
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
</dd>
<dt><code>imagelabel</code></dt>
<dd>This is an output only element, which shows the
security label used on resources associated with the virtual domain.
The format of the content depends on the security driver in use
</dd>
</dl>
seclabel: extend XML to allow per-disk label overrides When doing security relabeling, there are cases where a per-file override might be appropriate. For example, with a static label and relabeling, it might be appropriate to skip relabeling on a particular disk, where the backing file lives on NFS that lacks the ability to track labeling. Or with dynamic labeling, it might be appropriate to use a custom (non-dynamic) label for a disk specifically intended to be shared across domains. The new XML resembles the top-level <seclabel>, but with fewer options (basically relabel='no', or <label>text</label>): <domain ...> ... <devices> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='no'/> <!-- override for just this disk --> </source> ... </disk> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='yes'> <!-- override for just this disk --> <label>system_u:object_r:shared_content_t:s0</label> </seclabel> </source> ... </disk> ... </devices> <seclabel type='dynamic' model='selinux'> <baselabel>text</baselabel> <!-- used for all devices without override --> </seclabel> </domain> This patch only introduces the XML and documentation; future patches will actually parse and make use of it. The intent is that we can further extend things as needed, adding a per-device <seclabel> in more places (such as the source of a console device), and possibly allowing a <baselabel> instead of <label> for labeling where we want to reuse the cNNN,cNNN pair of a dynamically labeled domain but a different base label. First suggested by Daniel P. Berrange here: https://www.redhat.com/archives/libvir-list/2011-December/msg00258.html * docs/schemas/domaincommon.rng (devSeclabel): New define. (disk): Use it. * docs/formatdomain.html.in (elementsDisks, seclabel): Document the new XML. * tests/qemuxml2argvdata/qemuxml2argv-seclabel-dynamic-override.xml: New test, to validate RNG.
2011-12-23 00:47:49 +00:00
<p>When relabeling is in effect, it is also possible to fine-tune
the labeling done for specific source file names, by either
disabling the labeling (useful if the file lives on NFS or other
file system that lacks security labeling) or requesting an
alternate label (useful when a management application creates a
special label to allow sharing of some, but not all, resources
between domains), <span class="since">since 0.9.9</span>. When
a <code>seclabel</code> element is attached to a specific path
rather than the top-level domain assignment, only the
attribute <code>relabel</code> or the
selinux: distinguish failure to label from request to avoid label https://bugzilla.redhat.com/show_bug.cgi?id=924153 Commit 904e05a2 (v0.9.9) added a per-<disk> seclabel element with an attribute relabel='no' in order to try and minimize the impact of shutdown delays when an NFS server disappears. The idea was that if a disk is on NFS and can't be labeled in the first place, there is no need to attempt the (no-op) relabel on domain shutdown. Unfortunately, the way this was implemented was by modifying the domain XML so that the optimization would survive libvirtd restart, but in a way that is indistinguishable from an explicit user setting. Furthermore, once the setting is turned on, libvirt avoids attempts at labeling, even for operations like snapshot or blockcopy where the chain is being extended or pivoted onto non-NFS, where SELinux labeling is once again possible. As a result, it was impossible to do a blockcopy to pivot from an NFS image file onto a local file. The solution is to separate the semantics of a chain that must not be labeled (which the user can set even on persistent domains) vs. the optimization of not attempting a relabel on cleanup (a live-only annotation), and using only the user's explicit notation rather than the optimization as the decision on whether to skip a label attempt in the first place. When upgrading an older libvirtd to a newer, an NFS volume will still attempt the relabel; but as the avoidance of a relabel was only an optimization, this shouldn't cause any problems. In the ideal future, libvirt will eventually have XML describing EVERY file in the backing chain, with each file having a separate <seclabel> element. At that point, libvirt will be able to track more closely which files need a relabel attempt at shutdown. But until we reach that point, the single <seclabel> for the entire <disk> chain is treated as a hint - when a chain has only one file, then we know it is accurate; but if the chain has more than one file, we have to attempt relabel in spite of the attribute, in case part of the chain is local and SELinux mattered for that portion of the chain. * src/conf/domain_conf.h (_virSecurityDeviceLabelDef): Add new member. * src/conf/domain_conf.c (virSecurityDeviceLabelDefParseXML): Parse it, for live images only. (virSecurityDeviceLabelDefFormat): Output it. (virDomainDiskDefParseXML, virDomainChrSourceDefParseXML) (virDomainDiskSourceDefFormat, virDomainChrDefFormat) (virDomainDiskDefFormat): Pass flags on through. * src/security/security_selinux.c (virSecuritySELinuxRestoreSecurityImageLabelInt): Honor labelskip when possible. (virSecuritySELinuxSetSecurityFileLabel): Set labelskip, not norelabel, if labeling fails. (virSecuritySELinuxSetFileconHelper): Fix indentation. * docs/formatdomain.html.in (seclabel): Document new xml. * docs/schemas/domaincommon.rng (devSeclabel): Allow it in RNG. * tests/qemuxml2argvdata/qemuxml2argv-seclabel-*-labelskip.xml: * tests/qemuxml2argvdata/qemuxml2argv-seclabel-*-labelskip.args: * tests/qemuxml2xmloutdata/qemuxml2xmlout-seclabel-*-labelskip.xml: New test files. * tests/qemuxml2argvtest.c (mymain): Run the new tests. * tests/qemuxml2xmltest.c (mymain): Likewise. Signed-off-by: Eric Blake <eblake@redhat.com>
2013-08-12 15:15:42 +00:00
sub-element <code>label</code> are supported. Additionally,
<span class="since">since 1.1.2</span>, an output-only
element <code>labelskip</code> will be present for active
domains on disks where labeling was skipped due to the image
being on a file system that lacks security labeling.
seclabel: extend XML to allow per-disk label overrides When doing security relabeling, there are cases where a per-file override might be appropriate. For example, with a static label and relabeling, it might be appropriate to skip relabeling on a particular disk, where the backing file lives on NFS that lacks the ability to track labeling. Or with dynamic labeling, it might be appropriate to use a custom (non-dynamic) label for a disk specifically intended to be shared across domains. The new XML resembles the top-level <seclabel>, but with fewer options (basically relabel='no', or <label>text</label>): <domain ...> ... <devices> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='no'/> <!-- override for just this disk --> </source> ... </disk> <disk type='file' device='disk'> <source file='/path/to/image1'> <seclabel relabel='yes'> <!-- override for just this disk --> <label>system_u:object_r:shared_content_t:s0</label> </seclabel> </source> ... </disk> ... </devices> <seclabel type='dynamic' model='selinux'> <baselabel>text</baselabel> <!-- used for all devices without override --> </seclabel> </domain> This patch only introduces the XML and documentation; future patches will actually parse and make use of it. The intent is that we can further extend things as needed, adding a per-device <seclabel> in more places (such as the source of a console device), and possibly allowing a <baselabel> instead of <label> for labeling where we want to reuse the cNNN,cNNN pair of a dynamically labeled domain but a different base label. First suggested by Daniel P. Berrange here: https://www.redhat.com/archives/libvir-list/2011-December/msg00258.html * docs/schemas/domaincommon.rng (devSeclabel): New define. (disk): Use it. * docs/formatdomain.html.in (elementsDisks, seclabel): Document the new XML. * tests/qemuxml2argvdata/qemuxml2argv-seclabel-dynamic-override.xml: New test, to validate RNG.
2011-12-23 00:47:49 +00:00
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h2><a name="examples">Example configs</a></h2>
Split website out into one file per page. APply new layout and styling
2008-04-23 17:08:31 +00:00
<p>
Example configurations for each driver are provide on the
driver specific pages listed below
</p>
<ul>
<li><a href="drvxen.html#xmlconfig">Xen examples</a></li>
<li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li>
</ul>
</body>
</html>
Reference in New Issue Copy Permalink