Patchwork [RFC,13/14,v9] support to query dumping status

login
register
mail settings
Submitter Wen Congyang
Date March 14, 2012, 2:13 a.m.
Message ID <4F5FFEBB.1000503@cn.fujitsu.com>
Download mbox | patch
Permalink /patch/146532/
State New
Headers show

Comments

Wen Congyang - March 14, 2012, 2:13 a.m.
Add API to allow the user to query dumping status. It can only work after
async dumping is supported.

Signed-off-by: Wen Congyang <wency@cn.fujitsu.com>
---
 dump.c           |   32 ++++++++++++++++++++++++++++++++
 hmp-commands.hx  |    2 ++
 hmp.c            |   17 +++++++++++++++++
 hmp.h            |    1 +
 monitor.c        |    7 +++++++
 qapi-schema.json |   27 +++++++++++++++++++++++++++
 qmp-commands.hx  |   50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 136 insertions(+), 0 deletions(-)
Luiz Capitulino - March 14, 2012, 5:19 p.m.
On Wed, 14 Mar 2012 10:13:15 +0800
Wen Congyang <wency@cn.fujitsu.com> wrote:

> Add API to allow the user to query dumping status. It can only work after
> async dumping is supported.

NACK, we shouldn't add it then.

> 
> Signed-off-by: Wen Congyang <wency@cn.fujitsu.com>
> ---
>  dump.c           |   32 ++++++++++++++++++++++++++++++++
>  hmp-commands.hx  |    2 ++
>  hmp.c            |   17 +++++++++++++++++
>  hmp.h            |    1 +
>  monitor.c        |    7 +++++++
>  qapi-schema.json |   27 +++++++++++++++++++++++++++
>  qmp-commands.hx  |   50 ++++++++++++++++++++++++++++++++++++++++++++++++++
>  7 files changed, 136 insertions(+), 0 deletions(-)
> 
> diff --git a/dump.c b/dump.c
> index dab0c84..7f9ea09 100644
> --- a/dump.c
> +++ b/dump.c
> @@ -724,3 +724,35 @@ void qmp_dump_cancel(Error **errp)
>      s->state = DUMP_STATE_CANCELLED;
>      dump_cleanup(s);
>  }
> +
> +DumpInfo *qmp_query_dump(Error **errp)
> +{
> +    DumpInfo *info = g_malloc0(sizeof(*info));
> +    DumpState *s = dump_get_current();
> +
> +    switch (s->state) {
> +    case DUMP_STATE_SETUP:
> +        /* no dumping has happened ever */
> +        break;
> +    case DUMP_STATE_ACTIVE:
> +        info->has_status = true;
> +        info->status = g_strdup("active");
> +        break;
> +    case DUMP_STATE_COMPLETED:
> +        info->has_status = true;
> +        info->status = g_strdup("completed");
> +        break;
> +    case DUMP_STATE_ERROR:
> +        info->has_status = true;
> +        info->status = g_strdup("failed");
> +        info->has_error = true;
> +        info->error = g_strdup(s->error);
> +        break;
> +    case DUMP_STATE_CANCELLED:
> +        info->has_status = true;
> +        info->status = g_strdup("cancelled");
> +        break;
> +    }
> +
> +    return info;
> +}
> diff --git a/hmp-commands.hx b/hmp-commands.hx
> index 313f876..abd412e 100644
> --- a/hmp-commands.hx
> +++ b/hmp-commands.hx
> @@ -1438,6 +1438,8 @@ show device tree
>  show qdev device model list
>  @item info roms
>  show roms
> +@item info dump
> +show dumping status
>  @end table
>  ETEXI
>  
> diff --git a/hmp.c b/hmp.c
> index 31e85d3..d0aa94b 100644
> --- a/hmp.c
> +++ b/hmp.c
> @@ -875,3 +875,20 @@ void hmp_dump_cancel(Monitor *mon, const QDict *qdict)
>  {
>      qmp_dump_cancel(NULL);
>  }
> +
> +void hmp_info_dump(Monitor *mon)
> +{
> +    DumpInfo *info;
> +
> +    info = qmp_query_dump(NULL);
> +
> +    if (info->has_status) {
> +        monitor_printf(mon, "Dumping status: %s\n", info->status);
> +    }
> +
> +    if (info->has_error) {
> +        monitor_printf(mon, "Dumping failed reason: %s\n", info->error);
> +    }
> +
> +    qapi_free_DumpInfo(info);
> +}
> diff --git a/hmp.h b/hmp.h
> index 75c6c1d..3d105a9 100644
> --- a/hmp.h
> +++ b/hmp.h
> @@ -61,5 +61,6 @@ void hmp_block_job_set_speed(Monitor *mon, const QDict *qdict);
>  void hmp_block_job_cancel(Monitor *mon, const QDict *qdict);
>  void hmp_dump(Monitor *mon, const QDict *qdict);
>  void hmp_dump_cancel(Monitor *mon, const QDict *qdict);
> +void hmp_info_dump(Monitor *mon);
>  
>  #endif
> diff --git a/monitor.c b/monitor.c
> index fe54b7c..8348637 100644
> --- a/monitor.c
> +++ b/monitor.c
> @@ -2603,6 +2603,13 @@ static mon_cmd_t info_cmds[] = {
>          .mhandler.info = do_trace_print_events,
>      },
>      {
> +        .name       = "dump",
> +        .args_type  = "",
> +        .params     = "",
> +        .help       = "show dumping status",
> +        .mhandler.info = hmp_info_dump,
> +    },
> +    {
>          .name       = NULL,
>      },
>  };
> diff --git a/qapi-schema.json b/qapi-schema.json
> index 1fdfee8..9728f5f 100644
> --- a/qapi-schema.json
> +++ b/qapi-schema.json
> @@ -1690,3 +1690,30 @@
>  # Since: 1.1
>  ##
>  { 'command': 'dump_cancel' }
> +
> +##
> +# @DumpInfo
> +#
> +# Information about current dumping process.
> +#
> +# @status: #optional string describing the current dumping status.
> +#          As of 1,1 this can be 'active', 'completed', 'failed' or
> +#          'cancelled'. If this field is not returned, no dumping process
> +#          has been initiated
> +# @error: #optional string describing the current dumping failed reason.
> +#
> +# Since: 1.1
> +##
> +{ 'type': 'DumpInfo',
> +  'data': { '*status': 'str', '*error': 'str' } }
> +
> +##
> +# @query-dump
> +#
> +# Returns information about current dumping process.
> +#
> +# Returns: @DumpInfo
> +#
> +# Since: 1.1
> +##
> +{ 'command': 'query-dump', 'returns': 'DumpInfo' }
> diff --git a/qmp-commands.hx b/qmp-commands.hx
> index cbe5b91..036e111 100644
> --- a/qmp-commands.hx
> +++ b/qmp-commands.hx
> @@ -616,6 +616,8 @@ Example:
>  Notes:
>  
>  (1) All boolean arguments default to false
> +(2) The 'info dump' command should be used to check dumping's progress
> +    and final result (this information is provided by the 'status' member)
>  
>  EQMP
>  #endif
> @@ -2106,6 +2108,54 @@ EQMP
>      },
>  
>  SQMP
> +query-dump
> +-------------
> +
> +Dumping status.
> +
> +Return a json-object.
> +
> +The main json-object contains the following:
> +
> +- "status": dumping status (json-string)
> +     - Possible values: "active", "completed", "failed", "cancelled"
> +
> +Examples:
> +
> +1. Before the first dumping
> +
> +-> { "execute": "query-dump" }
> +<- { "return": {} }
> +
> +2. Dumping is done and has succeeded
> +
> +-> { "execute": "query-dump" }
> +<- { "return": { "status": "completed" } }
> +
> +3. Dumping is done and has failed
> +
> +-> { "execute": "query-dump" }
> +<- { "return": { "status": "failed",
> +                 "error": "dump: failed to save memory." } }
> +
> +4. Dumping is being performed:
> +
> +-> { "execute": "query-dump" }
> +<- {
> +      "return":{
> +         "status":"active",
> +      }
> +   }
> +
> +EQMP
> +
> +    {
> +        .name       = "query-dump",
> +        .args_type  = "",
> +        .mhandler.cmd_new = qmp_marshal_input_query_dump,
> +    },
> +
> +SQMP
>  query-balloon
>  -------------
>

Patch

diff --git a/dump.c b/dump.c
index dab0c84..7f9ea09 100644
--- a/dump.c
+++ b/dump.c
@@ -724,3 +724,35 @@  void qmp_dump_cancel(Error **errp)
     s->state = DUMP_STATE_CANCELLED;
     dump_cleanup(s);
 }
+
+DumpInfo *qmp_query_dump(Error **errp)
+{
+    DumpInfo *info = g_malloc0(sizeof(*info));
+    DumpState *s = dump_get_current();
+
+    switch (s->state) {
+    case DUMP_STATE_SETUP:
+        /* no dumping has happened ever */
+        break;
+    case DUMP_STATE_ACTIVE:
+        info->has_status = true;
+        info->status = g_strdup("active");
+        break;
+    case DUMP_STATE_COMPLETED:
+        info->has_status = true;
+        info->status = g_strdup("completed");
+        break;
+    case DUMP_STATE_ERROR:
+        info->has_status = true;
+        info->status = g_strdup("failed");
+        info->has_error = true;
+        info->error = g_strdup(s->error);
+        break;
+    case DUMP_STATE_CANCELLED:
+        info->has_status = true;
+        info->status = g_strdup("cancelled");
+        break;
+    }
+
+    return info;
+}
diff --git a/hmp-commands.hx b/hmp-commands.hx
index 313f876..abd412e 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -1438,6 +1438,8 @@  show device tree
 show qdev device model list
 @item info roms
 show roms
+@item info dump
+show dumping status
 @end table
 ETEXI
 
diff --git a/hmp.c b/hmp.c
index 31e85d3..d0aa94b 100644
--- a/hmp.c
+++ b/hmp.c
@@ -875,3 +875,20 @@  void hmp_dump_cancel(Monitor *mon, const QDict *qdict)
 {
     qmp_dump_cancel(NULL);
 }
+
+void hmp_info_dump(Monitor *mon)
+{
+    DumpInfo *info;
+
+    info = qmp_query_dump(NULL);
+
+    if (info->has_status) {
+        monitor_printf(mon, "Dumping status: %s\n", info->status);
+    }
+
+    if (info->has_error) {
+        monitor_printf(mon, "Dumping failed reason: %s\n", info->error);
+    }
+
+    qapi_free_DumpInfo(info);
+}
diff --git a/hmp.h b/hmp.h
index 75c6c1d..3d105a9 100644
--- a/hmp.h
+++ b/hmp.h
@@ -61,5 +61,6 @@  void hmp_block_job_set_speed(Monitor *mon, const QDict *qdict);
 void hmp_block_job_cancel(Monitor *mon, const QDict *qdict);
 void hmp_dump(Monitor *mon, const QDict *qdict);
 void hmp_dump_cancel(Monitor *mon, const QDict *qdict);
+void hmp_info_dump(Monitor *mon);
 
 #endif
diff --git a/monitor.c b/monitor.c
index fe54b7c..8348637 100644
--- a/monitor.c
+++ b/monitor.c
@@ -2603,6 +2603,13 @@  static mon_cmd_t info_cmds[] = {
         .mhandler.info = do_trace_print_events,
     },
     {
+        .name       = "dump",
+        .args_type  = "",
+        .params     = "",
+        .help       = "show dumping status",
+        .mhandler.info = hmp_info_dump,
+    },
+    {
         .name       = NULL,
     },
 };
diff --git a/qapi-schema.json b/qapi-schema.json
index 1fdfee8..9728f5f 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -1690,3 +1690,30 @@ 
 # Since: 1.1
 ##
 { 'command': 'dump_cancel' }
+
+##
+# @DumpInfo
+#
+# Information about current dumping process.
+#
+# @status: #optional string describing the current dumping status.
+#          As of 1,1 this can be 'active', 'completed', 'failed' or
+#          'cancelled'. If this field is not returned, no dumping process
+#          has been initiated
+# @error: #optional string describing the current dumping failed reason.
+#
+# Since: 1.1
+##
+{ 'type': 'DumpInfo',
+  'data': { '*status': 'str', '*error': 'str' } }
+
+##
+# @query-dump
+#
+# Returns information about current dumping process.
+#
+# Returns: @DumpInfo
+#
+# Since: 1.1
+##
+{ 'command': 'query-dump', 'returns': 'DumpInfo' }
diff --git a/qmp-commands.hx b/qmp-commands.hx
index cbe5b91..036e111 100644
--- a/qmp-commands.hx
+++ b/qmp-commands.hx
@@ -616,6 +616,8 @@  Example:
 Notes:
 
 (1) All boolean arguments default to false
+(2) The 'info dump' command should be used to check dumping's progress
+    and final result (this information is provided by the 'status' member)
 
 EQMP
 #endif
@@ -2106,6 +2108,54 @@  EQMP
     },
 
 SQMP
+query-dump
+-------------
+
+Dumping status.
+
+Return a json-object.
+
+The main json-object contains the following:
+
+- "status": dumping status (json-string)
+     - Possible values: "active", "completed", "failed", "cancelled"
+
+Examples:
+
+1. Before the first dumping
+
+-> { "execute": "query-dump" }
+<- { "return": {} }
+
+2. Dumping is done and has succeeded
+
+-> { "execute": "query-dump" }
+<- { "return": { "status": "completed" } }
+
+3. Dumping is done and has failed
+
+-> { "execute": "query-dump" }
+<- { "return": { "status": "failed",
+                 "error": "dump: failed to save memory." } }
+
+4. Dumping is being performed:
+
+-> { "execute": "query-dump" }
+<- {
+      "return":{
+         "status":"active",
+      }
+   }
+
+EQMP
+
+    {
+        .name       = "query-dump",
+        .args_type  = "",
+        .mhandler.cmd_new = qmp_marshal_input_query_dump,
+    },
+
+SQMP
 query-balloon
 -------------