qemu/qapi/dump.json

1 # -*- Mode: Python -*-
5 # See the COPYING file in the top-level directory.
9 # Dump guest memory
16 # An enumeration of guest-memory-dump's format.
20 # @kdump-zlib: makedumpfile flattened, kdump-compressed format with
23 # @kdump-lzo: makedumpfile flattened, kdump-compressed format with lzo
26 # @kdump-snappy: makedumpfile flattened, kdump-compressed format with
29 # @kdump-raw-zlib: raw assembled kdump-compressed format with zlib
32 # @kdump-raw-lzo: raw assembled kdump-compressed format with lzo
35 # @kdump-raw-snappy: raw assembled kdump-compressed format with snappy
38 # @win-dmp: Windows full crashdump format, can be used instead of ELF
46       'kdump-zlib', 'kdump-lzo', 'kdump-snappy',
47       'kdump-raw-zlib', 'kdump-raw-lzo', 'kdump-raw-snappy',
48       'win-dmp' ] }
51 # @dump-guest-memory:
53 # Dump guest's memory to vmcore.  It is a synchronous operation that
57 #     allows using gdb to process the core file.
67 #     2. The guest can be in real-mode even if paging is enabled.  For
69 #        goes in real-mode
81 #     for the dump to finish.  The user can track progress using
82 #     `query-dump`.  (since 2.6).
87 #     to dump all guest's memory, please specify the start @begin and
90 # @format: if specified, the format of guest memory dump.  But non-elf
92 #     and @length is not allowed to be specified with non-elf @format
99 # .. qmp-example::
101 #     -> { "execute": "dump-guest-memory",
102 #          "arguments": { "paging": false, "protocol": "fd:dump" } }
103 #     <- { "return": {} }
105 { 'command': 'dump-guest-memory',
113 # Describe the status of a long-running background guest memory dump.
115 # @none: no `dump-guest-memory` has started yet.
117 # @active: there is one dump running in background.
119 # @completed: the last dump has finished successfully.
121 # @failed: the last dump has failed.
131 # The result format for `query-dump`.
133 # @status: enum of `DumpStatus`, which shows current dump status
135 # @completed: bytes written in latest dump (uncompressed)
137 # @total: total bytes to be written in latest dump (uncompressed)
147 # @query-dump:
149 # Query latest dump status.
151 # Returns: An object showing the dump status.
155 # .. qmp-example::
157 #     -> { "execute": "query-dump" }
158 #     <- { "return": { "status": "active", "completed": 1024000,
161 { 'command': 'query-dump', 'returns': 'DumpQueryResult' }
166 # Emitted when background dump has completed
168 # @result: final dump status
170 # @error: human-readable error string that provides hint on why dump
176 # .. qmp-example::
178 #     <- { "event": "DUMP_COMPLETED",
189 # @formats: the available formats for `dump-guest-memory`
198 # @query-dump-guest-memory-capability:
200 # Return the available formats for `dump-guest-memory`
202 # Returns: An object listing available formats for `dump-guest-memory`
206 # .. qmp-example::
208 #     -> { "execute": "query-dump-guest-memory-capability" }
209 #     <- { "return": { "formats":
210 #                      ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] } }
212 { 'command': 'query-dump-guest-memory-capability',