2011-08-13 05:33:15 +04:00
<?xml version="1.0"?>
<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
<!-- domain-related definitions used in multiple grammars -->
<include href='basictypes.rng'/>
<include href='storageencryption.rng'/>
<include href='networkcommon.rng'/>
<!--
2012-02-01 17:03:49 +04:00
description and title element, may be placed anywhere under the root
2011-08-13 05:33:15 +04:00
-->
<define name="description">
<element name="description">
<text/>
</element>
</define>
2012-02-01 17:03:49 +04:00
<define name="title">
<element name="title">
<data type="string">
<!-- Use literal newline instead of \n for bug in libxml2 2.7.6 -->
<param name="pattern">[^
]+</param>
</data>
</element>
</define>
2011-08-13 05:33:15 +04:00
<!--
We handle only document defining a domain
-->
<define name="domain">
<element name="domain">
<ref name="hvs"/>
<ref name="ids"/>
<interleave>
2012-02-01 17:03:49 +04:00
<optional>
<ref name="title"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="description"/>
</optional>
2012-01-24 06:26:18 +04:00
<optional>
<ref name="metadata"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="cpu"/>
</optional>
<optional>
<ref name="sysinfo"/>
</optional>
<ref name="os"/>
<ref name="clock"/>
<ref name="resources"/>
<ref name="features"/>
2012-09-06 23:56:49 +04:00
<ref name="events"/>
2012-08-02 14:12:50 +04:00
<optional>
<ref name="pm"/>
</optional>
2013-06-07 11:12:18 +04:00
<optional>
<ref name="idmap"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="devices"/>
</optional>
2012-08-16 02:10:36 +04:00
<zeroOrMore>
2011-08-13 05:33:15 +04:00
<ref name="seclabel"/>
2012-08-16 02:10:36 +04:00
</zeroOrMore>
2011-08-13 05:33:15 +04:00
<optional>
<ref name='qemucmdline'/>
</optional>
</interleave>
</element>
</define>
<define name="seclabel">
<element name="seclabel">
2011-12-23 04:47:46 +04:00
<optional>
<attribute name='model'>
<text/>
</attribute>
</optional>
<choice>
<group>
<!-- with dynamic label (default), relabel must be yes, baselabel
is optional, and label and imagelabel are output-only -->
<optional>
<attribute name='type'>
<value>dynamic</value>
</attribute>
</optional>
<optional>
<attribute name='relabel'>
<value>yes</value>
</attribute>
</optional>
<interleave>
<optional>
<element name='label'>
<text/>
</element>
</optional>
<optional>
<element name='imagelabel'>
<text/>
</element>
</optional>
<optional>
<element name='baselabel'>
<text/>
</element>
</optional>
</interleave>
</group>
<group>
<!-- with static label, relabel can be either format (default
no), label is required, imagelabel is output-only, and no
baselabel is present -->
<attribute name='type'>
<value>static</value>
</attribute>
<optional>
<attribute name='relabel'>
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<interleave>
<element name='label'>
<text/>
</element>
<optional>
<element name='imagelabel'>
<text/>
</element>
</optional>
</interleave>
</group>
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 18:12:52 +04:00
<group>
2012-02-04 18:01:56 +04:00
<!-- with none, relabel must be no if present -->
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 18:12:52 +04:00
<attribute name='type'>
<value>none</value>
</attribute>
2012-02-04 18:01:56 +04:00
<optional>
<attribute name='relabel'>
<value>no</value>
</attribute>
</optional>
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 18:12:52 +04:00
</group>
2011-12-23 04:47:46 +04:00
</choice>
2011-08-13 05:33:15 +04:00
</element>
</define>
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 04:47:49 +04:00
<define name="devSeclabel">
<element name="seclabel">
<!-- A per-device seclabel override is more limited, either
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 19:15:42 +04:00
relabel=no or a <label> must be present on input;
output also can include labelskip=yes. -->
<optional>
<attribute name='model'>
<text/>
</attribute>
</optional>
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 04:47:49 +04:00
<choice>
<group>
2012-08-16 02:10:36 +04:00
<attribute name='relabel'>
<value>no</value>
</attribute>
</group>
<group>
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 19:15:42 +04:00
<attribute name='labelskip'>
<value>yes</value>
</attribute>
</group>
<group>
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 04:47:49 +04:00
<optional>
<attribute name='relabel'>
<value>yes</value>
</attribute>
</optional>
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 19:15:42 +04:00
<oneOrMore>
2012-08-16 02:10:36 +04:00
<element name='label'>
<text/>
</element>
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 19:15:42 +04:00
</oneOrMore>
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 04:47:49 +04:00
</group>
</choice>
</element>
</define>
2011-08-13 05:33:15 +04:00
<define name="hvs">
<attribute name="type">
<choice>
<value>qemu</value>
2011-11-28 18:26:57 +04:00
<value>kqemu</value>
<value>kvm</value>
<value>xen</value>
2011-08-13 05:33:15 +04:00
<value>lxc</value>
2011-11-28 18:26:57 +04:00
<value>uml</value>
2011-08-13 05:33:15 +04:00
<value>openvz</value>
<value>test</value>
2011-11-28 18:26:57 +04:00
<value>vmware</value>
<value>hyperv</value>
<value>vbox</value>
<value>phyp</value>
2012-08-13 19:50:14 +04:00
<value>parallels</value>
2011-08-13 05:33:15 +04:00
</choice>
</attribute>
</define>
<define name="os">
<choice>
<ref name="osxen"/>
<ref name="oshvm"/>
<ref name="osexe"/>
</choice>
</define>
<define name="osxen">
<choice>
<group>
<optional>
<ref name="bootloader"/>
</optional>
<element name="os">
<ref name="ostypexen"/>
<ref name="osbootkernel"/>
</element>
</group>
<group>
<ref name="bootloader"/>
<optional>
<element name="os">
<ref name="ostypexen"/>
<optional>
<ref name="osbootkernel"/>
</optional>
</element>
</optional>
</group>
</choice>
</define>
<define name="oshvm">
<element name="os">
<ref name="ostypehvm"/>
<interleave>
<optional>
<element name="loader">
<ref name="absFilePath"/>
</element>
</optional>
2012-06-15 06:34:04 +04:00
<optional>
2011-08-13 05:33:15 +04:00
<ref name="osbootkernel"/>
2012-06-15 06:34:04 +04:00
</optional>
2013-06-12 14:14:31 +04:00
<zeroOrMore>
<ref name="osbootdev"/>
</zeroOrMore>
2011-08-13 05:33:15 +04:00
<optional>
<element name="bootmenu">
<attribute name="enable">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</element>
</optional>
<optional>
<ref name="smbios"/>
</optional>
<optional>
<ref name="bios"/>
</optional>
</interleave>
</element>
</define>
<define name="ostypexen">
<element name="type">
<optional>
<attribute name="arch">
<choice>
<value>i686</value>
<value>x86_64</value>
<value>ia64</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="machine">
<choice>
<value>xenpv</value>
<value>xenner</value>
</choice>
</attribute>
</optional>
<choice>
<value>xen</value>
<value>linux</value>
</choice>
</element>
</define>
<define name="ostypehvm">
<element name="type">
<optional>
<choice>
<ref name="hvmx86"/>
<ref name="hvmmips"/>
<ref name="hvmsparc"/>
<ref name="hvmppc"/>
2011-12-01 21:45:55 +04:00
<ref name="hvmppc64"/>
2012-06-29 19:02:06 +04:00
<ref name="hvms390"/>
2013-07-30 23:41:14 +04:00
<ref name="hvmarm"/>
2014-01-02 14:42:56 +04:00
<ref name="hvmaarch64"/>
2011-08-13 05:33:15 +04:00
</choice>
</optional>
<value>hvm</value>
</element>
</define>
<define name="hvmx86">
<group>
<optional>
<attribute name="arch">
<choice>
<value>i686</value>
<value>x86_64</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="machine">
<data type="string">
<param name="pattern">[a-zA-Z0-9_\.\-]+</param>
</data>
</attribute>
</optional>
</group>
</define>
<define name="hvmmips">
<group>
<optional>
<attribute name="arch">
<value>mips</value>
</attribute>
</optional>
<optional>
<attribute name="machine">
<value>mips</value>
</attribute>
</optional>
</group>
</define>
<define name="hvmsparc">
<group>
<optional>
<attribute name="arch">
<value>sparc</value>
</attribute>
</optional>
<optional>
<attribute name="machine">
<value>sun4m</value>
</attribute>
</optional>
</group>
</define>
<define name="hvmppc">
<group>
<optional>
<attribute name="arch">
<value>ppc</value>
</attribute>
</optional>
<optional>
<attribute name="machine">
<choice>
<value>g3beige</value>
<value>mac99</value>
<value>prep</value>
2013-03-14 08:49:42 +04:00
<value>ppce500v2</value>
2011-08-13 05:33:15 +04:00
</choice>
</attribute>
</optional>
</group>
</define>
2011-12-01 21:45:55 +04:00
<define name="hvmppc64">
<group>
<optional>
<attribute name="arch">
<value>ppc64</value>
</attribute>
</optional>
<optional>
<attribute name="machine">
<choice>
<value>pseries</value>
</choice>
</attribute>
</optional>
</group>
</define>
2012-06-29 19:02:06 +04:00
<define name="hvms390">
<group>
<optional>
<attribute name="arch">
<choice>
<value>s390</value>
<value>s390x</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="machine">
<choice>
2013-03-05 19:44:19 +04:00
<value>s390</value>
2012-06-29 19:02:06 +04:00
<value>s390-virtio</value>
2013-03-05 19:44:19 +04:00
<value>s390-ccw</value>
<value>s390-ccw-virtio</value>
2012-06-29 19:02:06 +04:00
</choice>
</attribute>
</optional>
</group>
</define>
2013-07-30 23:41:14 +04:00
<define name="hvmarm">
<group>
<optional>
<attribute name="arch">
<choice>
<value>armv7l</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="machine">
<data type="string">
<param name="pattern">[a-zA-Z0-9_\.\-]+</param>
</data>
</attribute>
</optional>
</group>
</define>
2014-01-02 14:42:56 +04:00
<define name="hvmaarch64">
<group>
<optional>
<attribute name="arch">
<choice>
<value>aarch64</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="machine">
<data type="string">
<param name="pattern">[a-zA-Z0-9_\.\-]+</param>
</data>
</attribute>
</optional>
</group>
</define>
2011-08-13 05:33:15 +04:00
<define name="osexe">
<element name="os">
<element name="type">
2012-03-26 21:11:09 +04:00
<optional>
<attribute name="arch">
<choice>
<value>i686</value>
<value>x86_64</value>
<value>ppc</value>
<value>ppc64</value>
<value>mips</value>
<value>sparc</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
<value>exe</value>
</element>
<interleave>
<optional>
<element name="init">
<ref name="absFilePath"/>
</element>
</optional>
2012-03-26 21:09:31 +04:00
<zeroOrMore>
<element name="initarg">
<text/>
</element>
</zeroOrMore>
2011-08-13 05:33:15 +04:00
</interleave>
</element>
</define>
<!--
The Identifiers can be:
- an optional id attribute with a number on the domain element
- a mandatory name
- an optional uuid
-->
<define name="ids">
<optional>
<attribute name="id">
<ref name="unsignedInt"/>
</attribute>
</optional>
<interleave>
<element name="name">
<ref name="domainName"/>
</element>
<optional>
<element name="uuid">
<ref name="UUID"/>
</element>
</optional>
</interleave>
</define>
2013-06-07 11:12:18 +04:00
<define name="idmap">
2014-01-10 21:40:01 +04:00
<element name="idmap">
<interleave>
<zeroOrMore>
<element name="uid">
<attribute name="start">
<ref name="unsignedInt"/>
</attribute>
<attribute name="target">
<ref name="unsignedInt"/>
</attribute>
<attribute name="count">
<ref name="unsignedInt"/>
</attribute>
<empty/>
</element>
</zeroOrMore>
<zeroOrMore>
<element name="gid">
<attribute name="start">
<ref name="unsignedInt"/>
</attribute>
<attribute name="target">
<ref name="unsignedInt"/>
</attribute>
<attribute name="count">
<ref name="unsignedInt"/>
</attribute>
<empty/>
</element>
</zeroOrMore>
</interleave>
</element>
2013-06-07 11:12:18 +04:00
</define>
2011-08-13 05:33:15 +04:00
<!--
Resources usage defines the amount of memory (maximum and possibly
current usage) and number of virtual CPUs used by that domain.
We can't check here the rule that currentMemory <= memory
-->
<define name="resources">
<interleave>
<element name="memory">
2012-03-06 01:52:07 +04:00
<ref name='scaledInteger'/>
2012-08-15 11:51:58 +04:00
<optional>
<attribute name="dumpCore">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
</element>
<optional>
<element name="currentMemory">
2012-03-06 01:52:07 +04:00
<ref name='scaledInteger'/>
2011-08-13 05:33:15 +04:00
</element>
</optional>
<optional>
<element name="memoryBacking">
2013-05-14 09:25:50 +04:00
<interleave>
<optional>
<element name="hugepages">
<empty/>
</element>
</optional>
<optional>
<element name="nosharepages">
<empty/>
</element>
</optional>
2013-05-17 00:00:03 +04:00
<optional>
<element name="locked">
<empty/>
</element>
</optional>
2013-05-14 09:25:50 +04:00
</interleave>
2011-08-13 05:33:15 +04:00
</element>
</optional>
<optional>
<element name="vcpu">
2012-03-08 17:36:26 +04:00
<optional>
<attribute name="placement">
<choice>
<value>static</value>
<value>auto</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<attribute name="cpuset">
<ref name="cpuset"/>
</attribute>
</optional>
<optional>
<attribute name="current">
<ref name="countCPU"/>
</attribute>
</optional>
<ref name="countCPU"/>
</element>
</optional>
<optional>
2013-04-04 15:40:36 +04:00
<ref name="blkiotune"/>
</optional>
<optional>
<ref name="memtune"/>
</optional>
<optional>
<ref name="cputune"/>
</optional>
<optional>
<ref name="numatune"/>
</optional>
2013-03-21 15:28:10 +04:00
<optional>
<ref name="respartition"/>
</optional>
2013-04-04 15:40:36 +04:00
</interleave>
</define>
<!-- The Blkio cgroup related tunables would go in the blkiotune -->
<define name="blkiotune">
<element name="blkiotune">
<interleave>
<!-- I/O weight the VM can use -->
<optional>
<element name="weight">
<ref name="weight"/>
</element>
</optional>
<zeroOrMore>
<element name="device">
<interleave>
<element name="path">
<ref name="absFilePath"/>
</element>
2013-12-11 12:29:49 +04:00
<optional>
<element name="weight">
<ref name="weight"/>
</element>
</optional>
<optional>
<element name="read_iops_sec">
<data type='unsignedInt'/>
</element>
</optional>
<optional>
<element name="write_iops_sec">
<data type='unsignedInt'/>
</element>
</optional>
<optional>
<element name="read_bytes_sec">
<data type='unsignedLong'/>
</element>
</optional>
<optional>
<element name="write_bytes_sec">
<data type='unsignedLong'/>
</element>
</optional>
2013-04-04 15:40:36 +04:00
</interleave>
</element>
</zeroOrMore>
</interleave>
</element>
</define>
<!-- All the memory/swap related tunables would go in the memtune -->
<define name="memtune">
<element name="memtune">
<!-- Maximum memory the VM can use -->
<optional>
<element name="hard_limit">
<ref name='scaledInteger'/>
</element>
</optional>
<!-- Minimum memory ascertained for the VM during contention -->
<optional>
<element name="soft_limit">
<ref name='scaledInteger'/>
</element>
</optional>
<!-- Minimum amount of memory required to start the VM -->
<optional>
<element name="min_guarantee">
<ref name='scaledInteger'/>
</element>
</optional>
<!-- Maximum swap area the VM can use -->
<optional>
<element name="swap_hard_limit">
<ref name='scaledInteger'/>
</element>
</optional>
</element>
</define>
<!-- All the cpu related tunables would go in the cputune -->
<define name="cputune">
<element name="cputune">
<optional>
<element name="shares">
<ref name="cpushares"/>
</element>
</optional>
<optional>
<element name="period">
<ref name="cpuperiod"/>
2011-08-13 05:33:15 +04:00
</element>
</optional>
2013-04-04 15:40:36 +04:00
<optional>
<element name="quota">
<ref name="cpuquota"/>
</element>
</optional>
<optional>
<element name="emulator_period">
<ref name="cpuperiod"/>
</element>
</optional>
<optional>
<element name="emulator_quota">
<ref name="cpuquota"/>
</element>
</optional>
<zeroOrMore>
<element name="vcpupin">
<attribute name="vcpu">
<ref name="vcpuid"/>
</attribute>
<attribute name="cpuset">
<ref name="cpuset"/>
</attribute>
</element>
</zeroOrMore>
<optional>
<element name="emulatorpin">
<attribute name="cpuset">
<ref name="cpuset"/>
</attribute>
</element>
</optional>
</element>
</define>
2011-08-13 05:33:15 +04:00
2013-04-04 15:40:36 +04:00
<!-- All the NUMA related tunables would go in the numatune -->
<define name="numatune">
<element name="numatune">
2011-08-13 05:33:15 +04:00
<optional>
2013-04-04 15:40:36 +04:00
<element name="memory">
2011-08-13 05:33:15 +04:00
<optional>
2013-04-04 15:40:36 +04:00
<attribute name="mode">
<choice>
<value>strict</value>
<value>preferred</value>
<value>interleave</value>
</choice>
</attribute>
</optional>
<choice>
<group>
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 20:04:34 +04:00
<optional>
2013-04-04 15:40:36 +04:00
<attribute name='placement'>
<value>static</value>
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 20:04:34 +04:00
</attribute>
</optional>
2013-04-04 15:40:36 +04:00
<optional>
<attribute name='nodeset'>
<ref name='cpuset'/>
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 20:04:34 +04:00
</attribute>
2013-04-04 15:40:36 +04:00
</optional>
</group>
<attribute name='placement'>
<value>auto</value>
</attribute>
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 20:04:34 +04:00
</choice>
2011-08-13 05:33:15 +04:00
</element>
</optional>
2013-04-04 15:40:36 +04:00
</element>
2011-08-13 05:33:15 +04:00
</define>
2013-04-04 15:40:36 +04:00
2013-03-21 15:28:10 +04:00
<define name="respartition">
<element name="resource">
<element name="partition">
<ref name="absFilePath"/>
</element>
</element>
</define>
2011-08-13 05:33:15 +04:00
<define name="clock">
<optional>
<element name="clock">
<choice>
2012-02-06 17:59:16 +04:00
<group>
<attribute name="offset">
<choice>
<value>localtime</value>
<value>utc</value>
</choice>
</attribute>
<optional>
<attribute name='adjustment'>
<choice>
<ref name='timeDelta'/>
<value>reset</value>
</choice>
</attribute>
</optional>
</group>
2011-08-13 05:33:15 +04:00
<group>
<attribute name="offset">
<value>timezone</value>
</attribute>
<optional>
<attribute name="timezone">
<ref name="timeZone"/>
</attribute>
</optional>
</group>
<group>
<attribute name="offset">
<value>variable</value>
</attribute>
<optional>
<attribute name="adjustment">
<ref name="timeDelta"/>
</attribute>
</optional>
2012-02-06 17:59:16 +04:00
<optional>
<attribute name="basis">
<choice>
<value>utc</value>
<value>localtime</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
</group>
</choice>
<zeroOrMore>
<ref name="timer"/>
</zeroOrMore>
</element>
</optional>
</define>
<define name="timer">
<element name="timer">
2014-02-04 22:02:04 +04:00
<choice>
<group>
<attribute name="name">
<choice>
<value>platform</value>
<value>rtc</value>
</choice>
</attribute>
<optional>
<attribute name="track">
<choice>
<value>boot</value>
<value>guest</value>
<value>wall</value>
</choice>
</attribute>
</optional>
<optional>
<ref name="tickpolicy"/>
</optional>
</group>
<group>
<attribute name="name">
<value>tsc</value>
</attribute>
<optional>
<ref name="tickpolicy"/>
</optional>
<optional>
<attribute name="frequency">
<ref name="unsignedInt"/>
</attribute>
</optional>
<optional>
<attribute name="mode">
<choice>
<value>auto</value>
<value>native</value>
<value>emulate</value>
<value>paravirt</value>
<value>smpsafe</value>
</choice>
</attribute>
</optional>
</group>
<group>
<attribute name="name">
<choice>
<value>hpet</value>
<value>pit</value>
</choice>
</attribute>
<optional>
<ref name="tickpolicy"/>
</optional>
</group>
<group>
<attribute name="name">
2014-01-21 21:50:12 +04:00
<choice>
<value>kvmclock</value>
<value>hypervclock</value>
</choice>
2014-02-04 22:02:04 +04:00
</attribute>
</group>
</choice>
2011-08-13 05:33:15 +04:00
<optional>
<attribute name="present">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<empty/>
</element>
</define>
2014-02-04 22:02:04 +04:00
<define name="tickpolicy">
<choice>
<group>
<attribute name="tickpolicy">
<choice>
<value>delay</value>
<value>merge</value>
<value>discard</value>
</choice>
2011-08-13 05:33:15 +04:00
</attribute>
2014-02-04 22:02:04 +04:00
</group>
<group>
<attribute name="tickpolicy">
<value>catchup</value>
2011-08-13 05:33:15 +04:00
</attribute>
2014-02-04 22:02:04 +04:00
<optional>
<element name="catchup">
<optional>
<attribute name="threshold">
<ref name="unsignedInt"/>
</attribute>
</optional>
<optional>
<attribute name="slew">
<ref name="unsignedInt"/>
</attribute>
</optional>
<optional>
<attribute name="limit">
<ref name="unsignedInt"/>
</attribute>
</optional>
</element>
</optional>
</group>
</choice>
2011-08-13 05:33:15 +04:00
</define>
<!--
A bootloader may be used to extract the OS information instead of
defining the OS parameter in the instance. It points just to the
binary or script used to extract the data from the first disk device.
-->
<define name="bootloader">
<interleave>
<element name="bootloader">
<choice>
<ref name="absFilePath"/>
<empty/>
</choice>
</element>
<optional>
<element name="bootloader_args">
<text/>
</element>
</optional>
</interleave>
</define>
<define name="osbootkernel">
<interleave>
<optional>
<element name="kernel">
<ref name="absFilePath"/>
</element>
</optional>
<optional>
<element name="initrd">
<ref name="absFilePath"/>
</element>
</optional>
<optional>
<element name="root">
<ref name="absFilePath"/>
</element>
</optional>
<optional>
<element name="cmdline">
<text/>
</element>
</optional>
2013-03-14 08:49:42 +04:00
<optional>
<element name="dtb">
<ref name="absFilePath"/>
</element>
</optional>
2011-08-13 05:33:15 +04:00
</interleave>
</define>
<define name="osbootdev">
<element name="boot">
<attribute name="dev">
<choice>
<value>hd</value>
<value>fd</value>
<value>cdrom</value>
<value>network</value>
</choice>
</attribute>
<empty/>
</element>
</define>
<define name="diskspec">
2011-11-15 13:02:46 +04:00
<interleave>
<optional>
2013-04-22 18:06:14 +04:00
<ref name="diskDriver"/>
2011-11-15 13:02:46 +04:00
</optional>
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 04:10:18 +04:00
<optional>
<ref name='diskMirror'/>
</optional>
2011-11-15 13:02:46 +04:00
<optional>
<ref name="diskAuth"/>
</optional>
<ref name="target"/>
<optional>
<ref name="deviceBoot"/>
</optional>
<optional>
<element name="readonly">
<empty/>
</element>
</optional>
<optional>
<element name="shareable">
<empty/>
</element>
</optional>
<optional>
<element name="transient">
<empty/>
</element>
</optional>
<optional>
<element name="serial">
<ref name="diskSerial"/>
</element>
</optional>
<optional>
<ref name="encryption"/>
</optional>
<optional>
<ref name="diskIoTune"/>
</optional>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-11-15 13:02:46 +04:00
<optional>
<ref name="address"/>
</optional>
2012-08-20 17:58:50 +04:00
<optional>
<ref name="geometry"/>
</optional>
2012-08-29 19:48:30 +04:00
<optional>
2012-09-04 18:30:55 +04:00
<ref name="diskBlockIo"/>
2012-08-29 19:48:30 +04:00
</optional>
2012-09-11 12:57:01 +04:00
<optional>
<element name="wwn">
<ref name="wwn"/>
</element>
</optional>
2012-12-06 14:23:02 +04:00
<optional>
<element name="vendor">
<data type="string">
<param name="pattern">[x20-x7E]{0,8}</param>
</data>
</element>
</optional>
<optional>
<element name="product">
<data type="string">
<param name="pattern">[x20-x7E]{0,16}</param>
</data>
</element>
</optional>
2011-11-15 13:02:46 +04:00
</interleave>
2011-08-13 05:33:15 +04:00
</define>
2011-08-13 23:20:21 +04:00
<define name="snapshot">
<attribute name="snapshot">
<choice>
<value>no</value>
<value>internal</value>
<value>external</value>
</choice>
</attribute>
</define>
2011-08-13 05:33:15 +04:00
<define name="lease">
<element name="lease">
<interleave>
<element name="lockspace">
<text/>
</element>
<element name="key">
<text/>
</element>
<element name="target">
<attribute name="path">
<text/>
</attribute>
<optional>
<attribute name="offset">
<ref name="unsignedInt"/>
</attribute>
</optional>
</element>
</interleave>
</element>
</define>
2011-10-17 18:54:03 +04:00
<define name="startupPolicy">
<attribute name="startupPolicy">
<choice>
<value>mandatory</value>
<value>requisite</value>
<value>optional</value>
</choice>
</attribute>
</define>
2011-08-13 05:33:15 +04:00
<!--
A disk description can be either of type file or block
The name of the attribute on the source element depends on the type
-->
<define name="disk">
<element name="disk">
2013-01-02 18:37:08 +04:00
<choice>
<group>
<optional>
<attribute name="device">
<choice>
<value>floppy</value>
<value>disk</value>
<value>cdrom</value>
</choice>
</attribute>
</optional>
</group>
<group>
<attribute name="device">
<choice>
<value>lun</value>
</choice>
</attribute>
<optional>
<attribute name="rawio">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="sgio">
<choice>
<value>filtered</value>
<value>unfiltered</value>
</choice>
</attribute>
</optional>
</group>
</choice>
2011-08-13 23:20:21 +04:00
<optional>
<ref name="snapshot"/>
</optional>
2011-08-13 05:33:15 +04:00
<choice>
<group>
<attribute name="type">
<value>file</value>
</attribute>
<interleave>
<optional>
<element name="source">
2011-10-17 18:54:03 +04:00
<optional>
<attribute name="file">
<ref name="absFilePath"/>
</attribute>
</optional>
<optional>
<ref name="startupPolicy"/>
</optional>
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 04:47:49 +04:00
<optional>
<ref name='devSeclabel'/>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</optional>
<ref name="diskspec"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>block</value>
</attribute>
<interleave>
<optional>
<element name="source">
2013-09-09 06:08:06 +04:00
<optional>
<attribute name="dev">
<ref name="absFilePath"/>
</attribute>
</optional>
2013-07-31 11:51:44 +04:00
<optional>
<ref name="startupPolicy"/>
</optional>
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 04:47:49 +04:00
<optional>
<ref name='devSeclabel'/>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</optional>
<ref name="diskspec"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>dir</value>
</attribute>
<interleave>
<optional>
<element name="source">
<attribute name="dir">
<ref name="absFilePath"/>
</attribute>
2013-07-31 11:51:44 +04:00
<optional>
<ref name="startupPolicy"/>
</optional>
2011-08-13 05:33:15 +04:00
<empty/>
</element>
</optional>
<ref name="diskspec"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>network</value>
</attribute>
<interleave>
<optional>
<element name="source">
2013-04-03 16:14:05 +04:00
<ref name='diskSourceNetwork'/>
2011-08-13 05:33:15 +04:00
</element>
</optional>
<ref name="diskspec"/>
</interleave>
</group>
2013-04-04 23:37:56 +04:00
<group>
<attribute name="type">
<value>volume</value>
</attribute>
<interleave>
<optional>
<element name="source">
<attribute name="pool">
<ref name="genericName"/>
</attribute>
<attribute name="volume">
<ref name="volName"/>
</attribute>
2013-07-18 21:18:03 +04:00
<optional>
<attribute name="mode">
<choice>
<value>host</value>
<value>direct</value>
</choice>
</attribute>
</optional>
2013-04-04 23:37:58 +04:00
<optional>
<ref name="startupPolicy"/>
</optional>
2013-04-04 23:37:59 +04:00
<optional>
<ref name='devSeclabel'/>
</optional>
2013-04-04 23:37:56 +04:00
</element>
</optional>
<ref name="diskspec"/>
</interleave>
</group>
2011-08-13 05:33:15 +04:00
<ref name="diskspec"/>
</choice>
</element>
</define>
2013-04-03 16:14:05 +04:00
<define name="diskSourceNetwork">
<attribute name="protocol">
<choice>
<value>nbd</value>
<value>rbd</value>
<value>sheepdog</value>
<value>gluster</value>
<value>iscsi</value>
2013-08-22 23:03:07 +04:00
<value>http</value>
2013-09-16 21:12:51 +04:00
<value>https</value>
2013-08-22 23:03:08 +04:00
<value>ftp</value>
2013-09-16 21:12:52 +04:00
<value>ftps</value>
2013-09-16 21:12:53 +04:00
<value>tftp</value>
2013-04-03 16:14:05 +04:00
</choice>
</attribute>
<optional>
<attribute name="name"/>
</optional>
<zeroOrMore>
<element name="host">
<choice>
<group>
<optional>
<attribute name="transport">
<choice>
<value>tcp</value>
<value>rdma</value>
</choice>
</attribute>
</optional>
<attribute name="name">
<choice>
<ref name="dnsName"/>
<ref name="ipAddr"/>
</choice>
</attribute>
<optional>
<attribute name="port">
<ref name="unsignedInt"/>
</attribute>
</optional>
</group>
<group>
<attribute name="transport">
<value>unix</value>
</attribute>
<attribute name="socket">
<ref name="absFilePath"/>
</attribute>
</group>
</choice>
</element>
</zeroOrMore>
<empty/>
</define>
snapshot: also support disks by path
I got confused when 'virsh domblkinfo dom disk' required the
path to a disk (which can be ambiguous, since a single file
can back multiple disks), rather than the unambiguous target
device name that I was using in disk snapshots. So, in true
developer fashion, I went for the best of both worlds - all
interfaces that operate on a disk (aka block) now accept
either the target name or the unambiguous path to the backing
file used by the disk.
* src/conf/domain_conf.h (virDomainDiskIndexByName): Add
parameter.
(virDomainDiskPathByName): New prototype.
* src/libvirt_private.syms (domain_conf.h): Export it.
* src/conf/domain_conf.c (virDomainDiskIndexByName): Also allow
searching by path, and decide whether ambiguity is okay.
(virDomainDiskPathByName): New function.
(virDomainDiskRemoveByName, virDomainSnapshotAlignDisks): Update
callers.
* src/qemu/qemu_driver.c (qemudDomainBlockPeek)
(qemuDomainAttachDeviceConfig, qemuDomainUpdateDeviceConfig)
(qemuDomainGetBlockInfo, qemuDiskPathToAlias): Likewise.
* src/qemu/qemu_process.c (qemuProcessFindDomainDiskByPath):
Likewise.
* src/libxl/libxl_driver.c (libxlDomainAttachDeviceDiskLive)
(libxlDomainDetachDeviceDiskLive, libxlDomainAttachDeviceConfig)
(libxlDomainUpdateDeviceConfig): Likewise.
* src/uml/uml_driver.c (umlDomainBlockPeek): Likewise.
* src/xen/xend_internal.c (xenDaemonDomainBlockPeek): Likewise.
* docs/formatsnapshot.html.in: Update documentation.
* tools/virsh.pod (domblkstat, domblkinfo): Likewise.
* docs/schemas/domaincommon.rng (diskTarget): Tighten pattern on
disk targets.
* docs/schemas/domainsnapshot.rng (disksnapshot): Update to match.
* tests/domainsnapshotxml2xmlin/disk_snapshot.xml: Update test.
2011-08-20 06:38:36 +04:00
<define name="diskTarget">
<data type="string">
<param name="pattern">(ioemu:)?(fd|hd|sd|vd|xvd|ubd)[a-zA-Z0-9_]+</param>
</data>
</define>
2011-08-13 05:33:15 +04:00
<define name="target">
<element name="target">
<attribute name="dev">
snapshot: also support disks by path
I got confused when 'virsh domblkinfo dom disk' required the
path to a disk (which can be ambiguous, since a single file
can back multiple disks), rather than the unambiguous target
device name that I was using in disk snapshots. So, in true
developer fashion, I went for the best of both worlds - all
interfaces that operate on a disk (aka block) now accept
either the target name or the unambiguous path to the backing
file used by the disk.
* src/conf/domain_conf.h (virDomainDiskIndexByName): Add
parameter.
(virDomainDiskPathByName): New prototype.
* src/libvirt_private.syms (domain_conf.h): Export it.
* src/conf/domain_conf.c (virDomainDiskIndexByName): Also allow
searching by path, and decide whether ambiguity is okay.
(virDomainDiskPathByName): New function.
(virDomainDiskRemoveByName, virDomainSnapshotAlignDisks): Update
callers.
* src/qemu/qemu_driver.c (qemudDomainBlockPeek)
(qemuDomainAttachDeviceConfig, qemuDomainUpdateDeviceConfig)
(qemuDomainGetBlockInfo, qemuDiskPathToAlias): Likewise.
* src/qemu/qemu_process.c (qemuProcessFindDomainDiskByPath):
Likewise.
* src/libxl/libxl_driver.c (libxlDomainAttachDeviceDiskLive)
(libxlDomainDetachDeviceDiskLive, libxlDomainAttachDeviceConfig)
(libxlDomainUpdateDeviceConfig): Likewise.
* src/uml/uml_driver.c (umlDomainBlockPeek): Likewise.
* src/xen/xend_internal.c (xenDaemonDomainBlockPeek): Likewise.
* docs/formatsnapshot.html.in: Update documentation.
* tools/virsh.pod (domblkstat, domblkinfo): Likewise.
* docs/schemas/domaincommon.rng (diskTarget): Tighten pattern on
disk targets.
* docs/schemas/domainsnapshot.rng (disksnapshot): Update to match.
* tests/domainsnapshotxml2xmlin/disk_snapshot.xml: Update test.
2011-08-20 06:38:36 +04:00
<ref name="diskTarget"/>
2011-08-13 05:33:15 +04:00
</attribute>
<optional>
<attribute name="bus">
<choice>
<value>ide</value>
<value>fdc</value>
<value>scsi</value>
<value>virtio</value>
<value>xen</value>
<value>usb</value>
<value>uml</value>
2011-09-28 07:46:08 +04:00
<value>sata</value>
2013-07-31 17:00:26 +04:00
<value>sd</value>
2011-08-13 05:33:15 +04:00
</choice>
</attribute>
</optional>
2012-03-14 19:26:46 +04:00
<optional>
<attribute name="tray">
<choice>
<value>open</value>
<value>closed</value>
</choice>
</attribute>
</optional>
2013-08-23 14:38:11 +04:00
<optional>
<attribute name="removable">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</define>
2012-08-20 17:58:50 +04:00
<define name="geometry">
<element name="geometry">
<attribute name="cyls">
<data type="integer"/>
</attribute>
<attribute name="heads">
<data type="integer"/>
</attribute>
<attribute name="secs">
<data type="integer"/>
</attribute>
<optional>
<attribute name="trans">
<choice>
<value>auto</value>
<value>none</value>
<value>lba</value>
</choice>
</attribute>
</optional>
</element>
</define>
2012-09-04 18:30:55 +04:00
<define name="diskBlockIo">
<element name="blockio">
2012-08-29 19:48:30 +04:00
<optional>
<attribute name="logical_block_size">
<data type="integer"/>
</attribute>
</optional>
<optional>
<attribute name="physical_block_size">
<data type="integer"/>
</attribute>
</optional>
</element>
</define>
2011-08-13 05:33:15 +04:00
<!--
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 04:10:18 +04:00
Disk may use a special driver for access.
2011-08-13 05:33:15 +04:00
-->
2013-04-22 18:06:14 +04:00
<define name="diskDriver">
2011-08-13 05:33:15 +04:00
<element name="driver">
<choice>
<group>
<ref name="driverFormat"/>
<optional>
<ref name="driverCache"/>
</optional>
</group>
<group>
<optional>
<ref name="driverFormat"/>
</optional>
<ref name="driverCache"/>
</group>
</choice>
<optional>
<ref name="driverErrorPolicy"/>
</optional>
2011-10-04 22:17:06 +04:00
<optional>
<ref name="driverRerrorPolicy"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="driverIO"/>
</optional>
<optional>
<ref name="ioeventfd"/>
</optional>
<optional>
<ref name="event_idx"/>
</optional>
2012-01-12 13:31:14 +04:00
<optional>
<ref name="copy_on_read"/>
</optional>
2013-05-14 16:44:54 +04:00
<optional>
<ref name="discard"/>
</optional>
2011-08-13 05:33:15 +04:00
<empty/>
</element>
</define>
<define name="driverFormat">
<attribute name="name">
<ref name="genericName"/>
</attribute>
<optional>
2012-09-28 22:57:54 +04:00
<attribute name='type'>
<choice>
2013-04-22 18:06:14 +04:00
<ref name='storageFormat'/>
2012-09-28 22:57:54 +04:00
<value>aio</value> <!-- back-compat for 'raw' -->
</choice>
2011-08-13 05:33:15 +04:00
</attribute>
</optional>
</define>
2013-04-22 18:06:14 +04:00
<define name='storageFormat'>
2012-09-28 22:57:54 +04:00
<choice>
<value>raw</value>
<value>dir</value>
<value>bochs</value>
<value>cloop</value>
<value>cow</value>
<value>dmg</value>
<value>iso</value>
<value>qcow</value>
<value>qcow2</value>
<value>qed</value>
<value>vmdk</value>
<value>vpc</value>
<value>fat</value>
<value>vhd</value>
</choice>
</define>
2011-08-13 05:33:15 +04:00
<define name="driverCache">
<attribute name="cache">
<choice>
<value>none</value>
<value>writeback</value>
<value>writethrough</value>
<value>directsync</value>
2011-09-22 23:33:47 +04:00
<value>unsafe</value>
2011-08-13 05:33:15 +04:00
</choice>
</attribute>
</define>
<define name="driverErrorPolicy">
<attribute name="error_policy">
<choice>
<value>stop</value>
2011-10-04 22:17:06 +04:00
<value>report</value>
2011-08-13 05:33:15 +04:00
<value>ignore</value>
<value>enospace</value>
</choice>
</attribute>
</define>
2011-10-04 22:17:06 +04:00
<define name="driverRerrorPolicy">
<attribute name="rerror_policy">
<choice>
<value>stop</value>
<value>report</value>
<value>ignore</value>
</choice>
</attribute>
</define>
2011-08-13 05:33:15 +04:00
<define name="driverIO">
<attribute name="io">
<choice>
<value>threads</value>
<value>native</value>
</choice>
</attribute>
</define>
<define name="ioeventfd">
<attribute name="ioeventfd">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
</define>
<define name="event_idx">
<attribute name="event_idx">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
</define>
2012-01-12 13:31:14 +04:00
<define name="copy_on_read">
<attribute name='copy_on_read'>
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
2013-05-14 16:44:54 +04:00
</define>
<define name="discard">
<attribute name='discard'>
<choice>
2013-05-17 06:35:02 +04:00
<value>unmap</value>
<value>ignore</value>
2013-05-14 16:44:54 +04:00
</choice>
</attribute>
2012-01-12 13:31:14 +04:00
</define>
2011-08-13 05:33:15 +04:00
<define name="controller">
<element name="controller">
rng: tighten up domain <controller> schema
The rng schema for <controller> had been non-specific about which
types of controllers allowed which models, and also allowed the
num_queues attribute (since that hasn't been released yet, should we
rename it to "numQueues"?) and <master> subelement to be included for
any controller type. In reality, half of the models are allowed only
for type='scsi', and the other half only for type='usb', num_queues is
allowed only for type='scsi', and <master> only for type='usb'.
This patch makes a separate <group> for type='scsi' and type='usb',
with each group allowing only the appropriate model values, and
allowing num_queue and <master> only when appropriate.
<interleave> also hadn't been specified, forcing a specific order of
subelements, which should never be done. (Note that the <interleave>
had to surround the main element attributes that are in the <group>
subelements, due to one of the <group>s containing a subelement).
2013-04-18 08:25:18 +04:00
<attribute name="index">
<ref name="unsignedInt"/>
</attribute>
<interleave>
<optional>
<ref name="alias"/>
</optional>
<optional>
<ref name="address"/>
</optional>
<choice>
<!-- fdc/ide/sata/ccid have only the common attributes -->
<group>
2011-08-13 05:33:15 +04:00
<attribute name="type">
<choice>
<value>fdc</value>
<value>ide</value>
<value>sata</value>
<value>ccid</value>
</choice>
</attribute>
rng: tighten up domain <controller> schema
The rng schema for <controller> had been non-specific about which
types of controllers allowed which models, and also allowed the
num_queues attribute (since that hasn't been released yet, should we
rename it to "numQueues"?) and <master> subelement to be included for
any controller type. In reality, half of the models are allowed only
for type='scsi', and the other half only for type='usb', num_queues is
allowed only for type='scsi', and <master> only for type='usb'.
This patch makes a separate <group> for type='scsi' and type='usb',
with each group allowing only the appropriate model values, and
allowing num_queue and <master> only when appropriate.
<interleave> also hadn't been specified, forcing a specific order of
subelements, which should never be done. (Note that the <interleave>
had to surround the main element attributes that are in the <group>
subelements, due to one of the <group>s containing a subelement).
2013-04-18 08:25:18 +04:00
</group>
<!-- scsi has an optional attribute "model" -->
<group>
<attribute name="type">
<value>scsi</value>
2011-08-13 05:33:15 +04:00
</attribute>
rng: tighten up domain <controller> schema
The rng schema for <controller> had been non-specific about which
types of controllers allowed which models, and also allowed the
num_queues attribute (since that hasn't been released yet, should we
rename it to "numQueues"?) and <master> subelement to be included for
any controller type. In reality, half of the models are allowed only
for type='scsi', and the other half only for type='usb', num_queues is
allowed only for type='scsi', and <master> only for type='usb'.
This patch makes a separate <group> for type='scsi' and type='usb',
with each group allowing only the appropriate model values, and
allowing num_queue and <master> only when appropriate.
<interleave> also hadn't been specified, forcing a specific order of
subelements, which should never be done. (Note that the <interleave>
had to surround the main element attributes that are in the <group>
subelements, due to one of the <group>s containing a subelement).
2013-04-18 08:25:18 +04:00
<optional>
<attribute name="model">
<choice>
<value>auto</value>
<value>buslogic</value>
<value>lsilogic</value>
<value>lsisas1068</value>
<value>vmpvscsi</value>
<value>ibmvscsi</value>
<value>virtio-scsi</value>
<value>lsisas1078</value>
</choice>
</attribute>
</optional>
</group>
<!-- usb has an optional attribute "model", and optional subelement "master" -->
<group>
<attribute name="type">
<value>usb</value>
2011-08-13 05:33:15 +04:00
</attribute>
rng: tighten up domain <controller> schema
The rng schema for <controller> had been non-specific about which
types of controllers allowed which models, and also allowed the
num_queues attribute (since that hasn't been released yet, should we
rename it to "numQueues"?) and <master> subelement to be included for
any controller type. In reality, half of the models are allowed only
for type='scsi', and the other half only for type='usb', num_queues is
allowed only for type='scsi', and <master> only for type='usb'.
This patch makes a separate <group> for type='scsi' and type='usb',
with each group allowing only the appropriate model values, and
allowing num_queue and <master> only when appropriate.
<interleave> also hadn't been specified, forcing a specific order of
subelements, which should never be done. (Note that the <interleave>
had to surround the main element attributes that are in the <group>
subelements, due to one of the <group>s containing a subelement).
2013-04-18 08:25:18 +04:00
<optional>
<attribute name="model">
<choice>
<value>piix3-uhci</value>
<value>piix4-uhci</value>
<value>ehci</value>
<value>ich9-ehci1</value>
<value>ich9-uhci1</value>
<value>ich9-uhci2</value>
<value>ich9-uhci3</value>
<value>vt82c686b-uhci</value>
<value>pci-ohci</value>
<value>nec-xhci</value>
<value>none</value>
</choice>
</attribute>
</optional>
<optional>
<ref name="usbmaster"/>
</optional>
</group>
2013-04-17 19:05:15 +04:00
<!-- pci has an optional attribute "model" -->
<group>
<attribute name="type">
<value>pci</value>
</attribute>
2013-08-12 15:39:04 +04:00
<!-- *-root controllers have an optional element "pcihole64"-->
<choice>
<group>
<attribute name="model">
<choice>
<value>pci-root</value>
<value>pcie-root</value>
</choice>
</attribute>
<optional>
<element name="pcihole64">
<ref name="scaledInteger"/>
</element>
</optional>
</group>
<group>
<attribute name="model">
<choice>
<value>pci-bridge</value>
<value>dmi-to-pci-bridge</value>
</choice>
</attribute>
</group>
</choice>
2013-04-17 19:05:15 +04:00
</group>
rng: tighten up domain <controller> schema
The rng schema for <controller> had been non-specific about which
types of controllers allowed which models, and also allowed the
num_queues attribute (since that hasn't been released yet, should we
rename it to "numQueues"?) and <master> subelement to be included for
any controller type. In reality, half of the models are allowed only
for type='scsi', and the other half only for type='usb', num_queues is
allowed only for type='scsi', and <master> only for type='usb'.
This patch makes a separate <group> for type='scsi' and type='usb',
with each group allowing only the appropriate model values, and
allowing num_queue and <master> only when appropriate.
<interleave> also hadn't been specified, forcing a specific order of
subelements, which should never be done. (Note that the <interleave>
had to surround the main element attributes that are in the <group>
subelements, due to one of the <group>s containing a subelement).
2013-04-18 08:25:18 +04:00
<!-- virtio-serial has optional "ports" and "vectors" -->
<group>
<attribute name="type">
<value>virtio-serial</value>
</attribute>
<optional>
<attribute name="ports">
<ref name="unsignedInt"/>
</attribute>
</optional>
<optional>
<attribute name="vectors">
<ref name="unsignedInt"/>
</attribute>
</optional>
</group>
</choice>
2013-04-24 13:24:38 +04:00
<optional>
<element name="driver">
<optional>
<attribute name="queues">
<ref name="unsignedInt"/>
</attribute>
</optional>
</element>
</optional>
rng: tighten up domain <controller> schema
The rng schema for <controller> had been non-specific about which
types of controllers allowed which models, and also allowed the
num_queues attribute (since that hasn't been released yet, should we
rename it to "numQueues"?) and <master> subelement to be included for
any controller type. In reality, half of the models are allowed only
for type='scsi', and the other half only for type='usb', num_queues is
allowed only for type='scsi', and <master> only for type='usb'.
This patch makes a separate <group> for type='scsi' and type='usb',
with each group allowing only the appropriate model values, and
allowing num_queue and <master> only when appropriate.
<interleave> also hadn't been specified, forcing a specific order of
subelements, which should never be done. (Note that the <interleave>
had to surround the main element attributes that are in the <group>
subelements, due to one of the <group>s containing a subelement).
2013-04-18 08:25:18 +04:00
</interleave>
2011-08-13 05:33:15 +04:00
</element>
</define>
<define name="filesystem">
<element name="filesystem">
<choice>
<group>
<attribute name="type">
<value>file</value>
</attribute>
2013-04-22 18:06:14 +04:00
<optional>
<ref name="fsDriver"/>
</optional>
2011-08-13 05:33:15 +04:00
<interleave>
<element name="source">
<attribute name="file">
<ref name="absFilePath"/>
</attribute>
<empty/>
</element>
</interleave>
</group>
<group>
<attribute name="type">
<value>block</value>
</attribute>
2013-04-22 18:06:14 +04:00
<optional>
<ref name="fsDriver"/>
</optional>
2011-08-13 05:33:15 +04:00
<interleave>
<element name="source">
<attribute name="dev">
<ref name="absFilePath"/>
</attribute>
<empty/>
</element>
</interleave>
</group>
<group>
2011-10-11 15:30:40 +04:00
<!-- type='mount' is default -->
<optional>
<attribute name="type">
<value>mount</value>
</attribute>
</optional>
2013-04-22 18:06:14 +04:00
<optional>
<ref name="fsDriver"/>
</optional>
2011-08-13 05:33:15 +04:00
<interleave>
<element name="source">
<attribute name="dir">
2013-11-07 21:14:32 +04:00
<ref name="absDirPath"/>
2011-08-13 05:33:15 +04:00
</attribute>
<empty/>
</element>
</interleave>
</group>
2012-06-20 18:03:30 +04:00
<group>
<optional>
<attribute name="type">
<value>bind</value>
</attribute>
</optional>
2013-04-22 18:06:14 +04:00
<optional>
<ref name="fsDriver"/>
</optional>
2012-06-20 18:03:30 +04:00
<interleave>
<element name="source">
<attribute name="dir">
2013-11-07 21:14:32 +04:00
<ref name="absDirPath"/>
2012-06-20 18:03:30 +04:00
</attribute>
<empty/>
</element>
</interleave>
</group>
2011-08-13 05:33:15 +04:00
<group>
<attribute name="type">
<value>template</value>
</attribute>
2013-04-22 18:06:14 +04:00
<optional>
<ref name="fsDriver"/>
</optional>
2011-08-13 05:33:15 +04:00
<interleave>
<element name="source">
<attribute name="name">
<ref name="genericName"/>
</attribute>
<empty/>
</element>
</interleave>
</group>
2012-05-08 20:50:48 +04:00
<group>
<attribute name="type">
<value>ram</value>
</attribute>
2013-04-22 18:06:14 +04:00
<optional>
<ref name="fsDriver"/>
</optional>
2012-05-08 20:50:48 +04:00
<interleave>
<element name="source">
<attribute name="usage">
<ref name="unsignedLong"/>
</attribute>
<optional>
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 16:17:13 +04:00
<attribute name='units'>
2012-05-08 20:50:48 +04:00
<ref name='unit'/>
</attribute>
</optional>
<empty/>
</element>
</interleave>
</group>
2011-08-13 05:33:15 +04:00
</choice>
2012-04-17 13:50:41 +04:00
<interleave>
<element name="target">
<attribute name="dir">
<ref name="absDirPath"/>
</attribute>
2012-01-16 13:17:26 +04:00
<empty/>
</element>
2012-04-17 13:50:41 +04:00
<optional>
<attribute name="accessmode">
<choice>
<value>passthrough</value>
<value>mapped</value>
<value>squash</value>
</choice>
</attribute>
</optional>
<optional>
<element name='readonly'>
<empty/>
</element>
</optional>
<optional>
<ref name="alias"/>
</optional>
<optional>
<ref name="address"/>
</optional>
</interleave>
2012-05-23 16:38:55 +04:00
<interleave>
<optional>
<element name="space_hard_limit">
<ref name='scaledInteger'/>
</element>
</optional>
<optional>
<element name="space_soft_limit">
<ref name='scaledInteger'/>
</element>
</optional>
</interleave>
2011-08-13 05:33:15 +04:00
</element>
</define>
2013-04-22 18:06:14 +04:00
<define name="fsDriver">
<element name="driver">
<!-- Annoying inconsistency. 'disk' uses 'name'
for this kind of info, and 'type' for the
storage format. We need the latter too, so
had to invent a new attribute name -->
<optional>
<attribute name="type">
<choice>
<value>path</value>
<value>handle</value>
<value>loop</value>
2013-04-22 18:06:17 +04:00
<value>nbd</value>
2013-04-22 18:06:14 +04:00
</choice>
</attribute>
</optional>
<optional>
<attribute name="format">
<ref name="storageFormat"/>
</attribute>
</optional>
<optional>
<attribute name="wrpolicy">
<value>immediate</value>
</attribute>
</optional>
<empty/>
</element>
</define>
2011-08-13 05:33:15 +04:00
<!--
An interface description can either be of type bridge in which case
it will use a bridging source, or of type ethernet which uses a device
source and a device target instead. They both share a set of interface
options. FIXME
-->
<define name="interface">
<element name="interface">
<choice>
<group>
<attribute name="type">
<value>bridge</value>
</attribute>
<interleave>
<optional>
<element name="source">
<attribute name="bridge">
<ref name="deviceName"/>
</attribute>
<empty/>
</element>
</optional>
2012-08-12 20:01:32 +04:00
<optional>
<ref name="virtualPortProfile"/>
</optional>
2011-08-13 05:33:15 +04:00
<ref name="interface-options"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>ethernet</value>
</attribute>
<interleave>
<optional>
<element name="source">
<attribute name="dev">
<ref name="deviceName"/>
</attribute>
<empty/>
</element>
</optional>
<ref name="interface-options"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>network</value>
</attribute>
<interleave>
<element name="source">
<attribute name="network">
<ref name="deviceName"/>
</attribute>
<optional>
<attribute name="portgroup">
<ref name="deviceName"/>
</attribute>
</optional>
<empty/>
</element>
<optional>
<ref name="virtualPortProfile"/>
</optional>
<ref name="interface-options"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>direct</value>
</attribute>
<interleave>
<element name="source">
<attribute name="dev">
<ref name="deviceName"/>
</attribute>
<optional>
<attribute name="mode">
<ref name="bridgeMode"/>
</attribute>
</optional>
<empty/>
</element>
<optional>
<ref name="virtualPortProfile"/>
</optional>
<ref name="interface-options"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>user</value>
</attribute>
<interleave>
<ref name="interface-options"/>
</interleave>
</group>
<group>
<attribute name="type">
<value>internal</value>
</attribute>
<interleave>
<element name="source">
<attribute name="name">
<ref name="deviceName"/>
</attribute>
<empty/>
</element>
<ref name="interface-options"/>
</interleave>
</group>
2012-01-16 18:08:07 +04:00
<group>
<attribute name="type">
<choice>
<value>mcast</value>
<value>client</value>
</choice>
</attribute>
<interleave>
<element name="source">
<attribute name="address">
<ref name="ipv4Addr"/>
</attribute>
<attribute name="port">
<ref name="PortNumber"/>
</attribute>
<empty/>
</element>
<optional>
<element name="mac">
<attribute name="address">
2012-03-19 20:49:17 +04:00
<ref name="uniMacAddr"/>
2012-01-16 18:08:07 +04:00
</attribute>
<empty/>
</element>
</optional>
</interleave>
</group>
<group>
<attribute name="type">
<value>server</value>
</attribute>
<interleave>
<element name="source">
<optional>
<attribute name="address">
<ref name="ipv4Addr"/>
</attribute>
</optional>
<attribute name="port">
<ref name="PortNumber"/>
</attribute>
<empty/>
</element>
<optional>
<element name="mac">
<attribute name="address">
2012-03-19 20:49:17 +04:00
<ref name="uniMacAddr"/>
2012-01-16 18:08:07 +04:00
</attribute>
<empty/>
</element>
</optional>
</interleave>
</group>
2012-02-15 21:37:15 +04:00
<group>
<attribute name="type">
<value>hostdev</value>
</attribute>
<optional>
<attribute name="managed">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<interleave>
<element name="source">
2012-10-12 00:33:46 +04:00
<optional>
<attribute name="missing">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
2012-02-15 21:37:15 +04:00
<choice>
<group>
<ref name="usbproduct"/>
<optional>
<ref name="usbaddress"/>
</optional>
</group>
<element name="address">
<choice>
<group>
<attribute name="type">
<value>pci</value>
</attribute>
<ref name="pciaddress"/>
</group>
<group>
<attribute name="type">
<value>usb</value>
</attribute>
<attribute name="bus">
<ref name="usbAddr"/>
</attribute>
<attribute name="device">
<ref name="usbPort"/>
</attribute>
</group>
</choice>
</element>
</choice>
</element>
<optional>
<ref name="virtualPortProfile"/>
</optional>
<ref name="interface-options"/>
</interleave>
</group>
2011-08-13 05:33:15 +04:00
</choice>
</element>
</define>
<!--
The interface options possible are:
- the MAC address
- the IP address bound to the interface
- the name of the script used to set up the binding
- the target device used
- boot order
-->
<define name="interface-options">
<interleave>
<optional>
<element name="target">
<attribute name="dev">
<ref name="deviceName"/>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="mac">
<attribute name="address">
2012-03-19 20:49:17 +04:00
<ref name="uniMacAddr"/>
2011-08-13 05:33:15 +04:00
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="ip">
<attribute name="address">
<ref name="ipv4Addr"/>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="script">
<attribute name="path">
<ref name="filePath"/>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="model">
2011-12-08 10:41:22 +04:00
<attribute name="type">
<data type="string">
<param name='pattern'>[a-zA-Z0-9\-_]+</param>
</data>
</attribute>
2011-08-13 05:33:15 +04:00
<empty/>
</element>
</optional>
<optional>
<element name="driver">
2013-03-15 23:15:14 +04:00
<choice>
<group>
<attribute name="name">
<choice>
<value>kvm</value>
<value>vfio</value>
</choice>
</attribute>
</group>
<group>
<optional>
<attribute name="name">
<choice>
<value>qemu</value>
<value>vhost</value>
</choice>
</attribute>
</optional>
2013-04-10 14:19:37 +04:00
<optional>
<attribute name='queues'>
<ref name="positiveInteger"/>
</attribute>
</optional>
2013-03-15 23:15:14 +04:00
<optional>
<attribute name="txmode">
<choice>
<value>iothread</value>
<value>timer</value>
</choice>
</attribute>
</optional>
<optional>
<ref name="ioeventfd"/>
</optional>
<optional>
<ref name="event_idx"/>
</optional>
</group>
</choice>
2011-08-13 05:33:15 +04:00
<empty/>
</element>
</optional>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
<optional>
<element name="filterref">
<ref name="filterref-node-attributes"/>
</element>
</optional>
<optional>
<element name="tune">
<optional>
<!-- size of send buffer for network tap devices -->
<element name="sndbuf">
<ref name="unsignedInt"/>
</element>
</optional>
</element>
</optional>
<optional>
<ref name="deviceBoot"/>
</optional>
2012-01-25 04:54:12 +04:00
<optional>
<ref name="rom"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="bandwidth"/>
</optional>
2012-08-12 11:51:30 +04:00
<optional>
<ref name="vlan"/>
</optional>
2011-08-13 05:33:15 +04:00
</interleave>
</define>
<!--
An emulator description is just a path to the binary used for the task
-->
<define name="emulator">
<element name="emulator">
<ref name="absFilePath"/>
</element>
</define>
<!--
A graphic description, currently in Xen only 2 types are supported:
- sdl with optional display, xauth and fullscreen
- vnc with a required port and optional listen IP address, password
and keymap
-->
<define name="graphic">
<element name="graphics">
<choice>
<group>
<attribute name="type">
<value>sdl</value>
</attribute>
<optional>
<attribute name="display">
<text/>
</attribute>
</optional>
<optional>
<attribute name="xauth">
<text/>
</attribute>
</optional>
<optional>
<attribute name="fullscreen">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
</group>
<group>
<attribute name="type">
<value>vnc</value>
</attribute>
<choice>
<group>
<optional>
<attribute name="port">
<ref name="PortNumber"/>
</attribute>
</optional>
<optional>
<attribute name="autoport">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
2013-04-29 16:34:01 +04:00
<optional>
<attribute name="websocket">
<ref name="PortNumber"/>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<attribute name="listen">
<ref name="addrIPorName"/>
</attribute>
</optional>
2013-05-21 18:31:48 +04:00
<optional>
<attribute name='sharePolicy'>
<choice>
<value>allow-exclusive</value>
<value>force-shared</value>
<value>ignore</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
</group>
<group>
<optional>
<attribute name="socket">
<ref name="absFilePath"/>
</attribute>
</optional>
</group>
</choice>
<optional>
<attribute name="passwd">
<text/>
</attribute>
</optional>
<optional>
<attribute name="keymap">
<text/>
</attribute>
</optional>
<optional>
<attribute name="passwdValidTo">
<data type="dateTime"/>
</attribute>
</optional>
<optional>
<attribute name="connected">
<choice>
<value>keep</value>
</choice>
</attribute>
</optional>
<ref name="listenElements"/>
</group>
<group>
<attribute name="type">
<value>spice</value>
</attribute>
<optional>
<attribute name="port">
<ref name="PortNumber"/>
</attribute>
</optional>
<optional>
<attribute name="tlsPort">
<ref name="PortNumber"/>
</attribute>
</optional>
<optional>
<attribute name="autoport">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="listen">
<ref name="addrIPorName"/>
</attribute>
</optional>
<optional>
<attribute name="passwd">
<text/>
</attribute>
</optional>
<optional>
<attribute name="keymap">
<text/>
</attribute>
</optional>
<optional>
<attribute name="passwdValidTo">
<data type="dateTime"/>
</attribute>
</optional>
<optional>
<attribute name="connected">
<choice>
<value>fail</value>
<value>disconnect</value>
<value>keep</value>
</choice>
</attribute>
</optional>
2012-05-08 21:42:44 +04:00
<optional>
<attribute name="defaultMode">
<choice>
<value>any</value>
<value>secure</value>
<value>insecure</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
<interleave>
<ref name="listenElements"/>
<zeroOrMore>
<element name="channel">
<attribute name="name">
<choice>
<value>main</value>
<value>display</value>
<value>inputs</value>
<value>cursor</value>
<value>playback</value>
<value>record</value>
<value>smartcard</value>
2012-05-08 17:00:28 +04:00
<value>usbredir</value>
2011-08-13 05:33:15 +04:00
</choice>
</attribute>
<attribute name="mode">
<choice>
<value>any</value>
<value>secure</value>
<value>insecure</value>
</choice>
</attribute>
<empty/>
</element>
</zeroOrMore>
<optional>
<element name="image">
<attribute name="compression">
<choice>
<value>auto_glz</value>
<value>auto_lz</value>
<value>quic</value>
<value>glz</value>
<value>lz</value>
<value>off</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="jpeg">
<attribute name="compression">
<choice>
<value>auto</value>
<value>never</value>
<value>always</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="zlib">
<attribute name="compression">
<choice>
<value>auto</value>
<value>never</value>
<value>always</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="playback">
<attribute name="compression">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="streaming">
<attribute name="mode">
<choice>
<value>filter</value>
<value>all</value>
<value>off</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
<optional>
<element name="clipboard">
<attribute name="copypaste">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
2012-03-09 11:26:24 +04:00
<optional>
<element name="mouse">
<attribute name="mode">
<choice>
<value>server</value>
<value>client</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
2014-01-16 20:11:15 +04:00
<optional>
<element name="filetransfer">
<attribute name="enable">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
<empty/>
</element>
</optional>
2011-08-13 05:33:15 +04:00
</interleave>
</group>
<group>
<attribute name="type">
<value>rdp</value>
</attribute>
<optional>
<attribute name="port">
<ref name="PortNumber"/>
</attribute>
</optional>
<optional>
<attribute name="autoport">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="replaceUser">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="multiUser">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="listen">
<ref name="addrIPorName"/>
</attribute>
</optional>
<ref name="listenElements"/>
</group>
<group>
<attribute name="type">
<value>desktop</value>
</attribute>
<optional>
<attribute name="display">
<text/>
</attribute>
</optional>
<optional>
<attribute name="fullscreen">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
</group>
</choice>
</element>
</define>
<define name="listenElements">
<zeroOrMore>
<element name="listen">
<choice>
<group>
<attribute name="type">
<value>address</value>
</attribute>
<attribute name="address">
<ref name="addrIPorName"/>
</attribute>
</group>
<group>
<attribute name="type">
<value>network</value>
</attribute>
<attribute name="network">
<text/>
</attribute>
<optional>
<attribute name="address">
<ref name="addrIPorName"/>
</attribute>
</optional>
</group>
</choice>
</element>
</zeroOrMore>
</define>
<!--
A video adapter description, allowing configuration of device
2013-01-18 22:36:36 +04:00
model, number of virtual heads, video ram size, and for qxl
both ram bar sizes.
2011-08-13 05:33:15 +04:00
-->
<define name="video">
<element name="video">
<optional>
<element name="model">
2013-01-18 22:36:36 +04:00
<choice>
<attribute name="type">
<choice>
<value>vga</value>
<value>cirrus</value>
<value>vmvga</value>
<value>xen</value>
<value>vbox</value>
</choice>
</attribute>
<group>
<attribute name="type">
<value>qxl</value>
</attribute>
<optional>
<attribute name="ram">
<ref name="unsignedInt"/>
</attribute>
</optional>
</group>
</choice>
2011-08-13 05:33:15 +04:00
<optional>
<attribute name="vram">
<ref name="unsignedInt"/>
</attribute>
</optional>
<optional>
<attribute name="heads">
<ref name="unsignedInt"/>
</attribute>
</optional>
2012-12-17 10:01:20 +04:00
<optional>
<attribute name="primary">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<element name="acceleration">
<optional>
<attribute name="accel3d">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="accel2d">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
</element>
</optional>
</element>
</optional>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
</element>
</define>
<!--
2012-09-06 23:56:49 +04:00
When a certain event happens, multiple policies can be applied
depends on what happened:
2011-08-13 05:33:15 +04:00
-->
2012-09-06 23:56:49 +04:00
<define name="events">
2011-08-13 05:33:15 +04:00
<interleave>
<optional>
<element name="on_reboot">
<ref name="offOptions"/>
</element>
</optional>
<optional>
<element name="on_poweroff">
<ref name="offOptions"/>
</element>
</optional>
<optional>
<element name="on_crash">
<ref name="crashOptions"/>
</element>
</optional>
2012-09-07 00:17:01 +04:00
<optional>
<element name="on_lockfailure">
<ref name="lockfailureOptions"/>
</element>
</optional>
2011-08-13 05:33:15 +04:00
</interleave>
</define>
<!--
Options when a domain terminates:
destroy: The domain is cleaned up
restart: A new domain is started in place of the old one
preserve: The domain will remain in memory until it is destroyed manually
rename-restart: a variant of the previous one but where the old domain is
renamed before being saved to allow a restart
-->
<define name="offOptions">
<choice>
<value>destroy</value>
<value>restart</value>
<value>preserve</value>
<value>rename-restart</value>
</choice>
</define>
<!--
Options when a domain crashes:
destroy: The domain is cleaned up
restart: A new domain is started in place of the old one
preserve: The domain will remain in memory until it is destroyed manually
rename-restart: a variant of the previous one but where the old domain is
renamed before being saved to allow a restart
coredump-destroy: The crashed domain's core will be dumped, and then the
domain will be terminated completely and all resources
released
coredump-restart: The crashed domain's core will be dumped, and then the
domain will be restarted with the same configuration
-->
<define name="crashOptions">
<choice>
<value>destroy</value>
<value>restart</value>
<value>preserve</value>
<value>rename-restart</value>
<value>coredump-destroy</value>
<value>coredump-restart</value>
</choice>
</define>
2012-09-07 00:17:01 +04:00
<!--
Options when resource locks are lost:
poweroff: power off the domain
restart: power off the domain and start it up again to reacquire the
locks
pause: pause the execution of the domain so that it can be manually
resumed when lock issues are solved
ignore: keep the domain running
-->
<define name="lockfailureOptions">
<choice>
<value>poweroff</value>
<value>restart</value>
<value>pause</value>
<value>ignore</value>
</choice>
</define>
2012-08-02 14:12:50 +04:00
<!--
Control ACPI sleep states (dis)allowed for the domain
For each of the states the following rules apply:
on: the state will be forcefully enabled
off: the state will be forcefully disabled
not specified: hypervisor will be left to decide its defaults
-->
<define name="pm">
<element name="pm">
<interleave>
<optional>
<element name="suspend-to-mem">
<ref name="suspendChoices"/>
</element>
</optional>
<optional>
<element name="suspend-to-disk">
<ref name="suspendChoices"/>
</element>
</optional>
</interleave>
<empty/>
</element>
</define>
<define name="suspendChoices">
<optional>
<attribute name="enabled">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
</define>
2011-08-13 05:33:15 +04:00
<!--
Specific setup for a qemu emulated character device. Note: this
definition doesn't fully specify the constraints on this node.
-->
<define name="qemucdev">
<ref name="qemucdevSrcType"/>
<optional>
<attribute name="tty">
<ref name="absFilePath"/>
</attribute>
</optional>
<interleave>
<ref name="qemucdevSrcDef"/>
<optional>
<ref name="qemucdevTgtDef"/>
</optional>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
</interleave>
</define>
<define name="qemucdevConsoleTgtType">
<attribute name="type">
<choice>
<value>xen</value>
<value>serial</value>
<value>uml</value>
<value>virtio</value>
2012-03-26 21:11:09 +04:00
<value>lxc</value>
<value>openvz</value>
2013-01-07 21:17:14 +04:00
<value>sclp</value>
<value>sclplm</value>
2011-08-13 05:33:15 +04:00
</choice>
</attribute>
</define>
2013-01-05 09:25:36 +04:00
<define name='qemucdevSerialTgtType'>
<attribute name='type'>
<choice>
<value>isa-serial</value>
<value>usb-serial</value>
</choice>
</attribute>
</define>
2011-08-13 05:33:15 +04:00
<define name="qemucdevTgtDef">
<element name="target">
<interleave>
2013-01-05 09:25:36 +04:00
<choice>
<optional>
<ref name="qemucdevConsoleTgtType"/>
</optional>
<optional>
<ref name="qemucdevSerialTgtType"/>
</optional>
</choice>
2011-08-13 05:33:15 +04:00
<optional>
<attribute name="port"/>
</optional>
</interleave>
</element>
</define>
<define name="qemucdevSrcTypeChoice">
<choice>
<value>dev</value>
<value>file</value>
<value>pipe</value>
<value>unix</value>
<value>tcp</value>
<value>udp</value>
<value>null</value>
<value>stdio</value>
<value>vc</value>
<value>pty</value>
<value>spicevmc</value>
2014-02-10 14:18:16 +04:00
<value>spiceport</value>
2011-08-13 05:33:15 +04:00
</choice>
</define>
2012-09-13 11:25:47 +04:00
<define name="usbdevfilter">
<element name="usbdev">
<attribute name="allow">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
<optional>
<attribute name="class">
<choice>
<ref name="usbClass"/>
<ref name="usbIdDefault"/>
</choice>
</attribute>
</optional>
<optional>
<attribute name="vendor">
<choice>
<ref name="usbId"/>
<ref name="usbIdDefault"/>
</choice>
</attribute>
</optional>
<optional>
<attribute name="product">
<choice>
<ref name="usbId"/>
<ref name="usbIdDefault"/>
</choice>
</attribute>
</optional>
<optional>
<attribute name="version">
<choice>
<ref name="usbVersion"/>
<ref name="usbIdDefault"/>
</choice>
</attribute>
</optional>
</element>
</define>
2011-08-13 05:33:15 +04:00
<define name="qemucdevSrcType">
<attribute name="type">
<ref name="qemucdevSrcTypeChoice"/>
</attribute>
</define>
<define name="qemucdevSrcDef">
<zeroOrMore>
<element name="source">
<optional>
<attribute name="mode"/>
</optional>
<optional>
<attribute name="path"/>
</optional>
<optional>
<attribute name="host"/>
</optional>
<optional>
<attribute name="service"/>
</optional>
<optional>
<attribute name="wiremode"/>
</optional>
2014-02-10 14:18:16 +04:00
<optional>
<attribute name="channel"/>
</optional>
2012-09-20 17:16:17 +04:00
<optional>
<ref name='devSeclabel'/>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</zeroOrMore>
<optional>
<element name="protocol">
<optional>
<attribute name="type">
<choice>
<value>raw</value>
<value>telnet</value>
<value>telnets</value>
<value>tls</value>
</choice>
</attribute>
</optional>
</element>
</optional>
</define>
<!--
The description for a console
just a tty device
-->
<define name="console">
<element name="console">
<choice>
<group>
<optional>
<attribute name="tty">
<ref name="absFilePath"/>
</attribute>
</optional>
<empty/>
</group>
<choice>
<ref name="qemucdev"/>
</choice>
</choice>
</element>
</define>
2012-05-16 02:55:09 +04:00
<define name="codec">
<element name="codec">
<attribute name="type">
<choice>
<value>duplex</value>
<value>micro</value>
</choice>
</attribute>
</element>
</define>
2011-08-13 05:33:15 +04:00
<define name="sound">
<element name="sound">
<attribute name="model">
<choice>
<value>sb16</value>
<value>es1370</value>
<value>pcspk</value>
<value>ac97</value>
<value>ich6</value>
2013-09-24 18:17:38 +04:00
<value>ich9</value>
2011-08-13 05:33:15 +04:00
</choice>
</attribute>
2012-05-16 02:55:09 +04:00
<interleave>
<optional>
<ref name="alias"/>
</optional>
<optional>
<ref name="address"/>
</optional>
<zeroOrMore>
<choice>
<ref name="codec"/>
</choice>
</zeroOrMore>
</interleave>
2011-08-13 05:33:15 +04:00
</element>
</define>
<define name="watchdog">
<element name="watchdog">
<attribute name="model">
<choice>
<value>i6300esb</value>
<value>ib700</value>
</choice>
</attribute>
<optional>
<attribute name="action">
<choice>
<value>reset</value>
<value>shutdown</value>
<value>poweroff</value>
<value>pause</value>
<value>none</value>
<value>dump</value>
</choice>
</attribute>
</optional>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
</element>
</define>
2013-04-19 12:37:51 +04:00
<define name="nvram">
<element name="nvram">
<optional>
<ref name="address"/>
</optional>
</element>
</define>
2011-08-13 05:33:15 +04:00
<define name="memballoon">
<element name="memballoon">
<attribute name="model">
<choice>
<value>virtio</value>
<value>xen</value>
<value>none</value>
</choice>
</attribute>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
2013-06-26 15:00:00 +04:00
<optional>
<element name="stats">
<attribute name="period">
<ref name="positiveInteger"/>
</attribute>
</element>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</define>
<define name="parallel">
<element name="parallel">
<ref name="qemucdev"/>
</element>
</define>
<define name="serial">
<element name="serial">
<ref name="qemucdev"/>
</element>
</define>
<define name="guestfwdTarget">
<element name="target">
<attribute name="type">
<value>guestfwd</value>
</attribute>
<attribute name="address"/>
<attribute name="port"/>
</element>
</define>
<define name="virtioTarget">
<element name="target">
<attribute name="type">
<value>virtio</value>
</attribute>
<optional>
<attribute name="name"/>
</optional>
</element>
</define>
<define name="channel">
<element name="channel">
<ref name="qemucdevSrcType"/>
<interleave>
<ref name="qemucdevSrcDef"/>
<choice>
<ref name="guestfwdTarget"/>
<ref name="virtioTarget"/>
</choice>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
</interleave>
</element>
</define>
<define name="smartcard">
<element name="smartcard">
<choice>
<group>
<attribute name="mode">
<value>host</value>
</attribute>
<!-- might need to add optional database element here later -->
</group>
<group>
<attribute name="mode">
<value>host-certificates</value>
</attribute>
<ref name='certificate'/>
<ref name='certificate'/>
<ref name='certificate'/>
<optional>
<element name="database">
<ref name="absDirPath"/>
</element>
</optional>
</group>
<group>
<attribute name="mode">
<value>passthrough</value>
</attribute>
<ref name="qemucdevSrcType"/>
<interleave>
<ref name="qemucdevSrcDef"/>
<optional>
<ref name="qemucdevTgtDef"/>
</optional>
</interleave>
</group>
</choice>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
</element>
</define>
<define name="certificate">
<element name="certificate">
<text/>
</element>
</define>
2013-04-13 00:55:45 +04:00
<define name="tpm">
<element name="tpm">
<optional>
<attribute name="model">
<choice>
<value>tpm-tis</value>
</choice>
</attribute>
</optional>
<ref name="tpm-backend"/>
<optional>
<ref name="alias"/>
</optional>
</element>
</define>
<define name="tpm-backend">
<element name="backend">
<choice>
<group>
<attribute name="type">
<value>passthrough</value>
</attribute>
<ref name="tpm-passthrough-device"/>
</group>
</choice>
</element>
</define>
<define name="tpm-passthrough-device">
<optional>
<element name="device">
<optional>
<attribute name="path">
<ref name="filePath"/>
</attribute>
</optional>
</element>
</optional>
</define>
2011-08-13 05:33:15 +04:00
<define name="input">
<element name="input">
<attribute name="type">
<choice>
<value>tablet</value>
<value>mouse</value>
</choice>
</attribute>
<optional>
<attribute name="bus">
<choice>
<value>ps2</value>
<value>usb</value>
<value>xen</value>
</choice>
</attribute>
</optional>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
</element>
</define>
<define name="hub">
<element name="hub">
<attribute name="type">
<choice>
<value>usb</value>
</choice>
</attribute>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-08-13 05:33:15 +04:00
<optional>
<ref name="address"/>
</optional>
</element>
</define>
<define name="redirdev">
<element name="redirdev">
<attribute name="bus">
<choice>
<value>usb</value>
</choice>
</attribute>
<attribute name="type">
<ref name="qemucdevSrcTypeChoice"/>
</attribute>
<ref name="qemucdevSrcDef"/>
2012-01-16 13:28:51 +04:00
<optional>
<ref name="alias"/>
</optional>
2011-09-06 11:06:59 +04:00
<optional>
<ref name="address"/>
</optional>
2012-11-14 18:51:30 +04:00
<optional>
<ref name="deviceBoot"/>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</define>
2012-09-13 11:25:47 +04:00
<define name="redirfilter">
<element name="redirfilter">
<zeroOrMore>
<ref name="usbdevfilter"/>
</zeroOrMore>
</element>
</define>
2012-11-23 17:50:29 +04:00
2011-08-13 05:33:15 +04:00
<define name="hostdev">
<element name="hostdev">
2013-05-03 22:07:24 +04:00
<interleave>
<choice>
<group>
<ref name="hostdevsubsys"/>
</group>
<group>
<ref name="hostdevcaps"/>
</group>
</choice>
<optional>
<ref name="alias"/>
</optional>
<optional>
<ref name="deviceBoot"/>
</optional>
<optional>
<ref name="rom"/>
</optional>
<optional>
<ref name="address"/>
</optional>
2013-05-03 22:07:25 +04:00
<optional>
<element name="readonly">
<empty/>
</element>
</optional>
2013-05-03 22:07:33 +04:00
<optional>
<element name="shareable">
<empty/>
</element>
</optional>
2013-05-03 22:07:24 +04:00
</interleave>
2012-11-23 17:50:29 +04:00
</element>
</define>
<define name="hostdevsubsys">
<optional>
<attribute name="mode">
<value>subsystem</value>
</attribute>
</optional>
<optional>
<attribute name="managed">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<choice>
<ref name="hostdevsubsyspci"/>
<ref name="hostdevsubsysusb"/>
2013-05-03 22:07:20 +04:00
<ref name="hostdevsubsysscsi"/>
2012-11-23 17:50:29 +04:00
</choice>
</define>
<define name="hostdevcaps">
<attribute name="mode">
<value>capabilities</value>
</attribute>
<choice>
<group>
<ref name="hostdevcapsstorage"/>
</group>
<group>
<ref name="hostdevcapsmisc"/>
</group>
2013-04-05 16:26:39 +04:00
<group>
<ref name="hostdevcapsnet"/>
</group>
2012-11-23 17:50:29 +04:00
</choice>
</define>
<define name="hostdevsubsyspci">
<attribute name="type">
<value>pci</value>
</attribute>
2013-03-15 23:15:14 +04:00
<interleave>
2011-09-20 21:31:52 +04:00
<optional>
2013-03-15 23:15:14 +04:00
<element name="driver">
<attribute name="name">
<choice>
<value>kvm</value>
<value>vfio</value>
</choice>
</attribute>
<empty/>
</element>
2011-09-20 21:31:52 +04:00
</optional>
2013-03-15 23:15:14 +04:00
<element name="source">
<optional>
<ref name="startupPolicy"/>
</optional>
<element name="address">
<ref name="pciaddress"/>
</element>
2012-11-23 17:50:29 +04:00
</element>
2013-03-15 23:15:14 +04:00
</interleave>
2011-08-13 05:33:15 +04:00
</define>
2012-11-23 17:50:29 +04:00
<define name="hostdevsubsysusb">
<attribute name="type">
<value>usb</value>
</attribute>
<element name="source">
<optional>
<ref name="startupPolicy"/>
</optional>
<choice>
<group>
<ref name="usbproduct"/>
<optional>
<ref name="usbaddress"/>
</optional>
</group>
<ref name="usbaddress"/>
</choice>
</element>
</define>
2013-05-03 22:07:20 +04:00
<define name="hostdevsubsysscsi">
<attribute name="type">
<value>scsi</value>
</attribute>
2013-05-03 22:07:40 +04:00
<optional>
<attribute name="sgio">
<choice>
<value>filtered</value>
<value>unfiltered</value>
</choice>
</attribute>
</optional>
2013-05-03 22:07:20 +04:00
<element name="source">
<interleave>
<ref name="sourceinfoadapter"/>
<element name="address">
<ref name="scsiaddress"/>
</element>
</interleave>
</element>
</define>
2012-11-23 17:50:29 +04:00
<define name="hostdevcapsstorage">
<attribute name="type">
<value>storage</value>
</attribute>
<element name="source">
<element name="block">
<ref name="absFilePath"/>
</element>
</element>
</define>
<define name="hostdevcapsmisc">
<attribute name="type">
<value>misc</value>
</attribute>
<element name="source">
<element name="char">
<ref name="absFilePath"/>
</element>
</element>
</define>
2013-04-05 16:26:39 +04:00
<define name="hostdevcapsnet">
<attribute name="type">
<value>net</value>
</attribute>
<element name="source">
<element name="interface">
<ref name="deviceName"/>
</element>
</element>
</define>
2011-08-13 05:33:15 +04:00
<define name="usbproduct">
<element name="vendor">
<attribute name="id">
<ref name="usbId"/>
</attribute>
</element>
<element name="product">
<attribute name="id">
<ref name="usbId"/>
</attribute>
</element>
</define>
<define name="usbaddress">
<element name="address">
<attribute name="bus">
<ref name="usbAddr"/>
</attribute>
<attribute name="device">
<ref name="usbPort"/>
</attribute>
</element>
</define>
2013-05-03 22:07:20 +04:00
<define name="scsiaddress">
<attribute name="bus">
<ref name="driveBus"/>
</attribute>
<attribute name="target">
<ref name="driveTarget"/>
</attribute>
<attribute name="unit">
<ref name="driveUnit"/>
</attribute>
</define>
2011-08-13 05:33:15 +04:00
<define name="usbportaddress">
<attribute name="bus">
<ref name="usbAddr"/>
</attribute>
<attribute name="port">
<ref name="usbPort"/>
</attribute>
</define>
2011-12-13 03:39:31 +04:00
<define name="spaprvioaddress">
<optional>
<attribute name="reg">
<ref name="spaprvioReg"/>
</attribute>
</optional>
</define>
2013-03-05 19:44:19 +04:00
<define name="ccwaddress">
<optional>
<attribute name="cssid">
<ref name="ccwCssidRange"/>
</attribute>
<attribute name="ssid">
<ref name="ccwSsidRange"/>
</attribute>
<attribute name="devno">
<ref name="ccwDevnoRange"/>
</attribute>
</optional>
</define>
2011-08-13 05:33:15 +04:00
<define name="driveaddress">
<optional>
<attribute name="controller">
<ref name="driveController"/>
</attribute>
</optional>
<optional>
<attribute name="bus">
<ref name="driveBus"/>
</attribute>
</optional>
2012-02-27 14:19:54 +04:00
<optional>
<attribute name="target">
<ref name="driveTarget"/>
</attribute>
</optional>
2012-01-13 07:39:23 +04:00
<optional>
<attribute name="unit">
<ref name="driveUnit"/>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
</define>
<define name="virtioserialaddress">
<attribute name="controller">
<ref name="driveController"/>
</attribute>
<optional>
<attribute name="bus">
<ref name="driveBus"/>
</attribute>
</optional>
<optional>
<attribute name="port">
<ref name="driveUnit"/>
</attribute>
</optional>
</define>
<define name="ccidaddress">
<attribute name="controller">
<ref name="driveController"/>
</attribute>
<optional>
<attribute name="slot">
<ref name="driveUnit"/>
</attribute>
</optional>
</define>
<define name="devices">
<element name="devices">
<interleave>
<optional>
<ref name="emulator"/>
</optional>
<zeroOrMore>
<choice>
<ref name="disk"/>
<ref name="controller"/>
<ref name="lease"/>
<ref name="filesystem"/>
<ref name="interface"/>
<ref name="input"/>
<ref name="sound"/>
<ref name="hostdev"/>
<ref name="graphic"/>
<ref name="video"/>
<ref name="console"/>
<ref name="parallel"/>
<ref name="serial"/>
<ref name="channel"/>
<ref name="smartcard"/>
<ref name="hub"/>
<ref name="redirdev"/>
2012-09-13 11:25:47 +04:00
<ref name="redirfilter"/>
2012-12-20 15:06:52 +04:00
<ref name="rng"/>
2013-04-13 00:55:45 +04:00
<ref name="tpm"/>
2011-08-13 05:33:15 +04:00
</choice>
</zeroOrMore>
<optional>
<ref name="watchdog"/>
</optional>
<optional>
<ref name="memballoon"/>
</optional>
2013-04-19 12:37:51 +04:00
<optional>
<ref name="nvram"/>
</optional>
2013-12-09 13:11:14 +04:00
<optional>
<ref name="panic"/>
</optional>
2011-08-13 05:33:15 +04:00
</interleave>
</element>
</define>
<!--
2012-10-16 20:25:56 +04:00
A set of optional features: PAE, APIC, ACPI,
2013-09-23 20:32:11 +04:00
HyperV Enlightenment, paravirtual spinlocks and HAP support
2011-08-13 05:33:15 +04:00
-->
<define name="features">
<optional>
<element name="features">
<interleave>
<optional>
<element name="pae">
<empty/>
</element>
</optional>
<optional>
<element name="apic">
2012-09-13 02:10:56 +04:00
<optional>
<attribute name="eoi">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</optional>
<optional>
<element name="acpi">
<empty/>
</element>
</optional>
<optional>
<element name="hap">
<empty/>
</element>
</optional>
2012-10-16 20:25:56 +04:00
<optional>
<ref name="hyperv"/>
</optional>
2012-01-25 18:34:12 +04:00
<optional>
<element name="viridian">
<empty/>
</element>
</optional>
2012-01-18 15:38:49 +04:00
<optional>
<element name="privnet">
<empty/>
</element>
</optional>
2013-09-23 20:32:11 +04:00
<optional>
<element name="pvspinlock">
<optional>
<ref name="featurestate"/>
</optional>
<empty/>
</element>
</optional>
2011-08-13 05:33:15 +04:00
</interleave>
</element>
</optional>
</define>
<!--
CPU specification
-->
<define name="cpu">
<element name="cpu">
<choice>
2011-11-11 16:51:45 +04:00
<group>
<interleave>
<optional>
<ref name="cpuTopology"/>
</optional>
<optional>
<ref name="cpuNuma"/>
</optional>
</interleave>
</group>
2011-08-13 05:33:15 +04:00
<group>
2011-08-18 14:14:36 +04:00
<ref name="cpuMode"/>
<interleave>
<optional>
<ref name="cpuModel"/>
</optional>
<optional>
<ref name="cpuNuma"/>
</optional>
</interleave>
</group>
<group>
<optional>
<ref name="cpuMode"/>
</optional>
2011-08-13 05:33:15 +04:00
<ref name="cpuMatch"/>
<interleave>
<ref name="cpuModel"/>
<optional>
<ref name="cpuVendor"/>
</optional>
<optional>
<ref name="cpuTopology"/>
</optional>
<zeroOrMore>
<ref name="cpuFeature"/>
</zeroOrMore>
2011-11-11 16:51:45 +04:00
<optional>
<ref name="cpuNuma"/>
</optional>
2011-08-13 05:33:15 +04:00
</interleave>
</group>
</choice>
</element>
</define>
2011-08-18 14:14:36 +04:00
<define name="cpuMode">
<attribute name="mode">
<choice>
<value>custom</value>
<value>host-model</value>
<value>host-passthrough</value>
</choice>
</attribute>
</define>
2011-08-13 05:33:15 +04:00
<define name="cpuMatch">
<attribute name="match">
<choice>
<value>minimum</value>
<value>exact</value>
<value>strict</value>
</choice>
</attribute>
</define>
<define name="cpuModel">
<element name="model">
2011-12-21 17:27:16 +04:00
<optional>
<attribute name="fallback">
<choice>
<value>allow</value>
<value>forbid</value>
</choice>
</attribute>
</optional>
2012-06-28 14:21:17 +04:00
<optional>
<attribute name="vendor_id">
<data type="string">
<param name='pattern'>[^,]{12}</param>
</data>
</attribute>
</optional>
2011-08-18 14:14:36 +04:00
<choice>
<text/>
<empty/>
</choice>
2011-08-13 05:33:15 +04:00
</element>
</define>
<define name="cpuVendor">
<element name="vendor">
<text/>
</element>
</define>
<define name="cpuFeature">
<element name="feature">
<attribute name="policy">
<choice>
<value>force</value>
<value>require</value>
<value>optional</value>
<value>disable</value>
<value>forbid</value>
</choice>
</attribute>
<attribute name="name">
<ref name="featureName"/>
</attribute>
<empty/>
</element>
</define>
<define name="cpuTopology">
<element name="topology">
<attribute name="sockets">
<ref name="positiveInteger"/>
</attribute>
<attribute name="cores">
<ref name="positiveInteger"/>
</attribute>
<attribute name="threads">
<ref name="positiveInteger"/>
</attribute>
</element>
</define>
2011-11-11 16:51:45 +04:00
<define name="cpuNuma">
<element name="numa">
<oneOrMore>
<ref name="numaCell"/>
</oneOrMore>
</element>
</define>
<define name="numaCell">
<element name="cell">
<attribute name="cpus">
<ref name="cpuset"/>
</attribute>
<attribute name="memory">
<ref name="memoryKB"/>
</attribute>
</element>
</define>
2011-08-13 05:33:15 +04:00
<!--
System information specification:
Placeholder for system specific informations likes the ones
contained in the SMBIOS area.
Only a limited subset of entries can be modified there, so we
fully enumerate each case here.
The DMTF spec doesn't specify any string subset, just 0 terminated
byte strings, but better be safe and restrict at least the names
to avoid problems with space normalization in attribute values,
the value is kept as the element body for maximum flexibility.
A priori we allow only type 0 and type 1 string updates
-->
<define name="sysinfo">
<element name="sysinfo">
<attribute name="type">
<value>smbios</value>
</attribute>
<interleave>
<optional>
<element name="bios">
<oneOrMore>
<element name="entry">
<attribute name="name">
<ref name="sysinfo-bios-name"/>
</attribute>
<ref name="sysinfo-value"/>
</element>
</oneOrMore>
</element>
</optional>
<optional>
<element name="system">
<oneOrMore>
<element name="entry">
<attribute name="name">
<ref name="sysinfo-system-name"/>
</attribute>
<ref name="sysinfo-value"/>
</element>
</oneOrMore>
</element>
</optional>
</interleave>
</element>
</define>
<define name="sysinfo-bios-name">
<choice>
<value>vendor</value>
<value>version</value>
<value>date</value>
<value>release</value>
</choice>
</define>
<define name="sysinfo-system-name">
<choice>
<value>manufacturer</value>
<value>product</value>
<value>version</value>
<value>serial</value>
<value>uuid</value>
<value>sku</value>
<value>family</value>
</choice>
</define>
<define name="sysinfo-value">
<data type="string">
<param name='pattern'>[a-zA-Z0-9/\-_\. \(\)]+</param>
</data>
</define>
<define name="smbios">
<element name="smbios">
<attribute name="mode">
<choice>
<value>emulate</value>
<value>host</value>
<value>sysinfo</value>
</choice>
</attribute>
<empty/>
</element>
</define>
<define name="bios">
<element name="bios">
2012-09-18 14:30:52 +04:00
<optional>
<attribute name="useserial">
<choice>
<value>yes</value>
<value>no</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="rebootTimeout">
<ref name="rebootTimeoutDelay"/>
</attribute>
</optional>
2011-08-13 05:33:15 +04:00
</element>
</define>
<define name="address">
<element name="address">
<choice>
<group>
<attribute name="type">
<value>pci</value>
</attribute>
<ref name="pciaddress"/>
</group>
<group>
<attribute name="type">
<value>drive</value>
</attribute>
<ref name="driveaddress"/>
</group>
<group>
<attribute name="type">
<value>virtio-serial</value>
</attribute>
<ref name="virtioserialaddress"/>
</group>
<group>
<attribute name="type">
<value>ccid</value>
</attribute>
<ref name="ccidaddress"/>
</group>
<group>
<attribute name="type">
<value>usb</value>
</attribute>
<ref name="usbportaddress"/>
</group>
2011-12-13 03:39:31 +04:00
<group>
<attribute name="type">
<value>spapr-vio</value>
</attribute>
<ref name="spaprvioaddress"/>
</group>
2013-03-05 19:44:19 +04:00
<group>
<attribute name="type">
<value>ccw</value>
</attribute>
<ref name="ccwaddress"/>
</group>
2013-12-09 13:11:13 +04:00
<group>
<attribute name="type">
<value>isa</value>
</attribute>
<ref name="isaaddress"/>
</group>
2011-08-13 05:33:15 +04:00
</choice>
</element>
</define>
2012-01-25 04:54:12 +04:00
<define name="rom">
<element name="rom">
2012-01-25 20:20:49 +04:00
<optional>
<attribute name="bar">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="file">
<ref name="absFilePath"/>
</attribute>
</optional>
2012-01-25 04:54:12 +04:00
<empty/>
</element>
</define>
2012-12-20 15:06:52 +04:00
<define name="rng">
<element name="rng">
<attribute name="model">
<choice>
<value>virtio</value>
</choice>
</attribute>
2013-02-13 18:37:39 +04:00
<interleave>
<ref name="rng-backend"/>
<optional>
<ref name="rng-rate"/>
</optional>
2013-12-05 21:33:01 +04:00
<optional>
<ref name="alias"/>
</optional>
<optional>
<ref name="address"/>
</optional>
2013-02-13 18:37:39 +04:00
</interleave>
2012-12-20 15:06:52 +04:00
</element>
</define>
<define name="rng-backend">
<element name="backend">
<choice>
<group>
<attribute name="model">
<value>random</value>
</attribute>
2013-03-05 02:42:07 +04:00
<choice>
<value>/dev/random</value>
<value>/dev/hwrng</value>
2013-03-07 18:06:53 +04:00
<empty/>
2013-03-05 02:42:07 +04:00
</choice>
2012-12-20 15:06:52 +04:00
</group>
<group>
<attribute name="model">
<value>egd</value>
</attribute>
<ref name="qemucdevSrcType"/>
<ref name="qemucdevSrcDef"/>
</group>
</choice>
</element>
</define>
2013-02-13 18:37:39 +04:00
<define name="rng-rate">
<element name="rate">
<attribute name="bytes">
<ref name="positiveInteger"/>
</attribute>
<optional>
<attribute name="period">
<ref name="positiveInteger"/>
</attribute>
</optional>
<empty/>
</element>
</define>
2011-08-13 05:33:15 +04:00
<define name="usbmaster">
<element name="master">
<attribute name="startport">
<ref name="usbPort"/>
</attribute>
<empty/>
</element>
</define>
<define name="filterref-node-attributes">
<attribute name="filter">
<data type="NCName"/>
</attribute>
<optional>
<element name="parameter">
<attribute name="name">
<ref name="filter-param-name"/>
</attribute>
<attribute name="value">
<ref name="filter-param-value"/>
</attribute>
</element>
</optional>
</define>
<define name="deviceBoot">
<element name="boot">
<attribute name="order">
<ref name="positiveInteger"/>
</attribute>
<empty/>
</element>
</define>
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 04:10:18 +04:00
<define name='diskMirror'>
<element name='mirror'>
<attribute name='file'>
<ref name='absFilePath'/>
</attribute>
<optional>
<attribute name='format'>
2013-04-22 18:06:14 +04:00
<ref name='storageFormat'/>
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 04:10:18 +04:00
</attribute>
</optional>
<optional>
<attribute name='ready'>
<value>yes</value>
</attribute>
</optional>
</element>
</define>
2011-10-28 22:29:39 +04:00
<define name="diskAuth">
<element name="auth">
<attribute name="username">
<ref name="genericName"/>
</attribute>
<ref name="diskAuthSecret"/>
</element>
</define>
<define name='diskAuthSecret'>
<element name='secret'>
<attribute name='type'>
<choice>
<value>ceph</value>
2013-03-21 15:53:53 +04:00
<value>iscsi</value>
2011-10-28 22:29:39 +04:00
</choice>
</attribute>
<choice>
<attribute name='uuid'>
<ref name="UUID"/>
</attribute>
2011-10-29 01:19:34 +04:00
<attribute name='usage'>
<ref name='genericName'/>
2011-10-28 22:29:39 +04:00
</attribute>
</choice>
</element>
</define>
2011-08-13 05:33:15 +04:00
2011-11-15 13:02:46 +04:00
<define name='diskIoTune'>
<element name="iotune">
<interleave>
<choice>
<element name="total_bytes_sec">
<data type="unsignedLong"/>
</element>
<group>
<interleave>
<optional>
<element name="read_bytes_sec">
<data type="unsignedLong"/>
</element>
</optional>
<optional>
<element name="write_bytes_sec">
<data type="unsignedLong"/>
</element>
</optional>
</interleave>
</group>
</choice>
<choice>
<element name="total_iops_sec">
<data type="unsignedLong"/>
</element>
<group>
<interleave>
<optional>
<element name="read_iops_sec">
<data type="unsignedLong"/>
</element>
</optional>
<optional>
<element name="write_iops_sec">
<data type="unsignedLong"/>
</element>
</optional>
</interleave>
</group>
</choice>
</interleave>
</element>
</define>
2012-10-16 20:25:56 +04:00
<!-- Optional HyperV Enlightenment features -->
<define name="hyperv">
<element name="hyperv">
<interleave>
<optional>
<element name="relaxed">
2013-09-23 16:59:28 +04:00
<ref name="featurestate"/>
2012-10-16 20:25:56 +04:00
</element>
</optional>
2013-06-21 14:20:12 +04:00
<optional>
<element name="vapic">
2013-09-23 16:59:28 +04:00
<ref name="featurestate"/>
2013-06-21 14:20:12 +04:00
</element>
</optional>
<optional>
<element name="spinlocks">
2013-09-23 16:59:28 +04:00
<ref name="featurestate"/>
2013-07-04 14:12:57 +04:00
<optional>
<attribute name="retries">
<data type="unsignedInt"/>
</attribute>
</optional>
2013-06-21 14:20:12 +04:00
</element>
</optional>
2012-10-16 20:25:56 +04:00
</interleave>
</element>
</define>
2013-09-23 16:59:28 +04:00
<define name="featurestate">
2012-10-16 20:25:56 +04:00
<attribute name="state">
<choice>
<value>on</value>
<value>off</value>
</choice>
</attribute>
</define>
2011-08-13 05:33:15 +04:00
<!--
Optional hypervisor extensions in their own namespace:
QEmu
-->
<define name="qemucmdline">
<element name="commandline" ns="http://libvirt.org/schemas/domain/qemu/1.0">
<zeroOrMore>
<element name="arg">
<attribute name='value'/>
</element>
</zeroOrMore>
<zeroOrMore>
<element name="env">
<attribute name='name'>
<ref name="filter-param-name"/>
</attribute>
<optional>
<attribute name='value'/>
</optional>
<empty/>
</element>
</zeroOrMore>
</element>
</define>
2012-01-24 06:26:18 +04:00
<define name="metadata">
<element name="metadata">
<zeroOrMore>
<ref name="customElement"/>
</zeroOrMore>
</element>
</define>
<define name="customElement">
<element>
<anyName/>
<zeroOrMore>
<choice>
<attribute>
<anyName/>
</attribute>
<text/>
<ref name="customElement"/>
</choice>
</zeroOrMore>
</element>
</define>
2011-08-13 05:33:15 +04:00
<!--
Type library
-->
<define name="countCPU">
<data type="unsignedShort">
<param name="pattern">[0-9]+</param>
<param name="minInclusive">1</param>
</data>
</define>
<define name="vcpuid">
<data type="unsignedShort">
<param name="pattern">[0-9]+</param>
</data>
</define>
<define name="cpushares">
<data type="unsignedInt">
<param name="pattern">[0-9]+</param>
</data>
</define>
<define name="cpuperiod">
<data type="unsignedLong">
<param name="pattern">[0-9]+</param>
<param name="minInclusive">1000</param>
<param name="maxInclusive">1000000</param>
</data>
</define>
<define name="cpuquota">
<data type="long">
<param name="pattern">-?[0-9]+</param>
<param name="maxInclusive">18446744073709551</param>
<param name='minInclusive'>-1</param>
</data>
</define>
2012-09-18 14:30:52 +04:00
<define name="rebootTimeoutDelay">
<data type="short">
<param name="minInclusive">-1</param>
</data>
</define>
2012-02-23 08:18:39 +04:00
<!-- weight currently is in range [100, 1000] -->
2011-08-13 05:33:15 +04:00
<define name="weight">
<data type="unsignedInt">
<param name="pattern">[0-9]+</param>
<param name="minInclusive">100</param>
<param name="maxInclusive">1000</param>
</data>
</define>
2012-02-23 04:48:38 +04:00
<!-- Memory as an attribute is in KiB, no way to express a unit -->
2011-08-13 05:33:15 +04:00
<define name="memoryKB">
<data type="unsignedInt">
<param name="pattern">[0-9]+</param>
</data>
</define>
<define name="domainName">
<data type="string">
2012-02-01 03:51:36 +04:00
<!-- Use literal newline instead of \n for bug in libxml2 2.7.6 -->
<param name="pattern">[^
]+</param>
2011-08-13 05:33:15 +04:00
</data>
</define>
<define name="diskSerial">
<data type="string">
<param name="pattern">[A-Za-z0-9_\.\+\-]+</param>
</data>
</define>
<define name="bridgeMode">
<data type="string">
<param name="pattern">(vepa|bridge|private|passthrough)</param>
</data>
</define>
<define name="addrIPorName">
<data type="string">
<param name="pattern">(([0-2]?[0-9]?[0-9]\.){3}[0-2]?[0-9]?[0-9])|(([0-9a-fA-F]+|:)+[0-9a-fA-F]+)|([a-zA-Z0-9_\.\+\-]*)</param>
</data>
</define>
2012-09-13 11:25:47 +04:00
<define name="usbIdDefault">
<data type="string">
<param name="pattern">-1</param>
</data>
</define>
2011-08-13 05:33:15 +04:00
<define name="usbId">
<data type="string">
<param name="pattern">(0x)?[0-9a-fA-F]{1,4}</param>
</data>
</define>
2012-09-13 11:25:47 +04:00
<define name="usbVersion">
<data type="string">
<param name="pattern">[0-9]{1,2}.[0-9]{1,2}</param>
</data>
</define>
2011-08-13 05:33:15 +04:00
<define name="usbAddr">
<data type="string">
<param name="pattern">(0x)?[0-9a-fA-F]{1,3}</param>
</data>
</define>
2012-09-13 11:25:47 +04:00
<define name="usbClass">
<data type="string">
<param name="pattern">(0x)?[0-9a-fA-F]{1,2}</param>
</data>
</define>
2011-08-13 05:33:15 +04:00
<define name="usbPort">
<data type="string">
<param name="pattern">((0x)?[0-9a-fA-F]{1,3}\.){0,3}(0x)?[0-9a-fA-F]{1,3}</param>
</data>
</define>
<define name="driveController">
<data type="string">
<param name="pattern">[0-9]{1,2}</param>
</data>
</define>
<define name="driveBus">
<data type="string">
<param name="pattern">[0-9]{1,2}</param>
</data>
</define>
2012-02-27 14:19:54 +04:00
<define name="driveTarget">
<data type="string">
<param name="pattern">[0-9]{1,2}</param>
</data>
</define>
2011-08-13 05:33:15 +04:00
<define name="driveUnit">
<data type="string">
<param name="pattern">[0-9]{1,2}</param>
</data>
</define>
<define name="featureName">
<data type="string">
2012-01-04 00:59:51 +04:00
<param name='pattern'>[a-zA-Z0-9\-_\.]+</param>
2011-08-13 05:33:15 +04:00
</data>
</define>
<define name="timeDelta">
<data type="string">
<param name="pattern">(-|\+)?[0-9]+</param>
</data>
</define>
<define name="timeZone">
<data type="string">
<param name="pattern">[a-zA-Z0-9_\.\+\-/]+</param>
</data>
</define>
<define name="filter-param-name">
<data type="string">
<param name="pattern">[a-zA-Z0-9_]+</param>
</data>
</define>
<define name="filter-param-value">
<data type="string">
<param name="pattern">[a-zA-Z0-9_\.:]+</param>
</data>
</define>
2011-12-13 03:39:31 +04:00
<define name="spaprvioReg">
<data type="string">
<param name="pattern">(0x)?[0-9a-fA-F]{1,16}</param>
</data>
</define>
2012-01-16 13:28:51 +04:00
<define name='aliasName'>
<data type="string">
2013-08-23 17:03:31 +04:00
<param name="pattern">[a-zA-Z0-9_\-.]+</param>
2012-01-16 13:28:51 +04:00
</data>
</define>
<define name='alias'>
<element name='alias'>
<attribute name='name'>
<ref name='aliasName'/>
</attribute>
</element>
<empty/>
</define>
2013-03-05 19:44:19 +04:00
<define name="ccwCssidRange">
<choice>
<data type="string">
<param name="pattern">0x[0-9a-eA-E][0-9a-fA-F]?</param>
</data>
<data type="string">
<param name="pattern">0x[fF][0-9a-eA-E]?</param>
</data>
<data type="int">
<param name="minInclusive">0</param>
<param name="maxInclusive">254</param>
</data>
</choice>
</define>
<define name="ccwSsidRange">
<data type="string">
<param name="pattern">(0x)?[0-3]</param>
</data>
</define>
<define name="ccwDevnoRange">
<choice>
<data type="string">
<param name="pattern">0x[0-9a-fA-F]{1,4}</param>
</data>
<data type="int">
<param name="minInclusive">0</param>
<param name="maxInclusive">65535</param>
</data>
</choice>
</define>
2013-12-09 13:11:14 +04:00
<define name="panic">
<element name="panic">
<optional>
<ref name="address"/>
</optional>
</element>
</define>
2011-08-13 05:33:15 +04:00
</grammar>