Mailing List Archive

[xen staging] docs/migration: add missing definitions to libxc-migration-stream
commit 25fcedefaa9fcbd20203202aa1b73eef051a5fa9
Author: Paul Durrant <pdurrant@amazon.com>
AuthorDate: Thu Oct 8 19:57:31 2020 +0100
Commit: Andrew Cooper <andrew.cooper3@citrix.com>
CommitDate: Mon Jan 25 19:27:13 2021 +0000

docs/migration: add missing definitions to libxc-migration-stream

The STATIC_DATA_END, X86_CPUID_POLICY and X86_MSR_POLICY record types have
sections explaining what they are but their values are not defined. Indeed
their values are defined as "Reserved for future mandatory records."

Also, the spec revision is adjusted to match the migration stream version
and an END record is added to the description of a 'typical save record for
and x86 HVM guest.'

Signed-off-by: Paul Durrant <pdurrant@amazon.com>
Fixes: 6f71b5b1506 ("docs/migration Specify migration v3 and STATIC_DATA_END")
Fixes: ddd273d8863 ("docs/migration: Specify X86_{CPUID,MSR}_POLICY records")
Acked-by: Wei Liu <wl@xen.org>
Acked-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
docs/specs/libxc-migration-stream.pandoc | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/docs/specs/libxc-migration-stream.pandoc b/docs/specs/libxc-migration-stream.pandoc
index 6b0c49e97a..8aeab3b11b 100644
--- a/docs/specs/libxc-migration-stream.pandoc
+++ b/docs/specs/libxc-migration-stream.pandoc
@@ -3,7 +3,7 @@
Andrew Cooper <<andrew.cooper3@citrix.com>>
Wen Congyang <<wency@cn.fujitsu.com>>
Yang Hongyang <<hongyang.yang@easystack.cn>>
-% Revision 2
+% Revision 3

Introduction
============
@@ -227,7 +227,13 @@ type 0x00000000: END

0x0000000F: CHECKPOINT_DIRTY_PFN_LIST (Secondary -> Primary)

- 0x00000010 - 0x7FFFFFFF: Reserved for future _mandatory_
+ 0x00000010: STATIC_DATA_END
+
+ 0x00000011: X86_CPUID_POLICY
+
+ 0x00000012: X86_MSR_POLICY
+
+ 0x00000013 - 0x7FFFFFFF: Reserved for future _mandatory_
records.

0x80000000 - 0xFFFFFFFF: Reserved for future _optional_
@@ -732,6 +738,7 @@ A typical save record for an x86 HVM guest image would look like:
* X86_TSC_INFO
* HVM_PARAMS
* HVM_CONTEXT
+* END record

HVM_PARAMS must precede HVM_CONTEXT, as certain parameters can affect
the validity of architectural state in the context.
--
generated by git-patchbot for /home/xen/git/xen.git#staging