2011-08-13 01:33:15 +00:00
|
|
|
<?xml version="1.0"?>
|
2010-05-03 21:15:18 +00:00
|
|
|
<!-- A Relax NG schema for the libvirt domain snapshot properties XML format -->
|
|
|
|
|
<grammar xmlns="http://relaxng.org/ns/structure/1.0">
|
|
|
|
|
<start>
|
|
|
|
|
<ref name='domainsnapshot'/>
|
|
|
|
|
</start>
|
|
|
|
|
|
2011-08-13 01:33:15 +00:00
|
|
|
<include href='domaincommon.rng'/>
|
|
|
|
|
|
2010-05-03 21:15:18 +00:00
|
|
|
<define name='domainsnapshot'>
|
|
|
|
|
<element name='domainsnapshot'>
|
|
|
|
|
<interleave>
|
|
|
|
|
<optional>
|
|
|
|
|
<element name='name'>
|
|
|
|
|
<text/>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
|
|
|
|
<optional>
|
|
|
|
|
<element name='description'>
|
|
|
|
|
<text/>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
|
|
|
|
<optional>
|
|
|
|
|
<element name='state'>
|
2011-08-19 00:14:40 +00:00
|
|
|
<ref name='state'/>
|
2010-05-03 21:15:18 +00:00
|
|
|
</element>
|
|
|
|
|
</optional>
|
|
|
|
|
<optional>
|
|
|
|
|
<element name='creationTime'>
|
|
|
|
|
<text/>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
snapshot: new XML for external system checkpoint
Each <domainsnapshot> can now contain an optional <memory>
element that describes how the VM state was handled, similar
to disk snapshots. The new element will always appear in
output; for back-compat, an input that lacks the element will
assume 'no' or 'internal' according to the domain state.
Along with this change, it is now possible to pass <disks> in
the XML for an offline snapshot; this also needs to be wired up
in a future patch, to make it possible to choose internal vs.
external on a per-disk basis for each disk in an offline domain.
At that point, using the --disk-only flag for an offline domain
will be able to work.
For some examples below, remember that qemu supports the
following snapshot actions:
qemu-img: offline external and internal disk
savevm: online internal VM and disk
migrate: online external VM
transaction: online external disk
=====
<domainsnapshot>
<memory snapshot='no'/>
...
</domainsnapshot>
implies that there is no VM state saved (mandatory for
offline and disk-only snapshots, not possible otherwise);
using qemu-img for offline domains and transaction for online.
=====
<domainsnapshot>
<memory snapshot='internal'/>
...
</domainsnapshot>
state is saved inside one of the disks (as in qemu's 'savevm'
system checkpoint implementation). If needed in the future,
we can also add an attribute pointing out _which_ disk saved
the internal state; maybe disk='vda'.
=====
<domainsnapshot>
<memory snapshot='external' file='/path/to/state'/>
...
</domainsnapshot>
This is not wired up yet, but future patches will allow this to
control a combination of 'virsh save /path/to/state' plus disk
snapshots from the same point in time.
=====
So for 1.0.1 (and later, as needed), I plan to implement this table
of combinations, with '*' designating new code and '+' designating
existing code reached through new combinations of xml and/or the
existing DISK_ONLY flag:
domain memory disk disk-only | result
-----------------------------------------
offline omit omit any | memory=no disk=int, via qemu-img
offline no omit any |+memory=no disk=int, via qemu-img
offline omit/no no any | invalid combination (nothing to snapshot)
offline omit/no int any |+memory=no disk=int, via qemu-img
offline omit/no ext any |*memory=no disk=ext, via qemu-img
offline int/ext any any | invalid combination (no memory to save)
online omit omit off | memory=int disk=int, via savevm
online omit omit on | memory=no disk=default, via transaction
online omit no/ext off | unsupported for now
online omit no on | invalid combination (nothing to snapshot)
online omit ext on | memory=no disk=ext, via transaction
online omit int off |+memory=int disk=int, via savevm
online omit int on | unsupported for now
online no omit any |+memory=no disk=default, via transaction
online no no any | invalid combination (nothing to snapshot)
online no int any | unsupported for now
online no ext any |+memory=no disk=ext, via transaction
online int/ext any on | invalid combination (disk-only vs. memory)
online int omit off |+memory=int disk=int, via savevm
online int no/ext off | unsupported for now
online int int off |+memory=int disk=int, via savevm
online ext omit off |*memory=ext disk=default, via migrate+trans
online ext no off |+memory=ext disk=no, via migrate
online ext int off | unsupported for now
online ext ext off |*memory=ext disk=ext, via migrate+transaction
* docs/schemas/domainsnapshot.rng (memory): New RNG element.
* docs/formatsnapshot.html.in: Document it.
* src/conf/snapshot_conf.h (virDomainSnapshotDef): New fields.
* src/conf/domain_conf.c (virDomainSnapshotDefFree)
(virDomainSnapshotDefParseString, virDomainSnapshotDefFormat):
Manage new fields.
* tests/domainsnapshotxml2xmltest.c: New test.
* tests/domainsnapshotxml2xmlin/*.xml: Update existing tests.
* tests/domainsnapshotxml2xmlout/*.xml: Likewise.
2012-10-23 15:12:23 +00:00
|
|
|
<optional>
|
|
|
|
|
<element name='memory'>
|
|
|
|
|
<choice>
|
|
|
|
|
<attribute name='snapshot'>
|
|
|
|
|
<choice>
|
|
|
|
|
<value>no</value>
|
|
|
|
|
<value>internal</value>
|
|
|
|
|
</choice>
|
|
|
|
|
</attribute>
|
|
|
|
|
<group>
|
|
|
|
|
<optional>
|
|
|
|
|
<attribute name='snapshot'>
|
|
|
|
|
<value>external</value>
|
|
|
|
|
</attribute>
|
|
|
|
|
</optional>
|
|
|
|
|
<attribute name='file'>
|
|
|
|
|
<ref name='absFilePath'/>
|
|
|
|
|
</attribute>
|
|
|
|
|
</group>
|
|
|
|
|
</choice>
|
|
|
|
|
<empty/>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
2011-08-18 23:33:36 +00:00
|
|
|
<optional>
|
|
|
|
|
<element name='disks'>
|
|
|
|
|
<zeroOrMore>
|
|
|
|
|
<ref name='disksnapshot'/>
|
|
|
|
|
</zeroOrMore>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
2010-05-03 21:15:18 +00:00
|
|
|
<optional>
|
|
|
|
|
<element name='active'>
|
2011-08-25 21:11:03 +00:00
|
|
|
<choice>
|
|
|
|
|
<value>0</value>
|
|
|
|
|
<value>1</value>
|
|
|
|
|
</choice>
|
2010-05-03 21:15:18 +00:00
|
|
|
</element>
|
|
|
|
|
</optional>
|
|
|
|
|
<optional>
|
2011-08-13 01:33:15 +00:00
|
|
|
<choice>
|
|
|
|
|
<element name='domain'>
|
|
|
|
|
<element name='uuid'>
|
|
|
|
|
<ref name="UUID"/>
|
|
|
|
|
</element>
|
2010-05-03 21:15:18 +00:00
|
|
|
</element>
|
2014-04-14 22:54:15 +00:00
|
|
|
<!-- Nested grammar ensures that any of our overrides of
|
|
|
|
|
storagecommon/domaincommon defines do not conflict
|
|
|
|
|
with any domain.rng overrides. -->
|
|
|
|
|
<grammar>
|
|
|
|
|
<include href='domain.rng'/>
|
|
|
|
|
</grammar>
|
2011-08-13 01:33:15 +00:00
|
|
|
</choice>
|
2010-05-03 21:15:18 +00:00
|
|
|
</optional>
|
|
|
|
|
<optional>
|
|
|
|
|
<element name='parent'>
|
|
|
|
|
<element name='name'>
|
|
|
|
|
<text/>
|
|
|
|
|
</element>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
2017-05-25 08:20:57 +00:00
|
|
|
<optional>
|
|
|
|
|
<element name='cookie'>
|
|
|
|
|
<zeroOrMore>
|
|
|
|
|
<ref name='customElement'/>
|
|
|
|
|
</zeroOrMore>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
2010-05-03 21:15:18 +00:00
|
|
|
</interleave>
|
|
|
|
|
</element>
|
|
|
|
|
</define>
|
|
|
|
|
|
2011-08-19 00:14:40 +00:00
|
|
|
<define name='state'>
|
|
|
|
|
<choice>
|
|
|
|
|
<value>running</value>
|
|
|
|
|
<value>blocked</value>
|
|
|
|
|
<value>paused</value>
|
|
|
|
|
<value>shutdown</value>
|
|
|
|
|
<value>shutoff</value>
|
|
|
|
|
<value>crashed</value>
|
|
|
|
|
<value>disk-snapshot</value>
|
|
|
|
|
</choice>
|
|
|
|
|
</define>
|
|
|
|
|
|
2014-04-14 22:54:15 +00:00
|
|
|
<define name='storageSourceExtra' combine='choice'>
|
|
|
|
|
<!-- overrides the no-op version in storagecommon.rng -->
|
|
|
|
|
<ref name='disksnapshotdriver'/>
|
|
|
|
|
</define>
|
|
|
|
|
|
2011-08-18 23:33:36 +00:00
|
|
|
<define name='disksnapshot'>
|
|
|
|
|
<element name='disk'>
|
|
|
|
|
<attribute name='name'>
|
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 02:38:36 +00:00
|
|
|
<choice>
|
|
|
|
|
<ref name='diskTarget'/>
|
|
|
|
|
<ref name='absFilePath'/>
|
|
|
|
|
</choice>
|
2011-08-18 23:33:36 +00:00
|
|
|
</attribute>
|
|
|
|
|
<choice>
|
|
|
|
|
<attribute name='snapshot'>
|
|
|
|
|
<value>no</value>
|
|
|
|
|
</attribute>
|
|
|
|
|
<attribute name='snapshot'>
|
|
|
|
|
<value>internal</value>
|
|
|
|
|
</attribute>
|
|
|
|
|
<group>
|
|
|
|
|
<optional>
|
|
|
|
|
<attribute name='snapshot'>
|
|
|
|
|
<value>external</value>
|
|
|
|
|
</attribute>
|
|
|
|
|
</optional>
|
2013-11-12 13:15:51 +00:00
|
|
|
<choice>
|
|
|
|
|
<group>
|
|
|
|
|
<optional>
|
|
|
|
|
<attribute name='type'>
|
|
|
|
|
<value>file</value>
|
|
|
|
|
</attribute>
|
|
|
|
|
</optional>
|
|
|
|
|
<interleave>
|
2011-08-18 23:33:36 +00:00
|
|
|
<optional>
|
2013-11-12 13:15:51 +00:00
|
|
|
<element name='source'>
|
|
|
|
|
<optional>
|
|
|
|
|
<attribute name='file'>
|
|
|
|
|
<ref name='absFilePath'/>
|
|
|
|
|
</attribute>
|
|
|
|
|
</optional>
|
2014-04-14 22:54:15 +00:00
|
|
|
<optional>
|
|
|
|
|
<ref name='storageStartupPolicy'/>
|
|
|
|
|
</optional>
|
2018-06-05 13:54:00 +00:00
|
|
|
<zeroOrMore>
|
|
|
|
|
<ref name='devSeclabel'/>
|
|
|
|
|
</zeroOrMore>
|
2020-04-01 14:10:12 +00:00
|
|
|
<optional>
|
|
|
|
|
<ref name='diskSourceCommon'/>
|
|
|
|
|
</optional>
|
|
|
|
|
<optional>
|
|
|
|
|
<ref name="encryption"/>
|
|
|
|
|
</optional>
|
2013-11-12 13:15:51 +00:00
|
|
|
<empty/>
|
|
|
|
|
</element>
|
2011-08-18 23:33:36 +00:00
|
|
|
</optional>
|
2014-04-14 22:54:15 +00:00
|
|
|
<ref name='storageSourceExtra'/>
|
2013-11-12 13:15:51 +00:00
|
|
|
</interleave>
|
|
|
|
|
</group>
|
|
|
|
|
<group>
|
|
|
|
|
<attribute name='type'>
|
|
|
|
|
<value>block</value>
|
|
|
|
|
</attribute>
|
|
|
|
|
<interleave>
|
|
|
|
|
<optional>
|
|
|
|
|
<element name="source">
|
|
|
|
|
<attribute name="dev">
|
|
|
|
|
<ref name="absFilePath"/>
|
|
|
|
|
</attribute>
|
2018-06-05 13:54:00 +00:00
|
|
|
<zeroOrMore>
|
|
|
|
|
<ref name='devSeclabel'/>
|
|
|
|
|
</zeroOrMore>
|
2020-04-01 14:10:12 +00:00
|
|
|
<optional>
|
|
|
|
|
<ref name='diskSourceCommon'/>
|
|
|
|
|
</optional>
|
|
|
|
|
<optional>
|
|
|
|
|
<ref name="encryption"/>
|
|
|
|
|
</optional>
|
2013-11-12 13:15:51 +00:00
|
|
|
<empty/>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
2014-04-14 22:54:15 +00:00
|
|
|
<ref name='storageSourceExtra'/>
|
2013-11-12 13:15:51 +00:00
|
|
|
</interleave>
|
|
|
|
|
</group>
|
2014-04-14 22:54:16 +00:00
|
|
|
<ref name='diskSourceNetwork'/>
|
2013-11-12 13:15:51 +00:00
|
|
|
</choice>
|
2011-08-18 23:33:36 +00:00
|
|
|
</group>
|
|
|
|
|
</choice>
|
|
|
|
|
</element>
|
|
|
|
|
</define>
|
|
|
|
|
|
2013-12-06 14:10:52 +00:00
|
|
|
<define name='disksnapshotdriver'>
|
|
|
|
|
<optional>
|
|
|
|
|
<element name='driver'>
|
|
|
|
|
<optional>
|
|
|
|
|
<attribute name='type'>
|
2014-04-14 22:54:14 +00:00
|
|
|
<ref name='storageFormatBacking'/>
|
2013-12-06 14:10:52 +00:00
|
|
|
</attribute>
|
|
|
|
|
</optional>
|
|
|
|
|
<empty/>
|
|
|
|
|
</element>
|
|
|
|
|
</optional>
|
|
|
|
|
</define>
|
|
|
|
|
|
2010-05-03 21:15:18 +00:00
|
|
|
</grammar>
|
