qemu/qapi/run-state.json

1 # -*- Mode: Python -*-
16 # @finish-migrate: guest is paused to finish the migration process
20 #     the end of the migration.  This depends on the command-line -S
24 # @internal-error: An internal error that prevents further guest
27 # @io-error: the last IOP has failed and the device is configured to
34 # @prelaunch: QEMU was started with -S and guest has not started
36 # @restore-vm: guest is paused to restore VM state
40 # @save-vm: guest is paused to save the VM state
42 # @shutdown: guest is shut down (and -no-shutdown is in use)
49 # @guest-panicked: guest has been panicked as a result of guest OS
56 { 'enum': 'RunState',
57   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
58             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
59             'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
60             'guest-panicked', 'colo' ] }
69 # @host-error: An error prevents further use of guest
71 # @host-qmp-quit: Reaction to the QMP command 'quit'
73 # @host-qmp-system-reset: Reaction to the QMP command 'system_reset'
75 # @host-signal: Reaction to a signal, such as SIGINT
77 # @host-ui: Reaction to a UI event, like window close
79 # @guest-shutdown: Guest shutdown/suspend request, via ACPI or other
80 #     hardware-specific means
82 # @guest-reset: Guest reset request, and command line turns that into
85 # @guest-panic: Guest panicked, and command line turns that into a
88 # @subsystem-reset: Partial guest reset that does not trigger QMP
89 #     events and ignores --no-reboot.  This is useful for sanitizing
92 # @snapshot-load: A snapshot is being loaded by the record & replay
96 { 'enum': 'ShutdownCause',
98   'data': [ 'none', 'host-error', 'host-qmp-quit', 'host-qmp-system-reset',
99             'host-signal', 'host-ui', 'guest-shutdown', 'guest-reset',
100             'guest-panic', 'subsystem-reset', 'snapshot-load'] }
118 # @query-status:
126 # .. qmp-example::
128 #     -> { "execute": "query-status" }
129 #     <- { "return": { "running": true,
132 { 'command': 'query-status', 'returns': 'StatusInfo',
133   'allow-preconfig': true }
142 #     as a guest-initiated ACPI shutdown request or other
143 #     hardware-specific action) rather than a host request (such as
149 # .. note:: If the command-line option ``-no-shutdown`` has been
155 # .. qmp-example::
157 #     <- { "event": "SHUTDOWN",
158 #          "data": { "guest": true, "reason": "guest-shutdown" },
167 # control system, such as via ACPI.
171 # .. qmp-example::
173 #     <- { "event": "POWERDOWN",
183 # @guest: If true, the reset was triggered by a guest request (such as
184 #     a guest-initiated ACPI reboot request or other hardware-specific
185 #     action) rather than a host request (such as the QMP command
192 # .. qmp-example::
194 #     <- { "event": "RESET",
195 #          "data": { "guest": false, "reason": "guest-reset" },
207 # .. qmp-example::
209 #     <- { "event": "STOP",
221 # .. qmp-example::
223 #     <- { "event": "RESUME",
236 # .. qmp-example::
238 #     <- { "event": "SUSPEND",
255 # .. qmp-example::
257 #     <- { "event": "SUSPEND_DISK",
270 # .. qmp-example::
272 #     <- { "event": "WAKEUP",
288 # .. note:: This event is rate-limited.
292 # .. qmp-example::
294 #     <- { "event": "WATCHDOG",
320 # @inject-nmi: a non-maskable interrupt is injected into the first
325 { 'enum': 'WatchdogAction',
327             'inject-nmi' ] }
341 { 'enum': 'RebootAction',
355 { 'enum': 'ShutdownAction',
368 # @exit-failure: Shutdown the VM and exit with nonzero status
373 { 'enum': 'PanicAction',
374   'data': [ 'pause', 'shutdown', 'exit-failure', 'none' ] }
377 # @watchdog-set-action:
385 # .. qmp-example::
387 #     -> { "execute": "watchdog-set-action",
388 #          "arguments": { "action": "inject-nmi" } }
389 #     <- { "return": {} }
391 { 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} }
394 # @set-action:
409 # .. qmp-example::
411 #     -> { "execute": "set-action",
415 #                         "watchdog": "inject-nmi" } }
416 #     <- { "return": {} }
418 { 'command': 'set-action',
423   'allow-preconfig': true }
436 # .. qmp-example::
438 #     <- { "event": "GUEST_PANICKED",
456 # .. qmp-example::
458 #     <- { "event": "GUEST_CRASHLOADED",
472 # .. qmp-example::
474 #     <- { "event": "GUEST_PVSHUTDOWN",
492 { 'enum': 'GuestPanicAction',
500 # @hyper-v: hyper-v guest panic information type
508 { 'enum': 'GuestPanicInformationType',
509   'data': [ 'hyper-v', 's390', 'tdx' ] }
523  'data': {'hyper-v': 'GuestPanicInformationHyperV',
530 # Hyper-V specific guest panic information (HV crash MSRs)
536 #     guest OS ID, which has the kernel version in bits 16-47 and
537 #     0x8100 in bits 48-63.
564 # @disabled-wait: the CPU has entered a disabled wait state
566 # @extint-loop: clock comparator or cpu timer interrupt with new PSW
569 # @pgmint-loop: program interrupt with BAD new PSW
571 # @opint-loop: operation exception interrupt with invalid code at the
576 { 'enum': 'S390CrashReason',
578             'disabled-wait',
579             'extint-loop',
580             'pgmint-loop',
581             'opint-loop' ] }
590 # @psw-mask: control fields of guest PSW
592 # @psw-addr: guest instruction address
600           'psw-mask': 'uint64',
601           'psw-addr': 'uint64',
607 # TDX Guest panic information specific to TDX, as specified in the
608 # "Guest-Hypervisor Communication Interface (GHCI) Specification",
611 # @error-code: TD-specific error code
613 # @message: Human-readable error message provided by the guest. Not
616 # @gpa: guest-physical address of a page that contains more verbose
617 #     error information, as zero-terminated string.  Present when the
618 #     "GPA valid" bit (bit 63) is set in @error-code.
624  'data': {'error-code': 'uint32',
633 # @recipient: recipient is defined as @MemoryFailureRecipient.
637 # @flags: flags for MemoryFailureAction.
641 # .. qmp-example::
643 #     <- { "event": "MEMORY_FAILURE",
646 #                    "flags": { "action-required": false,
653             'flags': 'MemoryFailureFlags'} }
667 { 'enum': 'MemoryFailureRecipient',
677 #     case for action-optional failures.
684 #     action-required failures if the recipient is the hypervisor;
693 { 'enum': 'MemoryFailureAction',
704 # @action-required: whether a memory failure event is action-required
705 #     or action-optional (e.g. a failure during memory scrub).
713   'data': { 'action-required': 'bool',
724 # @internal-error: enable the feature, raise a internal error if the
731 { 'enum': 'NotifyVmexitOption',
732   'data': [ 'run', 'internal-error', 'disable' ] }