aboutsummaryrefslogtreecommitdiff
path: root/qapi-schema.json
diff options
context:
space:
mode:
authorPeter Xu <peterx@redhat.com>2016-02-18 13:16:54 +0800
committerPaolo Bonzini <pbonzini@redhat.com>2016-02-22 18:40:28 +0100
commit39ba2ea61f510512764e6f9063a8396d05fe57fe (patch)
tree1f8243bc6934d82a8faa75e6eed2d24448c026e1 /qapi-schema.json
parent2264c2c96e0a1f0913412da73e9bcaf9f8fa4427 (diff)
downloadqemu-39ba2ea61f510512764e6f9063a8396d05fe57fe.zip
qemu-39ba2ea61f510512764e6f9063a8396d05fe57fe.tar.gz
qemu-39ba2ea61f510512764e6f9063a8396d05fe57fe.tar.bz2
Dump: add qmp command "query-dump"
When dump-guest-memory is requested with detach flag, after its return, user could query its status using "query-dump" command (with no argument). The result contains: - status: current dump status - completed: bytes written in the latest dump - total: bytes to write in the latest dump From completed and total, we could know how much work finished by calculating: 100.0 * completed / total (%) Reviewed-by: Fam Zheng <famz@redhat.com> Signed-off-by: Peter Xu <peterx@redhat.com> Message-Id: <1455772616-8668-10-git-send-email-peterx@redhat.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'qapi-schema.json')
-rw-r--r--qapi-schema.json32
1 files changed, 31 insertions, 1 deletions
diff --git a/qapi-schema.json b/qapi-schema.json
index ccd30c8..7b8f2a1 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -2196,7 +2196,8 @@
# is the fd's name.
#
# @detach: #optional if true, QMP will return immediately rather than
-# waiting for the dump to finish. (since 2.6).
+# waiting for the dump to finish. The user can track progress
+# using "query-dump". (since 2.6).
#
# @begin: #optional if specified, the starting physical address.
#
@@ -2237,6 +2238,35 @@
'data': [ 'none', 'active', 'completed', 'failed' ] }
##
+# @DumpQueryResult
+#
+# The result format for 'query-dump'.
+#
+# @status: enum of @DumpStatus, which shows current dump status
+#
+# @completed: bytes written in latest dump (uncompressed)
+#
+# @total: total bytes to be written in latest dump (uncompressed)
+#
+# Since 2.6
+##
+{ 'struct': 'DumpQueryResult',
+ 'data': { 'status': 'DumpStatus',
+ 'completed': 'int',
+ 'total': 'int' } }
+
+##
+# @query-dump
+#
+# Query latest dump status.
+#
+# Returns: A @DumpStatus object showing the dump status.
+#
+# Since: 2.6
+##
+{ 'command': 'query-dump', 'returns': 'DumpQueryResult' }
+
+##
# @DumpGuestMemoryCapability:
#
# A list of the available formats for dump-guest-memory