[PATCH v7 09/23] backup: Parse and output checkpoint XML

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Add a new file checkpoint_conf.c that performs the translation to and
from new XML describing a checkpoint. The code shares a common base
class with snapshots, since a checkpoint similarly represents the
domain state at a moment in time. Add some basic testing of round trip
XML handling through the new code.

Signed-off-by: Eric Blake <eblake@xxxxxxxxxx>
---
 src/conf/checkpoint_conf.h          |  96 +++++
 src/conf/virconftypes.h             |   3 +
 po/POTFILES                         |   1 +
 src/conf/Makefile.inc.am            |   2 +
 src/conf/checkpoint_conf.c          | 553 ++++++++++++++++++++++++++++
 src/libvirt_private.syms            |   8 +
 tests/Makefile.am                   |   9 +-
 tests/domaincheckpointxml2xmltest.c | 212 +++++++++++
 8 files changed, 882 insertions(+), 2 deletions(-)
 create mode 100644 src/conf/checkpoint_conf.h
 create mode 100644 src/conf/checkpoint_conf.c
 create mode 100644 tests/domaincheckpointxml2xmltest.c

diff --git a/src/conf/checkpoint_conf.h b/src/conf/checkpoint_conf.h
new file mode 100644
index 0000000000..6647d0cd7c
--- /dev/null
+++ b/src/conf/checkpoint_conf.h
@@ -0,0 +1,96 @@
+/*
+ * checkpoint_conf.h: domain checkpoint XML processing
+ *                 (based on snapshot_conf.h)
+ *
+ * Copyright (C) 2006-2019 Red Hat, Inc.
+ * Copyright (C) 2006-2008 Daniel P. Berrange
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library.  If not, see
+ * <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef LIBVIRT_CHECKPOINT_CONF_H
+# define LIBVIRT_CHECKPOINT_CONF_H
+
+# include "internal.h"
+# include "domain_conf.h"
+# include "moment_conf.h"
+
+/* Items related to checkpoint state */
+
+typedef enum {
+    VIR_DOMAIN_CHECKPOINT_TYPE_DEFAULT = 0,
+    VIR_DOMAIN_CHECKPOINT_TYPE_NONE,
+    VIR_DOMAIN_CHECKPOINT_TYPE_BITMAP,
+
+    VIR_DOMAIN_CHECKPOINT_TYPE_LAST
+} virDomainCheckpointType;
+
+/* Stores disk-checkpoint information */
+typedef struct _virDomainCheckpointDiskDef virDomainCheckpointDiskDef;
+typedef virDomainCheckpointDiskDef *virDomainCheckpointDiskDefPtr;
+struct _virDomainCheckpointDiskDef {
+    char *name;     /* name matching the <target dev='...' of the domain */
+    int idx;        /* index within checkpoint->dom->disks that matches name */
+    int type;       /* virDomainCheckpointType */
+    char *bitmap;   /* bitmap name, if type is bitmap */
+    unsigned long long size; /* current checkpoint size in bytes */
+};
+
+/* Stores the complete checkpoint metadata */
+struct _virDomainCheckpointDef {
+    virDomainMomentDef common;
+
+    /* Additional Public XML.  */
+    size_t ndisks; /* should not exceed dom->ndisks */
+    virDomainCheckpointDiskDef *disks;
+};
+
+
+typedef enum {
+    VIR_DOMAIN_CHECKPOINT_PARSE_REDEFINE = 1 << 0,
+    VIR_DOMAIN_CHECKPOINT_PARSE_INTERNAL = 1 << 1,
+} virDomainCheckpointParseFlags;
+
+typedef enum {
+    VIR_DOMAIN_CHECKPOINT_FORMAT_SECURE    = 1 << 0,
+    VIR_DOMAIN_CHECKPOINT_FORMAT_NO_DOMAIN = 1 << 1,
+    VIR_DOMAIN_CHECKPOINT_FORMAT_SIZE      = 1 << 2,
+    VIR_DOMAIN_CHECKPOINT_FORMAT_INTERNAL  = 1 << 3,
+    VIR_DOMAIN_CHECKPOINT_FORMAT_CURRENT   = 1 << 4,
+} virDomainCheckpointFormatFlags;
+
+unsigned int virDomainCheckpointFormatConvertXMLFlags(unsigned int flags);
+
+virDomainCheckpointDefPtr virDomainCheckpointDefParseString(const char *xmlStr,
+                                                            virCapsPtr caps,
+                                                            virDomainXMLOptionPtr xmlopt,
+                                                            bool *current,
+                                                            unsigned int flags);
+virDomainCheckpointDefPtr virDomainCheckpointDefParseNode(xmlDocPtr xml,
+                                                          xmlNodePtr root,
+                                                          virCapsPtr caps,
+                                                          virDomainXMLOptionPtr xmlopt,
+                                                          bool *current,
+                                                          unsigned int flags);
+void virDomainCheckpointDefFree(virDomainCheckpointDefPtr def);
+char *virDomainCheckpointDefFormat(virDomainCheckpointDefPtr def,
+                                   virCapsPtr caps,
+                                   virDomainXMLOptionPtr xmlopt,
+                                   unsigned int flags);
+int virDomainCheckpointAlignDisks(virDomainCheckpointDefPtr checkpoint);
+
+VIR_ENUM_DECL(virDomainCheckpoint);
+
+#endif /* LIBVIRT_CHECKPOINT_CONF_H */
diff --git a/src/conf/virconftypes.h b/src/conf/virconftypes.h
index 6a8267c422..f01721c6d5 100644
--- a/src/conf/virconftypes.h
+++ b/src/conf/virconftypes.h
@@ -103,6 +103,9 @@ typedef virDomainBlkiotune *virDomainBlkiotunePtr;
 typedef struct _virDomainBlockIoTuneInfo virDomainBlockIoTuneInfo;
 typedef virDomainBlockIoTuneInfo *virDomainBlockIoTuneInfoPtr;

+typedef struct _virDomainCheckpointDef virDomainCheckpointDef;
+typedef virDomainCheckpointDef *virDomainCheckpointDefPtr;
+
 typedef struct _virDomainChrDef virDomainChrDef;
 typedef virDomainChrDef *virDomainChrDefPtr;

diff --git a/po/POTFILES b/po/POTFILES
index 88af551664..57c55fb35f 100644
--- a/po/POTFILES
+++ b/po/POTFILES
@@ -15,6 +15,7 @@ src/bhyve/bhyve_monitor.c
 src/bhyve/bhyve_parse_command.c
 src/bhyve/bhyve_process.c
 src/conf/capabilities.c
+src/conf/checkpoint_conf.c
 src/conf/cpu_conf.c
 src/conf/device_conf.c
 src/conf/domain_addr.c
diff --git a/src/conf/Makefile.inc.am b/src/conf/Makefile.inc.am
index 6eb64db9de..913e21e2d1 100644
--- a/src/conf/Makefile.inc.am
+++ b/src/conf/Makefile.inc.am
@@ -10,6 +10,8 @@ NETDEV_CONF_SOURCES = \
 DOMAIN_CONF_SOURCES = \
 	conf/capabilities.c \
 	conf/capabilities.h \
+	conf/checkpoint_conf.c \
+	conf/checkpoint_conf.h \
 	conf/domain_addr.c \
 	conf/domain_addr.h \
 	conf/domain_capabilities.c \
diff --git a/src/conf/checkpoint_conf.c b/src/conf/checkpoint_conf.c
new file mode 100644
index 0000000000..bdcf763a48
--- /dev/null
+++ b/src/conf/checkpoint_conf.c
@@ -0,0 +1,553 @@
+/*
+ * checkpoint_conf.c: domain checkpoint XML processing
+ *
+ * Copyright (C) 2006-2019 Red Hat, Inc.
+ * Copyright (C) 2006-2008 Daniel P. Berrange
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library.  If not, see
+ * <http://www.gnu.org/licenses/>.
+ */
+
+#include <config.h>
+
+#include <sys/time.h>
+
+#include "internal.h"
+#include "virbitmap.h"
+#include "virbuffer.h"
+#include "datatypes.h"
+#include "domain_conf.h"
+#include "virlog.h"
+#include "viralloc.h"
+#include "checkpoint_conf.h"
+#include "virstoragefile.h"
+#include "viruuid.h"
+#include "virfile.h"
+#include "virerror.h"
+#include "virxml.h"
+#include "virstring.h"
+
+#define VIR_FROM_THIS VIR_FROM_DOMAIN_CHECKPOINT
+
+VIR_LOG_INIT("conf.checkpoint_conf");
+
+VIR_ENUM_IMPL(virDomainCheckpoint, VIR_DOMAIN_CHECKPOINT_TYPE_LAST,
+              "default", "no", "bitmap");
+
+
+/* Checkpoint Def functions */
+static void
+virDomainCheckpointDiskDefClear(virDomainCheckpointDiskDefPtr disk)
+{
+    VIR_FREE(disk->name);
+    VIR_FREE(disk->bitmap);
+}
+
+void virDomainCheckpointDefFree(virDomainCheckpointDefPtr def)
+{
+    size_t i;
+
+    if (!def)
+        return;
+
+    virDomainMomentDefClear(&def->common);
+    for (i = 0; i < def->ndisks; i++)
+        virDomainCheckpointDiskDefClear(&def->disks[i]);
+    VIR_FREE(def->disks);
+    VIR_FREE(def);
+}
+
+static int
+virDomainCheckpointDiskDefParseXML(xmlNodePtr node,
+                                   xmlXPathContextPtr ctxt,
+                                   virDomainCheckpointDiskDefPtr def)
+{
+    int ret = -1;
+    char *checkpoint = NULL;
+    char *bitmap = NULL;
+    xmlNodePtr saved = ctxt->node;
+
+    ctxt->node = node;
+
+    def->name = virXMLPropString(node, "name");
+    if (!def->name) {
+        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                       _("missing name from disk checkpoint element"));
+        goto cleanup;
+    }
+
+    checkpoint = virXMLPropString(node, "checkpoint");
+    if (checkpoint) {
+        def->type = virDomainCheckpointTypeFromString(checkpoint);
+        if (def->type <= 0) {
+            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
+                           _("unknown disk checkpoint setting '%s'"),
+                           checkpoint);
+            goto cleanup;
+        }
+    } else {
+        def->type = VIR_DOMAIN_CHECKPOINT_TYPE_BITMAP;
+    }
+
+    bitmap = virXMLPropString(node, "bitmap");
+    if (bitmap) {
+        if (def->type != VIR_DOMAIN_CHECKPOINT_TYPE_BITMAP) {
+            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
+                           _("disk checkpoint bitmap '%s' requires "
+                             "type='bitmap'"),
+                           bitmap);
+            goto cleanup;
+        }
+        VIR_STEAL_PTR(def->bitmap, bitmap);
+    }
+
+    ret = 0;
+ cleanup:
+    ctxt->node = saved;
+
+    VIR_FREE(checkpoint);
+    VIR_FREE(bitmap);
+    if (ret < 0)
+        virDomainCheckpointDiskDefClear(def);
+    return ret;
+}
+
+/* flags is bitwise-or of virDomainCheckpointParseFlags.  If flags
+ * does not include VIR_DOMAIN_CHECKPOINT_PARSE_REDEFINE, then caps
+ * are ignored. If flags does not include
+ * VIR_DOMAIN_CHECKPOINT_PARSE_INTERNAL, then current is ignored.
+ */
+static virDomainCheckpointDefPtr
+virDomainCheckpointDefParse(xmlXPathContextPtr ctxt,
+                            virCapsPtr caps,
+                            virDomainXMLOptionPtr xmlopt,
+                            bool *current,
+                            unsigned int flags)
+{
+    virDomainCheckpointDefPtr def = NULL;
+    virDomainCheckpointDefPtr ret = NULL;
+    xmlNodePtr *nodes = NULL;
+    size_t i;
+    int n;
+    char *creation = NULL;
+    struct timeval tv;
+    int active;
+    char *tmp;
+
+    if (VIR_ALLOC(def) < 0)
+        goto cleanup;
+
+    gettimeofday(&tv, NULL);
+
+    def->common.name = virXPathString("string(./name)", ctxt);
+    if (def->common.name == NULL) {
+        if (flags & VIR_DOMAIN_CHECKPOINT_PARSE_REDEFINE) {
+            virReportError(VIR_ERR_XML_ERROR, "%s",
+                           _("a redefined checkpoint must have a name"));
+            goto cleanup;
+        }
+        if (virAsprintf(&def->common.name, "%lld", (long long)tv.tv_sec) < 0)
+            goto cleanup;
+    }
+
+    def->common.description = virXPathString("string(./description)", ctxt);
+
+    if (flags & VIR_DOMAIN_CHECKPOINT_PARSE_REDEFINE) {
+        if (virXPathLongLong("string(./creationTime)", ctxt,
+                             &def->common.creationTime) < 0) {
+            virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                           _("missing creationTime from existing checkpoint"));
+            goto cleanup;
+        }
+
+        def->common.parent = virXPathString("string(./parent/name)", ctxt);
+
+        if ((tmp = virXPathString("string(./domain/@type)", ctxt))) {
+            int domainflags = VIR_DOMAIN_DEF_PARSE_INACTIVE |
+                              VIR_DOMAIN_DEF_PARSE_SKIP_VALIDATE;
+            xmlNodePtr domainNode = virXPathNode("./domain", ctxt);
+
+            VIR_FREE(tmp);
+            if (!domainNode) {
+                virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                               _("missing domain in checkpoint"));
+                goto cleanup;
+            }
+            def->common.dom = virDomainDefParseNode(ctxt->node->doc, domainNode,
+                                                    caps, xmlopt, NULL,
+                                                    domainflags);
+            if (!def->common.dom)
+                goto cleanup;
+        } else {
+            virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                           _("missing domain in checkpoint redefine"));
+            goto cleanup;
+        }
+    } else {
+        def->common.creationTime = tv.tv_sec;
+    }
+
+    if ((n = virXPathNodeSet("./disks/*", ctxt, &nodes)) < 0)
+        goto cleanup;
+    if (n && VIR_ALLOC_N(def->disks, n) < 0)
+        goto cleanup;
+    def->ndisks = n;
+    for (i = 0; i < def->ndisks; i++) {
+        if (virDomainCheckpointDiskDefParseXML(nodes[i], ctxt,
+                                               &def->disks[i]) < 0)
+            goto cleanup;
+    }
+
+    if (flags & VIR_DOMAIN_CHECKPOINT_PARSE_INTERNAL) {
+        if (!current) {
+            virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                           _("internal parse requested with NULL current"));
+            goto cleanup;
+        }
+        if (virXPathInt("string(./active)", ctxt, &active) < 0) {
+            virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                           _("Could not find 'active' element"));
+            goto cleanup;
+        }
+        *current = active != 0;
+    }
+
+    VIR_STEAL_PTR(ret, def);
+
+ cleanup:
+    VIR_FREE(creation);
+    VIR_FREE(nodes);
+    virDomainCheckpointDefFree(def);
+
+    return ret;
+}
+
+virDomainCheckpointDefPtr
+virDomainCheckpointDefParseNode(xmlDocPtr xml,
+                                xmlNodePtr root,
+                                virCapsPtr caps,
+                                virDomainXMLOptionPtr xmlopt,
+                                bool *current,
+                                unsigned int flags)
+{
+    xmlXPathContextPtr ctxt = NULL;
+    virDomainCheckpointDefPtr def = NULL;
+
+    if (!virXMLNodeNameEqual(root, "domaincheckpoint")) {
+        virReportError(VIR_ERR_XML_ERROR, "%s", _("domaincheckpoint"));
+        goto cleanup;
+    }
+
+    ctxt = xmlXPathNewContext(xml);
+    if (ctxt == NULL) {
+        virReportOOMError();
+        goto cleanup;
+    }
+
+    ctxt->node = root;
+    def = virDomainCheckpointDefParse(ctxt, caps, xmlopt, current, flags);
+ cleanup:
+    xmlXPathFreeContext(ctxt);
+    return def;
+}
+
+virDomainCheckpointDefPtr
+virDomainCheckpointDefParseString(const char *xmlStr,
+                                  virCapsPtr caps,
+                                  virDomainXMLOptionPtr xmlopt,
+                                  bool *current,
+                                  unsigned int flags)
+{
+    virDomainCheckpointDefPtr ret = NULL;
+    xmlDocPtr xml;
+    int keepBlanksDefault = xmlKeepBlanksDefault(0);
+
+    if ((xml = virXMLParse(NULL, xmlStr, _("(domain_checkpoint)")))) {
+        xmlKeepBlanksDefault(keepBlanksDefault);
+        ret = virDomainCheckpointDefParseNode(xml, xmlDocGetRootElement(xml),
+                                              caps, xmlopt, current, flags);
+        xmlFreeDoc(xml);
+    }
+    xmlKeepBlanksDefault(keepBlanksDefault);
+
+    return ret;
+}
+
+
+/**
+ * virDomainCheckpointDefAssignBitmapNames:
+ * @def: checkpoint def object
+ *
+ * Generate default bitmap names for checkpoint targets. Returns 0 on
+ * success, -1 on error.
+ */
+static int
+virDomainCheckpointDefAssignBitmapNames(virDomainCheckpointDefPtr def)
+{
+    size_t i;
+
+    for (i = 0; i < def->ndisks; i++) {
+        virDomainCheckpointDiskDefPtr disk = &def->disks[i];
+
+        if (disk->type != VIR_DOMAIN_CHECKPOINT_TYPE_BITMAP ||
+            disk->bitmap)
+            continue;
+
+        if (VIR_STRDUP(disk->bitmap, def->common.name) < 0)
+            return -1;
+    }
+
+    return 0;
+}
+
+
+static int
+virDomainCheckpointCompareDiskIndex(const void *a, const void *b)
+{
+    const virDomainCheckpointDiskDef *diska = a;
+    const virDomainCheckpointDiskDef *diskb = b;
+
+    /* Integer overflow shouldn't be a problem here.  */
+    return diska->idx - diskb->idx;
+}
+
+/* Align def->disks to def->domain.  Sort the list of def->disks,
+ * filling in any missing disks with appropriate default.  Convert
+ * paths to disk targets for uniformity.  Issue an error and return -1
+ * if any def->disks[n]->name appears more than once or does not map
+ * to dom->disks. */
+int
+virDomainCheckpointAlignDisks(virDomainCheckpointDefPtr def)
+{
+    int ret = -1;
+    virBitmapPtr map = NULL;
+    size_t i;
+    int ndisks;
+    int checkpoint_default = VIR_DOMAIN_CHECKPOINT_TYPE_NONE;
+
+    if (!def->common.dom) {
+        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                       _("missing domain in checkpoint"));
+        goto cleanup;
+    }
+
+    if (def->ndisks > def->common.dom->ndisks) {
+        virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
+                       _("too many disk checkpoint requests for domain"));
+        goto cleanup;
+    }
+
+    /* Unlikely to have a guest without disks but technically possible.  */
+    if (!def->common.dom->ndisks) {
+        virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
+                       _("domain must have at least one disk to perform "
+                         "checkpoints"));
+        goto cleanup;
+    }
+
+    /* If <disks> omitted, do bitmap on all disks; otherwise, do nothing
+     * for omitted disks */
+    if (!def->ndisks)
+        checkpoint_default = VIR_DOMAIN_CHECKPOINT_TYPE_BITMAP;
+
+    if (!(map = virBitmapNew(def->common.dom->ndisks)))
+        goto cleanup;
+
+    /* Double check requested disks.  */
+    for (i = 0; i < def->ndisks; i++) {
+        virDomainCheckpointDiskDefPtr disk = &def->disks[i];
+        int idx = virDomainDiskIndexByName(def->common.dom, disk->name, false);
+
+        if (idx < 0) {
+            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
+                           _("no disk named '%s'"), disk->name);
+            goto cleanup;
+        }
+
+        if (virBitmapIsBitSet(map, idx)) {
+            virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
+                           _("disk '%s' specified twice"),
+                           disk->name);
+            goto cleanup;
+        }
+        ignore_value(virBitmapSetBit(map, idx));
+        disk->idx = idx;
+
+        if (STRNEQ(disk->name, def->common.dom->disks[idx]->dst)) {
+            VIR_FREE(disk->name);
+            if (VIR_STRDUP(disk->name, def->common.dom->disks[idx]->dst) < 0)
+                goto cleanup;
+        }
+    }
+
+    /* Provide defaults for all remaining disks.  */
+    ndisks = def->ndisks;
+    if (VIR_EXPAND_N(def->disks, def->ndisks,
+                     def->common.dom->ndisks - def->ndisks) < 0)
+        goto cleanup;
+
+    for (i = 0; i < def->common.dom->ndisks; i++) {
+        virDomainCheckpointDiskDefPtr disk;
+
+        if (virBitmapIsBitSet(map, i))
+            continue;
+        disk = &def->disks[ndisks++];
+        if (VIR_STRDUP(disk->name, def->common.dom->disks[i]->dst) < 0)
+            goto cleanup;
+        disk->idx = i;
+
+        /* Don't checkpoint empty drives */
+        if (virStorageSourceIsEmpty(def->common.dom->disks[i]->src))
+            disk->type = VIR_DOMAIN_CHECKPOINT_TYPE_NONE;
+        else
+            disk->type = checkpoint_default;
+    }
+
+    qsort(&def->disks[0], def->ndisks, sizeof(def->disks[0]),
+          virDomainCheckpointCompareDiskIndex);
+
+    /* Generate default bitmap names for checkpoint */
+    if (virDomainCheckpointDefAssignBitmapNames(def) < 0)
+        goto cleanup;
+
+    ret = 0;
+
+ cleanup:
+    virBitmapFree(map);
+    return ret;
+}
+
+
+/* Converts public VIR_DOMAIN_CHECKPOINT_XML_* into
+ * VIR_DOMAIN_CHECKPOINT_FORMAT_* flags, and silently ignores any other
+ * flags.  */
+unsigned int virDomainCheckpointFormatConvertXMLFlags(unsigned int flags)
+{
+    unsigned int formatFlags = 0;
+
+    if (flags & VIR_DOMAIN_CHECKPOINT_XML_SECURE)
+        formatFlags |= VIR_DOMAIN_CHECKPOINT_FORMAT_SECURE;
+    if (flags & VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN)
+        formatFlags |= VIR_DOMAIN_CHECKPOINT_FORMAT_NO_DOMAIN;
+    if (flags & VIR_DOMAIN_CHECKPOINT_XML_SIZE)
+        formatFlags |= VIR_DOMAIN_CHECKPOINT_FORMAT_SIZE;
+
+    return formatFlags;
+}
+
+
+static int
+virDomainCheckpointDiskDefFormat(virBufferPtr buf,
+                                 virDomainCheckpointDiskDefPtr disk,
+                                 unsigned int flags)
+{
+    if (!disk->name)
+        return 0;
+
+    virBufferEscapeString(buf, "<disk name='%s'", disk->name);
+    if (disk->type)
+        virBufferAsprintf(buf, " checkpoint='%s'",
+                          virDomainCheckpointTypeToString(disk->type));
+    if (disk->bitmap) {
+        virBufferEscapeString(buf, " bitmap='%s'", disk->bitmap);
+        if (flags & VIR_DOMAIN_CHECKPOINT_FORMAT_SIZE)
+            virBufferAsprintf(buf, " size='%llu'", disk->size);
+    }
+    virBufferAddLit(buf, "/>\n");
+    return 0;
+}
+
+
+static int
+virDomainCheckpointDefFormatInternal(virBufferPtr buf,
+                                     virDomainCheckpointDefPtr def,
+                                     virCapsPtr caps,
+                                     virDomainXMLOptionPtr xmlopt,
+                                     unsigned int flags)
+{
+    size_t i;
+    unsigned int domainflags = VIR_DOMAIN_DEF_FORMAT_INACTIVE;
+
+    if (flags & VIR_DOMAIN_CHECKPOINT_FORMAT_SECURE)
+        domainflags |= VIR_DOMAIN_DEF_FORMAT_SECURE;
+
+    virBufferAddLit(buf, "<domaincheckpoint>\n");
+    virBufferAdjustIndent(buf, 2);
+
+    virBufferEscapeString(buf, "<name>%s</name>\n", def->common.name);
+    virBufferEscapeString(buf, "<description>%s</description>\n",
+                          def->common.description);
+
+    if (def->common.parent) {
+        virBufferAddLit(buf, "<parent>\n");
+        virBufferAdjustIndent(buf, 2);
+        virBufferEscapeString(buf, "<name>%s</name>\n", def->common.parent);
+        virBufferAdjustIndent(buf, -2);
+        virBufferAddLit(buf, "</parent>\n");
+    }
+
+    virBufferAsprintf(buf, "<creationTime>%lld</creationTime>\n",
+                      def->common.creationTime);
+
+    if (def->ndisks) {
+        virBufferAddLit(buf, "<disks>\n");
+        virBufferAdjustIndent(buf, 2);
+        for (i = 0; i < def->ndisks; i++) {
+            if (virDomainCheckpointDiskDefFormat(buf, &def->disks[i],
+                                                 flags) < 0)
+                goto error;
+        }
+        virBufferAdjustIndent(buf, -2);
+        virBufferAddLit(buf, "</disks>\n");
+    }
+
+    if (!(flags & VIR_DOMAIN_CHECKPOINT_FORMAT_NO_DOMAIN) &&
+        virDomainDefFormatInternal(def->common.dom, caps, domainflags, buf,
+                                   xmlopt) < 0)
+        goto error;
+
+    if (flags & VIR_DOMAIN_CHECKPOINT_FORMAT_INTERNAL)
+        virBufferAsprintf(buf, "<active>%d</active>\n",
+                          !!(flags & VIR_DOMAIN_CHECKPOINT_FORMAT_CURRENT));
+
+    virBufferAdjustIndent(buf, -2);
+    virBufferAddLit(buf, "</domaincheckpoint>\n");
+
+    if (virBufferCheckError(buf) < 0)
+        goto error;
+
+    return 0;
+
+ error:
+    virBufferFreeAndReset(buf);
+    return -1;
+}
+
+char *
+virDomainCheckpointDefFormat(virDomainCheckpointDefPtr def,
+                             virCapsPtr caps,
+                             virDomainXMLOptionPtr xmlopt,
+                             unsigned int flags)
+{
+    virBuffer buf = VIR_BUFFER_INITIALIZER;
+
+    virCheckFlags(VIR_DOMAIN_CHECKPOINT_FORMAT_SECURE |
+                  VIR_DOMAIN_CHECKPOINT_FORMAT_NO_DOMAIN |
+                  VIR_DOMAIN_CHECKPOINT_FORMAT_SIZE, NULL);
+    if (virDomainCheckpointDefFormatInternal(&buf, def, caps, xmlopt,
+                                             flags) < 0)
+        return NULL;
+
+    return virBufferContentAndReset(&buf);
+}
diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms
index 73ef24d66f..5be63c7b3d 100644
--- a/src/libvirt_private.syms
+++ b/src/libvirt_private.syms
@@ -69,6 +69,14 @@ virCapabilitiesSetHostCPU;
 virCapabilitiesSetNetPrefix;


+# conf/checkpoint_conf.h
+virDomainCheckpointDefFormat;
+virDomainCheckpointDefFree;
+virDomainCheckpointDefParseString;
+virDomainCheckpointTypeFromString;
+virDomainCheckpointTypeToString;
+
+
 # conf/cpu_conf.h
 virCPUCacheModeTypeFromString;
 virCPUCacheModeTypeToString;
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 666b3945c6..6aec2b99cb 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -278,7 +278,7 @@ endif WITH_LIBXL

 if WITH_QEMU
 test_programs += qemuxml2argvtest qemuxml2xmltest \
-	qemuargv2xmltest domainsnapshotxml2xmltest \
+	qemuargv2xmltest domaincheckpointxml2xmltest domainsnapshotxml2xmltest \
 	qemumonitorjsontest qemuhotplugtest \
 	qemuagenttest qemucapabilitiestest qemucaps2xmltest \
 	qemumemlocktest \
@@ -663,6 +663,11 @@ qemublocktest_LDADD = \
 	$(LDADDS) \
 	$(NULL)

+domaincheckpointxml2xmltest_SOURCES = \
+	domaincheckpointxml2xmltest.c testutilsqemu.c testutilsqemu.h \
+	testutils.c testutils.h
+domaincheckpointxml2xmltest_LDADD = $(qemu_LDADDS) $(LDADDS)
+
 domainsnapshotxml2xmltest_SOURCES = \
 	domainsnapshotxml2xmltest.c testutilsqemu.c testutilsqemu.h \
 	testutils.c testutils.h
@@ -698,7 +703,7 @@ qemufirmwaretest_LDADD = $(qemu_LDADDS) $(LDADDS)

 else ! WITH_QEMU
 EXTRA_DIST += qemuxml2argvtest.c qemuxml2xmltest.c qemuargv2xmltest.c \
-	domainsnapshotxml2xmltest.c \
+	domaincheckpointxml2xmltest.c domainsnapshotxml2xmltest.c \
 	testutilsqemu.c testutilsqemu.h \
 	testutilsqemuschema.c testutilsqemuschema.h \
 	qemumonitorjsontest.c qemuhotplugtest.c \
diff --git a/tests/domaincheckpointxml2xmltest.c b/tests/domaincheckpointxml2xmltest.c
new file mode 100644
index 0000000000..838ae989ae
--- /dev/null
+++ b/tests/domaincheckpointxml2xmltest.c
@@ -0,0 +1,212 @@
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <string.h>
+
+#include <sys/types.h>
+#include <fcntl.h>
+
+#include <regex.h>
+
+#include "testutils.h"
+
+#ifdef WITH_QEMU
+
+# include "internal.h"
+# include "qemu/qemu_conf.h"
+# include "qemu/qemu_domain.h"
+# include "checkpoint_conf.h"
+# include "testutilsqemu.h"
+# include "virstring.h"
+
+# define VIR_FROM_THIS VIR_FROM_NONE
+
+static virQEMUDriver driver;
+
+/* This regex will skip the following XML constructs in test files
+ * that are dynamically generated and thus problematic to test:
+ * <name>1234352345</name> if the checkpoint has no name,
+ * <creationTime>23523452345</creationTime>.
+ */
+static const char *testCheckpointXMLVariableLineRegexStr =
+    "<(name|creationTime)>[0-9]+</(name|creationTime)>";
+
+regex_t *testCheckpointXMLVariableLineRegex = NULL;
+
+static char *
+testFilterXML(char *xml)
+{
+    virBuffer buf = VIR_BUFFER_INITIALIZER;
+    char **xmlLines = NULL;
+    char **xmlLine;
+    char *ret = NULL;
+
+    if (!(xmlLines = virStringSplit(xml, "\n", 0))) {
+        VIR_FREE(xml);
+        goto cleanup;
+    }
+    VIR_FREE(xml);
+
+    for (xmlLine = xmlLines; *xmlLine; xmlLine++) {
+        if (regexec(testCheckpointXMLVariableLineRegex,
+                    *xmlLine, 0, NULL, 0) == 0)
+            continue;
+
+        virBufferStrcat(&buf, *xmlLine, "\n", NULL);
+    }
+
+    if (virBufferCheckError(&buf) < 0)
+        goto cleanup;
+
+    ret = virBufferContentAndReset(&buf);
+
+ cleanup:
+    virBufferFreeAndReset(&buf);
+    virStringListFree(xmlLines);
+    return ret;
+}
+
+static int
+testCompareXMLToXMLFiles(const char *inxml,
+                         const char *outxml,
+                         bool redefine)
+{
+    char *inXmlData = NULL;
+    char *outXmlData = NULL;
+    char *actual = NULL;
+    int ret = -1;
+    virDomainCheckpointDefPtr def = NULL;
+    unsigned int parseflags = 0;
+    unsigned int formatflags = VIR_DOMAIN_CHECKPOINT_FORMAT_SECURE;
+
+    if (redefine)
+        parseflags |= VIR_DOMAIN_CHECKPOINT_PARSE_REDEFINE;
+
+    if (virTestLoadFile(inxml, &inXmlData) < 0)
+        goto cleanup;
+
+    if (virTestLoadFile(outxml, &outXmlData) < 0)
+        goto cleanup;
+
+    if (!(def = virDomainCheckpointDefParseString(inXmlData, driver.caps,
+                                                  driver.xmlopt, NULL,
+                                                  parseflags)))
+        goto cleanup;
+
+    /* Parsing XML does not populate the domain definition, so add a
+     * canned bare-bones fallback */
+    if (!def->common.dom)
+        formatflags |= VIR_DOMAIN_CHECKPOINT_FORMAT_NO_DOMAIN;
+
+    if (!(actual = virDomainCheckpointDefFormat(def, driver.caps,
+                                                driver.xmlopt,
+                                                formatflags)))
+        goto cleanup;
+
+    if (!redefine) {
+        if (!(actual = testFilterXML(actual)))
+            goto cleanup;
+
+        if (!(outXmlData = testFilterXML(outXmlData)))
+            goto cleanup;
+    }
+
+    if (STRNEQ(outXmlData, actual)) {
+        virTestDifferenceFull(stderr, outXmlData, outxml, actual, inxml);
+        goto cleanup;
+    }
+
+    ret = 0;
+
+ cleanup:
+    VIR_FREE(inXmlData);
+    VIR_FREE(outXmlData);
+    VIR_FREE(actual);
+    virDomainCheckpointDefFree(def);
+    return ret;
+}
+
+struct testInfo {
+    const char *inxml;
+    const char *outxml;
+    bool redefine;
+};
+
+
+static int
+testCompareXMLToXMLHelper(const void *data)
+{
+    const struct testInfo *info = data;
+
+    return testCompareXMLToXMLFiles(info->inxml, info->outxml, info->redefine);
+}
+
+
+static int
+mymain(void)
+{
+    int ret = 0;
+
+    if (qemuTestDriverInit(&driver) < 0)
+        return EXIT_FAILURE;
+
+    if (VIR_ALLOC(testCheckpointXMLVariableLineRegex) < 0)
+        goto cleanup;
+
+    if (regcomp(testCheckpointXMLVariableLineRegex,
+                testCheckpointXMLVariableLineRegexStr,
+                REG_EXTENDED | REG_NOSUB) != 0) {
+        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                       "failed to compile test regex");
+        goto cleanup;
+    }
+
+
+# define DO_TEST(prefix, name, inpath, outpath, redefine) \
+    do { \
+        const struct testInfo info = {abs_srcdir "/" inpath "/" name ".xml", \
+                                      abs_srcdir "/" outpath "/" name ".xml", \
+                                      redefine}; \
+        if (virTestRun("CHECKPOINT XML-2-XML " prefix " " name, \
+                       testCompareXMLToXMLHelper, &info) < 0) \
+            ret = -1; \
+    } while (0)
+
+# define DO_TEST_INOUT(name, redefine) \
+    DO_TEST("in->out", name, \
+            "domaincheckpointxml2xmlin", \
+            "domaincheckpointxml2xmlout", \
+            redefine)
+
+    /* Unset or set all envvars here that are copied in qemudBuildCommandLine
+     * using ADD_ENV_COPY, otherwise these tests may fail due to unexpected
+     * values for these envvars */
+    setenv("PATH", "/bin", 1);
+
+//    DO_TEST_INOUT("empty", false);
+//    DO_TEST_INOUT("sample", false);
+    DO_TEST("in", "redefine", "domaincheckpointxml2xmlin",
+            "domaincheckpointxml2xmlin", true);
+
+ cleanup:
+    if (testCheckpointXMLVariableLineRegex)
+        regfree(testCheckpointXMLVariableLineRegex);
+    VIR_FREE(testCheckpointXMLVariableLineRegex);
+    qemuTestDriverFree(&driver);
+
+    return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
+}
+
+VIR_TEST_MAIN(mymain)
+
+#else
+
+int
+main(void)
+{
+    return EXIT_AM_SKIP;
+}
+
+#endif /* WITH_QEMU */
-- 
2.20.1

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list



[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux