diff options
Diffstat (limited to 'qapi-schema.json')
| -rw-r--r-- | qapi-schema.json | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/qapi-schema.json b/qapi-schema.json index 2ca7195d25..dfa0e1f47a 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -1755,3 +1755,46 @@ # Since: 0.14.0 ## { 'command': 'device_del', 'data': {'id': 'str'} } + +## +# @dump-guest-memory +# +# Dump guest's memory to vmcore. It is a synchronous operation that can take +# very long depending on the amount of guest memory. This command is only +# supported only on i386 and x86_64 +# +# @paging: if true, do paging to get guest's memory mapping. The @paging's +# default value of @paging is false, If you want to use gdb to process the +# core, please set @paging to true. The reason why the @paging's value is +# false: +# 1. guest machine in a catastrophic state can have corrupted memory, +# which we cannot trust. +# 2. The guest machine can be in read-mode even if paging is enabled. +# For example: the guest machine uses ACPI to sleep, and ACPI sleep +# state goes in real-mode +# @protocol: the filename or file descriptor of the vmcore. The supported +# protocol can be file or fd: +# 1. file: the protocol starts with "file:", and the following string is +# the file's path. +# 2. fd: the protocol starts with "fd:", and the following string is the +# fd's name. +# @begin: #optional if specified, the starting physical address. +# @length: #optional if specified, the memory size, in bytes. If you don't +# want to dump all guest's memory, please specify the start @begin and +# @length +# +# Returns: nothing on success +# If @begin contains an invalid address, InvalidParameter +# If only one of @begin and @length is specified, MissingParameter +# If @protocol stats with "fd:", and the fd cannot be found, FdNotFound +# If @protocol starts with "file:", and the file cannot be +# opened, OpenFileFailed +# If @protocol does not start with "fd:" or "file:", InvalidParameter +# If an I/O error occurs while writing the file, IOError +# If the target does not support this command, Unsupported +# +# Since: 1.2 +## +{ 'command': 'dump-guest-memory', + 'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int', + '*length': 'int' } } |