Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 1 | # -*- Mode: Python -*- |
Andrea Bolognani | f7160f3 | 2020-07-29 20:50:24 +0200 | [diff] [blame] | 2 | # vim: filetype=python |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 3 | # |
| 4 | |
| 5 | ## |
| 6 | # = VM run state |
| 7 | ## |
| 8 | |
| 9 | ## |
| 10 | # @RunState: |
| 11 | # |
| 12 | # An enumeration of VM run states. |
| 13 | # |
| 14 | # @debug: QEMU is running on a debugger |
| 15 | # |
| 16 | # @finish-migrate: guest is paused to finish the migration process |
| 17 | # |
| 18 | # @inmigrate: guest is paused waiting for an incoming migration. Note |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 19 | # that this state does not tell whether the machine will start at |
| 20 | # the end of the migration. This depends on the command-line -S |
| 21 | # option and any invocation of 'stop' or 'cont' that has happened |
| 22 | # since QEMU was started. |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 23 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 24 | # @internal-error: An internal error that prevents further guest |
| 25 | # execution has occurred |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 26 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 27 | # @io-error: the last IOP has failed and the device is configured to |
| 28 | # pause on I/O errors |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 29 | # |
| 30 | # @paused: guest has been paused via the 'stop' command |
| 31 | # |
| 32 | # @postmigrate: guest is paused following a successful 'migrate' |
| 33 | # |
| 34 | # @prelaunch: QEMU was started with -S and guest has not started |
| 35 | # |
| 36 | # @restore-vm: guest is paused to restore VM state |
| 37 | # |
| 38 | # @running: guest is actively running |
| 39 | # |
| 40 | # @save-vm: guest is paused to save the VM state |
| 41 | # |
| 42 | # @shutdown: guest is shut down (and -no-shutdown is in use) |
| 43 | # |
| 44 | # @suspended: guest is suspended (ACPI S3) |
| 45 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 46 | # @watchdog: the watchdog action is configured to pause and has been |
| 47 | # triggered |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 48 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 49 | # @guest-panicked: guest has been panicked as a result of guest OS |
| 50 | # panic |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 51 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 52 | # @colo: guest is paused to save/restore VM state under colo |
| 53 | # checkpoint, VM can not get into this state unless colo |
| 54 | # capability is enabled for migration. (since 2.8) |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 55 | ## |
| 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', |
Paolo Bonzini | 164dafd | 2020-10-27 04:44:18 -0400 | [diff] [blame] | 60 | 'guest-panicked', 'colo' ] } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 61 | |
| 62 | ## |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 63 | # @ShutdownCause: |
| 64 | # |
| 65 | # An enumeration of reasons for a Shutdown. |
| 66 | # |
| 67 | # @none: No shutdown request pending |
| 68 | # |
| 69 | # @host-error: An error prevents further use of guest |
| 70 | # |
Dominik Csapak | 9254893 | 2018-12-05 12:01:31 +0100 | [diff] [blame] | 71 | # @host-qmp-quit: Reaction to the QMP command 'quit' |
| 72 | # |
| 73 | # @host-qmp-system-reset: Reaction to the QMP command 'system_reset' |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 74 | # |
| 75 | # @host-signal: Reaction to a signal, such as SIGINT |
| 76 | # |
| 77 | # @host-ui: Reaction to a UI event, like window close |
| 78 | # |
| 79 | # @guest-shutdown: Guest shutdown/suspend request, via ACPI or other |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 80 | # hardware-specific means |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 81 | # |
| 82 | # @guest-reset: Guest reset request, and command line turns that into |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 83 | # a shutdown |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 84 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 85 | # @guest-panic: Guest panicked, and command line turns that into a |
| 86 | # shutdown |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 87 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 88 | # @subsystem-reset: Partial guest reset that does not trigger QMP |
| 89 | # events and ignores --no-reboot. This is useful for sanitizing |
| 90 | # hypercalls on s390 that are used during kexec/kdump/boot |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 91 | # |
Jason A. Donenfeld | 7966d70 | 2022-10-25 02:43:17 +0200 | [diff] [blame] | 92 | # @snapshot-load: A snapshot is being loaded by the record & replay |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 93 | # subsystem. This value is used only within QEMU. It doesn't |
Markus Armbruster | 5305a4e | 2024-03-22 15:09:09 +0100 | [diff] [blame] | 94 | # occur in QMP. (since 7.2) |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 95 | ## |
| 96 | { 'enum': 'ShutdownCause', |
| 97 | # Beware, shutdown_caused_by_guest() depends on enumeration order |
Dominik Csapak | 9254893 | 2018-12-05 12:01:31 +0100 | [diff] [blame] | 98 | 'data': [ 'none', 'host-error', 'host-qmp-quit', 'host-qmp-system-reset', |
| 99 | 'host-signal', 'host-ui', 'guest-shutdown', 'guest-reset', |
Jason A. Donenfeld | 7966d70 | 2022-10-25 02:43:17 +0200 | [diff] [blame] | 100 | 'guest-panic', 'subsystem-reset', 'snapshot-load'] } |
Dominik Csapak | d43013e | 2018-12-05 12:01:29 +0100 | [diff] [blame] | 101 | |
| 102 | ## |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 103 | # @StatusInfo: |
| 104 | # |
Steve Sistare | b9ae473 | 2024-01-03 12:05:31 -0800 | [diff] [blame] | 105 | # Information about VM run state |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 106 | # |
| 107 | # @running: true if all VCPUs are runnable, false if not runnable |
| 108 | # |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 109 | # @status: the virtual machine @RunState |
| 110 | # |
Andrea Bolognani | 23e4645 | 2022-05-03 09:37:35 +0200 | [diff] [blame] | 111 | # Since: 0.14 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 112 | ## |
| 113 | { 'struct': 'StatusInfo', |
Peter Maydell | 34c1820 | 2023-04-17 17:40:41 +0100 | [diff] [blame] | 114 | 'data': {'running': 'bool', |
Peter Maydell | 34c1820 | 2023-04-17 17:40:41 +0100 | [diff] [blame] | 115 | 'status': 'RunState'} } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 116 | |
| 117 | ## |
| 118 | # @query-status: |
| 119 | # |
Steve Sistare | b9ae473 | 2024-01-03 12:05:31 -0800 | [diff] [blame] | 120 | # Query the run status of the VM |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 121 | # |
Steve Sistare | b9ae473 | 2024-01-03 12:05:31 -0800 | [diff] [blame] | 122 | # Returns: @StatusInfo reflecting the VM |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 123 | # |
Andrea Bolognani | 23e4645 | 2022-05-03 09:37:35 +0200 | [diff] [blame] | 124 | # Since: 0.14 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 125 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 126 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 127 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 128 | # -> { "execute": "query-status" } |
| 129 | # <- { "return": { "running": true, |
| 130 | # "status": "running" } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 131 | ## |
Igor Mammedov | d6fe3d0 | 2018-05-11 18:51:43 +0200 | [diff] [blame] | 132 | { 'command': 'query-status', 'returns': 'StatusInfo', |
| 133 | 'allow-preconfig': true } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 134 | |
| 135 | ## |
| 136 | # @SHUTDOWN: |
| 137 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 138 | # Emitted when the virtual machine has shut down, indicating that qemu |
| 139 | # is about to exit. |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 140 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 141 | # @guest: If true, the shutdown was triggered by a guest request (such |
| 142 | # as a guest-initiated ACPI shutdown request or other |
| 143 | # hardware-specific action) rather than a host request (such as |
Markus Armbruster | 5305a4e | 2024-03-22 15:09:09 +0100 | [diff] [blame] | 144 | # sending qemu a SIGINT). (since 2.10) |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 145 | # |
Markus Armbruster | 209e64d | 2024-03-22 15:09:08 +0100 | [diff] [blame] | 146 | # @reason: The @ShutdownCause which resulted in the SHUTDOWN. |
| 147 | # (since 4.0) |
Dominik Csapak | ecd7a0d | 2018-12-05 12:01:30 +0100 | [diff] [blame] | 148 | # |
John Snow | 543ff13 | 2024-06-26 18:21:18 -0400 | [diff] [blame] | 149 | # .. note:: If the command-line option ``-no-shutdown`` has been |
John Snow | d461c27 | 2024-06-26 18:21:16 -0400 | [diff] [blame] | 150 | # specified, qemu will not exit, and a STOP event will eventually |
| 151 | # follow the SHUTDOWN event. |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 152 | # |
Markus Armbruster | 9bc6e89 | 2020-11-18 07:41:58 +0100 | [diff] [blame] | 153 | # Since: 0.12 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 154 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 155 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 156 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 157 | # <- { "event": "SHUTDOWN", |
| 158 | # "data": { "guest": true, "reason": "guest-shutdown" }, |
| 159 | # "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 160 | ## |
Dominik Csapak | ecd7a0d | 2018-12-05 12:01:30 +0100 | [diff] [blame] | 161 | { 'event': 'SHUTDOWN', 'data': { 'guest': 'bool', 'reason': 'ShutdownCause' } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 162 | |
| 163 | ## |
| 164 | # @POWERDOWN: |
| 165 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 166 | # Emitted when the virtual machine is powered down through the power |
| 167 | # control system, such as via ACPI. |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 168 | # |
Markus Armbruster | 9bc6e89 | 2020-11-18 07:41:58 +0100 | [diff] [blame] | 169 | # Since: 0.12 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 170 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 171 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 172 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 173 | # <- { "event": "POWERDOWN", |
| 174 | # "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 175 | ## |
| 176 | { 'event': 'POWERDOWN' } |
| 177 | |
| 178 | ## |
| 179 | # @RESET: |
| 180 | # |
| 181 | # Emitted when the virtual machine is reset |
| 182 | # |
| 183 | # @guest: If true, the reset was triggered by a guest request (such as |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 184 | # a guest-initiated ACPI reboot request or other hardware-specific |
| 185 | # action) rather than a host request (such as the QMP command |
Markus Armbruster | 5305a4e | 2024-03-22 15:09:09 +0100 | [diff] [blame] | 186 | # system_reset). (since 2.10) |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 187 | # |
Markus Armbruster | 5305a4e | 2024-03-22 15:09:09 +0100 | [diff] [blame] | 188 | # @reason: The @ShutdownCause of the RESET. (since 4.0) |
Dominik Csapak | ecd7a0d | 2018-12-05 12:01:30 +0100 | [diff] [blame] | 189 | # |
Markus Armbruster | 9bc6e89 | 2020-11-18 07:41:58 +0100 | [diff] [blame] | 190 | # Since: 0.12 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 191 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 192 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 193 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 194 | # <- { "event": "RESET", |
| 195 | # "data": { "guest": false, "reason": "guest-reset" }, |
| 196 | # "timestamp": { "seconds": 1267041653, "microseconds": 9518 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 197 | ## |
Dominik Csapak | ecd7a0d | 2018-12-05 12:01:30 +0100 | [diff] [blame] | 198 | { 'event': 'RESET', 'data': { 'guest': 'bool', 'reason': 'ShutdownCause' } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 199 | |
| 200 | ## |
| 201 | # @STOP: |
| 202 | # |
| 203 | # Emitted when the virtual machine is stopped |
| 204 | # |
Markus Armbruster | 9bc6e89 | 2020-11-18 07:41:58 +0100 | [diff] [blame] | 205 | # Since: 0.12 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 206 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 207 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 208 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 209 | # <- { "event": "STOP", |
| 210 | # "timestamp": { "seconds": 1267041730, "microseconds": 281295 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 211 | ## |
| 212 | { 'event': 'STOP' } |
| 213 | |
| 214 | ## |
| 215 | # @RESUME: |
| 216 | # |
| 217 | # Emitted when the virtual machine resumes execution |
| 218 | # |
Markus Armbruster | 9bc6e89 | 2020-11-18 07:41:58 +0100 | [diff] [blame] | 219 | # Since: 0.12 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 220 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 221 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 222 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 223 | # <- { "event": "RESUME", |
| 224 | # "timestamp": { "seconds": 1271770767, "microseconds": 582542 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 225 | ## |
| 226 | { 'event': 'RESUME' } |
| 227 | |
| 228 | ## |
| 229 | # @SUSPEND: |
| 230 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 231 | # Emitted when guest enters a hardware suspension state, for example, |
| 232 | # S3 state, which is sometimes called standby state |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 233 | # |
| 234 | # Since: 1.1 |
| 235 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 236 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 237 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 238 | # <- { "event": "SUSPEND", |
| 239 | # "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 240 | ## |
| 241 | { 'event': 'SUSPEND' } |
| 242 | |
| 243 | ## |
| 244 | # @SUSPEND_DISK: |
| 245 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 246 | # Emitted when guest enters a hardware suspension state with data |
| 247 | # saved on disk, for example, S4 state, which is sometimes called |
| 248 | # hibernate state |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 249 | # |
John Snow | d461c27 | 2024-06-26 18:21:16 -0400 | [diff] [blame] | 250 | # .. note:: QEMU shuts down (similar to event @SHUTDOWN) when entering |
| 251 | # this state. |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 252 | # |
| 253 | # Since: 1.2 |
| 254 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 255 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 256 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 257 | # <- { "event": "SUSPEND_DISK", |
| 258 | # "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 259 | ## |
| 260 | { 'event': 'SUSPEND_DISK' } |
| 261 | |
| 262 | ## |
| 263 | # @WAKEUP: |
| 264 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 265 | # Emitted when the guest has woken up from suspend state and is |
| 266 | # running |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 267 | # |
| 268 | # Since: 1.1 |
| 269 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 270 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 271 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 272 | # <- { "event": "WAKEUP", |
| 273 | # "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 274 | ## |
| 275 | { 'event': 'WAKEUP' } |
| 276 | |
| 277 | ## |
| 278 | # @WATCHDOG: |
| 279 | # |
| 280 | # Emitted when the watchdog device's timer is expired |
| 281 | # |
| 282 | # @action: action that has been taken |
| 283 | # |
John Snow | d461c27 | 2024-06-26 18:21:16 -0400 | [diff] [blame] | 284 | # .. note:: If action is "reset", "shutdown", or "pause" the WATCHDOG |
| 285 | # event is followed respectively by the RESET, SHUTDOWN, or STOP |
| 286 | # events. |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 287 | # |
John Snow | d461c27 | 2024-06-26 18:21:16 -0400 | [diff] [blame] | 288 | # .. note:: This event is rate-limited. |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 289 | # |
Markus Armbruster | 9bc6e89 | 2020-11-18 07:41:58 +0100 | [diff] [blame] | 290 | # Since: 0.13 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 291 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 292 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 293 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 294 | # <- { "event": "WATCHDOG", |
| 295 | # "data": { "action": "reset" }, |
| 296 | # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 297 | ## |
| 298 | { 'event': 'WATCHDOG', |
Michal Privoznik | 14d53b4 | 2017-09-07 10:05:24 +0200 | [diff] [blame] | 299 | 'data': { 'action': 'WatchdogAction' } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 300 | |
| 301 | ## |
Michal Privoznik | 14d53b4 | 2017-09-07 10:05:24 +0200 | [diff] [blame] | 302 | # @WatchdogAction: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 303 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 304 | # An enumeration of the actions taken when the watchdog device's timer |
| 305 | # is expired |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 306 | # |
| 307 | # @reset: system resets |
| 308 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 309 | # @shutdown: system shutdown, note that it is similar to @powerdown, |
| 310 | # which tries to set to system status and notify guest |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 311 | # |
| 312 | # @poweroff: system poweroff, the emulator program exits |
| 313 | # |
| 314 | # @pause: system pauses, similar to @stop |
| 315 | # |
| 316 | # @debug: system enters debug state |
| 317 | # |
| 318 | # @none: nothing is done |
| 319 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 320 | # @inject-nmi: a non-maskable interrupt is injected into the first |
| 321 | # VCPU (all VCPUS on x86) (since 2.4) |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 322 | # |
| 323 | # Since: 2.1 |
| 324 | ## |
Michal Privoznik | 14d53b4 | 2017-09-07 10:05:24 +0200 | [diff] [blame] | 325 | { 'enum': 'WatchdogAction', |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 326 | 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none', |
| 327 | 'inject-nmi' ] } |
| 328 | |
| 329 | ## |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 330 | # @RebootAction: |
| 331 | # |
| 332 | # Possible QEMU actions upon guest reboot |
| 333 | # |
Paolo Bonzini | c27025e | 2021-01-20 14:30:27 +0100 | [diff] [blame] | 334 | # @reset: Reset the VM |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 335 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 336 | # @shutdown: Shutdown the VM and exit, according to the shutdown |
| 337 | # action |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 338 | # |
| 339 | # Since: 6.0 |
| 340 | ## |
| 341 | { 'enum': 'RebootAction', |
Paolo Bonzini | c27025e | 2021-01-20 14:30:27 +0100 | [diff] [blame] | 342 | 'data': [ 'reset', 'shutdown' ] } |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 343 | |
| 344 | ## |
| 345 | # @ShutdownAction: |
| 346 | # |
| 347 | # Possible QEMU actions upon guest shutdown |
| 348 | # |
| 349 | # @poweroff: Shutdown the VM and exit |
| 350 | # |
Andrea Bolognani | f39057d | 2022-05-03 09:37:30 +0200 | [diff] [blame] | 351 | # @pause: pause the VM |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 352 | # |
| 353 | # Since: 6.0 |
| 354 | ## |
| 355 | { 'enum': 'ShutdownAction', |
| 356 | 'data': [ 'poweroff', 'pause' ] } |
| 357 | |
| 358 | ## |
Alejandro Jimenez | c753e8e | 2020-12-11 17:31:52 -0500 | [diff] [blame] | 359 | # @PanicAction: |
| 360 | # |
| 361 | # @none: Continue VM execution |
| 362 | # |
| 363 | # @pause: Pause the VM |
| 364 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 365 | # @shutdown: Shutdown the VM and exit, according to the shutdown |
| 366 | # action |
Paolo Bonzini | c27025e | 2021-01-20 14:30:27 +0100 | [diff] [blame] | 367 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 368 | # @exit-failure: Shutdown the VM and exit with nonzero status (since |
| 369 | # 7.1) |
Ilya Leoshkevich | 0882caf | 2022-07-26 00:37:45 +0200 | [diff] [blame] | 370 | # |
Alejandro Jimenez | c753e8e | 2020-12-11 17:31:52 -0500 | [diff] [blame] | 371 | # Since: 6.0 |
| 372 | ## |
| 373 | { 'enum': 'PanicAction', |
Ilya Leoshkevich | 0882caf | 2022-07-26 00:37:45 +0200 | [diff] [blame] | 374 | 'data': [ 'pause', 'shutdown', 'exit-failure', 'none' ] } |
Alejandro Jimenez | c753e8e | 2020-12-11 17:31:52 -0500 | [diff] [blame] | 375 | |
| 376 | ## |
Eric Blake | 3da7a41 | 2018-02-26 16:57:43 -0600 | [diff] [blame] | 377 | # @watchdog-set-action: |
| 378 | # |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 379 | # Set watchdog action. |
| 380 | # |
| 381 | # @action: @WatchdogAction action taken when watchdog timer expires. |
Eric Blake | 3da7a41 | 2018-02-26 16:57:43 -0600 | [diff] [blame] | 382 | # |
| 383 | # Since: 2.11 |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 384 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 385 | # .. qmp-example:: |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 386 | # |
| 387 | # -> { "execute": "watchdog-set-action", |
| 388 | # "arguments": { "action": "inject-nmi" } } |
| 389 | # <- { "return": {} } |
Eric Blake | 3da7a41 | 2018-02-26 16:57:43 -0600 | [diff] [blame] | 390 | ## |
| 391 | { 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} } |
| 392 | |
| 393 | ## |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 394 | # @set-action: |
| 395 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 396 | # Set the actions that will be taken by the emulator in response to |
| 397 | # guest events. |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 398 | # |
| 399 | # @reboot: @RebootAction action taken on guest reboot. |
| 400 | # |
| 401 | # @shutdown: @ShutdownAction action taken on guest shutdown. |
| 402 | # |
Alejandro Jimenez | c753e8e | 2020-12-11 17:31:52 -0500 | [diff] [blame] | 403 | # @panic: @PanicAction action taken on guest panic. |
| 404 | # |
Markus Armbruster | 53d5c36 | 2024-02-27 12:39:13 +0100 | [diff] [blame] | 405 | # @watchdog: @WatchdogAction action taken when watchdog timer expires. |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 406 | # |
| 407 | # Since: 6.0 |
| 408 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 409 | # .. qmp-example:: |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 410 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 411 | # -> { "execute": "set-action", |
| 412 | # "arguments": { "reboot": "shutdown", |
| 413 | # "shutdown" : "pause", |
| 414 | # "panic": "pause", |
| 415 | # "watchdog": "inject-nmi" } } |
| 416 | # <- { "return": {} } |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 417 | ## |
| 418 | { 'command': 'set-action', |
| 419 | 'data': { '*reboot': 'RebootAction', |
| 420 | '*shutdown': 'ShutdownAction', |
Alejandro Jimenez | c753e8e | 2020-12-11 17:31:52 -0500 | [diff] [blame] | 421 | '*panic': 'PanicAction', |
Alejandro Jimenez | e6dba04 | 2020-12-11 11:52:43 -0500 | [diff] [blame] | 422 | '*watchdog': 'WatchdogAction' }, |
| 423 | 'allow-preconfig': true } |
| 424 | |
| 425 | ## |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 426 | # @GUEST_PANICKED: |
| 427 | # |
| 428 | # Emitted when guest OS panic is detected |
| 429 | # |
| 430 | # @action: action that has been taken, currently always "pause" |
| 431 | # |
| 432 | # @info: information about a panic (since 2.9) |
| 433 | # |
| 434 | # Since: 1.5 |
| 435 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 436 | # .. qmp-example:: |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 437 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 438 | # <- { "event": "GUEST_PANICKED", |
| 439 | # "data": { "action": "pause" }, |
| 440 | # "timestamp": { "seconds": 1648245231, "microseconds": 900001 } } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 441 | ## |
| 442 | { 'event': 'GUEST_PANICKED', |
| 443 | 'data': { 'action': 'GuestPanicAction', '*info': 'GuestPanicInformation' } } |
| 444 | |
| 445 | ## |
zhenwei pi | 7dc58de | 2020-01-14 10:31:02 +0800 | [diff] [blame] | 446 | # @GUEST_CRASHLOADED: |
| 447 | # |
| 448 | # Emitted when guest OS crash loaded is detected |
| 449 | # |
| 450 | # @action: action that has been taken, currently always "run" |
| 451 | # |
| 452 | # @info: information about a panic |
| 453 | # |
| 454 | # Since: 5.0 |
| 455 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 456 | # .. qmp-example:: |
zhenwei pi | 7dc58de | 2020-01-14 10:31:02 +0800 | [diff] [blame] | 457 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 458 | # <- { "event": "GUEST_CRASHLOADED", |
| 459 | # "data": { "action": "run" }, |
| 460 | # "timestamp": { "seconds": 1648245259, "microseconds": 893771 } } |
zhenwei pi | 7dc58de | 2020-01-14 10:31:02 +0800 | [diff] [blame] | 461 | ## |
| 462 | { 'event': 'GUEST_CRASHLOADED', |
| 463 | 'data': { 'action': 'GuestPanicAction', '*info': 'GuestPanicInformation' } } |
| 464 | |
| 465 | ## |
Alejandro Jimenez | 8db1f7b | 2024-05-27 08:27:52 +0200 | [diff] [blame] | 466 | # @GUEST_PVSHUTDOWN: |
| 467 | # |
| 468 | # Emitted when guest submits a shutdown request via pvpanic interface |
| 469 | # |
| 470 | # Since: 9.1 |
| 471 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 472 | # .. qmp-example:: |
Alejandro Jimenez | 8db1f7b | 2024-05-27 08:27:52 +0200 | [diff] [blame] | 473 | # |
| 474 | # <- { "event": "GUEST_PVSHUTDOWN", |
| 475 | # "timestamp": { "seconds": 1648245259, "microseconds": 893771 } } |
| 476 | ## |
| 477 | { 'event': 'GUEST_PVSHUTDOWN' } |
| 478 | |
| 479 | ## |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 480 | # @GuestPanicAction: |
| 481 | # |
| 482 | # An enumeration of the actions taken when guest OS panic is detected |
| 483 | # |
| 484 | # @pause: system pauses |
| 485 | # |
Markus Armbruster | 86bf13a | 2023-04-25 08:42:20 +0200 | [diff] [blame] | 486 | # @poweroff: system powers off (since 2.8) |
| 487 | # |
| 488 | # @run: system continues to run (since 5.0) |
| 489 | # |
| 490 | # Since: 2.1 |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 491 | ## |
| 492 | { 'enum': 'GuestPanicAction', |
zhenwei pi | 7dc58de | 2020-01-14 10:31:02 +0800 | [diff] [blame] | 493 | 'data': [ 'pause', 'poweroff', 'run' ] } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 494 | |
| 495 | ## |
| 496 | # @GuestPanicInformationType: |
| 497 | # |
| 498 | # An enumeration of the guest panic information types |
| 499 | # |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 500 | # @hyper-v: hyper-v guest panic information type |
| 501 | # |
| 502 | # @s390: s390 guest panic information type (Since: 2.12) |
| 503 | # |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 504 | # Since: 2.9 |
| 505 | ## |
| 506 | { 'enum': 'GuestPanicInformationType', |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 507 | 'data': [ 'hyper-v', 's390' ] } |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 508 | |
| 509 | ## |
| 510 | # @GuestPanicInformation: |
| 511 | # |
| 512 | # Information about a guest panic |
| 513 | # |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 514 | # @type: Crash type that defines the hypervisor specific information |
| 515 | # |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 516 | # Since: 2.9 |
| 517 | ## |
| 518 | {'union': 'GuestPanicInformation', |
| 519 | 'base': {'type': 'GuestPanicInformationType'}, |
| 520 | 'discriminator': 'type', |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 521 | 'data': {'hyper-v': 'GuestPanicInformationHyperV', |
| 522 | 's390': 'GuestPanicInformationS390'}} |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 523 | |
| 524 | ## |
| 525 | # @GuestPanicInformationHyperV: |
| 526 | # |
| 527 | # Hyper-V specific guest panic information (HV crash MSRs) |
| 528 | # |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 529 | # @arg1: for Windows, STOP code for the guest crash. For Linux, |
Markus Armbruster | 01bed0f | 2024-07-29 08:52:20 +0200 | [diff] [blame] | 530 | # an error code. |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 531 | # |
| 532 | # @arg2: for Windows, first argument of the STOP. For Linux, the |
Markus Armbruster | 01bed0f | 2024-07-29 08:52:20 +0200 | [diff] [blame] | 533 | # guest OS ID, which has the kernel version in bits 16-47 and |
| 534 | # 0x8100 in bits 48-63. |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 535 | # |
| 536 | # @arg3: for Windows, second argument of the STOP. For Linux, the |
Markus Armbruster | 01bed0f | 2024-07-29 08:52:20 +0200 | [diff] [blame] | 537 | # program counter of the guest. |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 538 | # |
| 539 | # @arg4: for Windows, third argument of the STOP. For Linux, the |
Markus Armbruster | 01bed0f | 2024-07-29 08:52:20 +0200 | [diff] [blame] | 540 | # RAX register (x86) or the stack pointer (aarch64) of the guest. |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 541 | # |
| 542 | # @arg5: for Windows, fourth argument of the STOP. For x86 Linux, the |
Markus Armbruster | 01bed0f | 2024-07-29 08:52:20 +0200 | [diff] [blame] | 543 | # stack pointer of the guest. |
Paolo Bonzini | b2913cc | 2024-03-25 11:45:02 +0100 | [diff] [blame] | 544 | # |
Markus Armbruster | 0e201d3 | 2017-08-24 21:13:57 +0200 | [diff] [blame] | 545 | # Since: 2.9 |
| 546 | ## |
| 547 | {'struct': 'GuestPanicInformationHyperV', |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 548 | 'data': {'arg1': 'uint64', |
| 549 | 'arg2': 'uint64', |
| 550 | 'arg3': 'uint64', |
| 551 | 'arg4': 'uint64', |
| 552 | 'arg5': 'uint64'}} |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 553 | |
| 554 | ## |
| 555 | # @S390CrashReason: |
| 556 | # |
| 557 | # Reason why the CPU is in a crashed state. |
| 558 | # |
| 559 | # @unknown: no crash reason was set |
| 560 | # |
| 561 | # @disabled-wait: the CPU has entered a disabled wait state |
| 562 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 563 | # @extint-loop: clock comparator or cpu timer interrupt with new PSW |
| 564 | # enabled for external interrupts |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 565 | # |
| 566 | # @pgmint-loop: program interrupt with BAD new PSW |
| 567 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 568 | # @opint-loop: operation exception interrupt with invalid code at the |
| 569 | # program interrupt new PSW |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 570 | # |
| 571 | # Since: 2.12 |
| 572 | ## |
| 573 | { 'enum': 'S390CrashReason', |
| 574 | 'data': [ 'unknown', |
| 575 | 'disabled-wait', |
| 576 | 'extint-loop', |
| 577 | 'pgmint-loop', |
| 578 | 'opint-loop' ] } |
| 579 | |
| 580 | ## |
| 581 | # @GuestPanicInformationS390: |
| 582 | # |
| 583 | # S390 specific guest panic information (PSW) |
| 584 | # |
| 585 | # @core: core id of the CPU that crashed |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 586 | # |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 587 | # @psw-mask: control fields of guest PSW |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 588 | # |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 589 | # @psw-addr: guest instruction address |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 590 | # |
Christian Borntraeger | 4ada99a | 2018-02-09 12:25:43 +0000 | [diff] [blame] | 591 | # @reason: guest crash reason |
| 592 | # |
| 593 | # Since: 2.12 |
| 594 | ## |
| 595 | {'struct': 'GuestPanicInformationS390', |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 596 | 'data': {'core': 'uint32', |
| 597 | 'psw-mask': 'uint64', |
| 598 | 'psw-addr': 'uint64', |
| 599 | 'reason': 'S390CrashReason'}} |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 600 | |
| 601 | ## |
| 602 | # @MEMORY_FAILURE: |
| 603 | # |
| 604 | # Emitted when a memory failure occurs on host side. |
| 605 | # |
| 606 | # @recipient: recipient is defined as @MemoryFailureRecipient. |
| 607 | # |
Markus Armbruster | 1e6b050 | 2024-03-22 15:09:07 +0100 | [diff] [blame] | 608 | # @action: action that has been taken. |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 609 | # |
Markus Armbruster | 1e6b050 | 2024-03-22 15:09:07 +0100 | [diff] [blame] | 610 | # @flags: flags for MemoryFailureAction. |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 611 | # |
| 612 | # Since: 5.2 |
| 613 | # |
John Snow | 14b48aa | 2024-07-16 22:13:08 -0400 | [diff] [blame] | 614 | # .. qmp-example:: |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 615 | # |
Markus Armbruster | d23055b | 2024-02-16 15:58:34 +0100 | [diff] [blame] | 616 | # <- { "event": "MEMORY_FAILURE", |
| 617 | # "data": { "recipient": "hypervisor", |
| 618 | # "action": "fatal", |
| 619 | # "flags": { "action-required": false, |
| 620 | # "recursive": false } }, |
| 621 | # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 622 | ## |
| 623 | { 'event': 'MEMORY_FAILURE', |
| 624 | 'data': { 'recipient': 'MemoryFailureRecipient', |
| 625 | 'action': 'MemoryFailureAction', |
| 626 | 'flags': 'MemoryFailureFlags'} } |
| 627 | |
| 628 | ## |
| 629 | # @MemoryFailureRecipient: |
| 630 | # |
| 631 | # Hardware memory failure occurs, handled by recipient. |
| 632 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 633 | # @hypervisor: memory failure at QEMU process address space. (none |
| 634 | # guest memory, but used by QEMU itself). |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 635 | # |
| 636 | # @guest: memory failure at guest memory, |
| 637 | # |
| 638 | # Since: 5.2 |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 639 | ## |
| 640 | { 'enum': 'MemoryFailureRecipient', |
| 641 | 'data': [ 'hypervisor', |
| 642 | 'guest' ] } |
| 643 | |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 644 | ## |
| 645 | # @MemoryFailureAction: |
| 646 | # |
| 647 | # Actions taken by QEMU in response to a hardware memory failure. |
| 648 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 649 | # @ignore: the memory failure could be ignored. This will only be the |
| 650 | # case for action-optional failures. |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 651 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 652 | # @inject: memory failure occurred in guest memory, the guest enabled |
| 653 | # MCE handling mechanism, and QEMU could inject the MCE into the |
| 654 | # guest successfully. |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 655 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 656 | # @fatal: the failure is unrecoverable. This occurs for |
| 657 | # action-required failures if the recipient is the hypervisor; |
| 658 | # QEMU will exit. |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 659 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 660 | # @reset: the failure is unrecoverable but confined to the guest. |
| 661 | # This occurs if the recipient is a guest guest which is not ready |
| 662 | # to handle memory failures. |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 663 | # |
| 664 | # Since: 5.2 |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 665 | ## |
| 666 | { 'enum': 'MemoryFailureAction', |
| 667 | 'data': [ 'ignore', |
| 668 | 'inject', |
| 669 | 'fatal', |
| 670 | 'reset' ] } |
| 671 | |
| 672 | ## |
| 673 | # @MemoryFailureFlags: |
| 674 | # |
| 675 | # Additional information on memory failures. |
| 676 | # |
| 677 | # @action-required: whether a memory failure event is action-required |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 678 | # or action-optional (e.g. a failure during memory scrub). |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 679 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 680 | # @recursive: whether the failure occurred while the previous failure |
| 681 | # was still in progress. |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 682 | # |
| 683 | # Since: 5.2 |
zhenwei pi | 77b285f | 2020-09-30 18:04:39 +0800 | [diff] [blame] | 684 | ## |
| 685 | { 'struct': 'MemoryFailureFlags', |
| 686 | 'data': { 'action-required': 'bool', |
| 687 | 'recursive': 'bool'} } |
Chenyi Qiang | e2e69f6 | 2022-09-29 15:20:14 +0800 | [diff] [blame] | 688 | |
| 689 | ## |
| 690 | # @NotifyVmexitOption: |
| 691 | # |
| 692 | # An enumeration of the options specified when enabling notify VM exit |
| 693 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 694 | # @run: enable the feature, do nothing and continue if the notify VM |
| 695 | # exit happens. |
Chenyi Qiang | e2e69f6 | 2022-09-29 15:20:14 +0800 | [diff] [blame] | 696 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 697 | # @internal-error: enable the feature, raise a internal error if the |
| 698 | # notify VM exit happens. |
Chenyi Qiang | e2e69f6 | 2022-09-29 15:20:14 +0800 | [diff] [blame] | 699 | # |
| 700 | # @disable: disable the feature. |
| 701 | # |
| 702 | # Since: 7.2 |
| 703 | ## |
| 704 | { 'enum': 'NotifyVmexitOption', |
Peter Maydell | c27f4b6 | 2023-04-17 17:40:40 +0100 | [diff] [blame] | 705 | 'data': [ 'run', 'internal-error', 'disable' ] } |