[Qemu-devel] [RFC PATCH v2 14/16] ASN.1 schema for new migration format

[Dr. David Alan Gilbert (git)]

From: "Dr. David Alan Gilbert" <address@hidden>

Signed-off-by: Dr. David Alan Gilbert <address@hidden>
---
 docs/specs/migration.schema | 133 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 133 insertions(+)
 create mode 100644 docs/specs/migration.schema

diff --git a/docs/specs/migration.schema b/docs/specs/migration.schema
new file mode 100644
index 0000000..e72c575
--- /dev/null
+++ b/docs/specs/migration.schema
@@ -0,0 +1,133 @@
+-- Copyright 2014 Red Hat, Inc. and/or its affiliates
+--
+-- Authors:
+--   Dave Gilbert <address@hidden>
+--
+-- This work is licensed under the terms of the GNU LGPL, version 2 or later.
+-- See the COPYING.LIB file in the top-level directory.
+
+Qemu {}
+DEFINITIONS IMPLICIT TAGS ::=
+BEGIN
+
+-- Some basic types used in multiple places --
+QemuString ::= UTF8String (SIZE (1..255))
+
+-- Types for specific devices --
+
+--------------------------------
+
+-- Types for RAM
+
+-- TODO: 4096 is actually page size whatever that is
+FullPage ::= [ APPLICATION 9040 ] SEQUENCE {
+  addr    INTEGER, -- Address of page
+  data    OCTET STRING (SIZE (4096))
+}
+
+XBZRLEPage ::=  [ APPLICATION 11330 ] SEQUENCE {
+  addr    INTEGER,      -- Address of page
+  data    OCTET STRING  -- Compressed using xbzrle's own encoding
+}
+
+RAMBlockID ::= SEQUENCE {
+  name   QemuString,
+  len    INTEGER
+}
+
+-- RAM Block list sent in setup
+RAMBlockList ::= [ APPLICATION 8018 ] SEQUENCE {
+  totalram     INTEGER, -- Total length of RAM space in bytes
+  blocks       SEQUENCE OF RAMBlockID
+}
+
+-- An entry in a 'RAMSecBlock' - encapsulates all the different ways to send
+-- a page
+RAMPage ::= CHOICE {
+  compr        [ APPLICATION 0 ] INTEGER, -- Address of a zero'd page
+  fullpage     FullPage,                  -- A full uncompressed page
+  xbzrle       XBZRLEPage,
+  hook         [ APPLICATION 9295 ] NULL  -- A flag gets set on the next page
+}
+
+-- An entry in a RAM iterative section - a (probably incomplete) set of pages
+-- for a particular (named) RAMBlock
+RAMSecBlock ::= SEQUENCE {
+  name         QemuString,   -- RAMBlock these pages are for
+  pagelist     SEQUENCE OF RAMPage
+}
+
+-- Contents of a 'Section' for RAM
+
+SubSection ::= [ APPLICATION 10707 ] SEQUENCE {
+  name         QemuString,
+  versionid    INTEGER,
+
+  contents     SEQUENCE OF VMStateEntries
+}
+
+SubSecList ::= [ APPLICATION 10700 ] SEQUENCE OF SubSection
+
+VMStateEntries ::= CHOICE {
+  -- Hmm need to think more --
+  array       SEQUENCE OF VMStateEntries,
+  bool        BOOLEAN,
+  int         INTEGER,
+  oldblob     OCTET STRING,
+  subsecl     SubSecList
+}
+
+VMState ::= CHOICE {
+  vmstateentries  SEQUENCE OF VMStateEntries
+}
+
+-- Restrict to unsigned?
+SectionID ::= INTEGER
+
+-- BER EoC is all 0's, so some corruptions just look like an end of stream
+-- this dummy mark at the end of sections helps to spot these
+SecEndMark ::= [ APPLICATION 10693 ] NULL
+
+SecFull ::= [ APPLICATION 2003 ] SEQUENCE {
+  name         QemuString,
+  sectionid    SectionID,
+  instanceid   INTEGER,
+  versionid    INTEGER,
+
+  contents     CHOICE {
+    ramblid    RAMBlockList,
+    -- TODO other iterator initial stuff --
+    vmstate    VMState,
+    oldblob  OCTET STRING
+  },
+
+  SecEndMark
+}
+
+SecMin ::= [ APPLICATION 211 ] SEQUENCE {
+  sectionid   SectionID,
+
+  contents     CHOICE {
+    ramsec     [ APPLICATION 9810 ] SEQUENCE OF RAMSecBlock
+    -- TODO other iterator general/end stuff --
+  },
+
+  SecEndMark
+}
+
+Sections ::= CHOICE {
+  full    SecFull,
+  min     SecMin
+}
+
+-- The whole file --
+-- Application tag used to get first 32bits of file
+-- to come out as 7f cd c5 51  - the 51 is Q
+-- the c5 and cd being E,M but with the top bit set
+-- which BER requires
+QemuFile ::= [ APPLICATION 1270481 ] SEQUENCE {
+  version INTEGER (3),
+  top     SEQUENCE OF Sections
+}
+
+END
-- 
1.9.0