virsh: common code for parsing --seconds

Several virsh commands ask for a --timeout parameter in
seconds, then use it to control interfaces that operate on
millisecond limits; I also plan on adding a 'virsh event'
command that also does this.  Factor this into a common
function.

* tools/virsh.h (vshCommandOptTimeoutToMs): New prototype.
* tools/virsh.c (vshCommandOptTimeoutToMs): New function.
* tools/virsh-domain.c (cmdBlockCommit, cmdBlockCopy)
(cmdBlockPull, cmdMigrate): Use it.
(vshWatchJob): Adjust timeout scale.

Signed-off-by: Eric Blake <eblake@redhat.com>

diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index fa9448ecfd5374a9213000402aefa94dbb994433..03bbaabd0c5796c8d490d75c91cc4f597e607429 100644 (file)
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -1,7 +1,7 @@
 /*
  * virsh-domain.c: Commands to manage domain
  *
- * Copyright (C) 2005, 2007-2013 Red Hat, Inc.
+ * Copyright (C) 2005, 2007-2014 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -1629,21 +1629,10 @@ cmdBlockCommit(vshControl *ctl, const vshCmd *cmd)
     const char *path = NULL;
     bool quit = false;
     int abort_flags = 0;
-    int rv;
 
     if (blocking) {
-        if ((rv = vshCommandOptInt(cmd, "timeout", &timeout)) < 0 ||
-            (rv > 0 && timeout < 1)) {
-            vshError(ctl, "%s", _("invalid timeout"));
+        if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
             return false;
-        } else if (rv > 0) {
-            /* Ensure that we can multiply by 1000 without overflowing. */
-            if (timeout > INT_MAX / 1000) {
-                vshError(ctl, "%s", _("timeout is too big"));
-                return false;
-            }
-            timeout *= 1000;
-        }
         if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
             return false;
         if (vshCommandOptBool(cmd, "async"))
@@ -1819,25 +1808,14 @@ cmdBlockCopy(vshControl *ctl, const vshCmd *cmd)
     const char *path = NULL;
     bool quit = false;
     int abort_flags = 0;
-    int rv;
 
     if (blocking) {
         if (pivot && finish) {
             vshError(ctl, "%s", _("cannot mix --pivot and --finish"));
             return false;
         }
-        if ((rv = vshCommandOptInt(cmd, "timeout", &timeout)) < 0 ||
-            (rv > 0 && timeout < 1)) {
-            vshError(ctl, "%s", _("invalid timeout"));
+        if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
             return false;
-        } else if (rv > 0) {
-            /* Ensure that we can multiply by 1000 without overflowing. */
-            if (timeout > INT_MAX / 1000) {
-                vshError(ctl, "%s", _("timeout is too big"));
-                return false;
-            }
-            timeout *= 1000;
-        }
         if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
             return false;
         if (vshCommandOptBool(cmd, "async"))
@@ -2100,21 +2078,10 @@ cmdBlockPull(vshControl *ctl, const vshCmd *cmd)
     const char *path = NULL;
     bool quit = false;
     int abort_flags = 0;
-    int rv;
 
     if (blocking) {
-        if ((rv = vshCommandOptInt(cmd, "timeout", &timeout)) < 0 ||
-            (rv > 0 && timeout < 1)) {
-            vshError(ctl, "%s", _("invalid timeout"));
+        if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0)
             return false;
-        } else if (rv > 0) {
-            /* Ensure that we can multiply by 1000 without overflowing. */
-            if (timeout > INT_MAX / 1000) {
-                vshError(ctl, "%s", _("timeout is too big"));
-                return false;
-            }
-            timeout *= 1000;
-        }
         if (vshCommandOptStringReq(ctl, cmd, "path", &path) < 0)
             return false;
         if (vshCommandOptBool(cmd, "async"))
@@ -3605,7 +3572,7 @@ vshWatchJob(vshControl *ctl,
             virDomainPtr dom,
             bool verbose,
             int pipe_fd,
-            int timeout,
+            int timeout_ms,
             jobWatchTimeoutFunc timeout_func,
             void *opaque,
             const char *label)
@@ -3675,14 +3642,14 @@ vshWatchJob(vshControl *ctl,
         }
 
         GETTIMEOFDAY(&curr);
-        if (timeout && (((int)(curr.tv_sec - start.tv_sec)  * 1000 +
-                         (int)(curr.tv_usec - start.tv_usec) / 1000) >
-                        timeout * 1000)) {
+        if (timeout_ms && (((int)(curr.tv_sec - start.tv_sec)  * 1000 +
+                            (int)(curr.tv_usec - start.tv_usec) / 1000) >
+                           timeout_ms)) {
             /* suspend the domain when migration timeouts. */
             vshDebug(ctl, VSH_ERR_DEBUG, "%s timeout", label);
             if (timeout_func)
                 (timeout_func)(ctl, dom, opaque);
-            timeout = 0;
+            timeout_ms = 0;
         }
 
         if (verbose || !jobStarted) {
@@ -8843,7 +8810,6 @@ cmdMigrate(vshControl *ctl, const vshCmd *cmd)
     int timeout = 0;
     bool live_flag = false;
     vshCtrlData data;
-    int rv;
 
     if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
         return false;
@@ -8853,22 +8819,12 @@ cmdMigrate(vshControl *ctl, const vshCmd *cmd)
 
     if (vshCommandOptBool(cmd, "live"))
         live_flag = true;
-    if ((rv = vshCommandOptInt(cmd, "timeout", &timeout)) < 0 ||
-        (rv > 0 && timeout < 1)) {
-        vshError(ctl, "%s", _("migrate: Invalid timeout"));
+    if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0) {
+        goto cleanup;
+    } else if (timeout > 0 && !live_flag) {
+        vshError(ctl, "%s",
+                 _("migrate: Unexpected timeout for offline migration"));
         goto cleanup;
-    } else if (rv > 0) {
-        if (! live_flag) {
-            vshError(ctl, "%s",
-                     _("migrate: Unexpected timeout for offline migration"));
-            goto cleanup;
-        }
-
-        /* Ensure that we can multiply by 1000 without overflowing. */
-        if (timeout > INT_MAX / 1000) {
-            vshError(ctl, "%s", _("migrate: Timeout is too big"));
-            goto cleanup;
-        }
     }
 
     if (pipe(p) < 0)

diff --git a/tools/virsh.c b/tools/virsh.c
index 9d07d3e223b133be05b653b83bd3faccd982724a..944c03740252a4a2ea67899e3b9769e2157f10b1 100644 (file)
--- a/tools/virsh.c
+++ b/tools/virsh.c
@@ -1,7 +1,7 @@
 /*
  * virsh.c: a shell to exercise the libvirt API
  *
- * Copyright (C) 2005, 2007-2013 Red Hat, Inc.
+ * Copyright (C) 2005, 2007-2014 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -1721,6 +1721,30 @@ vshCmdHasOption(vshControl *ctl, const vshCmd *cmd, const char *optname)
     return found;
 }
 
+/* Parse an optional --timeout parameter in seconds, but store the
+ * value of the timeout in milliseconds.  Return -1 on error, 0 if
+ * no timeout was requested, and 1 if timeout was set.  */
+int
+vshCommandOptTimeoutToMs(vshControl *ctl, const vshCmd *cmd, int *timeout)
+{
+    int rv = vshCommandOptInt(cmd, "timeout", timeout);
+
+    if (rv < 0 || (rv > 0 && *timeout < 1)) {
+        vshError(ctl, "%s", _("invalid timeout"));
+        return -1;
+    }
+    if (rv > 0) {
+        /* Ensure that we can multiply by 1000 without overflowing. */
+        if (*timeout > INT_MAX / 1000) {
+            vshError(ctl, "%s", _("timeout is too big"));
+            return -1;
+        }
+        *timeout *= 1000;
+    }
+    return rv;
+}
+
+
 static bool
 vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
 {

diff --git a/tools/virsh.h b/tools/virsh.h
index b84378806148a9b83da4d435ac322ea3dd36d911..4ee2d720bdcaaff51d68ff86a545fc693186290f 100644 (file)
--- a/tools/virsh.h
+++ b/tools/virsh.h
@@ -1,7 +1,7 @@
 /*
  * virsh.h: a shell to exercise the libvirt API
  *
- * Copyright (C) 2005, 2007-2013 Red Hat, Inc.
+ * Copyright (C) 2005, 2007-2014 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -302,6 +302,8 @@ const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                    const vshCmdOpt *opt);
 bool vshCmdHasOption(vshControl *ctl, const vshCmd *cmd, const char *optname);
 
+int vshCommandOptTimeoutToMs(vshControl *ctl, const vshCmd *cmd, int *timeout);
+
 /* Filter flags for various vshCommandOpt*By() functions */
 typedef enum {
     VSH_BYID   = (1 << 1),