30 changes: 18 additions & 12 deletions qapi/machine.json
View file
Expand Up @@ -457,7 +457,7 @@
# @nodeid: NUMA node ID (increase by 1 from 0 if omitted)
#
# @cpus: VCPUs belonging to this node (assign VCPUS round-robin
# if omitted)
# if omitted)
#
# @mem: memory size of this node; mutually exclusive with @memdev.
# Equally divide total memory among nodes if both @mem and @memdev are
Expand Down Expand Up @@ -517,7 +517,7 @@
# @targets: Target root bridge IDs from -device ...,id=<ID> for each root
# bridge.
#
# Since 7.1
# Since: 7.1
##
{ 'struct': 'CXLFixedMemoryWindowOptions',
'data': {
Expand All @@ -532,7 +532,7 @@
#
# @cxl-fmw: List of CXLFixedMemoryWindowOptions
#
# Since 7.1
# Since: 7.1
##
{ 'struct' : 'CXLFMWProperties',
'data': { 'cxl-fmw': ['CXLFixedMemoryWindowOptions'] }
Expand Down Expand Up @@ -690,7 +690,7 @@
# 5.2.27.5: Table 5-147 of ACPI 6.3 spec.
#
# @none: None (no memory side cache in this proximity domain,
# or cache associativity unknown)
# or cache associativity unknown)
#
# @direct: Direct Mapped
#
Expand Down Expand Up @@ -954,7 +954,7 @@
#
# Since: 2.7
#
# Example:
# Examples:
#
# For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8:
#
Expand Down Expand Up @@ -1029,7 +1029,7 @@
#
# Returns: - Nothing on success
# - If the balloon driver is enabled but not functional because the KVM
# kernel module cannot support it, KvmMissingCap
# 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,
Expand Down Expand Up @@ -1067,7 +1067,7 @@
#
# Returns: - @BalloonInfo on success
# - If the balloon driver is enabled but not functional because the KVM
# kernel module cannot support it, KvmMissingCap
# kernel module cannot support it, KVMMissingCap
# - If no balloon device is present, DeviceNotActive
#
# Since: 0.14
Expand Down Expand Up @@ -1260,6 +1260,14 @@
##
# @MemoryDeviceInfoKind:
#
# @nvdimm: since 2.12
#
# @virtio-pmem: since 4.1
#
# @virtio-mem: since 5.1
#
# @sgx-epc: since 6.2.
#
# Since: 2.1
##
{ 'enum': 'MemoryDeviceInfoKind',
Expand Down Expand Up @@ -1302,9 +1310,6 @@
#
# Union containing information about a memory device
#
# nvdimm is included since 2.12. virtio-pmem is included since 4.1.
# virtio-mem is included since 5.1. sgx-epc is included since 6.2.
#
# Since: 2.1
##
{ 'union': 'MemoryDeviceInfo',
Expand Down Expand Up @@ -1677,8 +1682,9 @@
# Since: 7.2
#
# Example:
# {"execute": "dumpdtb"}
# "arguments": { "filename": "fdt.dtb" } }
# -> { "execute": "dumpdtb" }
# "arguments": { "filename": "fdt.dtb" } }
# <- { "return": {} }
#
##
{ 'command': 'dumpdtb',
Expand Down
37 changes: 24 additions & 13 deletions qapi/migration.json
View file
Expand Up @@ -273,7 +273,7 @@
#
# Since: 0.14
#
# Example:
# Examples:
#
# 1. Before the first migration
#
Expand Down Expand Up @@ -521,6 +521,7 @@
#
# -> { "execute": "migrate-set-capabilities" , "arguments":
# { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
# <- { "return": {} }
#
##
{ 'command': 'migrate-set-capabilities',
Expand All @@ -531,7 +532,7 @@
#
# Returns information about the current migration capabilities status
#
# Returns: @MigrationCapabilitiesStatus
# Returns: @MigrationCapabilityStatus
#
# Since: 1.2
#
Expand Down Expand Up @@ -989,6 +990,7 @@
#
# -> { "execute": "migrate-set-parameters" ,
# "arguments": { "compress-level": 1 } }
# <- { "return": {} }
#
##
{ 'command': 'migrate-set-parameters', 'boxed': true,
Expand Down Expand Up @@ -1251,8 +1253,8 @@
#
# Example:
#
# { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
# "event": "MIGRATION_PASS", "data": {"pass": 2} }
# <- { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
# "event": "MIGRATION_PASS", "data": {"pass": 2} }
#
##
{ 'event': 'MIGRATION_PASS',
Expand Down Expand Up @@ -1833,8 +1835,9 @@
#
# Example:
#
# {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
# 'sample-pages': 512} }
# -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
# 'sample-pages': 512} }
# <- { "return": {} }
#
##
{ 'command': 'calc-dirty-rate', 'data': {'calc-time': 'int64',
Expand Down Expand Up @@ -1886,9 +1889,11 @@
# Since: 7.1
#
# Example:
# {"execute": "set-vcpu-dirty-limit"}
# "arguments": { "dirty-rate": 200,
# "cpu-index": 1 } }
#
# -> {"execute": "set-vcpu-dirty-limit"}
# "arguments": { "dirty-rate": 200,
# "cpu-index": 1 } }
# <- { "return": {} }
#
##
{ 'command': 'set-vcpu-dirty-limit',
Expand All @@ -1909,8 +1914,10 @@
# Since: 7.1
#
# Example:
# {"execute": "cancel-vcpu-dirty-limit"}
# "arguments": { "cpu-index": 1 } }
#
# -> {"execute": "cancel-vcpu-dirty-limit"},
# "arguments": { "cpu-index": 1 } }
# <- { "return": {} }
#
##
{ 'command': 'cancel-vcpu-dirty-limit',
Expand All @@ -1924,7 +1931,11 @@
# Since: 7.1
#
# Example:
# {"execute": "query-vcpu-dirty-limit"}
#
# -> {"execute": "query-vcpu-dirty-limit"}
# <- {"return": [
# { "limit-rate": 60, "current-rate": 3, "cpu-index": 0},
# { "limit-rate": 60, "current-rate": 3, "cpu-index": 1}]}
#
##
{ 'command': 'query-vcpu-dirty-limit',
Expand Down Expand Up @@ -1952,7 +1963,7 @@
#
# data: migration thread name
#
# returns: information about migration threads
# Returns: information about migration threads
#
# Since: 7.2
##
Expand Down
13 changes: 6 additions & 7 deletions qapi/misc.json
View file
Expand Up @@ -349,8 +349,8 @@
# @opaque: A free-form string that can be used to describe the fd.
#
# Returns: - @AddfdInfo on success
# - If file descriptor was not received, FdNotSupplied
# - If @fdset-id is a negative value, InvalidParameterValue
# - If file descriptor was not received, GenericError
# - If @fdset-id is a negative value, GenericError
#
# Notes: The list of fd sets is shared by all monitor connections.
#
Expand Down Expand Up @@ -379,7 +379,7 @@
# @fd: The file descriptor that is to be removed.
#
# Returns: - Nothing on success
# - If @fdset-id or @fd is not found, FdNotFound
# - If @fdset-id or @fd is not found, GenericError
#
# Since: 1.2
#
Expand Down Expand Up @@ -580,10 +580,9 @@
#
# Example:
#
# <- { "event": "RTC_CHANGE",
# "data": { "offset": 78 },
# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
#
# <- { "event": "RTC_CHANGE",
# "data": { "offset": 78 },
# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
##
{ 'event': 'RTC_CHANGE',
'data': { 'offset': 'int', 'qom-path': 'str' } }
Expand Down
27 changes: 10 additions & 17 deletions qapi/net.json
View file
Expand Up @@ -533,7 +533,7 @@
# Must be specified along with @start-address and @subnet-mask.
#
# @subnet-mask: The IPv4 subnet mask to use on the interface. Must
# be specified along with @start-address and @subnet-mask.
# be specified along with @start-address and @subnet-mask.
#
# @isolated: Enable isolation for this interface. Interface isolation
# ensures that vmnet interface is not able to communicate
Expand Down Expand Up @@ -641,14 +641,15 @@
#
# Available netdev drivers.
#
# Since: 2.7
# @l2tpv3: since 2.1
# @vhost-vdpa: since 5.1
# @vmnet-host: since 7.1
# @vmnet-shared: since 7.1
# @vmnet-bridged: since 7.1
# @stream: since 7.2
# @dgram: since 7.2
#
# @vhost-vdpa since 5.1
# @vmnet-host since 7.1
# @vmnet-shared since 7.1
# @vmnet-bridged since 7.1
# @stream since 7.2
# @dgram since 7.2
# Since: 2.7
##
{ 'enum': 'NetClientDriver',
'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'stream',
Expand All @@ -669,12 +670,6 @@
#
# Since: 1.2
#
# 'l2tpv3' - since 2.1
# 'vmnet-host' - since 7.1
# 'vmnet-shared' - since 7.1
# 'vmnet-bridged' - since 7.1
# 'stream' since 7.2
# 'dgram' since 7.2
##
{ 'union': 'Netdev',
'base': { 'id': 'str', 'type': 'NetClientDriver' },
Expand Down Expand Up @@ -914,16 +909,14 @@
#
# Since: 7.2
#
# Example:
# Examples:
#
# <- { "event": "NETDEV_STREAM_CONNECTED",
# "data": { "netdev-id": "netdev0",
# "addr": { "port": "47666", "ipv6": true,
# "host": "::1", "type": "inet" } },
# "timestamp": { "seconds": 1666269863, "microseconds": 311222 } }
#
# or
#
# <- { "event": "NETDEV_STREAM_CONNECTED",
# "data": { "netdev-id": "netdev0",
# "addr": { "path": "/tmp/qemu0", "type": "unix" } },
Expand Down
24 changes: 1 addition & 23 deletions qapi/qapi-schema.json
View file
Expand Up @@ -28,28 +28,6 @@
#
# Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for
# detailed information on the Server command and response formats.
#
# = Stability Considerations
#
# The current QMP command set (described in this file) may be useful for a
# number of use cases, however it's limited and several commands have bad
# defined semantics, specially with regard to command completion.
#
# These problems are going to be solved incrementally in the next QEMU releases
# and we're going to establish a deprecation policy for badly defined commands.
#
# If you're planning to adopt QMP, please observe the following:
#
# 1. The deprecation policy will take effect and be documented soon, please
# check the documentation of each used command as soon as a new release of
# QEMU is available
#
# 2. DO NOT rely on anything which is not explicit documented
#
# 3. Errors, in special, are not documented. Applications should NOT check
# for specific errors classes or data (it's strongly recommended to only
# check for the "error" key)
#
##

{ 'include': 'pragma.json' }
Expand All @@ -65,11 +43,11 @@
{ 'include': 'sockets.json' }
{ 'include': 'run-state.json' }
{ 'include': 'crypto.json' }
{ 'include': 'job.json' }
{ 'include': 'block.json' }
{ 'include': 'block-export.json' }
{ 'include': 'char.json' }
{ 'include': 'dump.json' }
{ 'include': 'job.json' }
{ 'include': 'net.json' }
{ 'include': 'rdma.json' }
{ 'include': 'rocker.json' }
Expand Down
2 changes: 1 addition & 1 deletion qapi/qdev.json
View file
Expand Up @@ -100,7 +100,7 @@
#
# Since: 0.14
#
# Example:
# Examples:
#
# -> { "execute": "device_del",
# "arguments": { "id": "net1" } }
Expand Down
4 changes: 2 additions & 2 deletions qapi/qom.json
View file
Expand Up @@ -103,7 +103,7 @@
#
# Since: 1.2
#
# Example:
# Examples:
#
# 1. Use absolute path
#
Expand Down Expand Up @@ -637,7 +637,7 @@
#
# @discard-data: if true, the file contents can be destroyed when QEMU exits,
# to avoid unnecessarily flushing data to the backing file. Note
# that ``discard-data`` is only an optimization, and QEMU might
# that @discard-data is only an optimization, and QEMU might
# not discard file contents if it aborts unexpectedly or is
# terminated using SIGKILL. (default: false)
#
Expand Down
2 changes: 1 addition & 1 deletion qapi/rdma.json
View file
Expand Up @@ -17,7 +17,7 @@
#
# @subnet-prefix: Subnet Prefix
#
# @interface-id : Interface ID
# @interface-id: Interface ID
#
# Since: 4.0
#
Expand Down
3 changes: 3 additions & 0 deletions qapi/replay.json
View file
Expand Up @@ -81,6 +81,7 @@
# Example:
#
# -> { "execute": "replay-break", "arguments": { "icount": 220414 } }
# <- { "return": {} }
#
##
{ 'command': 'replay-break', 'data': { 'icount': 'int' } }
Expand All @@ -96,6 +97,7 @@
# Example:
#
# -> { "execute": "replay-delete-break" }
# <- { "return": {} }
#
##
{ 'command': 'replay-delete-break' }
Expand All @@ -117,5 +119,6 @@
# Example:
#
# -> { "execute": "replay-seek", "arguments": { "icount": 220414 } }
# <- { "return": {} }
##
{ 'command': 'replay-seek', 'data': { 'icount': 'int' } }
11 changes: 7 additions & 4 deletions qapi/run-state.json
View file
Expand Up @@ -258,9 +258,8 @@
#
# Example:
#
# <- { "event": "SUSPEND_DISK",
# "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }
#
# <- { "event": "SUSPEND_DISK",
# "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }
##
{ 'event': 'SUSPEND_DISK' }

Expand Down Expand Up @@ -468,7 +467,11 @@
#
# @pause: system pauses
#
# Since: 2.1 (poweroff since 2.8, run since 5.0)
# @poweroff: system powers off (since 2.8)
#
# @run: system continues to run (since 5.0)
#
# Since: 2.1
##
{ 'enum': 'GuestPanicAction',
'data': [ 'pause', 'poweroff', 'run' ] }
Expand Down
3 changes: 2 additions & 1 deletion qapi/stats.json
View file
Expand Up @@ -69,7 +69,7 @@
#
# @vcpu: statistics that apply to a single virtual CPU.
#
# @cryptodev: statistics that apply to a crypto device. since 8.0
# @cryptodev: statistics that apply to a crypto device (since 8.0)
#
# Since: 7.1
##
Expand Down Expand Up @@ -107,6 +107,7 @@
# The arguments to the query-stats command; specifies a target for which to
# request statistics and optionally the required subset of information for
# that target:
#
# - which vCPUs to request statistics for
# - which providers to request statistics from
# - which named values to return within each provider
Expand Down
3 changes: 1 addition & 2 deletions qapi/tpm.json
View file
Expand Up @@ -44,8 +44,7 @@
# An enumeration of TPM types
#
# @passthrough: TPM passthrough type
# @emulator: Software Emulator TPM type
# Since: 2.11
# @emulator: Software Emulator TPM type (since 2.11)
#
# Since: 1.5
##
Expand Down
1 change: 1 addition & 0 deletions qapi/trace.json
View file
Expand Up @@ -87,6 +87,7 @@
# @vcpu: The vCPU to act upon (all by default; since 2.7).
#
# An event's state is modified if:
#
# - its name matches the @name pattern, and
# - if @vcpu is given, the event has the "vcpu" property.
#
Expand Down
12 changes: 6 additions & 6 deletions qapi/ui.json
View file
Expand Up @@ -985,7 +985,7 @@
# to 100
#
# Returns: - Nothing on success
# - If key is unknown or redundant, InvalidParameter
# - If key is unknown or redundant, GenericError
#
# Since: 1.3
#
Expand Down Expand Up @@ -1153,7 +1153,7 @@
# so it is possible to map which console belongs to which device and
# display.
#
# Example:
# Examples:
#
# 1. Press left mouse button.
#
Expand Down Expand Up @@ -1207,13 +1207,13 @@
# window resizes (virtio-gpu) this will default to "on",
# assuming the guest will resize the display to match
# the window size then. Otherwise it defaults to "off".
# Since 3.1
# (Since 3.1)
# @show-tabs: Display the tab bar for switching between the various graphical
# interfaces (e.g. VGA and virtual console character devices)
# by default.
# Since 7.1
# (Since 7.1)
# @show-menubar: Display the main window menubar. Defaults to "on".
# Since 8.0
# (Since 8.0)
#
# Since: 2.12
##
Expand Down Expand Up @@ -1247,7 +1247,7 @@
# available node on the host.
#
# @p2p: Whether to use peer-to-peer connections (accepted through
# ``add_client``).
# @add_client).
#
# @audiodev: Use the specified DBus audiodev to export audio.
#
Expand Down
21 changes: 11 additions & 10 deletions qapi/yank.json
View file
Expand Up @@ -50,16 +50,17 @@
# hanging QEMU.
#
# Currently implemented yank instances:
# - nbd block device:
# Yanking it will shut down the connection to the nbd server without
# attempting to reconnect.
# - socket chardev:
# Yanking it will shut down the connected socket.
# - migration:
# Yanking it will shut down all migration connections. Unlike
# @migrate_cancel, it will not notify the migration process, so migration
# will go into @failed state, instead of @cancelled state. @yank should be
# used to recover from hangs.
#
# - nbd block device:
# Yanking it will shut down the connection to the nbd server without
# attempting to reconnect.
# - socket chardev:
# Yanking it will shut down the connected socket.
# - migration:
# Yanking it will shut down all migration connections. Unlike
# @migrate_cancel, it will not notify the migration process, so migration
# will go into @failed state, instead of @cancelled state. @yank should be
# used to recover from hangs.
#
# Since: 6.0
##
Expand Down
10 changes: 5 additions & 5 deletions qga/qapi-schema.json
View file
Expand Up @@ -420,7 +420,7 @@
##
# @guest-fsfreeze-status:
#
# Get guest fsfreeze state. error state indicates
# Get guest fsfreeze state.
#
# Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined below)
#
Expand Down Expand Up @@ -722,7 +722,7 @@
# Get list of guest IP addresses, MAC addresses
# and netmasks.
#
# Returns: List of GuestNetworkInfo on success.
# Returns: List of GuestNetworkInterface on success.
#
# Since: 1.1
##
Expand Down Expand Up @@ -1553,11 +1553,11 @@
##
# @GuestDiskStatsInfo:
#
# @name disk name
# @name: disk name
#
# @major major device number of disk
# @major: major device number of disk
#
# @minor minor device number of disk
# @minor: minor device number of disk
##
{ 'struct': 'GuestDiskStatsInfo',
'data': {'name': 'str',
Expand Down
20 changes: 14 additions & 6 deletions storage-daemon/qapi/qapi-schema.json
View file
Expand Up @@ -15,18 +15,26 @@

{ 'include': '../../qapi/pragma.json' }

# Documentation generated with qapi-gen.py is in source order, with
# included sub-schemas inserted at the first include directive
# (subsequent include directives have no effect). To get a sane and
# stable order, it's best to include each sub-schema just once, or
# include it first right here.

{ 'include': '../../qapi/common.json' }
{ 'include': '../../qapi/sockets.json' }
{ 'include': '../../qapi/crypto.json' }
{ 'include': '../../qapi/job.json' }

##
# = Block devices
##
{ 'include': '../../qapi/block-core.json' }
{ 'include': '../../qapi/block-export.json' }

{ 'include': '../../qapi/char.json' }
{ 'include': '../../qapi/common.json' }
{ 'include': '../../qapi/authz.json' }
{ 'include': '../../qapi/transaction.json' }
{ 'include': '../../qapi/control.json' }
{ 'include': '../../qapi/crypto.json' }
{ 'include': '../../qapi/introspect.json' }
{ 'include': '../../qapi/job.json' }
{ 'include': '../../qapi/authz.json' }
{ 'include': '../../qapi/qom.json' }
{ 'include': '../../qapi/sockets.json' }
{ 'include': '../../qapi/transaction.json' }