[libvirt] [PATCH v3 7/8] undefine: Extend virsh undefine to support the new API

[Osier Yang]

If the domain has managed state file, and --managed-state is
not specified, then it fails with an error telling the user
that a managed save image still exists.

If the domain has managed state file, and --managed-state is
specified, it invokes virDomainUndefineFlags. If
virDomainUndefineFlags fails, then it tries to remove the managed
save image using virDomainManagedSaveRemove first, with
invoking virDomainUndefine following. (For compatibility between
new virsh with this patch and older libvirt without this patch).

Similarly if the domain has no managed state. See the codes for
detail.

NOTE: Have not removing the codes checking if the domain is running
in function "cmdUndefine", it will go along with qemu driver's fix
(allow to undefine a running domain).
---
 tools/virsh.c   |   53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 tools/virsh.pod |   14 +++++++++++---
 2 files changed, 63 insertions(+), 4 deletions(-)

diff --git a/tools/virsh.c b/tools/virsh.c
index e75a249..06eff0e 100644
--- a/tools/virsh.c
+++ b/tools/virsh.c
@@ -1420,6 +1420,7 @@ static const vshCmdInfo info_undefine[] = {
 
 static const vshCmdOptDef opts_undefine[] = {
     {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
+    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
     {NULL, 0, 0, NULL}
 };
 
@@ -1430,6 +1431,16 @@ cmdUndefine(vshControl *ctl, const vshCmd *cmd)
     bool ret = true;
     const char *name = NULL;
     int id;
+    int flags = 0;
+    int managed_save = vshCommandOptBool(cmd, "managed-save");
+    int has_managed_save = 0;
+    int rc = -1;
+
+    if (managed_save)
+        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
+
+    if (!managed_save)
+        flags = -1;
 
     if (!vshConnectionUsability(ctl, ctl->conn))
         return false;
@@ -1447,11 +1458,50 @@ cmdUndefine(vshControl *ctl, const vshCmd *cmd)
         virDomainFree(dom);
         return false;
     }
+
     if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
                                       VSH_BYNAME|VSH_BYUUID)))
         return false;
 
-    if (virDomainUndefine(dom) == 0) {
+    has_managed_save = virDomainHasManagedSaveImage(dom, 0);
+    if (has_managed_save < 0) {
+        virDomainFree(dom);
+        return false;
+    }
+
+    if (flags == -1) {
+        if (has_managed_save == 1) {
+            vshError(ctl,
+                     _("Refusing to undefine while domain managed save "
+                       "image exists"));
+            virDomainFree(dom);
+            return false;
+        }
+
+        rc = virDomainUndefine(dom);
+    } else {
+        rc = virDomainUndefineFlags(dom, flags);
+
+        /* It might fail for virDomainUndefineFlags is not
+         * supported on older libvirt, try to undefine the
+         * domain with combo virDomainManagedSaveRemove and
+         * virDomainUndefine.
+         */
+        if (rc < 0) {
+            virErrorPtr err = virGetLastError();
+            if (err && err->code != VIR_ERR_NO_SUPPORT)
+                goto end;
+
+            if (has_managed_save &&
+                virDomainManagedSaveRemove(dom, 0) < 0)
+                goto end;
+
+            rc = virDomainUndefine(dom);
+        }
+    }
+
+end:
+    if (rc == 0) {
         vshPrint(ctl, _("Domain %s has been undefined\n"), name);
     } else {
         vshError(ctl, _("Failed to undefine domain %s"), name);
@@ -2436,6 +2486,7 @@ cmdDominfo(vshControl *ctl, const vshCmd *cmd)
             VIR_FREE(seclabel);
         }
     }
+
     virDomainFree(dom);
     return ret;
 }
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 2d65cf9..377fac0 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -807,10 +807,18 @@ hypervisor.
 Output the device used for the TTY console of the domain. If the information
 is not available the processes will provide an exit code of 1.
 
-=item B<undefine> I<domain-id>
+=item B<undefine> I<domain-id> optional I<--managed-save>
 
-Undefine the configuration for an inactive domain. Since it's not running
-the domain name or UUID must be used as the I<domain-id>.
+Undefine a domain. If the domain is running, this converts it to a
+transient domain, without stopping it. If the domain is inactive,
+the domain configuration is removed.
+
+The I<--managed-save> flag guarantees that any managed save image(see
+the B<managedsave> command) is also cleaned up.  Without the flag, attempts
+to undefine a domain with managed save image will fail.
+
+NOTE: For an inactive domain, the domain name or UUID must be used as the
+I<domain-id>.
 
 =item B<vcpucount> I<domain-id>  optional I<--maximum> I<--current>
 I<--config> I<--live>
-- 
1.7.6