Docs/RCU: Correct sample code of qatomic_rcu_set
[qemu/ar7.git] / qapi / run-state.json
blob1f3b329f0564ae722b1d35058f8bcb95c41b4ada
1 # -*- Mode: Python -*-
2 # vim: filetype=python
5 ##
6 # = VM run state
7 ##
9 ##
10 # @RunState:
12 # An enumeration of VM run states.
14 # @debug: QEMU is running on a debugger
16 # @finish-migrate: guest is paused to finish the migration process
18 # @inmigrate: guest is paused waiting for an incoming migration.  Note
19 #             that this state does not tell whether the machine will start at the
20 #             end of the migration.  This depends on the command-line -S option and
21 #             any invocation of 'stop' or 'cont' that has happened since QEMU was
22 #             started.
24 # @internal-error: An internal error that prevents further guest execution
25 #                  has occurred
27 # @io-error: the last IOP has failed and the device is configured to pause
28 #            on I/O errors
30 # @paused: guest has been paused via the 'stop' command
32 # @postmigrate: guest is paused following a successful 'migrate'
34 # @prelaunch: QEMU was started with -S and guest has not started
36 # @restore-vm: guest is paused to restore VM state
38 # @running: guest is actively running
40 # @save-vm: guest is paused to save the VM state
42 # @shutdown: guest is shut down (and -no-shutdown is in use)
44 # @suspended: guest is suspended (ACPI S3)
46 # @watchdog: the watchdog action is configured to pause and has been triggered
48 # @guest-panicked: guest has been panicked as a result of guest OS panic
50 # @colo: guest is paused to save/restore VM state under colo checkpoint,
51 #        VM can not get into this state unless colo capability is enabled
52 #        for migration. (since 2.8)
54 { 'enum': 'RunState',
55   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
56             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
57             'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
58             'guest-panicked', 'colo' ] }
61 # @ShutdownCause:
63 # An enumeration of reasons for a Shutdown.
65 # @none: No shutdown request pending
67 # @host-error: An error prevents further use of guest
69 # @host-qmp-quit: Reaction to the QMP command 'quit'
71 # @host-qmp-system-reset: Reaction to the QMP command 'system_reset'
73 # @host-signal: Reaction to a signal, such as SIGINT
75 # @host-ui: Reaction to a UI event, like window close
77 # @guest-shutdown: Guest shutdown/suspend request, via ACPI or other
78 #                  hardware-specific means
80 # @guest-reset: Guest reset request, and command line turns that into
81 #               a shutdown
83 # @guest-panic: Guest panicked, and command line turns that into a shutdown
85 # @subsystem-reset: Partial guest reset that does not trigger QMP events and
86 #                   ignores --no-reboot. This is useful for sanitizing
87 #                   hypercalls on s390 that are used during kexec/kdump/boot
90 { 'enum': 'ShutdownCause',
91   # Beware, shutdown_caused_by_guest() depends on enumeration order
92   'data': [ 'none', 'host-error', 'host-qmp-quit', 'host-qmp-system-reset',
93             'host-signal', 'host-ui', 'guest-shutdown', 'guest-reset',
94             'guest-panic', 'subsystem-reset'] }
97 # @StatusInfo:
99 # Information about VCPU run state
101 # @running: true if all VCPUs are runnable, false if not runnable
103 # @singlestep: true if VCPUs are in single-step mode
105 # @status: the virtual machine @RunState
107 # Since:  0.14
109 # Notes: @singlestep is enabled through the GDB stub
111 { 'struct': 'StatusInfo',
112   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
115 # @query-status:
117 # Query the run status of all VCPUs
119 # Returns: @StatusInfo reflecting all VCPUs
121 # Since:  0.14
123 # Example:
125 # -> { "execute": "query-status" }
126 # <- { "return": { "running": true,
127 #                  "singlestep": false,
128 #                  "status": "running" } }
131 { 'command': 'query-status', 'returns': 'StatusInfo',
132   'allow-preconfig': true }
135 # @SHUTDOWN:
137 # Emitted when the virtual machine has shut down, indicating that qemu is
138 # about to exit.
140 # @guest: If true, the shutdown was triggered by a guest request (such as
141 #         a guest-initiated ACPI shutdown request or other hardware-specific action)
142 #         rather than a host request (such as sending qemu a SIGINT). (since 2.10)
144 # @reason: The @ShutdownCause which resulted in the SHUTDOWN. (since 4.0)
146 # Note: If the command-line option "-no-shutdown" has been specified, qemu will
147 #       not exit, and a STOP event will eventually follow the SHUTDOWN event
149 # Since: 0.12
151 # Example:
153 # <- { "event": "SHUTDOWN", "data": { "guest": true },
154 #      "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
157 { 'event': 'SHUTDOWN', 'data': { 'guest': 'bool', 'reason': 'ShutdownCause' } }
160 # @POWERDOWN:
162 # Emitted when the virtual machine is powered down through the power control
163 # system, such as via ACPI.
165 # Since: 0.12
167 # Example:
169 # <- { "event": "POWERDOWN",
170 #      "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
173 { 'event': 'POWERDOWN' }
176 # @RESET:
178 # Emitted when the virtual machine is reset
180 # @guest: If true, the reset was triggered by a guest request (such as
181 #         a guest-initiated ACPI reboot request or other hardware-specific action)
182 #         rather than a host request (such as the QMP command system_reset).
183 #         (since 2.10)
185 # @reason: The @ShutdownCause of the RESET. (since 4.0)
187 # Since: 0.12
189 # Example:
191 # <- { "event": "RESET", "data": { "guest": false },
192 #      "timestamp": { "seconds": 1267041653, "microseconds": 9518 } }
195 { 'event': 'RESET', 'data': { 'guest': 'bool', 'reason': 'ShutdownCause' } }
198 # @STOP:
200 # Emitted when the virtual machine is stopped
202 # Since: 0.12
204 # Example:
206 # <- { "event": "STOP",
207 #      "timestamp": { "seconds": 1267041730, "microseconds": 281295 } }
210 { 'event': 'STOP' }
213 # @RESUME:
215 # Emitted when the virtual machine resumes execution
217 # Since: 0.12
219 # Example:
221 # <- { "event": "RESUME",
222 #      "timestamp": { "seconds": 1271770767, "microseconds": 582542 } }
225 { 'event': 'RESUME' }
228 # @SUSPEND:
230 # Emitted when guest enters a hardware suspension state, for example, S3 state,
231 # which is sometimes called standby state
233 # Since: 1.1
235 # Example:
237 # <- { "event": "SUSPEND",
238 #      "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }
241 { 'event': 'SUSPEND' }
244 # @SUSPEND_DISK:
246 # Emitted when guest enters a hardware suspension state with data saved on
247 # disk, for example, S4 state, which is sometimes called hibernate state
249 # Note: QEMU shuts down (similar to event @SHUTDOWN) when entering this state
251 # Since: 1.2
253 # Example:
255 # <-   { "event": "SUSPEND_DISK",
256 #        "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }
259 { 'event': 'SUSPEND_DISK' }
262 # @WAKEUP:
264 # Emitted when the guest has woken up from suspend state and is running
266 # Since: 1.1
268 # Example:
270 # <- { "event": "WAKEUP",
271 #      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
274 { 'event': 'WAKEUP' }
277 # @WATCHDOG:
279 # Emitted when the watchdog device's timer is expired
281 # @action: action that has been taken
283 # Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
284 #       followed respectively by the RESET, SHUTDOWN, or STOP events
286 # Note: This event is rate-limited.
288 # Since: 0.13
290 # Example:
292 # <- { "event": "WATCHDOG",
293 #      "data": { "action": "reset" },
294 #      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
297 { 'event': 'WATCHDOG',
298   'data': { 'action': 'WatchdogAction' } }
301 # @WatchdogAction:
303 # An enumeration of the actions taken when the watchdog device's timer is
304 # expired
306 # @reset: system resets
308 # @shutdown: system shutdown, note that it is similar to @powerdown, which
309 #            tries to set to system status and notify guest
311 # @poweroff: system poweroff, the emulator program exits
313 # @pause: system pauses, similar to @stop
315 # @debug: system enters debug state
317 # @none: nothing is done
319 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
320 #              VCPUS on x86) (since 2.4)
322 # Since: 2.1
324 { 'enum': 'WatchdogAction',
325   'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
326             'inject-nmi' ] }
329 # @RebootAction:
331 # Possible QEMU actions upon guest reboot
333 # @none: Reset the VM
335 # @shutdown: Shutdown the VM and exit
337 # Since: 6.0
339 { 'enum': 'RebootAction',
340   'data': [ 'none', 'shutdown' ] }
343 # @ShutdownAction:
345 # Possible QEMU actions upon guest shutdown
347 # @poweroff: Shutdown the VM and exit
349 # @pause: pause the VM#
351 # Since: 6.0
353 { 'enum': 'ShutdownAction',
354   'data': [ 'poweroff', 'pause' ] }
357 # @PanicAction:
359 # @none: Continue VM execution
361 # @pause: Pause the VM
363 # Since: 6.0
365 { 'enum': 'PanicAction',
366   'data': [ 'poweroff', 'pause', 'none' ] }
369 # @watchdog-set-action:
371 # Set watchdog action
373 # Since: 2.11
375 { 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} }
378 # @set-action:
380 # Set the actions that will be taken by the emulator in response to guest
381 # events.
383 # @reboot: @RebootAction action taken on guest reboot.
385 # @shutdown: @ShutdownAction action taken on guest shutdown.
387 # @panic: @PanicAction action taken on guest panic.
389 # @watchdog: @WatchdogAction action taken when watchdog timer expires .
391 # Returns: Nothing on success.
393 # Since: 6.0
395 # Example:
397 # -> { "execute": "set-action",
398 #      "arguments": { "reboot": "shutdown",
399 #                     "shutdown" : "pause",
400 #                     "panic": "pause",
401 #                     "watchdog": "inject-nmi" } }
402 # <- { "return": {} }
404 { 'command': 'set-action',
405   'data': { '*reboot': 'RebootAction',
406             '*shutdown': 'ShutdownAction',
407             '*panic': 'PanicAction',
408             '*watchdog': 'WatchdogAction' },
409   'allow-preconfig': true }
412 # @GUEST_PANICKED:
414 # Emitted when guest OS panic is detected
416 # @action: action that has been taken, currently always "pause"
418 # @info: information about a panic (since 2.9)
420 # Since: 1.5
422 # Example:
424 # <- { "event": "GUEST_PANICKED",
425 #      "data": { "action": "pause" } }
428 { 'event': 'GUEST_PANICKED',
429   'data': { 'action': 'GuestPanicAction', '*info': 'GuestPanicInformation' } }
432 # @GUEST_CRASHLOADED:
434 # Emitted when guest OS crash loaded is detected
436 # @action: action that has been taken, currently always "run"
438 # @info: information about a panic
440 # Since: 5.0
442 # Example:
444 # <- { "event": "GUEST_CRASHLOADED",
445 #      "data": { "action": "run" } }
448 { 'event': 'GUEST_CRASHLOADED',
449   'data': { 'action': 'GuestPanicAction', '*info': 'GuestPanicInformation' } }
452 # @GuestPanicAction:
454 # An enumeration of the actions taken when guest OS panic is detected
456 # @pause: system pauses
458 # Since: 2.1 (poweroff since 2.8, run since 5.0)
460 { 'enum': 'GuestPanicAction',
461   'data': [ 'pause', 'poweroff', 'run' ] }
464 # @GuestPanicInformationType:
466 # An enumeration of the guest panic information types
468 # @hyper-v: hyper-v guest panic information type
470 # @s390: s390 guest panic information type (Since: 2.12)
472 # Since: 2.9
474 { 'enum': 'GuestPanicInformationType',
475   'data': [ 'hyper-v', 's390' ] }
478 # @GuestPanicInformation:
480 # Information about a guest panic
482 # @type: Crash type that defines the hypervisor specific information
484 # Since: 2.9
486 {'union': 'GuestPanicInformation',
487  'base': {'type': 'GuestPanicInformationType'},
488  'discriminator': 'type',
489  'data': { 'hyper-v': 'GuestPanicInformationHyperV',
490            's390': 'GuestPanicInformationS390' } }
493 # @GuestPanicInformationHyperV:
495 # Hyper-V specific guest panic information (HV crash MSRs)
497 # Since: 2.9
499 {'struct': 'GuestPanicInformationHyperV',
500  'data': { 'arg1': 'uint64',
501            'arg2': 'uint64',
502            'arg3': 'uint64',
503            'arg4': 'uint64',
504            'arg5': 'uint64' } }
507 # @S390CrashReason:
509 # Reason why the CPU is in a crashed state.
511 # @unknown: no crash reason was set
513 # @disabled-wait: the CPU has entered a disabled wait state
515 # @extint-loop: clock comparator or cpu timer interrupt with new PSW enabled
516 #               for external interrupts
518 # @pgmint-loop: program interrupt with BAD new PSW
520 # @opint-loop: operation exception interrupt with invalid code at the program
521 #              interrupt new PSW
523 # Since: 2.12
525 { 'enum': 'S390CrashReason',
526   'data': [ 'unknown',
527             'disabled-wait',
528             'extint-loop',
529             'pgmint-loop',
530             'opint-loop' ] }
533 # @GuestPanicInformationS390:
535 # S390 specific guest panic information (PSW)
537 # @core: core id of the CPU that crashed
538 # @psw-mask: control fields of guest PSW
539 # @psw-addr: guest instruction address
540 # @reason: guest crash reason
542 # Since: 2.12
544 {'struct': 'GuestPanicInformationS390',
545  'data': { 'core': 'uint32',
546            'psw-mask': 'uint64',
547            'psw-addr': 'uint64',
548            'reason': 'S390CrashReason' } }
551 # @MEMORY_FAILURE:
553 # Emitted when a memory failure occurs on host side.
555 # @recipient: recipient is defined as @MemoryFailureRecipient.
557 # @action: action that has been taken. action is defined as @MemoryFailureAction.
559 # @flags: flags for MemoryFailureAction. action is defined as @MemoryFailureFlags.
561 # Since: 5.2
563 # Example:
565 # <- { "event": "MEMORY_FAILURE",
566 #      "data": { "recipient": "hypervisor",
567 #                "action": "fatal",
568 #                "flags": { 'action-required': false } }
571 { 'event': 'MEMORY_FAILURE',
572   'data': { 'recipient': 'MemoryFailureRecipient',
573             'action': 'MemoryFailureAction',
574             'flags': 'MemoryFailureFlags'} }
577 # @MemoryFailureRecipient:
579 # Hardware memory failure occurs, handled by recipient.
581 # @hypervisor: memory failure at QEMU process address space.
582 #              (none guest memory, but used by QEMU itself).
584 # @guest: memory failure at guest memory,
586 # Since: 5.2
589 { 'enum': 'MemoryFailureRecipient',
590   'data': [ 'hypervisor',
591             'guest' ] }
595 # @MemoryFailureAction:
597 # Actions taken by QEMU in response to a hardware memory failure.
599 # @ignore: the memory failure could be ignored.  This will only be the case
600 #          for action-optional failures.
602 # @inject: memory failure occurred in guest memory, the guest enabled MCE
603 #          handling mechanism, and QEMU could inject the MCE into the guest
604 #          successfully.
606 # @fatal: the failure is unrecoverable.  This occurs for action-required
607 #         failures if the recipient is the hypervisor; QEMU will exit.
609 # @reset: the failure is unrecoverable but confined to the guest.  This
610 #         occurs if the recipient is a guest guest which is not ready
611 #         to handle memory failures.
613 # Since: 5.2
616 { 'enum': 'MemoryFailureAction',
617   'data': [ 'ignore',
618             'inject',
619             'fatal',
620             'reset' ] }
623 # @MemoryFailureFlags:
625 # Additional information on memory failures.
627 # @action-required: whether a memory failure event is action-required
628 #                   or action-optional (e.g. a failure during memory scrub).
630 # @recursive: whether the failure occurred while the previous
631 #             failure was still in progress.
633 # Since: 5.2
636 { 'struct': 'MemoryFailureFlags',
637   'data': { 'action-required': 'bool',
638             'recursive': 'bool'} }