1
0
Fork 0
mirror of https://github.com/retspen/webvirtcloud synced 2026-11-08 19:26:48 +00:00

fix(vrtManager): a shut-off VM with NVRAM or TPM state is not migrated

libvirt keeps a VM's UEFI variables (NVRAM) and emulated TPM state in
files of its host. A live migration carries both: on the test hosts
(libvirt 11.10, QEMU 10.1) the destination got the same NVRAM content
once the VM ran and the same TPM state, and the source TPM state was
removed. Moving a shut-off VM moves only its definition, so neither
went along: on its first start on the destination libvirt made a new
NVRAM from the template and a new TPM. Boot entries and enrolled keys
are lost, and disks sealed to the TPM no longer unlock.

A shut-off VM whose definition has an NVRAM file or an emulated TPM is
now refused before anything changes: "Start the VM and migrate it
live." A passthrough or external TPM keeps no state on the host and
still moves. The check sits in moveto, not in the define/undefine
workaround, as libvirt's own offline migration does not carry the files
either. The keep-NVRAM and keep-TPM undefine flags of that workaround
are gone, as no VM that needs them reaches it.

Checked on the test hosts: a shut-off UEFI VM with a TPM is refused and
stays on the source with nothing defined on the destination; the same
VM migrates live. The new tests fail on the previous code.
This commit is contained in:
catborise 2026-10-06 21:02:58 +03:00
parent 98bb6ebdb5
commit c7a7c843fb
2 changed files with 49 additions and 19 deletions

View file

@ -18,8 +18,6 @@ try:
VIR_DOMAIN_XML_SECURE,
VIR_DOMAIN_XML_INACTIVE,
VIR_DOMAIN_XML_MIGRATABLE,
VIR_DOMAIN_UNDEFINE_KEEP_NVRAM,
VIR_DOMAIN_UNDEFINE_KEEP_TPM,
VIR_ERR_NO_DOMAIN,
VIR_ERR_NO_STORAGE_POOL,
VIR_ERR_NO_STORAGE_VOL,
@ -156,6 +154,8 @@ class wvmInstances(wvmConnect):
mode.append(label)
dom = conn.instance
if state == 5:
self.refuse_local_state(dom.XMLDesc(0))
definitions = {dom.XMLDesc(0)}
if state != 5:
definitions.add(dom.XMLDesc(VIR_DOMAIN_XML_INACTIVE))
@ -184,6 +184,25 @@ class wvmInstances(wvmConnect):
self.migrate_within(dom, flags, uri, timeout)
return ", ".join(mode)
@staticmethod
def refuse_local_state(xml):
"""A shut-off VM moves without its UEFI variables (NVRAM) and TPM
state, which libvirt keeps in files of the source host: on the
destination it would start with new ones (lost boot entries and
enrolled keys, a new TPM that no longer unlocks disks). A live
migration carries both."""
tree = ElementTree.fromstring(xml)
state = []
if tree.find("os/nvram") is not None:
state.append("NVRAM")
if tree.find("devices/tpm/backend[@type='emulator']") is not None:
state.append("TPM")
if state:
raise util.OperationError(
f"A shut-off VM with {' and '.join(state)} state cannot be migrated: the state stays on the source "
"host. Start the VM and migrate it live."
)
def migrate_within(self, dom, flags, uri, timeout):
"""dom.migrate, cancelled when it has not finished after timeout
seconds: a VM that changes its memory faster than the network carries
@ -290,8 +309,8 @@ class wvmInstances(wvmConnect):
def move_definition(self, dom):
"""Migrates a shut-off VM: that is only its definition, as the disks
are on storage both hosts share. NVRAM and TPM state stay on the
source. The destination's qemu migration hook does not run for it.
are on storage both hosts share (moveto refuses a VM with NVRAM or
TPM state). The destination's qemu migration hook does not run for it.
Workaround, to be removed in a later version: libvirt's own offline
migration (VIR_MIGRATE_OFFLINE) fails with "operation failed: domain
@ -315,13 +334,10 @@ class wvmInstances(wvmConnect):
raise util.OperationError(f"The destination host already has a VM {key}")
xml = dom.XMLDesc(VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_MIGRATABLE)
keep = VIR_DOMAIN_UNDEFINE_KEEP_NVRAM
if ElementTree.fromstring(xml).find("devices/tpm") is not None:
keep |= VIR_DOMAIN_UNDEFINE_KEEP_TPM # libvirt >= 8.9 knows the flag
autostart = dom.autostart()
new = self.wvm.defineXML(xml)
try:
dom.undefineFlags(keep)
dom.undefineFlags(0)
try:
started = dom.isActive()
except libvirtError as error:
@ -333,11 +349,11 @@ class wvmInstances(wvmConnect):
dom.connect().defineXML(xml).setAutostart(autostart)
raise util.OperationError("The VM was started on the source host during the migration")
except Exception as error:
self.undo_definition(dom, new, keep, error)
self.undo_definition(dom, new, error)
raise
@staticmethod
def undo_definition(dom, new, keep, error):
def undo_definition(dom, new, error):
"""After a failed move, the VM is defined on one host only: the
destination definition goes only while the source still has its own."""
try:
@ -349,7 +365,7 @@ class wvmInstances(wvmConnect):
f"{error}; the VM may now be defined only on the destination host: check both hosts"
) from error
try:
new.undefineFlags(keep)
new.undefineFlags(0)
except libvirtError as undo_error:
raise util.OperationError(
f"{error}; the VM is now defined on both hosts, remove it from the destination: {undo_error}"

View file

@ -211,15 +211,29 @@ class ShutOffMigrationTestCase(unittest.TestCase):
destination(host).moveto(source, "vm", live=False, unsafe=False, offline=True)
self.assertEqual(host.defined, ["<domain><name>vm</name></domain>"])
self.assertEqual(source.instance.calls, [])
self.assertEqual(source.instance.undefined, libvirt.VIR_DOMAIN_UNDEFINE_KEEP_NVRAM)
self.assertEqual(source.instance.undefined, 0)
def test_tpm_state_stays_on_the_source(self):
source = FakeSource(5, xml="<domain><devices><tpm model='tpm-crb'/></devices></domain>")
destination().moveto(source, "vm", live=False, unsafe=False, offline=True)
self.assertEqual(
source.instance.undefined,
libvirt.VIR_DOMAIN_UNDEFINE_KEEP_NVRAM | libvirt.VIR_DOMAIN_UNDEFINE_KEEP_TPM,
)
def test_a_vm_with_nvram_or_tpm_state_is_refused(self):
"""That state stays on the source host: the VM would start on the
destination with new UEFI variables and a new TPM."""
cases = {
"nvram": "<os><nvram>/var/lib/libvirt/qemu/nvram/vm_VARS.fd</nvram></os>",
"tpm": "<devices><tpm model='tpm-crb'><backend type='emulator' version='2.0'/></tpm></devices>",
}
for case, xml in cases.items():
with self.subTest(case=case):
host = FakeHost()
source = FakeSource(5, xml=f"<domain>{xml}</domain>")
with self.assertRaisesRegex(util.OperationError, "migrate it live"):
destination(host).moveto(source, "vm", live=False, unsafe=False, offline=True)
self.assertEqual(host.defined, [])
self.assertIsNone(source.instance.undefined)
def test_a_tpm_without_local_state_moves(self):
xml = "<domain><devices><tpm model='tpm-tis'><backend type='passthrough'/></tpm></devices></domain>"
host = FakeHost()
destination(host).moveto(FakeSource(5, xml=xml), "vm", live=False, unsafe=False, offline=True)
self.assertEqual(host.defined, [xml])
def test_refused_before_anything_changes(self):
cases = {