From patchwork Tue Mar 25 20:17:25 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Dr. David Alan Gilbert" X-Patchwork-Id: 333727 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id E822614003E for ; Wed, 26 Mar 2014 08:47:32 +1100 (EST) Received: from localhost ([::1]:44028 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WSXpk-0004tm-VB for incoming@patchwork.ozlabs.org; Tue, 25 Mar 2014 16:20:28 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:46226) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WSXnW-0002Jx-DQ for qemu-devel@nongnu.org; Tue, 25 Mar 2014 16:18:16 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WSXnQ-0008Jp-EI for qemu-devel@nongnu.org; Tue, 25 Mar 2014 16:18:10 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50973) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WSXnQ-0008Jh-4n for qemu-devel@nongnu.org; Tue, 25 Mar 2014 16:18:04 -0400 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id s2PKI1dI008568 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Tue, 25 Mar 2014 16:18:01 -0400 Received: from dgilbert-t530.home.treblig.org (vpn1-7-106.ams2.redhat.com [10.36.7.106]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id s2PKHSSi029837; Tue, 25 Mar 2014 16:17:59 -0400 From: "Dr. David Alan Gilbert (git)" To: qemu-devel@nongnu.org Date: Tue, 25 Mar 2014 20:17:25 +0000 Message-Id: <1395778647-30925-15-git-send-email-dgilbert@redhat.com> In-Reply-To: <1395778647-30925-1-git-send-email-dgilbert@redhat.com> References: <1395778647-30925-1-git-send-email-dgilbert@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.23 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 209.132.183.28 Cc: stefanb@linux.vnet.ibm.com, quintela@redhat.com, mdroth@linux.vnet.ibm.com, agraf@suse.de, mst@redhat.com, aliguori@amazon.com, afaerber@suse.de Subject: [Qemu-devel] [RFC PATCH 14/16] Start some BER format docs X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org From: "Dr. David Alan Gilbert" Add information on the QEMUFile/Visitor/VMState split Describe how to verify a BER stream against the schema Signed-off-by: Dr. David Alan Gilbert --- docs/migration.txt | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/docs/migration.txt b/docs/migration.txt index 0e0a1d4..894abf3 100644 --- a/docs/migration.txt +++ b/docs/migration.txt @@ -48,8 +48,17 @@ This is used for RAM and block devices. It is not yet ported to vmstate. === What is the common infrastructure === -QEMU uses a QEMUFile abstraction to be able to do migration. Any type -of migration that wants to use QEMU infrastructure has to create a +Migration consists of a number of layers that handle different parts of the +problem: + QEMUFile - Buffering/reading/writing data without worrying about it's + contents. Versions exist for file I/O, sockets, RDMA and + to put data into a QEMU Block device. + Visitor - Visitors format data onto the QEMUFile. A binary format and + a BER format currently exist. + VMState - Represent the structure of the data for a given device with + support for versioning. + +Any type of migration that wants to use QEMU infrastructure has to create a QEMUFile with: QEMUFile *qemu_fopen_ops(void *opaque, @@ -296,3 +305,24 @@ save/send this state when we are in the middle of a pio operation (that is what ide_drive_pio_state_needed() checks). If DRQ_STAT is not enabled, the values on that fields are garbage and don't need to be sent. + +ASN.1/BER format migration +========================== + +In BER format migration the migration stream is described by an ASN.1 schema +(that's defined in docs/specs/migration.schema). + +The 'asn1c' program can be used to validate a migration stream against the schema + - although it'll probably use a lot of memory doing it - so it's best to do it +with a small RAM image. + +To validate an image against the schema: + a) Make a temporary directory and cd into it + b) asn1c -fcompound-names /path/to/migration.schema + c) make -f Makefile.am.sample CFLAGS+="-DPDU=QemuFile -DEMIT_ASN_DEBUG=1 -I." + d) ./progname -iber log.ber -d 2> debug > decoding + + If it's happy the 'decoding' output should be an XML like dump of the input file; +if it's not happy, the debug file might help you find out why (Search backwards +from the end for the first 'Freeing' to find the point at which it detected something +bad).