Archipelago » qemu

# -*- Mode: Python -*-

#

# QAPI Schema

##

# @ErrorClass

#

# QEMU error classes

#

# @GenericError: this is used for errors that don't require a specific error

#                class. This should be the default case for most errors

#

# @CommandNotFound: the requested command has not been found

#

# @DeviceEncrypted: the requested operation can't be fulfilled because the

#                   selected device is encrypted

#

# @DeviceNotActive: a device has failed to be become active

#

# @DeviceNotFound: the requested device has not been found

#

# @KVMMissingCap: the requested operation can't be fulfilled because a

#                 required KVM capability is missing

#

# Since: 1.2

##

{ 'enum': 'ErrorClass',

  'data': [ 'GenericError', 'CommandNotFound', 'DeviceEncrypted',

            'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] }

##

# @add_client

#

# Allow client connections for VNC, Spice and socket based

# character devices to be passed in to QEMU via SCM_RIGHTS.

#

# @protocol: protocol name. Valid names are "vnc", "spice" or the

#            name of a character device (eg. from -chardev id=XXXX)

#

# @fdname: file descriptor name previously passed via 'getfd' command

#

# @skipauth: #optional whether to skip authentication. Only applies

#            to "vnc" and "spice" protocols

#

# @tls: #optional whether to perform TLS. Only applies to the "spice"

#       protocol

#

# Returns: nothing on success.

#

# Since: 0.14.0

##

{ 'command': 'add_client',

  'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',

            '*tls': 'bool' } }

##

# @NameInfo:

#

# Guest name information.

#

# @name: #optional The name of the guest

#

# Since 0.14.0

##

{ 'type': 'NameInfo', 'data': {'*name': 'str'} }

##

# @query-name:

#

# Return the name information of a guest.

#

# Returns: @NameInfo of the guest

#

# Since 0.14.0

##

{ 'command': 'query-name', 'returns': 'NameInfo' }

##

# @VersionInfo:

#

# A description of QEMU's version.

#

# @qemu.major:  The major version of QEMU

#

# @qemu.minor:  The minor version of QEMU

#

# @qemu.micro:  The micro version of QEMU.  By current convention, a micro

#               version of 50 signifies a development branch.  A micro version

#               greater than or equal to 90 signifies a release candidate for

#               the next minor version.  A micro version of less than 50

#               signifies a stable release.

#

# @package:     QEMU will always set this field to an empty string.  Downstream

#               versions of QEMU should set this to a non-empty string.  The

#               exact format depends on the downstream however it highly

#               recommended that a unique name is used.

#

# Since: 0.14.0

##

{ 'type': 'VersionInfo',

  'data': {'qemu': {'major': 'int', 'minor': 'int', 'micro': 'int'},

           'package': 'str'} }

##

# @query-version:

#

# Returns the current version of QEMU.

#

# Returns:  A @VersionInfo object describing the current version of QEMU.

#

# Since: 0.14.0

##

{ 'command': 'query-version', 'returns': 'VersionInfo' }

##

# @KvmInfo:

#

# Information about support for KVM acceleration

#

# @enabled: true if KVM acceleration is active

#

# @present: true if KVM acceleration is built into this executable

#

# Since: 0.14.0

##

{ 'type': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }

##

# @query-kvm:

#

# Returns information about KVM acceleration

#

# Returns: @KvmInfo

#

# Since: 0.14.0

##

{ 'command': 'query-kvm', 'returns': 'KvmInfo' }

##

# @RunState

#

# An enumeration of VM run states.

#

# @debug: QEMU is running on a debugger

#

# @finish-migrate: guest is paused to finish the migration process

#

# @inmigrate: guest is paused waiting for an incoming migration.  Note

# that this state does not tell whether the machine will start at the

# end of the migration.  This depends on the command-line -S option and

# any invocation of 'stop' or 'cont' that has happened since QEMU was

# started.

#

# @internal-error: An internal error that prevents further guest execution

# has occurred

#

# @io-error: the last IOP has failed and the device is configured to pause

# on I/O errors

#

# @paused: guest has been paused via the 'stop' command

#

# @postmigrate: guest is paused following a successful 'migrate'

#

# @prelaunch: QEMU was started with -S and guest has not started

#

# @restore-vm: guest is paused to restore VM state

#

# @running: guest is actively running

#

# @save-vm: guest is paused to save the VM state

#

# @shutdown: guest is shut down (and -no-shutdown is in use)

#

# @suspended: guest is suspended (ACPI S3)

#

# @watchdog: the watchdog action is configured to pause and has been triggered

##

{ 'enum': 'RunState',

  'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',

            'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',

            'running', 'save-vm', 'shutdown', 'suspended', 'watchdog' ] }

##

# @SnapshotInfo

#

# @id: unique snapshot id

#

# @name: user chosen name

#

# @vm-state-size: size of the VM state

#

# @date-sec: UTC date of the snapshot in seconds

#

# @date-nsec: fractional part in nano seconds to be used with date-sec

#

# @vm-clock-sec: VM clock relative to boot in seconds

#

# @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec

#

# Since: 1.3

#

##

{ 'type': 'SnapshotInfo',

  'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',

            'date-sec': 'int', 'date-nsec': 'int',

            'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }

##

# @ImageInfo:

#

# Information about a QEMU image file

#

# @filename: name of the image file

#

# @format: format of the image file

#

# @virtual-size: maximum capacity in bytes of the image

#

# @actual-size: #optional actual size on disk in bytes of the image

#

# @dirty-flag: #optional true if image is not cleanly closed

#

# @cluster-size: #optional size of a cluster in bytes

#

# @encrypted: #optional true if the image is encrypted

#

# @backing-filename: #optional name of the backing file

#

# @full-backing-filename: #optional full path of the backing file

#

# @backing-filename-format: #optional the format of the backing file

#

# @snapshots: #optional list of VM snapshots

#

# Since: 1.3

#

##

{ 'type': 'ImageInfo',

  'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',

           '*actual-size': 'int', 'virtual-size': 'int',

           '*cluster-size': 'int', '*encrypted': 'bool',

           '*backing-filename': 'str', '*full-backing-filename': 'str',

           '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'] } }

##

# @StatusInfo:

#

# Information about VCPU run state

#

# @running: true if all VCPUs are runnable, false if not runnable

#

# @singlestep: true if VCPUs are in single-step mode

#

# @status: the virtual machine @RunState

#

# Since:  0.14.0

#

# Notes: @singlestep is enabled through the GDB stub

##

{ 'type': 'StatusInfo',

  'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }

##

# @query-status:

#

# Query the run status of all VCPUs

#

# Returns: @StatusInfo reflecting all VCPUs

#

# Since:  0.14.0

##

{ 'command': 'query-status', 'returns': 'StatusInfo' }

##

# @UuidInfo:

#

# Guest UUID information.

#

# @UUID: the UUID of the guest

#

# Since: 0.14.0

#

# Notes: If no UUID was specified for the guest, a null UUID is returned.

##

{ 'type': 'UuidInfo', 'data': {'UUID': 'str'} }

##

# @query-uuid:

#

# Query the guest UUID information.

#

# Returns: The @UuidInfo for the guest

#

# Since 0.14.0

##

{ 'command': 'query-uuid', 'returns': 'UuidInfo' }

##

# @ChardevInfo:

#

# Information about a character device.

#

# @label: the label of the character device

#

# @filename: the filename of the character device

#

# Notes: @filename is encoded using the QEMU command line character device

#        encoding.  See the QEMU man page for details.

#

# Since: 0.14.0

##

{ 'type': 'ChardevInfo', 'data': {'label': 'str', 'filename': 'str'} }

##

# @query-chardev:

#

# Returns information about current character devices.

#

# Returns: a list of @ChardevInfo

#

# Since: 0.14.0

##

{ 'command': 'query-chardev', 'returns': ['ChardevInfo'] }

##

# @DataFormat:

#

# An enumeration of data format.

#

# @utf8: The data format is 'utf8'.

#

# @base64: The data format is 'base64'.

#

# Since: 1.4

##

{ 'enum': 'DataFormat'

  'data': [ 'utf8', 'base64' ] }