2011-09-02 19:34:47 +02:00
|
|
|
# -*- Mode: Python -*-
|
|
|
|
#
|
|
|
|
# QAPI Schema
|
2011-09-02 19:34:48 +02:00
|
|
|
|
2014-06-05 13:45:29 +02:00
|
|
|
# QAPI common definitions
|
|
|
|
{ 'include': 'qapi/common.json' }
|
2014-02-08 11:01:55 +01:00
|
|
|
|
2014-06-05 13:45:30 +02:00
|
|
|
# QAPI block definitions
|
|
|
|
{ 'include': 'qapi/block.json' }
|
|
|
|
|
2014-02-08 11:01:55 +01:00
|
|
|
##
|
|
|
|
# LostTickPolicy:
|
|
|
|
#
|
|
|
|
# Policy for handling lost ticks in timer devices.
|
|
|
|
#
|
|
|
|
# @discard: throw away the missed tick(s) and continue with future injection
|
|
|
|
# normally. Guest time may be delayed, unless the OS has explicit
|
|
|
|
# handling of lost ticks
|
|
|
|
#
|
|
|
|
# @delay: continue to deliver ticks at the normal rate. Guest time will be
|
|
|
|
# delayed due to the late tick
|
|
|
|
#
|
|
|
|
# @merge: merge the missed tick(s) into one tick and inject. Guest time
|
|
|
|
# may be delayed, depending on how the OS reacts to the merging
|
|
|
|
# of ticks
|
|
|
|
#
|
|
|
|
# @slew: deliver ticks at a higher rate to catch up with the missed tick. The
|
|
|
|
# guest time should not be delayed once catchup is complete.
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'LostTickPolicy',
|
|
|
|
'data': ['discard', 'delay', 'merge', 'slew' ] }
|
|
|
|
|
2012-09-13 21:52:20 +02:00
|
|
|
# @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' } }
|
|
|
|
|
2011-09-02 19:34:48 +02:00
|
|
|
##
|
|
|
|
# @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' }
|
2011-08-26 22:38:13 +02:00
|
|
|
|
2011-09-12 20:10:53 +02:00
|
|
|
##
|
|
|
|
# @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' }
|
|
|
|
|
2011-09-12 22:54:20 +02:00
|
|
|
##
|
|
|
|
# @RunState
|
|
|
|
#
|
2012-08-23 07:14:25 +02:00
|
|
|
# An enumeration of VM run states.
|
2011-09-12 22:54:20 +02:00
|
|
|
#
|
|
|
|
# @debug: QEMU is running on a debugger
|
|
|
|
#
|
2012-04-27 18:16:41 +02:00
|
|
|
# @finish-migrate: guest is paused to finish the migration process
|
|
|
|
#
|
2012-10-23 14:54:21 +02:00
|
|
|
# @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.
|
2011-09-12 22:54:20 +02:00
|
|
|
#
|
|
|
|
# @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)
|
|
|
|
#
|
2012-04-27 18:33:36 +02:00
|
|
|
# @suspended: guest is suspended (ACPI S3)
|
|
|
|
#
|
2011-09-12 22:54:20 +02:00
|
|
|
# @watchdog: the watchdog action is configured to pause and has been triggered
|
2013-04-26 05:24:40 +02:00
|
|
|
#
|
|
|
|
# @guest-panicked: guest has been panicked as a result of guest OS panic
|
2011-09-12 22:54:20 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'RunState',
|
|
|
|
'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
|
|
|
|
'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
|
2013-04-26 05:24:40 +02:00
|
|
|
'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
|
|
|
|
'guest-panicked' ] }
|
2011-09-12 22:54:20 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @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' }
|
|
|
|
|
2011-09-13 22:16:25 +02:00
|
|
|
##
|
|
|
|
# @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' }
|
|
|
|
|
2011-09-14 21:05:49 +02:00
|
|
|
##
|
|
|
|
# @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'] }
|
2011-09-21 19:31:51 +02:00
|
|
|
|
2014-02-01 12:52:42 +01:00
|
|
|
##
|
|
|
|
# @ChardevBackendInfo:
|
|
|
|
#
|
|
|
|
# Information about a character device backend
|
|
|
|
#
|
|
|
|
# @name: The backend name
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevBackendInfo', 'data': {'name': 'str'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-chardev-backends:
|
|
|
|
#
|
|
|
|
# Returns information about character device backends.
|
|
|
|
#
|
|
|
|
# Returns: a list of @ChardevBackendInfo
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
|
|
|
|
|
2013-01-24 17:03:20 +01:00
|
|
|
##
|
|
|
|
# @DataFormat:
|
|
|
|
#
|
|
|
|
# An enumeration of data format.
|
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @utf8: Data is a UTF-8 string (RFC 3629)
|
2013-01-24 17:03:20 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @base64: Data is Base64 encoded binary (RFC 3548)
|
2013-01-24 17:03:20 +01:00
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
2013-06-19 11:23:27 +02:00
|
|
|
{ 'enum': 'DataFormat',
|
2013-01-24 17:03:20 +01:00
|
|
|
'data': [ 'utf8', 'base64' ] }
|
|
|
|
|
|
|
|
##
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @ringbuf-write:
|
2013-01-24 17:03:20 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# Write to a ring buffer character device.
|
2013-01-24 17:03:20 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @device: the ring buffer character device name
|
2013-01-24 17:03:20 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @data: data to write
|
2013-01-24 17:03:20 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @format: #optional data encoding (default 'utf8').
|
|
|
|
# - base64: data must be base64 encoded text. Its binary
|
|
|
|
# decoding gets written.
|
|
|
|
# Bug: invalid base64 is currently not rejected.
|
|
|
|
# Whitespace *is* invalid.
|
|
|
|
# - utf8: data's UTF-8 encoding is written
|
|
|
|
# - data itself is always Unicode regardless of format, like
|
|
|
|
# any other string.
|
2013-01-24 17:03:20 +01:00
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
{ 'command': 'ringbuf-write',
|
2013-02-06 21:27:14 +01:00
|
|
|
'data': {'device': 'str', 'data': 'str',
|
2013-01-24 17:03:20 +01:00
|
|
|
'*format': 'DataFormat'} }
|
|
|
|
|
2013-01-24 17:03:21 +01:00
|
|
|
##
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @ringbuf-read:
|
2013-01-24 17:03:21 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# Read from a ring buffer character device.
|
2013-01-24 17:03:21 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @device: the ring buffer character device name
|
2013-01-24 17:03:21 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @size: how many bytes to read at most
|
2013-01-24 17:03:21 +01:00
|
|
|
#
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
# @format: #optional data encoding (default 'utf8').
|
|
|
|
# - base64: the data read is returned in base64 encoding.
|
|
|
|
# - utf8: the data read is interpreted as UTF-8.
|
|
|
|
# Bug: can screw up when the buffer contains invalid UTF-8
|
|
|
|
# sequences, NUL characters, after the ring buffer lost
|
|
|
|
# data, and when reading stops because the size limit is
|
|
|
|
# reached.
|
|
|
|
# - The return value is always Unicode regardless of format,
|
|
|
|
# like any other string.
|
2013-01-24 17:03:21 +01:00
|
|
|
#
|
2013-02-06 21:27:15 +01:00
|
|
|
# Returns: data read from the device
|
2013-01-24 17:03:21 +01:00
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-06 21:27:24 +01:00
|
|
|
{ 'command': 'ringbuf-read',
|
2013-01-24 17:03:21 +01:00
|
|
|
'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
|
2013-02-06 21:27:15 +01:00
|
|
|
'returns': 'str' }
|
2013-01-24 17:03:21 +01:00
|
|
|
|
2012-05-21 18:59:51 +02:00
|
|
|
##
|
|
|
|
# @EventInfo:
|
|
|
|
#
|
|
|
|
# Information about a QMP event
|
|
|
|
#
|
|
|
|
# @name: The event name
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'EventInfo', 'data': {'name': 'str'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-events:
|
|
|
|
#
|
|
|
|
# Return a list of supported QMP events by this server
|
|
|
|
#
|
|
|
|
# Returns: A list of @EventInfo for all supported events
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-events', 'returns': ['EventInfo'] }
|
|
|
|
|
2011-09-13 22:37:16 +02:00
|
|
|
##
|
|
|
|
# @MigrationStats
|
|
|
|
#
|
|
|
|
# Detailed migration status.
|
|
|
|
#
|
|
|
|
# @transferred: amount of bytes already transferred to the target VM
|
|
|
|
#
|
|
|
|
# @remaining: amount of bytes remaining to be transferred to the target VM
|
|
|
|
#
|
|
|
|
# @total: total amount of bytes involved in the migration process
|
|
|
|
#
|
2013-03-26 10:58:37 +01:00
|
|
|
# @duplicate: number of duplicate (zero) pages (since 1.2)
|
|
|
|
#
|
|
|
|
# @skipped: number of skipped zero pages (since 1.5)
|
2012-08-06 20:42:56 +02:00
|
|
|
#
|
|
|
|
# @normal : number of normal pages (since 1.2)
|
|
|
|
#
|
2012-08-13 12:31:25 +02:00
|
|
|
# @normal-bytes: number of normal bytes sent (since 1.2)
|
|
|
|
#
|
|
|
|
# @dirty-pages-rate: number of pages dirtied by second by the
|
|
|
|
# guest (since 1.3)
|
2012-08-06 20:42:56 +02:00
|
|
|
#
|
2013-06-26 03:35:30 +02:00
|
|
|
# @mbps: throughput in megabits/sec. (since 1.6)
|
|
|
|
#
|
2014-04-04 11:57:55 +02:00
|
|
|
# @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
|
|
|
|
#
|
2012-08-06 20:42:56 +02:00
|
|
|
# Since: 0.14.0
|
2011-09-13 22:37:16 +02:00
|
|
|
##
|
|
|
|
{ 'type': 'MigrationStats',
|
2012-05-21 22:01:07 +02:00
|
|
|
'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
|
2013-03-26 10:58:37 +01:00
|
|
|
'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
|
2013-06-26 03:35:30 +02:00
|
|
|
'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
|
2014-04-04 11:57:55 +02:00
|
|
|
'mbps' : 'number', 'dirty-sync-count' : 'int' } }
|
2011-09-13 22:37:16 +02:00
|
|
|
|
2012-08-06 20:42:57 +02:00
|
|
|
##
|
|
|
|
# @XBZRLECacheStats
|
|
|
|
#
|
|
|
|
# Detailed XBZRLE migration cache statistics
|
|
|
|
#
|
|
|
|
# @cache-size: XBZRLE cache size
|
|
|
|
#
|
|
|
|
# @bytes: amount of bytes already transferred to the target VM
|
|
|
|
#
|
|
|
|
# @pages: amount of pages transferred to the target VM
|
|
|
|
#
|
|
|
|
# @cache-miss: number of cache miss
|
|
|
|
#
|
2014-04-04 11:57:56 +02:00
|
|
|
# @cache-miss-rate: rate of cache miss (since 2.1)
|
|
|
|
#
|
2012-08-06 20:42:57 +02:00
|
|
|
# @overflow: number of overflows
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'XBZRLECacheStats',
|
|
|
|
'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
|
2014-04-04 11:57:56 +02:00
|
|
|
'cache-miss': 'int', 'cache-miss-rate': 'number',
|
|
|
|
'overflow': 'int' } }
|
2012-08-06 20:42:57 +02:00
|
|
|
|
2011-09-13 22:37:16 +02:00
|
|
|
##
|
|
|
|
# @MigrationInfo
|
|
|
|
#
|
|
|
|
# Information about current migration process.
|
|
|
|
#
|
|
|
|
# @status: #optional string describing the current migration status.
|
2014-05-16 16:40:47 +02:00
|
|
|
# As of 0.14.0 this can be 'setup', 'active', 'completed', 'failed' or
|
2011-09-13 22:37:16 +02:00
|
|
|
# 'cancelled'. If this field is not returned, no migration process
|
|
|
|
# has been initiated
|
|
|
|
#
|
2012-05-21 22:01:07 +02:00
|
|
|
# @ram: #optional @MigrationStats containing detailed migration
|
|
|
|
# status, only returned if status is 'active' or
|
|
|
|
# 'completed'. 'comppleted' (since 1.2)
|
2011-09-13 22:37:16 +02:00
|
|
|
#
|
|
|
|
# @disk: #optional @MigrationStats containing detailed disk migration
|
|
|
|
# status, only returned if status is 'active' and it is a block
|
|
|
|
# migration
|
|
|
|
#
|
2012-08-06 20:42:57 +02:00
|
|
|
# @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
|
|
|
|
# migration statistics, only returned if XBZRLE feature is on and
|
|
|
|
# status is 'active' or 'completed' (since 1.2)
|
|
|
|
#
|
2012-08-18 13:17:10 +02:00
|
|
|
# @total-time: #optional total amount of milliseconds since migration started.
|
|
|
|
# If migration has ended, it returns the total migration
|
|
|
|
# time. (since 1.2)
|
|
|
|
#
|
2012-08-13 09:35:16 +02:00
|
|
|
# @downtime: #optional only present when migration finishes correctly
|
|
|
|
# total downtime in milliseconds for the guest.
|
|
|
|
# (since 1.3)
|
|
|
|
#
|
2012-08-13 09:53:12 +02:00
|
|
|
# @expected-downtime: #optional only present while migration is active
|
|
|
|
# expected downtime in milliseconds for the guest in last walk
|
|
|
|
# of the dirty bitmap. (since 1.3)
|
|
|
|
#
|
2013-07-22 16:01:58 +02:00
|
|
|
# @setup-time: #optional amount of setup time in milliseconds _before_ the
|
|
|
|
# iterations begin but _after_ the QMP command is issued. This is designed
|
|
|
|
# to provide an accounting of any activities (such as RDMA pinning) which
|
|
|
|
# may be expensive, but do not actually occur during the iterative
|
|
|
|
# migration rounds themselves. (since 1.6)
|
|
|
|
#
|
2011-09-13 22:37:16 +02:00
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'MigrationInfo',
|
|
|
|
'data': {'*status': 'str', '*ram': 'MigrationStats',
|
2012-08-06 20:42:57 +02:00
|
|
|
'*disk': 'MigrationStats',
|
2012-08-18 13:17:10 +02:00
|
|
|
'*xbzrle-cache': 'XBZRLECacheStats',
|
2012-08-13 09:35:16 +02:00
|
|
|
'*total-time': 'int',
|
2012-08-13 09:53:12 +02:00
|
|
|
'*expected-downtime': 'int',
|
2013-07-22 16:01:58 +02:00
|
|
|
'*downtime': 'int',
|
|
|
|
'*setup-time': 'int'} }
|
2011-09-13 22:37:16 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-migrate
|
|
|
|
#
|
|
|
|
# Returns information about current migration process.
|
|
|
|
#
|
|
|
|
# Returns: @MigrationInfo
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-migrate', 'returns': 'MigrationInfo' }
|
|
|
|
|
2012-08-06 20:42:47 +02:00
|
|
|
##
|
|
|
|
# @MigrationCapability
|
|
|
|
#
|
|
|
|
# Migration capabilities enumeration
|
|
|
|
#
|
|
|
|
# @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
|
|
|
|
# This feature allows us to minimize migration traffic for certain work
|
|
|
|
# loads, by sending compressed difference of the pages
|
|
|
|
#
|
2013-12-18 21:52:01 +01:00
|
|
|
# @rdma-pin-all: Controls whether or not the entire VM memory footprint is
|
2013-06-26 03:35:36 +02:00
|
|
|
# mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
|
2013-12-18 21:52:01 +01:00
|
|
|
# Disabled by default. (since 2.0)
|
2013-06-26 03:35:36 +02:00
|
|
|
#
|
2013-07-18 09:48:50 +02:00
|
|
|
# @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
|
|
|
|
# essentially saves 1MB of zeroes per block on the wire. Enabling requires
|
|
|
|
# source and target VM to support this feature. To enable it is sufficient
|
|
|
|
# to enable the capability on the source VM. The feature is disabled by
|
|
|
|
# default. (since 1.6)
|
|
|
|
#
|
2013-07-23 15:21:09 +02:00
|
|
|
# @auto-converge: If enabled, QEMU will automatically throttle down the guest
|
|
|
|
# to speed up convergence of RAM migration. (since 1.6)
|
|
|
|
#
|
2012-08-06 20:42:47 +02:00
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'enum': 'MigrationCapability',
|
2013-12-18 21:52:01 +01:00
|
|
|
'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks'] }
|
2012-08-06 20:42:47 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @MigrationCapabilityStatus
|
|
|
|
#
|
|
|
|
# Migration capability information
|
|
|
|
#
|
|
|
|
# @capability: capability enum
|
|
|
|
#
|
|
|
|
# @state: capability state bool
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'MigrationCapabilityStatus',
|
|
|
|
'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
|
|
|
|
|
|
|
|
##
|
2012-08-06 20:42:48 +02:00
|
|
|
# @migrate-set-capabilities
|
|
|
|
#
|
|
|
|
# Enable/Disable the following migration capabilities (like xbzrle)
|
|
|
|
#
|
|
|
|
# @capabilities: json array of capability modifications to make
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate-set-capabilities',
|
|
|
|
'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
|
|
|
|
|
|
|
|
##
|
2012-08-06 20:42:47 +02:00
|
|
|
# @query-migrate-capabilities
|
|
|
|
#
|
|
|
|
# Returns information about the current migration capabilities status
|
|
|
|
#
|
|
|
|
# Returns: @MigrationCapabilitiesStatus
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
|
|
|
|
|
2011-09-21 20:29:55 +02:00
|
|
|
##
|
|
|
|
# @MouseInfo:
|
|
|
|
#
|
|
|
|
# Information about a mouse device.
|
|
|
|
#
|
|
|
|
# @name: the name of the mouse device
|
|
|
|
#
|
|
|
|
# @index: the index of the mouse device
|
|
|
|
#
|
|
|
|
# @current: true if this device is currently receiving mouse events
|
|
|
|
#
|
|
|
|
# @absolute: true if this device supports absolute coordinates as input
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'MouseInfo',
|
|
|
|
'data': {'name': 'str', 'index': 'int', 'current': 'bool',
|
|
|
|
'absolute': 'bool'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-mice:
|
|
|
|
#
|
|
|
|
# Returns information about each active mouse device
|
|
|
|
#
|
|
|
|
# Returns: a list of @MouseInfo for each device
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-mice', 'returns': ['MouseInfo'] }
|
|
|
|
|
2011-09-21 21:38:35 +02:00
|
|
|
##
|
|
|
|
# @CpuInfo:
|
|
|
|
#
|
|
|
|
# Information about a virtual CPU
|
|
|
|
#
|
|
|
|
# @CPU: the index of the virtual CPU
|
|
|
|
#
|
|
|
|
# @current: this only exists for backwards compatible and should be ignored
|
2012-07-17 16:17:10 +02:00
|
|
|
#
|
2011-09-21 21:38:35 +02:00
|
|
|
# @halted: true if the virtual CPU is in the halt state. Halt usually refers
|
|
|
|
# to a processor specific low power mode.
|
|
|
|
#
|
|
|
|
# @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
|
|
|
|
# pointer.
|
|
|
|
# If the target is Sparc, this is the PC component of the
|
|
|
|
# instruction pointer.
|
|
|
|
#
|
|
|
|
# @nip: #optional If the target is PPC, the instruction pointer
|
|
|
|
#
|
|
|
|
# @npc: #optional If the target is Sparc, the NPC component of the instruction
|
|
|
|
# pointer
|
|
|
|
#
|
|
|
|
# @PC: #optional If the target is MIPS, the instruction pointer
|
|
|
|
#
|
|
|
|
# @thread_id: ID of the underlying host thread
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: @halted is a transient state that changes frequently. By the time the
|
|
|
|
# data is sent to the client, the guest may no longer be halted.
|
|
|
|
##
|
|
|
|
{ 'type': 'CpuInfo',
|
|
|
|
'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', '*pc': 'int',
|
|
|
|
'*nip': 'int', '*npc': 'int', '*PC': 'int', 'thread_id': 'int'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-cpus:
|
|
|
|
#
|
|
|
|
# Returns a list of information about each virtual CPU.
|
|
|
|
#
|
|
|
|
# Returns: a list of @CpuInfo for each virtual CPU
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-cpus', 'returns': ['CpuInfo'] }
|
|
|
|
|
2014-02-27 11:48:42 +01:00
|
|
|
##
|
|
|
|
# @IOThreadInfo:
|
|
|
|
#
|
|
|
|
# Information about an iothread
|
|
|
|
#
|
|
|
|
# @id: the identifier of the iothread
|
|
|
|
#
|
|
|
|
# @thread-id: ID of the underlying host thread
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'IOThreadInfo',
|
|
|
|
'data': {'id': 'str', 'thread-id': 'int'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-iothreads:
|
|
|
|
#
|
|
|
|
# Returns a list of information about each iothread.
|
|
|
|
#
|
|
|
|
# Note this list excludes the QEMU main loop thread, which is not declared
|
|
|
|
# using the -object iothread command-line option. It is always the main thread
|
|
|
|
# of the process.
|
|
|
|
#
|
|
|
|
# Returns: a list of @IOThreadInfo for each iothread
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
|
|
|
|
|
2011-10-17 20:41:22 +02:00
|
|
|
##
|
|
|
|
# @VncClientInfo:
|
|
|
|
#
|
|
|
|
# Information about a connected VNC client.
|
|
|
|
#
|
|
|
|
# @host: The host name of the client. QEMU tries to resolve this to a DNS name
|
|
|
|
# when possible.
|
|
|
|
#
|
|
|
|
# @family: 'ipv6' if the client is connected via IPv6 and TCP
|
|
|
|
# 'ipv4' if the client is connected via IPv4 and TCP
|
|
|
|
# 'unix' if the client is connected via a unix domain socket
|
|
|
|
# 'unknown' otherwise
|
|
|
|
#
|
|
|
|
# @service: The service name of the client's port. This may depends on the
|
|
|
|
# host system's service database so symbolic names should not be
|
|
|
|
# relied on.
|
|
|
|
#
|
|
|
|
# @x509_dname: #optional If x509 authentication is in use, the Distinguished
|
|
|
|
# Name of the client.
|
|
|
|
#
|
|
|
|
# @sasl_username: #optional If SASL authentication is in use, the SASL username
|
|
|
|
# used for authentication.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'VncClientInfo',
|
|
|
|
'data': {'host': 'str', 'family': 'str', 'service': 'str',
|
|
|
|
'*x509_dname': 'str', '*sasl_username': 'str'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @VncInfo:
|
|
|
|
#
|
|
|
|
# Information about the VNC session.
|
|
|
|
#
|
|
|
|
# @enabled: true if the VNC server is enabled, false otherwise
|
|
|
|
#
|
|
|
|
# @host: #optional The hostname the VNC server is bound to. This depends on
|
|
|
|
# the name resolution on the host and may be an IP address.
|
|
|
|
#
|
|
|
|
# @family: #optional 'ipv6' if the host is listening for IPv6 connections
|
|
|
|
# 'ipv4' if the host is listening for IPv4 connections
|
|
|
|
# 'unix' if the host is listening on a unix domain socket
|
|
|
|
# 'unknown' otherwise
|
|
|
|
#
|
|
|
|
# @service: #optional The service name of the server's port. This may depends
|
|
|
|
# on the host system's service database so symbolic names should not
|
|
|
|
# be relied on.
|
|
|
|
#
|
|
|
|
# @auth: #optional the current authentication type used by the server
|
|
|
|
# 'none' if no authentication is being used
|
|
|
|
# 'vnc' if VNC authentication is being used
|
|
|
|
# 'vencrypt+plain' if VEncrypt is used with plain text authentication
|
|
|
|
# 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
|
|
|
|
# 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
|
|
|
|
# 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
|
|
|
|
# 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
|
|
|
|
# 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
|
|
|
|
# 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
|
|
|
|
# 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
|
|
|
|
# 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
|
|
|
|
#
|
|
|
|
# @clients: a list of @VncClientInfo of all currently connected clients
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'VncInfo',
|
|
|
|
'data': {'enabled': 'bool', '*host': 'str', '*family': 'str',
|
|
|
|
'*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-vnc:
|
|
|
|
#
|
|
|
|
# Returns information about the current VNC server
|
|
|
|
#
|
|
|
|
# Returns: @VncInfo
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-vnc', 'returns': 'VncInfo' }
|
|
|
|
|
2011-10-20 21:01:33 +02:00
|
|
|
##
|
|
|
|
# @SpiceChannel
|
|
|
|
#
|
|
|
|
# Information about a SPICE client channel.
|
|
|
|
#
|
|
|
|
# @host: The host name of the client. QEMU tries to resolve this to a DNS name
|
|
|
|
# when possible.
|
|
|
|
#
|
|
|
|
# @family: 'ipv6' if the client is connected via IPv6 and TCP
|
|
|
|
# 'ipv4' if the client is connected via IPv4 and TCP
|
|
|
|
# 'unix' if the client is connected via a unix domain socket
|
|
|
|
# 'unknown' otherwise
|
|
|
|
#
|
|
|
|
# @port: The client's port number.
|
|
|
|
#
|
|
|
|
# @connection-id: SPICE connection id number. All channels with the same id
|
|
|
|
# belong to the same SPICE session.
|
|
|
|
#
|
2012-03-05 14:13:27 +01:00
|
|
|
# @connection-type: SPICE channel type number. "1" is the main control
|
|
|
|
# channel, filter for this one if you want to track spice
|
|
|
|
# sessions only
|
2011-10-20 21:01:33 +02:00
|
|
|
#
|
2012-03-05 14:13:27 +01:00
|
|
|
# @channel-id: SPICE channel ID number. Usually "0", might be different when
|
|
|
|
# multiple channels of the same type exist, such as multiple
|
2011-10-20 21:01:33 +02:00
|
|
|
# display channels in a multihead setup
|
|
|
|
#
|
|
|
|
# @tls: true if the channel is encrypted, false otherwise.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'SpiceChannel',
|
|
|
|
'data': {'host': 'str', 'family': 'str', 'port': 'str',
|
|
|
|
'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
|
|
|
|
'tls': 'bool'} }
|
|
|
|
|
2012-03-29 23:23:14 +02:00
|
|
|
##
|
|
|
|
# @SpiceQueryMouseMode
|
|
|
|
#
|
2012-08-23 07:14:25 +02:00
|
|
|
# An enumeration of Spice mouse states.
|
2012-03-29 23:23:14 +02:00
|
|
|
#
|
|
|
|
# @client: Mouse cursor position is determined by the client.
|
|
|
|
#
|
|
|
|
# @server: Mouse cursor position is determined by the server.
|
|
|
|
#
|
|
|
|
# @unknown: No information is available about mouse mode used by
|
|
|
|
# the spice server.
|
|
|
|
#
|
|
|
|
# Note: spice/enums.h has a SpiceMouseMode already, hence the name.
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'SpiceQueryMouseMode',
|
|
|
|
'data': [ 'client', 'server', 'unknown' ] }
|
|
|
|
|
2011-10-20 21:01:33 +02:00
|
|
|
##
|
|
|
|
# @SpiceInfo
|
|
|
|
#
|
|
|
|
# Information about the SPICE session.
|
2012-07-17 16:17:10 +02:00
|
|
|
#
|
2011-10-20 21:01:33 +02:00
|
|
|
# @enabled: true if the SPICE server is enabled, false otherwise
|
|
|
|
#
|
2012-08-21 10:51:58 +02:00
|
|
|
# @migrated: true if the last guest migration completed and spice
|
|
|
|
# migration had completed as well. false otherwise.
|
|
|
|
#
|
2011-10-20 21:01:33 +02:00
|
|
|
# @host: #optional The hostname the SPICE server is bound to. This depends on
|
|
|
|
# the name resolution on the host and may be an IP address.
|
|
|
|
#
|
|
|
|
# @port: #optional The SPICE server's port number.
|
|
|
|
#
|
|
|
|
# @compiled-version: #optional SPICE server version.
|
|
|
|
#
|
|
|
|
# @tls-port: #optional The SPICE server's TLS port number.
|
|
|
|
#
|
|
|
|
# @auth: #optional the current authentication type used by the server
|
2012-03-05 14:13:27 +01:00
|
|
|
# 'none' if no authentication is being used
|
|
|
|
# 'spice' uses SASL or direct TLS authentication, depending on command
|
|
|
|
# line options
|
2011-10-20 21:01:33 +02:00
|
|
|
#
|
2012-03-29 23:23:14 +02:00
|
|
|
# @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
|
|
|
|
# be determined by the client or the server, or unknown if spice
|
|
|
|
# server doesn't provide this information.
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
#
|
2011-10-20 21:01:33 +02:00
|
|
|
# @channels: a list of @SpiceChannel for each active spice channel
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'SpiceInfo',
|
2012-08-21 10:51:58 +02:00
|
|
|
'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
|
2011-10-20 21:01:33 +02:00
|
|
|
'*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
|
2012-03-29 23:23:14 +02:00
|
|
|
'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
|
2011-10-20 21:01:33 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-spice
|
|
|
|
#
|
|
|
|
# Returns information about the current SPICE server
|
|
|
|
#
|
|
|
|
# Returns: @SpiceInfo
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-spice', 'returns': 'SpiceInfo' }
|
|
|
|
|
2011-10-21 15:41:37 +02:00
|
|
|
##
|
|
|
|
# @BalloonInfo:
|
|
|
|
#
|
|
|
|
# Information about the guest balloon device.
|
|
|
|
#
|
|
|
|
# @actual: the number of bytes the balloon currently contains
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
##
|
2012-12-03 18:56:41 +01:00
|
|
|
{ 'type': 'BalloonInfo', 'data': {'actual': 'int' } }
|
2011-10-21 15:41:37 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-balloon:
|
|
|
|
#
|
|
|
|
# Return information about the balloon device.
|
|
|
|
#
|
|
|
|
# Returns: @BalloonInfo on success
|
|
|
|
# If the balloon driver is enabled but not functional because the KVM
|
|
|
|
# kernel module cannot support it, KvmMissingCap
|
|
|
|
# If no balloon device is present, DeviceNotActive
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-balloon', 'returns': 'BalloonInfo' }
|
|
|
|
|
2011-10-21 18:15:33 +02:00
|
|
|
##
|
|
|
|
# @PciMemoryRange:
|
|
|
|
#
|
|
|
|
# A PCI device memory region
|
|
|
|
#
|
|
|
|
# @base: the starting address (guest physical)
|
|
|
|
#
|
|
|
|
# @limit: the ending address (guest physical)
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @PciMemoryRegion
|
|
|
|
#
|
|
|
|
# Information about a PCI device I/O region.
|
|
|
|
#
|
|
|
|
# @bar: the index of the Base Address Register for this region
|
|
|
|
#
|
|
|
|
# @type: 'io' if the region is a PIO region
|
|
|
|
# 'memory' if the region is a MMIO region
|
|
|
|
#
|
|
|
|
# @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
|
|
|
|
#
|
|
|
|
# @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'PciMemoryRegion',
|
|
|
|
'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
|
|
|
|
'*prefetch': 'bool', '*mem_type_64': 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @PciBridgeInfo:
|
|
|
|
#
|
|
|
|
# Information about a PCI Bridge device
|
|
|
|
#
|
|
|
|
# @bus.number: primary bus interface number. This should be the number of the
|
|
|
|
# bus the device resides on.
|
|
|
|
#
|
|
|
|
# @bus.secondary: secondary bus interface number. This is the number of the
|
|
|
|
# main bus for the bridge
|
|
|
|
#
|
|
|
|
# @bus.subordinate: This is the highest number bus that resides below the
|
|
|
|
# bridge.
|
|
|
|
#
|
|
|
|
# @bus.io_range: The PIO range for all devices on this bridge
|
|
|
|
#
|
|
|
|
# @bus.memory_range: The MMIO range for all devices on this bridge
|
|
|
|
#
|
|
|
|
# @bus.prefetchable_range: The range of prefetchable MMIO for all devices on
|
|
|
|
# this bridge
|
|
|
|
#
|
|
|
|
# @devices: a list of @PciDeviceInfo for each device on this bridge
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'PciBridgeInfo',
|
|
|
|
'data': {'bus': { 'number': 'int', 'secondary': 'int', 'subordinate': 'int',
|
|
|
|
'io_range': 'PciMemoryRange',
|
|
|
|
'memory_range': 'PciMemoryRange',
|
|
|
|
'prefetchable_range': 'PciMemoryRange' },
|
|
|
|
'*devices': ['PciDeviceInfo']} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @PciDeviceInfo:
|
|
|
|
#
|
|
|
|
# Information about a PCI device
|
|
|
|
#
|
|
|
|
# @bus: the bus number of the device
|
|
|
|
#
|
|
|
|
# @slot: the slot the device is located in
|
|
|
|
#
|
|
|
|
# @function: the function of the slot used by the device
|
|
|
|
#
|
|
|
|
# @class_info.desc: #optional a string description of the device's class
|
|
|
|
#
|
|
|
|
# @class_info.class: the class code of the device
|
|
|
|
#
|
|
|
|
# @id.device: the PCI device id
|
|
|
|
#
|
|
|
|
# @id.vendor: the PCI vendor id
|
|
|
|
#
|
|
|
|
# @irq: #optional if an IRQ is assigned to the device, the IRQ number
|
|
|
|
#
|
|
|
|
# @qdev_id: the device name of the PCI device
|
|
|
|
#
|
|
|
|
# @pci_bridge: if the device is a PCI bridge, the bridge information
|
|
|
|
#
|
|
|
|
# @regions: a list of the PCI I/O regions associated with the device
|
|
|
|
#
|
|
|
|
# Notes: the contents of @class_info.desc are not stable and should only be
|
|
|
|
# treated as informational.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'PciDeviceInfo',
|
|
|
|
'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
|
|
|
|
'class_info': {'*desc': 'str', 'class': 'int'},
|
|
|
|
'id': {'device': 'int', 'vendor': 'int'},
|
|
|
|
'*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
|
|
|
|
'regions': ['PciMemoryRegion']} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @PciInfo:
|
|
|
|
#
|
|
|
|
# Information about a PCI bus
|
|
|
|
#
|
|
|
|
# @bus: the bus index
|
|
|
|
#
|
|
|
|
# @devices: a list of devices on this bus
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'type': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-pci:
|
|
|
|
#
|
|
|
|
# Return information about the PCI bus topology of the guest.
|
|
|
|
#
|
|
|
|
# Returns: a list of @PciInfo for each PCI bus
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-pci', 'returns': ['PciInfo'] }
|
|
|
|
|
2011-09-15 19:20:28 +02:00
|
|
|
##
|
|
|
|
# @quit:
|
|
|
|
#
|
|
|
|
# This command will cause the QEMU process to exit gracefully. While every
|
|
|
|
# attempt is made to send the QMP response before terminating, this is not
|
|
|
|
# guaranteed. When using this interface, a premature EOF would not be
|
|
|
|
# unexpected.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'quit' }
|
2011-09-15 19:34:39 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @stop:
|
|
|
|
#
|
|
|
|
# Stop all guest VCPU execution.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: This function will succeed even if the guest is already in the stopped
|
2012-10-23 14:54:21 +02:00
|
|
|
# state. In "inmigrate" state, it will ensure that the guest
|
|
|
|
# remains paused once migration finishes, as if the -S option was
|
|
|
|
# passed on the command line.
|
2011-09-15 19:34:39 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'stop' }
|
2011-09-15 19:41:46 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @system_reset:
|
|
|
|
#
|
|
|
|
# Performs a hard reset of a guest.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'system_reset' }
|
2011-09-28 16:06:15 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @system_powerdown:
|
|
|
|
#
|
|
|
|
# Requests that a guest perform a powerdown operation.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: A guest may or may not respond to this command. This command
|
|
|
|
# returning does not indicate that a guest has accepted the request or
|
|
|
|
# that it has shut down. Many guests will respond to this command by
|
|
|
|
# prompting the user in some way.
|
|
|
|
##
|
|
|
|
{ 'command': 'system_powerdown' }
|
2011-10-06 19:31:39 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @cpu:
|
|
|
|
#
|
|
|
|
# This command is a nop that is only provided for the purposes of compatibility.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: Do not use this command.
|
|
|
|
##
|
|
|
|
{ 'command': 'cpu', 'data': {'index': 'int'} }
|
2011-11-22 19:32:37 +01:00
|
|
|
|
2013-04-30 15:41:25 +02:00
|
|
|
##
|
|
|
|
# @cpu-add
|
|
|
|
#
|
|
|
|
# Adds CPU with specified ID
|
|
|
|
#
|
|
|
|
# @id: ID of CPU to be created, valid values [0..max_cpus)
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since 1.5
|
|
|
|
##
|
|
|
|
{ 'command': 'cpu-add', 'data': {'id': 'int'} }
|
|
|
|
|
2011-11-22 19:32:37 +01:00
|
|
|
##
|
|
|
|
# @memsave:
|
|
|
|
#
|
|
|
|
# Save a portion of guest memory to a file.
|
|
|
|
#
|
|
|
|
# @val: the virtual address of the guest to start from
|
|
|
|
#
|
|
|
|
# @size: the size of memory region to save
|
|
|
|
#
|
|
|
|
# @filename: the file to save the memory to as binary data
|
|
|
|
#
|
|
|
|
# @cpu-index: #optional the index of the virtual CPU to use for translating the
|
|
|
|
# virtual address (defaults to CPU 0)
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: Errors were not reliably returned until 1.1
|
|
|
|
##
|
|
|
|
{ 'command': 'memsave',
|
|
|
|
'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
|
2011-11-22 20:26:46 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @pmemsave:
|
|
|
|
#
|
|
|
|
# Save a portion of guest physical memory to a file.
|
|
|
|
#
|
|
|
|
# @val: the physical address of the guest to start from
|
|
|
|
#
|
|
|
|
# @size: the size of memory region to save
|
|
|
|
#
|
|
|
|
# @filename: the file to save the memory to as binary data
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: Errors were not reliably returned until 1.1
|
|
|
|
##
|
|
|
|
{ 'command': 'pmemsave',
|
|
|
|
'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
|
2011-11-22 20:58:31 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @cont:
|
|
|
|
#
|
|
|
|
# Resume guest VCPU execution.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Returns: If successful, nothing
|
|
|
|
# If QEMU was started with an encrypted block device and a key has
|
|
|
|
# not yet been set, DeviceEncrypted.
|
|
|
|
#
|
2012-10-23 14:54:21 +02:00
|
|
|
# Notes: This command will succeed if the guest is currently running. It
|
|
|
|
# will also succeed if the guest is in the "inmigrate" state; in
|
|
|
|
# this case, the effect of the command is to make sure the guest
|
|
|
|
# starts once migration finishes, removing the effect of the -S
|
|
|
|
# command line option if it was passed.
|
2011-11-22 20:58:31 +01:00
|
|
|
##
|
|
|
|
{ 'command': 'cont' }
|
|
|
|
|
2012-02-23 13:45:21 +01:00
|
|
|
##
|
|
|
|
# @system_wakeup:
|
|
|
|
#
|
|
|
|
# Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
#
|
|
|
|
# Returns: nothing.
|
|
|
|
##
|
|
|
|
{ 'command': 'system_wakeup' }
|
|
|
|
|
2011-11-23 15:55:53 +01:00
|
|
|
##
|
|
|
|
# @inject-nmi:
|
|
|
|
#
|
|
|
|
# Injects an Non-Maskable Interrupt into all guest's VCPUs.
|
|
|
|
#
|
|
|
|
# Returns: If successful, nothing
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: Only x86 Virtual Machines support this command.
|
|
|
|
##
|
|
|
|
{ 'command': 'inject-nmi' }
|
2011-11-23 16:11:55 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @set_link:
|
|
|
|
#
|
|
|
|
# Sets the link status of a virtual network adapter.
|
|
|
|
#
|
|
|
|
# @name: the device name of the virtual network adapter
|
|
|
|
#
|
|
|
|
# @up: true to set the link status to be up
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If @name is not a valid network device, DeviceNotFound
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: Not all network adapters support setting link status. This command
|
|
|
|
# will succeed even if the network adapter does not support link status
|
|
|
|
# notification.
|
|
|
|
##
|
|
|
|
{ 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
|
2011-11-23 16:28:21 +01:00
|
|
|
|
2011-11-25 17:38:09 +01:00
|
|
|
##
|
|
|
|
# @balloon:
|
|
|
|
#
|
|
|
|
# Request the balloon driver to change its balloon size.
|
|
|
|
#
|
|
|
|
# @value: the target size of the balloon in bytes
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If the balloon driver is enabled but not functional because the KVM
|
|
|
|
# kernel module cannot support it, KvmMissingCap
|
|
|
|
# If no balloon device is present, DeviceNotActive
|
|
|
|
#
|
|
|
|
# Notes: This command just issues a request to the guest. When it returns,
|
|
|
|
# the balloon size may not have changed. A guest can change the balloon
|
|
|
|
# size independent of this command.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'balloon', 'data': {'value': 'int'} }
|
2011-11-25 17:57:10 +01:00
|
|
|
|
2013-06-24 17:13:18 +02:00
|
|
|
##
|
|
|
|
# @Abort
|
|
|
|
#
|
|
|
|
# This action can be used to test transaction failure.
|
|
|
|
#
|
|
|
|
# Since: 1.6
|
|
|
|
###
|
|
|
|
{ 'type': 'Abort',
|
|
|
|
'data': { } }
|
|
|
|
|
2012-02-28 21:54:06 +01:00
|
|
|
##
|
2013-05-13 10:43:43 +02:00
|
|
|
# @TransactionAction
|
2012-02-28 21:54:06 +01:00
|
|
|
#
|
2012-03-06 18:55:57 +01:00
|
|
|
# A discriminated record of operations that can be performed with
|
|
|
|
# @transaction.
|
2012-02-28 21:54:06 +01:00
|
|
|
##
|
2013-05-13 10:43:43 +02:00
|
|
|
{ 'union': 'TransactionAction',
|
2012-03-06 18:55:57 +01:00
|
|
|
'data': {
|
blockdev: add DriveBackup transaction
This patch adds a transactional version of the drive-backup QMP command.
It allows atomic snapshots of multiple drives along with automatic
cleanup if there is a failure to start one of the backup jobs.
Note that QMP events are emitted for block job completion/cancellation
and the block job will be listed by query-block-jobs.
@device: the name of the device whose writes should be mirrored.
@target: the target of the new image. If the file exists, or if it
is a device, the existing file/device will be used as the new
destination. If it does not exist, a new file will be created.
@format: #optional the format of the new destination, default is to
probe if @mode is 'existing', else the format of the source
@mode: #optional whether and how QEMU should create a new image, default is
'absolute-paths'.
@speed: #optional the maximum speed, in bytes per second
@on-source-error: #optional the action to take on an error on the source,
default 'report'. 'stop' and 'enospc' can only be used
if the block device supports io-status (see BlockInfo).
@on-target-error: #optional the action to take on an error on the target,
default 'report' (no limitations, since this applies to
a different block device than @device).
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2013-06-24 17:13:17 +02:00
|
|
|
'blockdev-snapshot-sync': 'BlockdevSnapshot',
|
2013-06-24 17:13:18 +02:00
|
|
|
'drive-backup': 'DriveBackup',
|
2013-09-11 08:04:34 +02:00
|
|
|
'abort': 'Abort',
|
|
|
|
'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal'
|
2012-03-06 18:55:57 +01:00
|
|
|
} }
|
2012-02-28 21:54:06 +01:00
|
|
|
|
|
|
|
##
|
2012-03-06 18:55:57 +01:00
|
|
|
# @transaction
|
2012-02-28 21:54:06 +01:00
|
|
|
#
|
2013-05-13 10:43:43 +02:00
|
|
|
# Executes a number of transactionable QMP commands atomically. If any
|
|
|
|
# operation fails, then the entire set of actions will be abandoned and the
|
|
|
|
# appropriate error returned.
|
2012-02-28 21:54:06 +01:00
|
|
|
#
|
|
|
|
# List of:
|
2013-05-13 10:43:43 +02:00
|
|
|
# @TransactionAction: information needed for the respective operation
|
2012-02-28 21:54:06 +01:00
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
2013-05-13 10:43:43 +02:00
|
|
|
# Errors depend on the operations of the transaction
|
2012-02-28 21:54:06 +01:00
|
|
|
#
|
2013-05-13 10:43:43 +02:00
|
|
|
# Note: The transaction aborts on the first failure. Therefore, there will be
|
|
|
|
# information on only one failed operation returned in an error condition, and
|
2012-03-06 18:55:57 +01:00
|
|
|
# subsequent actions will not have been attempted.
|
|
|
|
#
|
|
|
|
# Since 1.1
|
2012-02-28 21:54:06 +01:00
|
|
|
##
|
2012-03-06 18:55:57 +01:00
|
|
|
{ 'command': 'transaction',
|
2013-05-13 10:43:43 +02:00
|
|
|
'data': { 'actions': [ 'TransactionAction' ] } }
|
2012-02-28 21:54:06 +01:00
|
|
|
|
2011-11-25 20:52:45 +01:00
|
|
|
##
|
|
|
|
# @human-monitor-command:
|
|
|
|
#
|
|
|
|
# Execute a command on the human monitor and return the output.
|
|
|
|
#
|
|
|
|
# @command-line: the command to execute in the human monitor
|
|
|
|
#
|
|
|
|
# @cpu-index: #optional The CPU to use for commands that require an implicit CPU
|
|
|
|
#
|
|
|
|
# Returns: the output of the command as a string
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 0.14.0
|
2013-01-22 09:03:13 +01:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Notes: This command only exists as a stop-gap. Its use is highly
|
|
|
|
# discouraged. The semantics of this command are not guaranteed.
|
2012-10-18 16:49:28 +02:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Known limitations:
|
2012-10-18 16:49:28 +02:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# o This command is stateless, this means that commands that depend
|
|
|
|
# on state information (such as getfd) might not work
|
2012-10-18 16:49:24 +02:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# o Commands that prompt the user for data (eg. 'cont' when the block
|
|
|
|
# device is encrypted) don't currently work
|
2012-10-18 16:49:24 +02:00
|
|
|
##
|
2014-06-05 13:45:31 +02:00
|
|
|
{ 'command': 'human-monitor-command',
|
|
|
|
'data': {'command-line': 'str', '*cpu-index': 'int'},
|
|
|
|
'returns': 'str' }
|
2012-10-18 16:49:24 +02:00
|
|
|
|
|
|
|
##
|
2011-11-28 01:54:09 +01:00
|
|
|
# @migrate_cancel
|
|
|
|
#
|
|
|
|
# Cancel the current executing migration process.
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Notes: This command succeeds even if there is no migration process running.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate_cancel' }
|
2011-11-28 02:18:01 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate_set_downtime
|
|
|
|
#
|
|
|
|
# Set maximum tolerated downtime for migration.
|
|
|
|
#
|
|
|
|
# @value: maximum downtime in seconds
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
|
2011-11-28 14:59:37 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate_set_speed
|
|
|
|
#
|
|
|
|
# Set maximum speed for migration.
|
|
|
|
#
|
|
|
|
# @value: maximum speed in bytes.
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Notes: A value lesser than zero will be automatically round up to zero.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
|
2011-12-12 21:29:34 +01:00
|
|
|
|
2012-08-06 20:42:54 +02:00
|
|
|
##
|
|
|
|
# @migrate-set-cache-size
|
|
|
|
#
|
|
|
|
# Set XBZRLE cache size
|
|
|
|
#
|
|
|
|
# @value: cache size in bytes
|
|
|
|
#
|
|
|
|
# The size will be rounded down to the nearest power of 2.
|
|
|
|
# The cache size can be modified before and during ongoing migration
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-migrate-cache-size
|
|
|
|
#
|
|
|
|
# query XBZRLE cache size
|
|
|
|
#
|
|
|
|
# Returns: XBZRLE cache size in bytes
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'command': 'query-migrate-cache-size', 'returns': 'int' }
|
|
|
|
|
2011-12-12 21:29:34 +01:00
|
|
|
##
|
2012-03-05 14:13:28 +01:00
|
|
|
# @ObjectPropertyInfo:
|
2011-12-12 21:29:34 +01:00
|
|
|
#
|
|
|
|
# @name: the name of the property
|
|
|
|
#
|
|
|
|
# @type: the type of the property. This will typically come in one of four
|
|
|
|
# forms:
|
|
|
|
#
|
|
|
|
# 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
|
|
|
|
# These types are mapped to the appropriate JSON type.
|
|
|
|
#
|
|
|
|
# 2) A legacy type in the form 'legacy<subtype>' where subtype is the
|
|
|
|
# legacy qdev typename. These types are always treated as strings.
|
|
|
|
#
|
|
|
|
# 3) A child type in the form 'child<subtype>' where subtype is a qdev
|
|
|
|
# device type name. Child properties create the composition tree.
|
|
|
|
#
|
|
|
|
# 4) A link type in the form 'link<subtype>' where subtype is a qdev
|
|
|
|
# device type name. Link properties form the device model graph.
|
|
|
|
#
|
2012-08-10 18:04:10 +02:00
|
|
|
# Since: 1.2
|
2011-12-12 21:29:34 +01:00
|
|
|
##
|
2012-01-30 15:55:55 +01:00
|
|
|
{ 'type': 'ObjectPropertyInfo',
|
2011-12-12 21:29:34 +01:00
|
|
|
'data': { 'name': 'str', 'type': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @qom-list:
|
|
|
|
#
|
2012-01-30 15:55:55 +01:00
|
|
|
# This command will list any properties of a object given a path in the object
|
2011-12-12 21:29:34 +01:00
|
|
|
# model.
|
|
|
|
#
|
2012-01-30 15:55:55 +01:00
|
|
|
# @path: the path within the object model. See @qom-get for a description of
|
2011-12-12 21:29:34 +01:00
|
|
|
# this parameter.
|
|
|
|
#
|
2012-01-30 15:55:55 +01:00
|
|
|
# Returns: a list of @ObjectPropertyInfo that describe the properties of the
|
|
|
|
# object.
|
2011-12-12 21:29:34 +01:00
|
|
|
#
|
2012-08-10 18:04:10 +02:00
|
|
|
# Since: 1.2
|
2011-12-12 21:29:34 +01:00
|
|
|
##
|
|
|
|
{ 'command': 'qom-list',
|
|
|
|
'data': { 'path': 'str' },
|
2012-01-30 15:55:55 +01:00
|
|
|
'returns': [ 'ObjectPropertyInfo' ] }
|
2011-12-12 21:29:35 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @qom-get:
|
|
|
|
#
|
2012-01-30 15:55:55 +01:00
|
|
|
# This command will get a property from a object model path and return the
|
2011-12-12 21:29:35 +01:00
|
|
|
# value.
|
|
|
|
#
|
2012-01-30 15:55:55 +01:00
|
|
|
# @path: The path within the object model. There are two forms of supported
|
2011-12-12 21:29:35 +01:00
|
|
|
# paths--absolute and partial paths.
|
|
|
|
#
|
2012-01-30 15:55:55 +01:00
|
|
|
# Absolute paths are derived from the root object and can follow child<>
|
2011-12-12 21:29:35 +01:00
|
|
|
# or link<> properties. Since they can follow link<> properties, they
|
|
|
|
# can be arbitrarily long. Absolute paths look like absolute filenames
|
|
|
|
# and are prefixed with a leading slash.
|
|
|
|
#
|
|
|
|
# Partial paths look like relative filenames. They do not begin
|
|
|
|
# with a prefix. The matching rules for partial paths are subtle but
|
2012-01-30 15:55:55 +01:00
|
|
|
# designed to make specifying objects easy. At each level of the
|
2011-12-12 21:29:35 +01:00
|
|
|
# composition tree, the partial path is matched as an absolute path.
|
|
|
|
# The first match is not returned. At least two matches are searched
|
|
|
|
# for. A successful result is only returned if only one match is
|
|
|
|
# found. If more than one match is found, a flag is return to
|
|
|
|
# indicate that the match was ambiguous.
|
|
|
|
#
|
|
|
|
# @property: The property name to read
|
|
|
|
#
|
|
|
|
# Returns: The property value. The type depends on the property type. legacy<>
|
|
|
|
# properties are returned as #str. child<> and link<> properties are
|
|
|
|
# returns as #str pathnames. All integer property types (u8, u16, etc)
|
|
|
|
# are returned as #int.
|
|
|
|
#
|
2012-08-10 18:04:10 +02:00
|
|
|
# Since: 1.2
|
2011-12-12 21:29:35 +01:00
|
|
|
##
|
|
|
|
{ 'command': 'qom-get',
|
|
|
|
'data': { 'path': 'str', 'property': 'str' },
|
|
|
|
'returns': 'visitor',
|
|
|
|
'gen': 'no' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @qom-set:
|
|
|
|
#
|
2012-01-30 15:55:55 +01:00
|
|
|
# This command will set a property from a object model path.
|
2011-12-12 21:29:35 +01:00
|
|
|
#
|
|
|
|
# @path: see @qom-get for a description of this parameter
|
|
|
|
#
|
|
|
|
# @property: the property name to set
|
|
|
|
#
|
|
|
|
# @value: a value who's type is appropriate for the property type. See @qom-get
|
|
|
|
# for a description of type mapping.
|
|
|
|
#
|
2012-08-10 18:04:10 +02:00
|
|
|
# Since: 1.2
|
2011-12-12 21:29:35 +01:00
|
|
|
##
|
|
|
|
{ 'command': 'qom-set',
|
|
|
|
'data': { 'path': 'str', 'property': 'str', 'value': 'visitor' },
|
|
|
|
'gen': 'no' }
|
2011-12-07 14:17:51 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @set_password:
|
|
|
|
#
|
|
|
|
# Sets the password of a remote display session.
|
|
|
|
#
|
|
|
|
# @protocol: `vnc' to modify the VNC server password
|
|
|
|
# `spice' to modify the Spice server password
|
|
|
|
#
|
|
|
|
# @password: the new password
|
|
|
|
#
|
|
|
|
# @connected: #optional how to handle existing clients when changing the
|
2012-07-17 16:17:10 +02:00
|
|
|
# password. If nothing is specified, defaults to `keep'
|
2011-12-07 14:17:51 +01:00
|
|
|
# `fail' to fail the command if clients are connected
|
|
|
|
# `disconnect' to disconnect existing clients
|
|
|
|
# `keep' to maintain existing clients
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If Spice is not enabled, DeviceNotFound
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'set_password',
|
|
|
|
'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
|
2011-12-07 14:47:57 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @expire_password:
|
|
|
|
#
|
|
|
|
# Expire the password of a remote display server.
|
|
|
|
#
|
|
|
|
# @protocol: the name of the remote display protocol `vnc' or `spice'
|
|
|
|
#
|
|
|
|
# @time: when to expire the password.
|
|
|
|
# `now' to expire the password immediately
|
|
|
|
# `never' to cancel password expiration
|
|
|
|
# `+INT' where INT is the number of seconds from now (integer)
|
|
|
|
# `INT' where INT is the absolute time in seconds
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If @protocol is `spice' and Spice is not active, DeviceNotFound
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: Time is relative to the server and currently there is no way to
|
|
|
|
# coordinate server time with client time. It is not recommended to
|
|
|
|
# use the absolute time version of the @time parameter unless you're
|
|
|
|
# sure you are on the same machine as the QEMU instance.
|
|
|
|
##
|
|
|
|
{ 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
|
2011-12-07 19:02:36 +01:00
|
|
|
|
2011-12-08 14:45:55 +01:00
|
|
|
##
|
|
|
|
# @change-vnc-password:
|
|
|
|
#
|
|
|
|
# Change the VNC server password.
|
|
|
|
#
|
|
|
|
# @target: the new password to use with VNC authentication
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
#
|
|
|
|
# Notes: An empty password in this command will set the password to the empty
|
|
|
|
# string. Existing clients are unaffected by executing this command.
|
|
|
|
##
|
|
|
|
{ 'command': 'change-vnc-password', 'data': {'password': 'str'} }
|
2011-12-08 14:13:50 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @change:
|
|
|
|
#
|
|
|
|
# This command is multiple commands multiplexed together.
|
|
|
|
#
|
|
|
|
# @device: This is normally the name of a block device but it may also be 'vnc'.
|
|
|
|
# when it's 'vnc', then sub command depends on @target
|
|
|
|
#
|
|
|
|
# @target: If @device is a block device, then this is the new filename.
|
|
|
|
# If @device is 'vnc', then if the value 'password' selects the vnc
|
|
|
|
# change password command. Otherwise, this specifies a new server URI
|
|
|
|
# address to listen to for VNC connections.
|
|
|
|
#
|
|
|
|
# @arg: If @device is a block device, then this is an optional format to open
|
|
|
|
# the device with.
|
|
|
|
# If @device is 'vnc' and @target is 'password', this is the new VNC
|
|
|
|
# password to set. If this argument is an empty string, then no future
|
|
|
|
# logins will be allowed.
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success.
|
|
|
|
# If @device is not a valid block device, DeviceNotFound
|
|
|
|
# If the new block device is encrypted, DeviceEncrypted. Note that
|
|
|
|
# if this error is returned, the device has been opened successfully
|
|
|
|
# and an additional call to @block_passwd is required to set the
|
|
|
|
# device's password. The behavior of reads and writes to the block
|
|
|
|
# device between when these calls are executed is undefined.
|
|
|
|
#
|
|
|
|
# Notes: It is strongly recommended that this interface is not used especially
|
|
|
|
# for changing block devices.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'change',
|
|
|
|
'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
|
2011-12-14 19:49:14 +01:00
|
|
|
|
2011-12-22 21:40:54 +01:00
|
|
|
##
|
|
|
|
# @ObjectTypeInfo:
|
|
|
|
#
|
|
|
|
# This structure describes a search result from @qom-list-types
|
|
|
|
#
|
|
|
|
# @name: the type name found in the search
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
#
|
|
|
|
# Notes: This command is experimental and may change syntax in future releases.
|
|
|
|
##
|
|
|
|
{ 'type': 'ObjectTypeInfo',
|
|
|
|
'data': { 'name': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @qom-list-types:
|
|
|
|
#
|
|
|
|
# This command will return a list of types given search parameters
|
|
|
|
#
|
|
|
|
# @implements: if specified, only return types that implement this type name
|
|
|
|
#
|
|
|
|
# @abstract: if true, include abstract types in the results
|
|
|
|
#
|
|
|
|
# Returns: a list of @ObjectTypeInfo or an empty list if no results are found
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
##
|
|
|
|
{ 'command': 'qom-list-types',
|
|
|
|
'data': { '*implements': 'str', '*abstract': 'bool' },
|
|
|
|
'returns': [ 'ObjectTypeInfo' ] }
|
2011-12-05 17:48:01 +01:00
|
|
|
|
2012-08-10 18:04:09 +02:00
|
|
|
##
|
|
|
|
# @DevicePropertyInfo:
|
|
|
|
#
|
|
|
|
# Information about device properties.
|
|
|
|
#
|
|
|
|
# @name: the name of the property
|
|
|
|
# @type: the typename of the property
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'DevicePropertyInfo',
|
|
|
|
'data': { 'name': 'str', 'type': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @device-list-properties:
|
|
|
|
#
|
|
|
|
# List properties associated with a device.
|
|
|
|
#
|
|
|
|
# @typename: the type name of a device
|
|
|
|
#
|
|
|
|
# Returns: a list of DevicePropertyInfo describing a devices properties
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'command': 'device-list-properties',
|
|
|
|
'data': { 'typename': 'str'},
|
|
|
|
'returns': [ 'DevicePropertyInfo' ] }
|
|
|
|
|
2011-12-05 17:48:01 +01:00
|
|
|
##
|
|
|
|
# @migrate
|
|
|
|
#
|
|
|
|
# Migrates the current running guest to another Virtual Machine.
|
|
|
|
#
|
|
|
|
# @uri: the Uniform Resource Identifier of the destination VM
|
|
|
|
#
|
|
|
|
# @blk: #optional do block migration (full disk copy)
|
|
|
|
#
|
|
|
|
# @inc: #optional incremental disk copy migration
|
|
|
|
#
|
|
|
|
# @detach: this argument exists only for compatibility reasons and
|
|
|
|
# is ignored by QEMU
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate',
|
|
|
|
'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
|
2012-03-19 19:39:42 +01:00
|
|
|
|
2012-01-25 13:24:51 +01:00
|
|
|
# @xen-save-devices-state:
|
|
|
|
#
|
|
|
|
# Save the state of all devices to file. The RAM and the block devices
|
|
|
|
# of the VM are not saved by this command.
|
|
|
|
#
|
|
|
|
# @filename: the file to save the state of the devices to as binary
|
|
|
|
# data. See xen-save-devices-state.txt for a description of the binary
|
|
|
|
# format.
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
##
|
|
|
|
{ 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
|
2012-03-29 17:38:50 +02:00
|
|
|
|
2012-10-03 15:48:19 +02:00
|
|
|
##
|
|
|
|
# @xen-set-global-dirty-log
|
|
|
|
#
|
|
|
|
# Enable or disable the global dirty log mode.
|
|
|
|
#
|
|
|
|
# @enable: true to enable, false to disable.
|
|
|
|
#
|
|
|
|
# Returns: nothing
|
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
##
|
|
|
|
{ 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
|
|
|
|
|
2012-03-29 17:38:50 +02:00
|
|
|
##
|
|
|
|
# @device_del:
|
|
|
|
#
|
|
|
|
# Remove a device from a guest
|
|
|
|
#
|
|
|
|
# @id: the name of the device
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If @id is not a valid device, DeviceNotFound
|
|
|
|
#
|
|
|
|
# Notes: When this command completes, the device may not be removed from the
|
|
|
|
# guest. Hot removal is an operation that requires guest cooperation.
|
|
|
|
# This command merely requests that the guest begin the hot removal
|
2013-03-06 13:58:59 +01:00
|
|
|
# process. Completion of the device removal process is signaled with a
|
|
|
|
# DEVICE_DELETED event. Guest reset will automatically complete removal
|
|
|
|
# for all devices.
|
2012-03-29 17:38:50 +02:00
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'device_del', 'data': {'id': 'str'} }
|
2012-05-07 06:10:47 +02:00
|
|
|
|
2014-02-18 07:11:36 +01:00
|
|
|
##
|
|
|
|
# @DumpGuestMemoryFormat:
|
|
|
|
#
|
|
|
|
# An enumeration of guest-memory-dump's format.
|
|
|
|
#
|
|
|
|
# @elf: elf format
|
|
|
|
#
|
|
|
|
# @kdump-zlib: kdump-compressed format with zlib-compressed
|
|
|
|
#
|
|
|
|
# @kdump-lzo: kdump-compressed format with lzo-compressed
|
|
|
|
#
|
|
|
|
# @kdump-snappy: kdump-compressed format with snappy-compressed
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'DumpGuestMemoryFormat',
|
|
|
|
'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
|
|
|
|
|
2012-05-07 06:10:47 +02:00
|
|
|
##
|
|
|
|
# @dump-guest-memory
|
|
|
|
#
|
|
|
|
# Dump guest's memory to vmcore. It is a synchronous operation that can take
|
|
|
|
# very long depending on the amount of guest memory. This command is only
|
2012-06-28 16:59:15 +02:00
|
|
|
# supported on i386 and x86_64.
|
|
|
|
#
|
|
|
|
# @paging: if true, do paging to get guest's memory mapping. This allows
|
2012-09-21 18:10:58 +02:00
|
|
|
# using gdb to process the core file.
|
2012-06-28 16:59:15 +02:00
|
|
|
#
|
2012-09-21 18:10:58 +02:00
|
|
|
# IMPORTANT: this option can make QEMU allocate several gigabytes
|
|
|
|
# of RAM. This can happen for a large guest, or a
|
|
|
|
# malicious guest pretending to be large.
|
|
|
|
#
|
|
|
|
# Also, paging=true has the following limitations:
|
|
|
|
#
|
|
|
|
# 1. The guest may be in a catastrophic state or can have corrupted
|
|
|
|
# memory, which cannot be trusted
|
|
|
|
# 2. The guest can be in real-mode even if paging is enabled. For
|
|
|
|
# example, the guest uses ACPI to sleep, and ACPI sleep state
|
|
|
|
# goes in real-mode
|
2012-06-28 16:59:15 +02:00
|
|
|
#
|
2012-05-07 06:10:47 +02:00
|
|
|
# @protocol: the filename or file descriptor of the vmcore. The supported
|
2012-09-21 18:10:58 +02:00
|
|
|
# protocols are:
|
2012-06-28 16:59:15 +02:00
|
|
|
#
|
2012-09-21 18:10:58 +02:00
|
|
|
# 1. file: the protocol starts with "file:", and the following
|
|
|
|
# string is the file's path.
|
|
|
|
# 2. fd: the protocol starts with "fd:", and the following string
|
|
|
|
# is the fd's name.
|
2012-06-28 16:59:15 +02:00
|
|
|
#
|
2012-05-07 06:10:47 +02:00
|
|
|
# @begin: #optional if specified, the starting physical address.
|
2012-06-28 16:59:15 +02:00
|
|
|
#
|
2012-05-07 06:10:47 +02:00
|
|
|
# @length: #optional if specified, the memory size, in bytes. If you don't
|
2012-09-21 18:10:58 +02:00
|
|
|
# want to dump all guest's memory, please specify the start @begin
|
|
|
|
# and @length
|
2012-05-07 06:10:47 +02:00
|
|
|
#
|
2014-02-18 07:11:36 +01:00
|
|
|
# @format: #optional if specified, the format of guest memory dump. But non-elf
|
|
|
|
# format is conflict with paging and filter, ie. @paging, @begin and
|
|
|
|
# @length is not allowed to be specified with non-elf @format at the
|
|
|
|
# same time (since 2.0)
|
|
|
|
#
|
2012-05-07 06:10:47 +02:00
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'command': 'dump-guest-memory',
|
|
|
|
'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
|
2014-02-18 07:11:36 +01:00
|
|
|
'*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
|
2012-09-21 18:10:58 +02:00
|
|
|
|
2014-02-18 07:11:38 +01:00
|
|
|
##
|
|
|
|
# @DumpGuestMemoryCapability:
|
|
|
|
#
|
|
|
|
# A list of the available formats for dump-guest-memory
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'DumpGuestMemoryCapability',
|
|
|
|
'data': {
|
|
|
|
'formats': ['DumpGuestMemoryFormat'] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-dump-guest-memory-capability:
|
|
|
|
#
|
|
|
|
# Returns the available formats for dump-guest-memory
|
|
|
|
#
|
|
|
|
# Returns: A @DumpGuestMemoryCapability object listing available formats for
|
|
|
|
# dump-guest-memory
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-dump-guest-memory-capability',
|
|
|
|
'returns': 'DumpGuestMemoryCapability' }
|
2012-09-21 18:10:58 +02:00
|
|
|
|
2012-04-18 22:34:15 +02:00
|
|
|
##
|
|
|
|
# @netdev_add:
|
|
|
|
#
|
|
|
|
# Add a network backend.
|
|
|
|
#
|
|
|
|
# @type: the type of network backend. Current valid values are 'user', 'tap',
|
|
|
|
# 'vde', 'socket', 'dump' and 'bridge'
|
|
|
|
#
|
|
|
|
# @id: the name of the new network backend
|
|
|
|
#
|
|
|
|
# @props: #optional a list of properties to be passed to the backend in
|
|
|
|
# the format 'name=value', like 'ifname=tap0,script=no'
|
|
|
|
#
|
|
|
|
# Notes: The semantics of @props is not well defined. Future commands will be
|
|
|
|
# introduced that provide stronger typing for backend creation.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If @type is not a valid network backend, DeviceNotFound
|
|
|
|
##
|
|
|
|
{ 'command': 'netdev_add',
|
|
|
|
'data': {'type': 'str', 'id': 'str', '*props': '**'},
|
|
|
|
'gen': 'no' }
|
2012-04-16 19:36:32 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @netdev_del:
|
|
|
|
#
|
|
|
|
# Remove a network backend.
|
|
|
|
#
|
|
|
|
# @id: the name of the network backend to remove
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If @id is not a valid network backend, DeviceNotFound
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'netdev_del', 'data': {'id': 'str'} }
|
2012-06-22 20:36:09 +02:00
|
|
|
|
2013-12-20 23:21:10 +01:00
|
|
|
##
|
|
|
|
# @object-add:
|
|
|
|
#
|
|
|
|
# Create a QOM object.
|
|
|
|
#
|
|
|
|
# @qom-type: the class name for the object to be created
|
|
|
|
#
|
|
|
|
# @id: the name of the new object
|
|
|
|
#
|
|
|
|
# @props: #optional a dictionary of properties to be passed to the backend
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# Error if @qom-type is not a valid class name
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'object-add',
|
|
|
|
'data': {'qom-type': 'str', 'id': 'str', '*props': 'dict'},
|
|
|
|
'gen': 'no' }
|
|
|
|
|
2013-12-20 23:21:09 +01:00
|
|
|
##
|
|
|
|
# @object-del:
|
|
|
|
#
|
|
|
|
# Remove a QOM object.
|
|
|
|
#
|
|
|
|
# @id: the name of the QOM object to remove
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# Error if @id is not a valid id for a QOM object
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'object-del', 'data': {'id': 'str'} }
|
|
|
|
|
2012-07-17 16:17:11 +02:00
|
|
|
##
|
|
|
|
# @NetdevNoneOptions
|
|
|
|
#
|
|
|
|
# Use it alone to have zero network devices.
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevNoneOptions',
|
|
|
|
'data': { } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @NetLegacyNicOptions
|
|
|
|
#
|
|
|
|
# Create a new Network Interface Card.
|
|
|
|
#
|
|
|
|
# @netdev: #optional id of -netdev to connect to
|
|
|
|
#
|
|
|
|
# @macaddr: #optional MAC address
|
|
|
|
#
|
|
|
|
# @model: #optional device model (e1000, rtl8139, virtio etc.)
|
|
|
|
#
|
|
|
|
# @addr: #optional PCI device address
|
|
|
|
#
|
|
|
|
# @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetLegacyNicOptions',
|
|
|
|
'data': {
|
|
|
|
'*netdev': 'str',
|
|
|
|
'*macaddr': 'str',
|
|
|
|
'*model': 'str',
|
|
|
|
'*addr': 'str',
|
|
|
|
'*vectors': 'uint32' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @String
|
|
|
|
#
|
|
|
|
# A fat type wrapping 'str', to be embedded in lists.
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'String',
|
|
|
|
'data': {
|
|
|
|
'str': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @NetdevUserOptions
|
|
|
|
#
|
|
|
|
# Use the user mode network stack which requires no administrator privilege to
|
|
|
|
# run.
|
|
|
|
#
|
|
|
|
# @hostname: #optional client hostname reported by the builtin DHCP server
|
|
|
|
#
|
|
|
|
# @restrict: #optional isolate the guest from the host
|
|
|
|
#
|
|
|
|
# @ip: #optional legacy parameter, use net= instead
|
|
|
|
#
|
|
|
|
# @net: #optional IP address and optional netmask
|
|
|
|
#
|
|
|
|
# @host: #optional guest-visible address of the host
|
|
|
|
#
|
|
|
|
# @tftp: #optional root directory of the built-in TFTP server
|
|
|
|
#
|
|
|
|
# @bootfile: #optional BOOTP filename, for use with tftp=
|
|
|
|
#
|
|
|
|
# @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
|
|
|
|
# assign
|
|
|
|
#
|
|
|
|
# @dns: #optional guest-visible address of the virtual nameserver
|
|
|
|
#
|
2012-10-27 19:53:39 +02:00
|
|
|
# @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
|
|
|
|
# to the guest
|
|
|
|
#
|
2012-07-17 16:17:11 +02:00
|
|
|
# @smb: #optional root directory of the built-in SMB server
|
|
|
|
#
|
|
|
|
# @smbserver: #optional IP address of the built-in SMB server
|
|
|
|
#
|
|
|
|
# @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
|
|
|
|
# endpoints
|
|
|
|
#
|
|
|
|
# @guestfwd: #optional forward guest TCP connections
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevUserOptions',
|
|
|
|
'data': {
|
|
|
|
'*hostname': 'str',
|
|
|
|
'*restrict': 'bool',
|
|
|
|
'*ip': 'str',
|
|
|
|
'*net': 'str',
|
|
|
|
'*host': 'str',
|
|
|
|
'*tftp': 'str',
|
|
|
|
'*bootfile': 'str',
|
|
|
|
'*dhcpstart': 'str',
|
|
|
|
'*dns': 'str',
|
2012-10-27 19:53:39 +02:00
|
|
|
'*dnssearch': ['String'],
|
2012-07-17 16:17:11 +02:00
|
|
|
'*smb': 'str',
|
|
|
|
'*smbserver': 'str',
|
|
|
|
'*hostfwd': ['String'],
|
|
|
|
'*guestfwd': ['String'] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @NetdevTapOptions
|
|
|
|
#
|
|
|
|
# Connect the host TAP network interface name to the VLAN.
|
|
|
|
#
|
|
|
|
# @ifname: #optional interface name
|
|
|
|
#
|
|
|
|
# @fd: #optional file descriptor of an already opened tap
|
|
|
|
#
|
2013-02-20 11:04:01 +01:00
|
|
|
# @fds: #optional multiple file descriptors of already opened multiqueue capable
|
|
|
|
# tap
|
|
|
|
#
|
2012-07-17 16:17:11 +02:00
|
|
|
# @script: #optional script to initialize the interface
|
|
|
|
#
|
|
|
|
# @downscript: #optional script to shut down the interface
|
|
|
|
#
|
|
|
|
# @helper: #optional command to execute to configure bridge
|
|
|
|
#
|
|
|
|
# @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
|
|
|
|
#
|
|
|
|
# @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
|
|
|
|
#
|
|
|
|
# @vhost: #optional enable vhost-net network accelerator
|
|
|
|
#
|
|
|
|
# @vhostfd: #optional file descriptor of an already opened vhost net device
|
|
|
|
#
|
2013-02-20 11:04:01 +01:00
|
|
|
# @vhostfds: #optional file descriptors of multiple already opened vhost net
|
|
|
|
# devices
|
|
|
|
#
|
2012-07-17 16:17:11 +02:00
|
|
|
# @vhostforce: #optional vhost on for non-MSIX virtio guests
|
|
|
|
#
|
2013-02-22 15:57:52 +01:00
|
|
|
# @queues: #optional number of queues to be created for multiqueue capable tap
|
|
|
|
#
|
2012-07-17 16:17:11 +02:00
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevTapOptions',
|
|
|
|
'data': {
|
|
|
|
'*ifname': 'str',
|
|
|
|
'*fd': 'str',
|
2013-01-30 12:12:34 +01:00
|
|
|
'*fds': 'str',
|
2012-07-17 16:17:11 +02:00
|
|
|
'*script': 'str',
|
|
|
|
'*downscript': 'str',
|
|
|
|
'*helper': 'str',
|
|
|
|
'*sndbuf': 'size',
|
|
|
|
'*vnet_hdr': 'bool',
|
|
|
|
'*vhost': 'bool',
|
|
|
|
'*vhostfd': 'str',
|
2013-01-30 12:12:34 +01:00
|
|
|
'*vhostfds': 'str',
|
|
|
|
'*vhostforce': 'bool',
|
|
|
|
'*queues': 'uint32'} }
|
2012-07-17 16:17:11 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @NetdevSocketOptions
|
|
|
|
#
|
|
|
|
# Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
|
|
|
|
# socket connection.
|
|
|
|
#
|
|
|
|
# @fd: #optional file descriptor of an already opened socket
|
|
|
|
#
|
|
|
|
# @listen: #optional port number, and optional hostname, to listen on
|
|
|
|
#
|
|
|
|
# @connect: #optional port number, and optional hostname, to connect to
|
|
|
|
#
|
|
|
|
# @mcast: #optional UDP multicast address and port number
|
|
|
|
#
|
|
|
|
# @localaddr: #optional source address and port for multicast and udp packets
|
|
|
|
#
|
|
|
|
# @udp: #optional UDP unicast address and port number
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevSocketOptions',
|
|
|
|
'data': {
|
|
|
|
'*fd': 'str',
|
|
|
|
'*listen': 'str',
|
|
|
|
'*connect': 'str',
|
|
|
|
'*mcast': 'str',
|
|
|
|
'*localaddr': 'str',
|
|
|
|
'*udp': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @NetdevVdeOptions
|
|
|
|
#
|
|
|
|
# Connect the VLAN to a vde switch running on the host.
|
|
|
|
#
|
|
|
|
# @sock: #optional socket path
|
|
|
|
#
|
|
|
|
# @port: #optional port number
|
|
|
|
#
|
|
|
|
# @group: #optional group owner of socket
|
|
|
|
#
|
|
|
|
# @mode: #optional permissions for socket
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevVdeOptions',
|
|
|
|
'data': {
|
|
|
|
'*sock': 'str',
|
|
|
|
'*port': 'uint16',
|
|
|
|
'*group': 'str',
|
|
|
|
'*mode': 'uint16' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @NetdevDumpOptions
|
|
|
|
#
|
|
|
|
# Dump VLAN network traffic to a file.
|
|
|
|
#
|
|
|
|
# @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
|
|
|
|
# suffixes.
|
|
|
|
#
|
|
|
|
# @file: #optional dump file path (default is qemu-vlan0.pcap)
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevDumpOptions',
|
|
|
|
'data': {
|
|
|
|
'*len': 'size',
|
|
|
|
'*file': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @NetdevBridgeOptions
|
|
|
|
#
|
|
|
|
# Connect a host TAP network interface to a host bridge device.
|
|
|
|
#
|
|
|
|
# @br: #optional bridge name
|
|
|
|
#
|
|
|
|
# @helper: #optional command to execute to configure bridge
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevBridgeOptions',
|
|
|
|
'data': {
|
|
|
|
'*br': 'str',
|
|
|
|
'*helper': 'str' } }
|
|
|
|
|
2012-07-24 17:35:04 +02:00
|
|
|
##
|
|
|
|
# @NetdevHubPortOptions
|
|
|
|
#
|
|
|
|
# Connect two or more net clients through a software hub.
|
|
|
|
#
|
|
|
|
# @hubid: hub identifier number
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevHubPortOptions',
|
|
|
|
'data': {
|
|
|
|
'hubid': 'int32' } }
|
|
|
|
|
2013-11-06 11:44:06 +01:00
|
|
|
##
|
|
|
|
# @NetdevNetmapOptions
|
|
|
|
#
|
|
|
|
# Connect a client to a netmap-enabled NIC or to a VALE switch port
|
|
|
|
#
|
|
|
|
# @ifname: Either the name of an existing network interface supported by
|
|
|
|
# netmap, or the name of a VALE port (created on the fly).
|
|
|
|
# A VALE port name is in the form 'valeXXX:YYY', where XXX and
|
|
|
|
# YYY are non-negative integers. XXX identifies a switch and
|
|
|
|
# YYY identifies a port of the switch. VALE ports having the
|
|
|
|
# same XXX are therefore connected to the same switch.
|
|
|
|
#
|
|
|
|
# @devname: #optional path of the netmap device (default: '/dev/netmap').
|
|
|
|
#
|
2013-12-11 09:49:14 +01:00
|
|
|
# Since 2.0
|
2013-11-06 11:44:06 +01:00
|
|
|
##
|
|
|
|
{ 'type': 'NetdevNetmapOptions',
|
|
|
|
'data': {
|
|
|
|
'ifname': 'str',
|
|
|
|
'*devname': 'str' } }
|
|
|
|
|
2014-06-10 12:02:16 +02:00
|
|
|
##
|
|
|
|
# @NetdevVhostUserOptions
|
|
|
|
#
|
|
|
|
# Vhost-user network backend
|
|
|
|
#
|
|
|
|
# @chardev: name of a unix socket chardev
|
|
|
|
#
|
|
|
|
# @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
|
|
|
|
#
|
|
|
|
# Since 2.1
|
|
|
|
##
|
|
|
|
{ 'type': 'NetdevVhostUserOptions',
|
|
|
|
'data': {
|
|
|
|
'chardev': 'str',
|
|
|
|
'*vhostforce': 'bool' } }
|
|
|
|
|
2012-07-17 16:17:11 +02:00
|
|
|
##
|
|
|
|
# @NetClientOptions
|
|
|
|
#
|
|
|
|
# A discriminated record of network device traits.
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'union': 'NetClientOptions',
|
|
|
|
'data': {
|
2012-07-24 17:35:04 +02:00
|
|
|
'none': 'NetdevNoneOptions',
|
|
|
|
'nic': 'NetLegacyNicOptions',
|
|
|
|
'user': 'NetdevUserOptions',
|
|
|
|
'tap': 'NetdevTapOptions',
|
|
|
|
'socket': 'NetdevSocketOptions',
|
|
|
|
'vde': 'NetdevVdeOptions',
|
|
|
|
'dump': 'NetdevDumpOptions',
|
|
|
|
'bridge': 'NetdevBridgeOptions',
|
2013-11-06 11:44:06 +01:00
|
|
|
'hubport': 'NetdevHubPortOptions',
|
2014-06-10 12:02:16 +02:00
|
|
|
'netmap': 'NetdevNetmapOptions',
|
|
|
|
'vhost-user': 'NetdevVhostUserOptions' } }
|
2012-07-17 16:17:11 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @NetLegacy
|
|
|
|
#
|
|
|
|
# Captures the configuration of a network device; legacy.
|
|
|
|
#
|
|
|
|
# @vlan: #optional vlan number
|
|
|
|
#
|
|
|
|
# @id: #optional identifier for monitor commands
|
|
|
|
#
|
|
|
|
# @name: #optional identifier for monitor commands, ignored if @id is present
|
|
|
|
#
|
|
|
|
# @opts: device type specific properties (legacy)
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'NetLegacy',
|
|
|
|
'data': {
|
|
|
|
'*vlan': 'int32',
|
|
|
|
'*id': 'str',
|
|
|
|
'*name': 'str',
|
|
|
|
'opts': 'NetClientOptions' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @Netdev
|
|
|
|
#
|
|
|
|
# Captures the configuration of a network device.
|
|
|
|
#
|
|
|
|
# @id: identifier for monitor commands.
|
|
|
|
#
|
|
|
|
# @opts: device type specific properties
|
|
|
|
#
|
|
|
|
# Since 1.2
|
|
|
|
##
|
|
|
|
{ 'type': 'Netdev',
|
|
|
|
'data': {
|
|
|
|
'id': 'str',
|
|
|
|
'opts': 'NetClientOptions' } }
|
|
|
|
|
2012-09-19 14:03:35 +02:00
|
|
|
##
|
|
|
|
# @InetSocketAddress
|
|
|
|
#
|
|
|
|
# Captures a socket address or address range in the Internet namespace.
|
|
|
|
#
|
|
|
|
# @host: host part of the address
|
|
|
|
#
|
|
|
|
# @port: port part of the address, or lowest port if @to is present
|
|
|
|
#
|
|
|
|
# @to: highest port to try
|
|
|
|
#
|
|
|
|
# @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
|
|
|
|
# #optional
|
|
|
|
#
|
|
|
|
# @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
|
|
|
|
# #optional
|
|
|
|
#
|
|
|
|
# Since 1.3
|
|
|
|
##
|
|
|
|
{ 'type': 'InetSocketAddress',
|
|
|
|
'data': {
|
|
|
|
'host': 'str',
|
|
|
|
'port': 'str',
|
|
|
|
'*to': 'uint16',
|
|
|
|
'*ipv4': 'bool',
|
|
|
|
'*ipv6': 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @UnixSocketAddress
|
|
|
|
#
|
|
|
|
# Captures a socket address in the local ("Unix socket") namespace.
|
|
|
|
#
|
|
|
|
# @path: filesystem path to use
|
|
|
|
#
|
|
|
|
# Since 1.3
|
|
|
|
##
|
|
|
|
{ 'type': 'UnixSocketAddress',
|
|
|
|
'data': {
|
|
|
|
'path': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @SocketAddress
|
|
|
|
#
|
|
|
|
# Captures the address of a socket, which could also be a named file descriptor
|
|
|
|
#
|
|
|
|
# Since 1.3
|
|
|
|
##
|
|
|
|
{ 'union': 'SocketAddress',
|
|
|
|
'data': {
|
|
|
|
'inet': 'InetSocketAddress',
|
|
|
|
'unix': 'UnixSocketAddress',
|
|
|
|
'fd': 'String' } }
|
|
|
|
|
2012-06-22 20:36:09 +02:00
|
|
|
##
|
|
|
|
# @getfd:
|
|
|
|
#
|
|
|
|
# Receive a file descriptor via SCM rights and assign it a name
|
|
|
|
#
|
|
|
|
# @fdname: file descriptor name
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
# Notes: If @fdname already exists, the file descriptor assigned to
|
|
|
|
# it will be closed and replaced by the received file
|
|
|
|
# descriptor.
|
|
|
|
# The 'closefd' command can be used to explicitly close the
|
|
|
|
# file descriptor when it is no longer needed.
|
|
|
|
##
|
|
|
|
{ 'command': 'getfd', 'data': {'fdname': 'str'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @closefd:
|
|
|
|
#
|
|
|
|
# Close a file descriptor previously passed via SCM rights
|
|
|
|
#
|
|
|
|
# @fdname: file descriptor name
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'closefd', 'data': {'fdname': 'str'} }
|
2012-08-10 18:04:11 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @MachineInfo:
|
|
|
|
#
|
|
|
|
# Information describing a machine.
|
|
|
|
#
|
|
|
|
# @name: the name of the machine
|
|
|
|
#
|
|
|
|
# @alias: #optional an alias for the machine name
|
|
|
|
#
|
|
|
|
# @default: #optional whether the machine is default
|
|
|
|
#
|
2013-04-08 18:21:02 +02:00
|
|
|
# @cpu-max: maximum number of CPUs supported by the machine type
|
|
|
|
# (since 1.5.0)
|
|
|
|
#
|
2012-08-10 18:04:11 +02:00
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'MachineInfo',
|
|
|
|
'data': { 'name': 'str', '*alias': 'str',
|
2013-04-08 18:21:02 +02:00
|
|
|
'*is-default': 'bool', 'cpu-max': 'int' } }
|
2012-08-10 18:04:11 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-machines:
|
|
|
|
#
|
|
|
|
# Return a list of supported machines
|
|
|
|
#
|
|
|
|
# Returns: a list of MachineInfo
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-machines', 'returns': ['MachineInfo'] }
|
2012-08-10 18:04:13 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @CpuDefinitionInfo:
|
|
|
|
#
|
|
|
|
# Virtual CPU definition.
|
|
|
|
#
|
|
|
|
# @name: the name of the CPU definition
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'CpuDefinitionInfo',
|
|
|
|
'data': { 'name': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-cpu-definitions:
|
|
|
|
#
|
|
|
|
# Return a list of supported virtual CPU definitions
|
|
|
|
#
|
|
|
|
# Returns: a list of CpuDefInfo
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
|
2012-08-14 22:43:43 +02:00
|
|
|
|
|
|
|
# @AddfdInfo:
|
|
|
|
#
|
|
|
|
# Information about a file descriptor that was added to an fd set.
|
|
|
|
#
|
|
|
|
# @fdset-id: The ID of the fd set that @fd was added to.
|
|
|
|
#
|
|
|
|
# @fd: The file descriptor that was received via SCM rights and
|
|
|
|
# added to the fd set.
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @add-fd:
|
|
|
|
#
|
|
|
|
# Add a file descriptor, that was passed via SCM rights, to an fd set.
|
|
|
|
#
|
|
|
|
# @fdset-id: #optional The ID of the fd set to add the file descriptor to.
|
|
|
|
#
|
|
|
|
# @opaque: #optional A free-form string that can be used to describe the fd.
|
|
|
|
#
|
|
|
|
# Returns: @AddfdInfo on success
|
|
|
|
# If file descriptor was not received, FdNotSupplied
|
2012-10-18 21:19:31 +02:00
|
|
|
# If @fdset-id is a negative value, InvalidParameterValue
|
2012-08-14 22:43:43 +02:00
|
|
|
#
|
|
|
|
# Notes: The list of fd sets is shared by all monitor connections.
|
|
|
|
#
|
|
|
|
# If @fdset-id is not specified, a new fd set will be created.
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
|
|
|
|
'returns': 'AddfdInfo' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @remove-fd:
|
|
|
|
#
|
|
|
|
# Remove a file descriptor from an fd set.
|
|
|
|
#
|
|
|
|
# @fdset-id: The ID of the fd set that the file descriptor belongs to.
|
|
|
|
#
|
|
|
|
# @fd: #optional The file descriptor that is to be removed.
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If @fdset-id or @fd is not found, FdNotFound
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
#
|
|
|
|
# Notes: The list of fd sets is shared by all monitor connections.
|
|
|
|
#
|
|
|
|
# If @fd is not specified, all file descriptors in @fdset-id
|
|
|
|
# will be removed.
|
|
|
|
##
|
|
|
|
{ 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @FdsetFdInfo:
|
|
|
|
#
|
|
|
|
# Information about a file descriptor that belongs to an fd set.
|
|
|
|
#
|
|
|
|
# @fd: The file descriptor value.
|
|
|
|
#
|
|
|
|
# @opaque: #optional A free-form string that can be used to describe the fd.
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'FdsetFdInfo',
|
|
|
|
'data': {'fd': 'int', '*opaque': 'str'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @FdsetInfo:
|
|
|
|
#
|
|
|
|
# Information about an fd set.
|
|
|
|
#
|
|
|
|
# @fdset-id: The ID of the fd set.
|
|
|
|
#
|
|
|
|
# @fds: A list of file descriptors that belong to this fd set.
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'FdsetInfo',
|
|
|
|
'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-fdsets:
|
|
|
|
#
|
|
|
|
# Return information describing all fd sets.
|
|
|
|
#
|
|
|
|
# Returns: A list of @FdsetInfo
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
#
|
|
|
|
# Note: The list of fd sets is shared by all monitor connections.
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
|
2012-08-20 16:31:38 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @TargetInfo:
|
|
|
|
#
|
|
|
|
# Information describing the QEMU target.
|
|
|
|
#
|
|
|
|
# @arch: the target architecture (eg "x86_64", "i386", etc)
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'type': 'TargetInfo',
|
2013-06-04 14:45:28 +02:00
|
|
|
'data': { 'arch': 'str' } }
|
2012-08-20 16:31:38 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-target:
|
|
|
|
#
|
|
|
|
# Return information about the target for this QEMU
|
|
|
|
#
|
|
|
|
# Returns: TargetInfo
|
|
|
|
#
|
|
|
|
# Since: 1.2.0
|
|
|
|
##
|
|
|
|
{ 'command': 'query-target', 'returns': 'TargetInfo' }
|
2012-08-31 04:56:24 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @QKeyCode:
|
|
|
|
#
|
|
|
|
# An enumeration of key name.
|
|
|
|
#
|
|
|
|
# This is used by the send-key command.
|
|
|
|
#
|
|
|
|
# Since: 1.3.0
|
2013-12-13 12:10:14 +01:00
|
|
|
#
|
2013-12-16 10:34:53 +01:00
|
|
|
# 'unmapped' and 'pause' since 2.0
|
2012-08-31 04:56:24 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'QKeyCode',
|
2013-12-13 12:10:14 +01:00
|
|
|
'data': [ 'unmapped',
|
|
|
|
'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
|
2012-08-31 04:56:24 +02:00
|
|
|
'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
|
|
|
|
'9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
|
|
|
|
'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
|
|
|
|
'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
|
|
|
|
'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
|
|
|
|
'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
|
|
|
|
'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
|
|
|
|
'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
|
|
|
|
'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
|
|
|
|
'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
|
|
|
|
'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
|
|
|
|
'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
|
|
|
|
'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
|
2013-12-16 10:34:53 +01:00
|
|
|
'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause' ] }
|
2012-08-31 04:56:26 +02:00
|
|
|
|
2012-09-20 19:19:47 +02:00
|
|
|
##
|
|
|
|
# @KeyValue
|
|
|
|
#
|
|
|
|
# Represents a keyboard key.
|
|
|
|
#
|
|
|
|
# Since: 1.3.0
|
|
|
|
##
|
|
|
|
{ 'union': 'KeyValue',
|
|
|
|
'data': {
|
|
|
|
'number': 'int',
|
|
|
|
'qcode': 'QKeyCode' } }
|
|
|
|
|
2012-08-31 04:56:26 +02:00
|
|
|
##
|
|
|
|
# @send-key:
|
|
|
|
#
|
|
|
|
# Send keys to guest.
|
|
|
|
#
|
2012-09-20 19:19:47 +02:00
|
|
|
# @keys: An array of @KeyValue elements. All @KeyValues in this array are
|
|
|
|
# simultaneously sent to the guest. A @KeyValue.number value is sent
|
|
|
|
# directly to the guest, while @KeyValue.qcode must be a valid
|
|
|
|
# @QKeyCode value
|
2012-08-31 04:56:26 +02:00
|
|
|
#
|
|
|
|
# @hold-time: #optional time to delay key up events, milliseconds. Defaults
|
|
|
|
# to 100
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
# If key is unknown or redundant, InvalidParameter
|
|
|
|
#
|
|
|
|
# Since: 1.3.0
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'send-key',
|
2012-09-20 19:19:47 +02:00
|
|
|
'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
|
2012-05-24 18:48:23 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @screendump:
|
|
|
|
#
|
|
|
|
# Write a PPM of the VGA screen to a file.
|
|
|
|
#
|
|
|
|
# @filename: the path of a new PPM file to store the image
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
|
|
|
{ 'command': 'screendump', 'data': {'filename': 'str'} }
|
2012-08-22 16:43:07 +02:00
|
|
|
|
2012-12-19 13:13:57 +01:00
|
|
|
##
|
|
|
|
# @ChardevFile:
|
|
|
|
#
|
|
|
|
# Configuration info for file chardevs.
|
|
|
|
#
|
|
|
|
# @in: #optional The name of the input file
|
|
|
|
# @out: The name of the output file
|
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevFile', 'data': { '*in' : 'str',
|
|
|
|
'out' : 'str' } }
|
|
|
|
|
2012-12-19 13:50:29 +01:00
|
|
|
##
|
2013-02-13 15:54:16 +01:00
|
|
|
# @ChardevHostdev:
|
2012-12-19 13:50:29 +01:00
|
|
|
#
|
2013-02-25 11:50:55 +01:00
|
|
|
# Configuration info for device and pipe chardevs.
|
2012-12-19 13:50:29 +01:00
|
|
|
#
|
|
|
|
# @device: The name of the special file for the device,
|
|
|
|
# i.e. /dev/ttyS0 on Unix or COM1: on Windows
|
|
|
|
# @type: What kind of device this is.
|
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
2013-02-13 15:54:16 +01:00
|
|
|
{ 'type': 'ChardevHostdev', 'data': { 'device' : 'str' } }
|
2012-12-19 13:50:29 +01:00
|
|
|
|
2012-12-20 13:53:12 +01:00
|
|
|
##
|
|
|
|
# @ChardevSocket:
|
|
|
|
#
|
2013-02-27 14:10:47 +01:00
|
|
|
# Configuration info for (stream) socket chardevs.
|
2012-12-20 13:53:12 +01:00
|
|
|
#
|
|
|
|
# @addr: socket address to listen on (server=true)
|
|
|
|
# or connect to (server=false)
|
|
|
|
# @server: #optional create server socket (default: true)
|
2013-06-24 08:39:50 +02:00
|
|
|
# @wait: #optional wait for incoming connection on server
|
|
|
|
# sockets (default: false).
|
2012-12-20 13:53:12 +01:00
|
|
|
# @nodelay: #optional set TCP_NODELAY socket option (default: false)
|
2013-06-24 08:39:50 +02:00
|
|
|
# @telnet: #optional enable telnet protocol on server
|
|
|
|
# sockets (default: false)
|
2012-12-20 13:53:12 +01:00
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
|
|
|
|
'*server' : 'bool',
|
|
|
|
'*wait' : 'bool',
|
|
|
|
'*nodelay' : 'bool',
|
|
|
|
'*telnet' : 'bool' } }
|
|
|
|
|
2013-02-27 14:10:47 +01:00
|
|
|
##
|
2013-05-20 08:51:03 +02:00
|
|
|
# @ChardevUdp:
|
2013-02-27 14:10:47 +01:00
|
|
|
#
|
|
|
|
# Configuration info for datagram socket chardevs.
|
|
|
|
#
|
|
|
|
# @remote: remote address
|
|
|
|
# @local: #optional local address
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
2013-05-20 08:51:03 +02:00
|
|
|
{ 'type': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
|
|
|
|
'*local' : 'SocketAddress' } }
|
2013-02-27 14:10:47 +01:00
|
|
|
|
2013-02-21 16:16:42 +01:00
|
|
|
##
|
|
|
|
# @ChardevMux:
|
|
|
|
#
|
|
|
|
# Configuration info for mux chardevs.
|
|
|
|
#
|
|
|
|
# @chardev: name of the base chardev.
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevMux', 'data': { 'chardev' : 'str' } }
|
|
|
|
|
2013-02-21 12:34:58 +01:00
|
|
|
##
|
|
|
|
# @ChardevStdio:
|
|
|
|
#
|
|
|
|
# Configuration info for stdio chardevs.
|
|
|
|
#
|
|
|
|
# @signal: #optional Allow signals (such as SIGINT triggered by ^C)
|
|
|
|
# be delivered to qemu. Default: true in -nographic mode,
|
|
|
|
# false otherwise.
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
|
|
|
|
|
2013-02-25 12:39:06 +01:00
|
|
|
##
|
|
|
|
# @ChardevSpiceChannel:
|
|
|
|
#
|
|
|
|
# Configuration info for spice vm channel chardevs.
|
|
|
|
#
|
|
|
|
# @type: kind of channel (for example vdagent).
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevSpiceChannel', 'data': { 'type' : 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @ChardevSpicePort:
|
|
|
|
#
|
|
|
|
# Configuration info for spice port chardevs.
|
|
|
|
#
|
|
|
|
# @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' } }
|
|
|
|
|
2013-02-25 15:52:32 +01:00
|
|
|
##
|
|
|
|
# @ChardevVC:
|
|
|
|
#
|
|
|
|
# Configuration info for virtual console chardevs.
|
|
|
|
#
|
|
|
|
# @width: console width, in pixels
|
|
|
|
# @height: console height, in pixels
|
|
|
|
# @cols: console width, in chars
|
|
|
|
# @rows: console height, in chars
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevVC', 'data': { '*width' : 'int',
|
|
|
|
'*height' : 'int',
|
|
|
|
'*cols' : 'int',
|
|
|
|
'*rows' : 'int' } }
|
|
|
|
|
2013-02-26 16:21:11 +01:00
|
|
|
##
|
Revert "chardev: Make the name of memory device consistent"
This reverts commit 6a85e60cb994bd95d1537aafbff65816f3de4637.
Commit 51767e7 "qemu-char: Add new char backend CirMemCharDriver"
introduced a memory ring buffer character device driver named
"memory". Commit 3949e59 "qemu-char: Saner naming of memchar stuff &
doc fixes" changed the driver name to "ringbuf", along with a whole
bunch of other names, with the following rationale:
Naming is a mess. The code calls the device driver
CirMemCharDriver, the public API calls it "memory", "memchardev",
or "memchar", and the special commands are named like
"memchar-FOO". "memory" is a particularly unfortunate choice,
because there's another character device driver called
MemoryDriver. Moreover, the device's distinctive property is that
it's a ring buffer, not that's in memory.
This is what we released in 1.4.0.
Unfortunately, the rename missed a critical instance of "memory": the
actual driver name. Thus, the new device could be used only by an
entirely undocumented name. The documented name did not work.
Bummer.
Commit 6a85e60 fixes this by changing the documentation to match the
code. It also changes some, but not all related occurences of
"ringbuf" to "memory". Left alone are identifiers in C code, HMP and
QMP commands. The latter are external interface, so they can't be
changed.
The result is an inconsistent mess. Moreover, "memory" is a rotten
name. The device's distinctive property is that it's a ring buffer,
not that's in memory. User's don't care whether it's in RAM, flash,
or carved into chocolate tablets by Oompa Loompas.
Revert the commit. Next commit will fix just the bug.
Cc: qemu-stable@nongnu.org
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1374849874-25531-2-git-send-email-armbru@redhat.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-07-26 16:44:32 +02:00
|
|
|
# @ChardevRingbuf:
|
2013-02-26 16:21:11 +01:00
|
|
|
#
|
2013-07-26 16:44:34 +02:00
|
|
|
# Configuration info for ring buffer chardevs.
|
2013-02-26 16:21:11 +01:00
|
|
|
#
|
2013-07-26 16:44:34 +02:00
|
|
|
# @size: #optional ring buffer size, must be power of two, default is 65536
|
2013-02-26 16:21:11 +01:00
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
Revert "chardev: Make the name of memory device consistent"
This reverts commit 6a85e60cb994bd95d1537aafbff65816f3de4637.
Commit 51767e7 "qemu-char: Add new char backend CirMemCharDriver"
introduced a memory ring buffer character device driver named
"memory". Commit 3949e59 "qemu-char: Saner naming of memchar stuff &
doc fixes" changed the driver name to "ringbuf", along with a whole
bunch of other names, with the following rationale:
Naming is a mess. The code calls the device driver
CirMemCharDriver, the public API calls it "memory", "memchardev",
or "memchar", and the special commands are named like
"memchar-FOO". "memory" is a particularly unfortunate choice,
because there's another character device driver called
MemoryDriver. Moreover, the device's distinctive property is that
it's a ring buffer, not that's in memory.
This is what we released in 1.4.0.
Unfortunately, the rename missed a critical instance of "memory": the
actual driver name. Thus, the new device could be used only by an
entirely undocumented name. The documented name did not work.
Bummer.
Commit 6a85e60 fixes this by changing the documentation to match the
code. It also changes some, but not all related occurences of
"ringbuf" to "memory". Left alone are identifiers in C code, HMP and
QMP commands. The latter are external interface, so they can't be
changed.
The result is an inconsistent mess. Moreover, "memory" is a rotten
name. The device's distinctive property is that it's a ring buffer,
not that's in memory. User's don't care whether it's in RAM, flash,
or carved into chocolate tablets by Oompa Loompas.
Revert the commit. Next commit will fix just the bug.
Cc: qemu-stable@nongnu.org
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1374849874-25531-2-git-send-email-armbru@redhat.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-07-26 16:44:32 +02:00
|
|
|
{ 'type': 'ChardevRingbuf', 'data': { '*size' : 'int' } }
|
2013-02-26 16:21:11 +01:00
|
|
|
|
2012-12-19 10:33:56 +01:00
|
|
|
##
|
|
|
|
# @ChardevBackend:
|
|
|
|
#
|
|
|
|
# Configuration info for the new chardev backend.
|
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
|
|
|
{ 'type': 'ChardevDummy', 'data': { } }
|
|
|
|
|
2012-12-20 13:53:12 +01:00
|
|
|
{ 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
|
2013-02-13 15:54:16 +01:00
|
|
|
'serial' : 'ChardevHostdev',
|
|
|
|
'parallel': 'ChardevHostdev',
|
2013-02-25 11:50:55 +01:00
|
|
|
'pipe' : 'ChardevHostdev',
|
2012-12-20 13:53:12 +01:00
|
|
|
'socket' : 'ChardevSocket',
|
2013-05-20 08:51:03 +02:00
|
|
|
'udp' : 'ChardevUdp',
|
2012-12-20 14:39:13 +01:00
|
|
|
'pty' : 'ChardevDummy',
|
2013-02-21 16:16:42 +01:00
|
|
|
'null' : 'ChardevDummy',
|
2013-02-21 11:58:44 +01:00
|
|
|
'mux' : 'ChardevMux',
|
2013-02-21 12:56:10 +01:00
|
|
|
'msmouse': 'ChardevDummy',
|
2013-02-21 12:34:58 +01:00
|
|
|
'braille': 'ChardevDummy',
|
2013-02-25 11:48:06 +01:00
|
|
|
'stdio' : 'ChardevStdio',
|
2013-02-25 12:39:06 +01:00
|
|
|
'console': 'ChardevDummy',
|
|
|
|
'spicevmc' : 'ChardevSpiceChannel',
|
2013-02-25 15:52:32 +01:00
|
|
|
'spiceport' : 'ChardevSpicePort',
|
2013-02-26 16:21:11 +01:00
|
|
|
'vc' : 'ChardevVC',
|
2013-07-26 16:44:34 +02:00
|
|
|
'ringbuf': 'ChardevRingbuf',
|
|
|
|
# next one is just for compatibility
|
Revert "chardev: Make the name of memory device consistent"
This reverts commit 6a85e60cb994bd95d1537aafbff65816f3de4637.
Commit 51767e7 "qemu-char: Add new char backend CirMemCharDriver"
introduced a memory ring buffer character device driver named
"memory". Commit 3949e59 "qemu-char: Saner naming of memchar stuff &
doc fixes" changed the driver name to "ringbuf", along with a whole
bunch of other names, with the following rationale:
Naming is a mess. The code calls the device driver
CirMemCharDriver, the public API calls it "memory", "memchardev",
or "memchar", and the special commands are named like
"memchar-FOO". "memory" is a particularly unfortunate choice,
because there's another character device driver called
MemoryDriver. Moreover, the device's distinctive property is that
it's a ring buffer, not that's in memory.
This is what we released in 1.4.0.
Unfortunately, the rename missed a critical instance of "memory": the
actual driver name. Thus, the new device could be used only by an
entirely undocumented name. The documented name did not work.
Bummer.
Commit 6a85e60 fixes this by changing the documentation to match the
code. It also changes some, but not all related occurences of
"ringbuf" to "memory". Left alone are identifiers in C code, HMP and
QMP commands. The latter are external interface, so they can't be
changed.
The result is an inconsistent mess. Moreover, "memory" is a rotten
name. The device's distinctive property is that it's a ring buffer,
not that's in memory. User's don't care whether it's in RAM, flash,
or carved into chocolate tablets by Oompa Loompas.
Revert the commit. Next commit will fix just the bug.
Cc: qemu-stable@nongnu.org
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1374849874-25531-2-git-send-email-armbru@redhat.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-07-26 16:44:32 +02:00
|
|
|
'memory' : 'ChardevRingbuf' } }
|
2012-12-19 10:33:56 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @ChardevReturn:
|
|
|
|
#
|
|
|
|
# Return info about the chardev backend just created.
|
|
|
|
#
|
2013-02-11 18:05:48 +01:00
|
|
|
# @pty: #optional name of the slave pseudoterminal device, present if
|
|
|
|
# and only if a chardev of type 'pty' was created
|
|
|
|
#
|
2012-12-19 10:33:56 +01:00
|
|
|
# Since: 1.4
|
|
|
|
##
|
2012-12-20 14:39:13 +01:00
|
|
|
{ 'type' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
|
2012-12-19 10:33:56 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @chardev-add:
|
|
|
|
#
|
2013-02-11 18:05:48 +01:00
|
|
|
# Add a character device backend
|
2012-12-19 10:33:56 +01:00
|
|
|
#
|
|
|
|
# @id: the chardev's ID, must be unique
|
|
|
|
# @backend: backend type and parameters
|
|
|
|
#
|
2013-02-11 18:05:48 +01:00
|
|
|
# Returns: ChardevReturn.
|
2012-12-19 10:33:56 +01:00
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
|
|
|
{ 'command': 'chardev-add', 'data': {'id' : 'str',
|
|
|
|
'backend' : 'ChardevBackend' },
|
|
|
|
'returns': 'ChardevReturn' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @chardev-remove:
|
|
|
|
#
|
2013-02-11 18:05:48 +01:00
|
|
|
# Remove a character device backend
|
2012-12-19 10:33:56 +01:00
|
|
|
#
|
|
|
|
# @id: the chardev's ID, must exist and not be in use
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
##
|
|
|
|
{ 'command': 'chardev-remove', 'data': {'id': 'str'} }
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 18:47:49 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @TpmModel:
|
|
|
|
#
|
|
|
|
# An enumeration of TPM models
|
|
|
|
#
|
|
|
|
# @tpm-tis: TPM TIS model
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-tpm-models:
|
|
|
|
#
|
|
|
|
# Return a list of supported TPM models
|
|
|
|
#
|
|
|
|
# Returns: a list of TpmModel
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @TpmType:
|
|
|
|
#
|
|
|
|
# An enumeration of TPM types
|
|
|
|
#
|
|
|
|
# @passthrough: TPM passthrough type
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'enum': 'TpmType', 'data': [ 'passthrough' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-tpm-types:
|
|
|
|
#
|
|
|
|
# Return a list of supported TPM types
|
|
|
|
#
|
|
|
|
# Returns: a list of TpmType
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'command': 'query-tpm-types', 'returns': ['TpmType'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @TPMPassthroughOptions:
|
|
|
|
#
|
|
|
|
# Information about the TPM passthrough type
|
|
|
|
#
|
|
|
|
# @path: #optional string describing the path used for accessing the TPM device
|
|
|
|
#
|
|
|
|
# @cancel-path: #optional string showing the TPM's sysfs cancel file
|
|
|
|
# for cancellation of TPM commands while they are executing
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
|
|
|
|
'*cancel-path' : 'str'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @TpmTypeOptions:
|
|
|
|
#
|
|
|
|
# A union referencing different TPM backend types' configuration options
|
|
|
|
#
|
2013-03-20 17:34:48 +01:00
|
|
|
# @passthrough: The configuration options for the TPM passthrough type
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 18:47:49 +01:00
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'union': 'TpmTypeOptions',
|
2013-03-20 17:34:48 +01:00
|
|
|
'data': { 'passthrough' : 'TPMPassthroughOptions' } }
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 18:47:49 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @TpmInfo:
|
|
|
|
#
|
|
|
|
# Information about the TPM
|
|
|
|
#
|
|
|
|
# @id: The Id of the TPM
|
|
|
|
#
|
|
|
|
# @model: The TPM frontend model
|
|
|
|
#
|
2013-03-20 17:34:48 +01:00
|
|
|
# @options: The TPM (backend) type configuration options
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 18:47:49 +01:00
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'TPMInfo',
|
|
|
|
'data': {'id': 'str',
|
|
|
|
'model': 'TpmModel',
|
2013-03-20 17:34:48 +01:00
|
|
|
'options': 'TpmTypeOptions' } }
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 18:47:49 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-tpm:
|
|
|
|
#
|
|
|
|
# Return information about the TPM device
|
|
|
|
#
|
|
|
|
# Returns: @TPMInfo on success
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'command': 'query-tpm', 'returns': ['TPMInfo'] }
|
2013-03-21 00:23:16 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @AcpiTableOptions
|
|
|
|
#
|
|
|
|
# Specify an ACPI table on the command line to load.
|
|
|
|
#
|
|
|
|
# At most one of @file and @data can be specified. The list of files specified
|
|
|
|
# by any one of them is loaded and concatenated in order. If both are omitted,
|
|
|
|
# @data is implied.
|
|
|
|
#
|
|
|
|
# Other fields / optargs can be used to override fields of the generic ACPI
|
|
|
|
# table header; refer to the ACPI specification 5.0, section 5.2.6 System
|
|
|
|
# Description Table Header. If a header field is not overridden, then the
|
|
|
|
# corresponding value from the concatenated blob is used (in case of @file), or
|
|
|
|
# it is filled in with a hard-coded value (in case of @data).
|
|
|
|
#
|
|
|
|
# String fields are copied into the matching ACPI member from lowest address
|
|
|
|
# upwards, and silently truncated / NUL-padded to length.
|
|
|
|
#
|
|
|
|
# @sig: #optional table signature / identifier (4 bytes)
|
|
|
|
#
|
|
|
|
# @rev: #optional table revision number (dependent on signature, 1 byte)
|
|
|
|
#
|
|
|
|
# @oem_id: #optional OEM identifier (6 bytes)
|
|
|
|
#
|
|
|
|
# @oem_table_id: #optional OEM table identifier (8 bytes)
|
|
|
|
#
|
|
|
|
# @oem_rev: #optional OEM-supplied revision number (4 bytes)
|
|
|
|
#
|
|
|
|
# @asl_compiler_id: #optional identifier of the utility that created the table
|
|
|
|
# (4 bytes)
|
|
|
|
#
|
|
|
|
# @asl_compiler_rev: #optional revision number of the utility that created the
|
|
|
|
# table (4 bytes)
|
|
|
|
#
|
|
|
|
# @file: #optional colon (:) separated list of pathnames to load and
|
|
|
|
# concatenate as table data. The resultant binary blob is expected to
|
|
|
|
# have an ACPI table header. At least one file is required. This field
|
|
|
|
# excludes @data.
|
|
|
|
#
|
|
|
|
# @data: #optional colon (:) separated list of pathnames to load and
|
|
|
|
# concatenate as table data. The resultant binary blob must not have an
|
|
|
|
# ACPI table header. At least one file is required. This field excludes
|
|
|
|
# @file.
|
|
|
|
#
|
|
|
|
# Since 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'AcpiTableOptions',
|
|
|
|
'data': {
|
|
|
|
'*sig': 'str',
|
|
|
|
'*rev': 'uint8',
|
|
|
|
'*oem_id': 'str',
|
|
|
|
'*oem_table_id': 'str',
|
|
|
|
'*oem_rev': 'uint32',
|
|
|
|
'*asl_compiler_id': 'str',
|
|
|
|
'*asl_compiler_rev': 'uint32',
|
|
|
|
'*file': 'str',
|
|
|
|
'*data': 'str' }}
|
2013-04-25 11:50:35 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @CommandLineParameterType:
|
|
|
|
#
|
|
|
|
# Possible types for an option parameter.
|
|
|
|
#
|
|
|
|
# @string: accepts a character string
|
|
|
|
#
|
|
|
|
# @boolean: accepts "on" or "off"
|
|
|
|
#
|
|
|
|
# @number: accepts a number
|
|
|
|
#
|
|
|
|
# @size: accepts a number followed by an optional suffix (K)ilo,
|
|
|
|
# (M)ega, (G)iga, (T)era
|
|
|
|
#
|
|
|
|
# Since 1.5
|
|
|
|
##
|
|
|
|
{ 'enum': 'CommandLineParameterType',
|
|
|
|
'data': ['string', 'boolean', 'number', 'size'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @CommandLineParameterInfo:
|
|
|
|
#
|
|
|
|
# Details about a single parameter of a command line option.
|
|
|
|
#
|
|
|
|
# @name: parameter name
|
|
|
|
#
|
|
|
|
# @type: parameter @CommandLineParameterType
|
|
|
|
#
|
|
|
|
# @help: #optional human readable text string, not suitable for parsing.
|
|
|
|
#
|
2014-06-05 11:20:43 +02:00
|
|
|
# @default: #optional default value string (since 2.1)
|
|
|
|
#
|
2013-04-25 11:50:35 +02:00
|
|
|
# Since 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'CommandLineParameterInfo',
|
|
|
|
'data': { 'name': 'str',
|
|
|
|
'type': 'CommandLineParameterType',
|
2014-06-05 11:20:43 +02:00
|
|
|
'*help': 'str',
|
|
|
|
'*default': 'str' } }
|
2013-04-25 11:50:35 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @CommandLineOptionInfo:
|
|
|
|
#
|
|
|
|
# Details about a command line option, including its list of parameter details
|
|
|
|
#
|
|
|
|
# @option: option name
|
|
|
|
#
|
|
|
|
# @parameters: an array of @CommandLineParameterInfo
|
|
|
|
#
|
|
|
|
# Since 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'CommandLineOptionInfo',
|
|
|
|
'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-command-line-options:
|
|
|
|
#
|
|
|
|
# Query command line option schema.
|
|
|
|
#
|
|
|
|
# @option: #optional option name
|
|
|
|
#
|
|
|
|
# Returns: list of @CommandLineOptionInfo for all options (or for the given
|
|
|
|
# @option). Returns an error if the given @option doesn't exist.
|
|
|
|
#
|
|
|
|
# Since 1.5
|
|
|
|
##
|
|
|
|
{'command': 'query-command-line-options', 'data': { '*option': 'str' },
|
|
|
|
'returns': ['CommandLineOptionInfo'] }
|
2013-05-06 18:20:07 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @X86CPURegister32
|
|
|
|
#
|
|
|
|
# A X86 32-bit register
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'enum': 'X86CPURegister32',
|
|
|
|
'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @X86CPUFeatureWordInfo
|
|
|
|
#
|
|
|
|
# Information about a X86 CPU feature word
|
|
|
|
#
|
|
|
|
# @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
|
|
|
|
#
|
|
|
|
# @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
|
|
|
|
# feature word
|
|
|
|
#
|
|
|
|
# @cpuid-register: Output register containing the feature bits
|
|
|
|
#
|
|
|
|
# @features: value of output register, containing the feature bits
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'type': 'X86CPUFeatureWordInfo',
|
|
|
|
'data': { 'cpuid-input-eax': 'int',
|
|
|
|
'*cpuid-input-ecx': 'int',
|
|
|
|
'cpuid-register': 'X86CPURegister32',
|
|
|
|
'features': 'int' } }
|
net: add support of mac-programming over macvtap in QEMU side
Currently macvtap based macvlan device is working in promiscuous
mode, we want to implement mac-programming over macvtap through
Libvirt for better performance.
Design:
QEMU notifies Libvirt when rx-filter config is changed in guest,
then Libvirt query the rx-filter information by a monitor command,
and sync the change to macvtap device. Related rx-filter config
of the nic contains main mac, rx-mode items and vlan table.
This patch adds a QMP event to notify management of rx-filter change,
and adds a monitor command for management to query rx-filter
information.
Test:
If we repeatedly add/remove vlan, and change macaddr of vlan
interfaces in guest by a loop script.
Result:
The events will flood the QMP client(management), management takes
too much resource to process the events.
Event_throttle API (set rate to 1 ms) can avoid the events to flood
QMP client, but it could cause an unexpected delay (~1ms), guests
guests normally expect rx-filter updates immediately.
So we use a flag for each nic to avoid events flooding, the event
is emitted once until the query command is executed. The flag
implementation could not introduce unexpected delay.
There maybe exist an uncontrollable delay if we let Libvirt do the
real change, guests normally expect rx-filter updates immediately.
But it's another separate issue, we can investigate it when the
work in Libvirt side is done.
Michael S. Tsirkin: tweaked to enable events on start
Michael S. Tsirkin: fixed not to crash when no id
Michael S. Tsirkin: fold in patch:
"additional fixes for mac-programming feature"
Amos Kong: always notify QMP client if mactable is changed
Amos Kong: return NULL list if no net client supports rx-filter query
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Amos Kong <akong@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2013-06-14 09:45:52 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @RxState:
|
|
|
|
#
|
|
|
|
# Packets receiving state
|
|
|
|
#
|
|
|
|
# @normal: filter assigned packets according to the mac-table
|
|
|
|
#
|
|
|
|
# @none: don't receive any assigned packet
|
|
|
|
#
|
|
|
|
# @all: receive all assigned packets
|
|
|
|
#
|
|
|
|
# Since: 1.6
|
|
|
|
##
|
|
|
|
{ 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @RxFilterInfo:
|
|
|
|
#
|
|
|
|
# Rx-filter information for a NIC.
|
|
|
|
#
|
|
|
|
# @name: net client name
|
|
|
|
#
|
|
|
|
# @promiscuous: whether promiscuous mode is enabled
|
|
|
|
#
|
|
|
|
# @multicast: multicast receive state
|
|
|
|
#
|
|
|
|
# @unicast: unicast receive state
|
|
|
|
#
|
2014-03-26 01:19:43 +01:00
|
|
|
# @vlan: vlan receive state (Since 2.0)
|
|
|
|
#
|
net: add support of mac-programming over macvtap in QEMU side
Currently macvtap based macvlan device is working in promiscuous
mode, we want to implement mac-programming over macvtap through
Libvirt for better performance.
Design:
QEMU notifies Libvirt when rx-filter config is changed in guest,
then Libvirt query the rx-filter information by a monitor command,
and sync the change to macvtap device. Related rx-filter config
of the nic contains main mac, rx-mode items and vlan table.
This patch adds a QMP event to notify management of rx-filter change,
and adds a monitor command for management to query rx-filter
information.
Test:
If we repeatedly add/remove vlan, and change macaddr of vlan
interfaces in guest by a loop script.
Result:
The events will flood the QMP client(management), management takes
too much resource to process the events.
Event_throttle API (set rate to 1 ms) can avoid the events to flood
QMP client, but it could cause an unexpected delay (~1ms), guests
guests normally expect rx-filter updates immediately.
So we use a flag for each nic to avoid events flooding, the event
is emitted once until the query command is executed. The flag
implementation could not introduce unexpected delay.
There maybe exist an uncontrollable delay if we let Libvirt do the
real change, guests normally expect rx-filter updates immediately.
But it's another separate issue, we can investigate it when the
work in Libvirt side is done.
Michael S. Tsirkin: tweaked to enable events on start
Michael S. Tsirkin: fixed not to crash when no id
Michael S. Tsirkin: fold in patch:
"additional fixes for mac-programming feature"
Amos Kong: always notify QMP client if mactable is changed
Amos Kong: return NULL list if no net client supports rx-filter query
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Amos Kong <akong@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2013-06-14 09:45:52 +02:00
|
|
|
# @broadcast-allowed: whether to receive broadcast
|
|
|
|
#
|
|
|
|
# @multicast-overflow: multicast table is overflowed or not
|
|
|
|
#
|
|
|
|
# @unicast-overflow: unicast table is overflowed or not
|
|
|
|
#
|
|
|
|
# @main-mac: the main macaddr string
|
|
|
|
#
|
|
|
|
# @vlan-table: a list of active vlan id
|
|
|
|
#
|
|
|
|
# @unicast-table: a list of unicast macaddr string
|
|
|
|
#
|
|
|
|
# @multicast-table: a list of multicast macaddr string
|
|
|
|
#
|
|
|
|
# Since 1.6
|
|
|
|
##
|
|
|
|
|
|
|
|
{ 'type': 'RxFilterInfo',
|
|
|
|
'data': {
|
|
|
|
'name': 'str',
|
|
|
|
'promiscuous': 'bool',
|
|
|
|
'multicast': 'RxState',
|
|
|
|
'unicast': 'RxState',
|
2014-03-26 01:19:43 +01:00
|
|
|
'vlan': 'RxState',
|
net: add support of mac-programming over macvtap in QEMU side
Currently macvtap based macvlan device is working in promiscuous
mode, we want to implement mac-programming over macvtap through
Libvirt for better performance.
Design:
QEMU notifies Libvirt when rx-filter config is changed in guest,
then Libvirt query the rx-filter information by a monitor command,
and sync the change to macvtap device. Related rx-filter config
of the nic contains main mac, rx-mode items and vlan table.
This patch adds a QMP event to notify management of rx-filter change,
and adds a monitor command for management to query rx-filter
information.
Test:
If we repeatedly add/remove vlan, and change macaddr of vlan
interfaces in guest by a loop script.
Result:
The events will flood the QMP client(management), management takes
too much resource to process the events.
Event_throttle API (set rate to 1 ms) can avoid the events to flood
QMP client, but it could cause an unexpected delay (~1ms), guests
guests normally expect rx-filter updates immediately.
So we use a flag for each nic to avoid events flooding, the event
is emitted once until the query command is executed. The flag
implementation could not introduce unexpected delay.
There maybe exist an uncontrollable delay if we let Libvirt do the
real change, guests normally expect rx-filter updates immediately.
But it's another separate issue, we can investigate it when the
work in Libvirt side is done.
Michael S. Tsirkin: tweaked to enable events on start
Michael S. Tsirkin: fixed not to crash when no id
Michael S. Tsirkin: fold in patch:
"additional fixes for mac-programming feature"
Amos Kong: always notify QMP client if mactable is changed
Amos Kong: return NULL list if no net client supports rx-filter query
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Amos Kong <akong@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2013-06-14 09:45:52 +02:00
|
|
|
'broadcast-allowed': 'bool',
|
|
|
|
'multicast-overflow': 'bool',
|
|
|
|
'unicast-overflow': 'bool',
|
|
|
|
'main-mac': 'str',
|
|
|
|
'vlan-table': ['int'],
|
|
|
|
'unicast-table': ['str'],
|
|
|
|
'multicast-table': ['str'] }}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-rx-filter:
|
|
|
|
#
|
|
|
|
# Return rx-filter information for all NICs (or for the given NIC).
|
|
|
|
#
|
|
|
|
# @name: #optional net client name
|
|
|
|
#
|
|
|
|
# Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
|
|
|
|
# Returns an error if the given @name doesn't exist, or given
|
|
|
|
# NIC doesn't support rx-filter querying, or given net client
|
|
|
|
# isn't a NIC.
|
|
|
|
#
|
|
|
|
# Since: 1.6
|
|
|
|
##
|
|
|
|
{ 'command': 'query-rx-filter', 'data': { '*name': 'str' },
|
|
|
|
'returns': ['RxFilterInfo'] }
|
2013-09-23 15:26:03 +02:00
|
|
|
|
2013-11-27 09:08:40 +01:00
|
|
|
##
|
|
|
|
# @InputButton
|
|
|
|
#
|
|
|
|
# Button of a pointer input device (mouse, tablet).
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'enum' : 'InputButton',
|
|
|
|
'data' : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @InputButton
|
|
|
|
#
|
|
|
|
# Position axis of a pointer input device (mouse, tablet).
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'enum' : 'InputAxis',
|
|
|
|
'data' : [ 'X', 'Y' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @InputKeyEvent
|
|
|
|
#
|
|
|
|
# Keyboard input event.
|
|
|
|
#
|
|
|
|
# @key: Which key this event is for.
|
|
|
|
# @down: True for key-down and false for key-up events.
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'type' : 'InputKeyEvent',
|
|
|
|
'data' : { 'key' : 'KeyValue',
|
|
|
|
'down' : 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @InputBtnEvent
|
|
|
|
#
|
|
|
|
# Pointer button input event.
|
|
|
|
#
|
|
|
|
# @button: Which button this event is for.
|
|
|
|
# @down: True for key-down and false for key-up events.
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'type' : 'InputBtnEvent',
|
|
|
|
'data' : { 'button' : 'InputButton',
|
|
|
|
'down' : 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @InputMoveEvent
|
|
|
|
#
|
|
|
|
# Pointer motion input event.
|
|
|
|
#
|
|
|
|
# @axis: Which axis is referenced by @value.
|
|
|
|
# @value: Pointer position. For absolute coordinates the
|
|
|
|
# valid range is 0 -> 0x7ffff
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'type' : 'InputMoveEvent',
|
|
|
|
'data' : { 'axis' : 'InputAxis',
|
|
|
|
'value' : 'int' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @InputEvent
|
|
|
|
#
|
|
|
|
# Input event union.
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
##
|
|
|
|
{ 'union' : 'InputEvent',
|
|
|
|
'data' : { 'key' : 'InputKeyEvent',
|
|
|
|
'btn' : 'InputBtnEvent',
|
|
|
|
'rel' : 'InputMoveEvent',
|
|
|
|
'abs' : 'InputMoveEvent' } }
|
2014-05-14 11:43:08 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @NumaOptions
|
|
|
|
#
|
|
|
|
# A discriminated record of NUMA options. (for OptsVisitor)
|
|
|
|
#
|
|
|
|
# Since 2.1
|
|
|
|
##
|
|
|
|
{ 'union': 'NumaOptions',
|
|
|
|
'data': {
|
|
|
|
'node': 'NumaNodeOptions' }}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @NumaNodeOptions
|
|
|
|
#
|
|
|
|
# Create a guest NUMA node. (for OptsVisitor)
|
|
|
|
#
|
|
|
|
# @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
|
|
|
|
#
|
|
|
|
# @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
|
|
|
|
# if omitted)
|
|
|
|
#
|
numa: add -numa node,memdev= option
This option provides the infrastructure for binding guest NUMA nodes
to host NUMA nodes. For example:
-object memory-ram,size=1024M,policy=bind,host-nodes=0,id=ram-node0 \
-numa node,nodeid=0,cpus=0,memdev=ram-node0 \
-object memory-ram,size=1024M,policy=interleave,host-nodes=1-3,id=ram-node1 \
-numa node,nodeid=1,cpus=1,memdev=ram-node1
The option replaces "-numa node,mem=".
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
Acked-by: Michael S. Tsirkin <mst@redhat.com>
MST: conflict resolution
2014-05-14 11:43:17 +02:00
|
|
|
# @mem: #optional memory size of this node; mutually exclusive with @memdev.
|
|
|
|
# Equally divide total memory among nodes if both @mem and @memdev are
|
|
|
|
# omitted.
|
|
|
|
#
|
|
|
|
# @memdev: #optional memory backend object. If specified for one node,
|
|
|
|
# it must be specified for all nodes.
|
2014-05-14 11:43:08 +02:00
|
|
|
#
|
|
|
|
# Since: 2.1
|
|
|
|
##
|
|
|
|
{ 'type': 'NumaNodeOptions',
|
|
|
|
'data': {
|
|
|
|
'*nodeid': 'uint16',
|
|
|
|
'*cpus': ['uint16'],
|
numa: add -numa node,memdev= option
This option provides the infrastructure for binding guest NUMA nodes
to host NUMA nodes. For example:
-object memory-ram,size=1024M,policy=bind,host-nodes=0,id=ram-node0 \
-numa node,nodeid=0,cpus=0,memdev=ram-node0 \
-object memory-ram,size=1024M,policy=interleave,host-nodes=1-3,id=ram-node1 \
-numa node,nodeid=1,cpus=1,memdev=ram-node1
The option replaces "-numa node,mem=".
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
Acked-by: Michael S. Tsirkin <mst@redhat.com>
MST: conflict resolution
2014-05-14 11:43:17 +02:00
|
|
|
'*mem': 'size',
|
|
|
|
'*memdev': 'str' }}
|
2014-06-10 13:15:25 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @HostMemPolicy
|
|
|
|
#
|
|
|
|
# Host memory policy types
|
|
|
|
#
|
|
|
|
# @default: restore default policy, remove any nondefault policy
|
|
|
|
#
|
|
|
|
# @preferred: set the preferred host nodes for allocation
|
|
|
|
#
|
|
|
|
# @bind: a strict policy that restricts memory allocation to the
|
|
|
|
# host nodes specified
|
|
|
|
#
|
|
|
|
# @interleave: memory allocations are interleaved across the set
|
|
|
|
# of host nodes specified
|
|
|
|
#
|
|
|
|
# Since 2.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'HostMemPolicy',
|
|
|
|
'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
|
2014-06-16 12:05:41 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @Memdev:
|
|
|
|
#
|
|
|
|
# Information of memory device
|
|
|
|
#
|
|
|
|
# @size: memory device size
|
|
|
|
#
|
|
|
|
# @merge: enables or disables memory merge support
|
|
|
|
#
|
|
|
|
# @dump: includes memory device's memory in a core dump or not
|
|
|
|
#
|
|
|
|
# @prealloc: enables or disables memory preallocation
|
|
|
|
#
|
|
|
|
# @host-nodes: host nodes for its memory policy
|
|
|
|
#
|
|
|
|
# @policy: memory policy of memory device
|
|
|
|
#
|
|
|
|
# Since: 2.1
|
|
|
|
##
|
|
|
|
|
|
|
|
{ 'type': 'Memdev',
|
|
|
|
'data': {
|
|
|
|
'size': 'size',
|
|
|
|
'merge': 'bool',
|
|
|
|
'dump': 'bool',
|
|
|
|
'prealloc': 'bool',
|
|
|
|
'host-nodes': ['uint16'],
|
|
|
|
'policy': 'HostMemPolicy' }}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-memdev:
|
|
|
|
#
|
|
|
|
# Returns information for all memory devices.
|
|
|
|
#
|
|
|
|
# Returns: a list of @Memdev.
|
|
|
|
#
|
|
|
|
# Since: 2.1
|
|
|
|
##
|
|
|
|
{ 'command': 'query-memdev', 'returns': ['Memdev'] }
|