qapi: Mark unstable QMP parts with feature 'unstable'

Add special feature 'unstable' everywhere the name starts with 'x-',
except for InputBarrierProperties member x-origin and
MemoryBackendProperties member x-use-canonical-path-for-ramblock-id,
because these two are actually stable.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Acked-by: John Snow <jsnow@redhat.com>
Message-Id: <20211028102520.747396-3-armbru@redhat.com>
master
Markus Armbruster 2021-10-28 12:25:13 +02:00
parent a3c45b3e62
commit 9fb49daabf
4 changed files with 130 additions and 45 deletions

View File

@ -1438,6 +1438,9 @@
# #
# @x-perf: Performance options. (Since 6.0) # @x-perf: Performance options. (Since 6.0)
# #
# Features:
# @unstable: Member @x-perf is experimental.
#
# Note: @on-source-error and @on-target-error only affect background # Note: @on-source-error and @on-target-error only affect background
# I/O. If an error occurs during a guest write request, the device's # I/O. If an error occurs during a guest write request, the device's
# rerror/werror actions will be used. # rerror/werror actions will be used.
@ -1452,7 +1455,9 @@
'*on-source-error': 'BlockdevOnError', '*on-source-error': 'BlockdevOnError',
'*on-target-error': 'BlockdevOnError', '*on-target-error': 'BlockdevOnError',
'*auto-finalize': 'bool', '*auto-dismiss': 'bool', '*auto-finalize': 'bool', '*auto-dismiss': 'bool',
'*filter-node-name': 'str', '*x-perf': 'BackupPerf' } } '*filter-node-name': 'str',
'*x-perf': { 'type': 'BackupPerf',
'features': [ 'unstable' ] } } }
## ##
# @DriveBackup: # @DriveBackup:
@ -1916,9 +1921,13 @@
# #
# Get the block graph. # Get the block graph.
# #
# Features:
# @unstable: This command is meant for debugging.
#
# Since: 4.0 # Since: 4.0
## ##
{ 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph' } { 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph',
'features': [ 'unstable' ] }
## ##
# @drive-mirror: # @drive-mirror:
@ -2257,6 +2266,9 @@
# #
# Get bitmap SHA256. # Get bitmap SHA256.
# #
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: - BlockDirtyBitmapSha256 on success # Returns: - BlockDirtyBitmapSha256 on success
# - If @node is not a valid block device, DeviceNotFound # - If @node is not a valid block device, DeviceNotFound
# - If @name is not found or if hashing has failed, GenericError with an # - If @name is not found or if hashing has failed, GenericError with an
@ -2265,7 +2277,8 @@
# Since: 2.10 # Since: 2.10
## ##
{ 'command': 'x-debug-block-dirty-bitmap-sha256', { 'command': 'x-debug-block-dirty-bitmap-sha256',
'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256' } 'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256',
'features': [ 'unstable' ] }
## ##
# @blockdev-mirror: # @blockdev-mirror:
@ -2495,27 +2508,57 @@
# #
# Properties for throttle-group objects. # Properties for throttle-group objects.
# #
# The options starting with x- are aliases for the same key without x- in
# the @limits object. As indicated by the x- prefix, this is not a stable
# interface and may be removed or changed incompatibly in the future. Use
# @limits for a supported stable interface.
#
# @limits: limits to apply for this throttle group # @limits: limits to apply for this throttle group
# #
# Features:
# @unstable: All members starting with x- are aliases for the same key
# without x- in the @limits object. This is not a stable
# interface and may be removed or changed incompatibly in
# the future. Use @limits for a supported stable
# interface.
#
# Since: 2.11 # Since: 2.11
## ##
{ 'struct': 'ThrottleGroupProperties', { 'struct': 'ThrottleGroupProperties',
'data': { '*limits': 'ThrottleLimits', 'data': { '*limits': 'ThrottleLimits',
'*x-iops-total' : 'int', '*x-iops-total-max' : 'int', '*x-iops-total': { 'type': 'int',
'*x-iops-total-max-length' : 'int', '*x-iops-read' : 'int', 'features': [ 'unstable' ] },
'*x-iops-read-max' : 'int', '*x-iops-read-max-length' : 'int', '*x-iops-total-max': { 'type': 'int',
'*x-iops-write' : 'int', '*x-iops-write-max' : 'int', 'features': [ 'unstable' ] },
'*x-iops-write-max-length' : 'int', '*x-bps-total' : 'int', '*x-iops-total-max-length': { 'type': 'int',
'*x-bps-total-max' : 'int', '*x-bps-total-max-length' : 'int', 'features': [ 'unstable' ] },
'*x-bps-read' : 'int', '*x-bps-read-max' : 'int', '*x-iops-read': { 'type': 'int',
'*x-bps-read-max-length' : 'int', '*x-bps-write' : 'int', 'features': [ 'unstable' ] },
'*x-bps-write-max' : 'int', '*x-bps-write-max-length' : 'int', '*x-iops-read-max': { 'type': 'int',
'*x-iops-size' : 'int' } } 'features': [ 'unstable' ] },
'*x-iops-read-max-length': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-iops-write': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-iops-write-max': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-iops-write-max-length': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-total': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-total-max': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-total-max-length': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-read': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-read-max': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-read-max-length': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-write': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-write-max': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-bps-write-max-length': { 'type': 'int',
'features': [ 'unstable' ] },
'*x-iops-size': { 'type': 'int',
'features': [ 'unstable' ] } } }
## ##
# @block-stream: # @block-stream:
@ -2916,6 +2959,7 @@
# read-only when the last writer is detached. This # read-only when the last writer is detached. This
# allows giving QEMU write permissions only on demand # allows giving QEMU write permissions only on demand
# when an operation actually needs write access. # when an operation actually needs write access.
# @unstable: Member x-check-cache-dropped is meant for debugging.
# #
# Since: 2.9 # Since: 2.9
## ##
@ -2926,7 +2970,8 @@
'*aio': 'BlockdevAioOptions', '*aio': 'BlockdevAioOptions',
'*drop-cache': {'type': 'bool', '*drop-cache': {'type': 'bool',
'if': 'CONFIG_LINUX'}, 'if': 'CONFIG_LINUX'},
'*x-check-cache-dropped': 'bool' }, '*x-check-cache-dropped': { 'type': 'bool',
'features': [ 'unstable' ] } },
'features': [ { 'name': 'dynamic-auto-read-only', 'features': [ { 'name': 'dynamic-auto-read-only',
'if': 'CONFIG_POSIX' } ] } 'if': 'CONFIG_POSIX' } ] }
@ -4041,13 +4086,16 @@
# future requests before a successful reconnect will # future requests before a successful reconnect will
# immediately fail. Default 0 (Since 4.2) # immediately fail. Default 0 (Since 4.2)
# #
# Features:
# @unstable: Member @x-dirty-bitmap is experimental.
#
# Since: 2.9 # Since: 2.9
## ##
{ 'struct': 'BlockdevOptionsNbd', { 'struct': 'BlockdevOptionsNbd',
'data': { 'server': 'SocketAddress', 'data': { 'server': 'SocketAddress',
'*export': 'str', '*export': 'str',
'*tls-creds': 'str', '*tls-creds': 'str',
'*x-dirty-bitmap': 'str', '*x-dirty-bitmap': { 'type': 'str', 'features': [ 'unstable' ] },
'*reconnect-delay': 'uint32' } } '*reconnect-delay': 'uint32' } }
## ##
@ -4865,13 +4913,17 @@
# and replacement of an active keyslot # and replacement of an active keyslot
# (possible loss of data if IO error happens) # (possible loss of data if IO error happens)
# #
# Features:
# @unstable: This command is experimental.
#
# Since: 5.1 # Since: 5.1
## ##
{ 'command': 'x-blockdev-amend', { 'command': 'x-blockdev-amend',
'data': { 'job-id': 'str', 'data': { 'job-id': 'str',
'node-name': 'str', 'node-name': 'str',
'options': 'BlockdevAmendOptions', 'options': 'BlockdevAmendOptions',
'*force': 'bool' } } '*force': 'bool' },
'features': [ 'unstable' ] }
## ##
# @BlockErrorAction: # @BlockErrorAction:
@ -5242,16 +5294,18 @@
# #
# @node: the name of the node that will be added. # @node: the name of the node that will be added.
# #
# Note: this command is experimental, and its API is not stable. It # Features:
# does not support all kinds of operations, all kinds of children, nor # @unstable: This command is experimental, and its API is not stable. It
# all block drivers. # does not support all kinds of operations, all kinds of
# children, nor all block drivers.
# #
# FIXME Removing children from a quorum node means introducing gaps in the # FIXME Removing children from a quorum node means introducing
# child indices. This cannot be represented in the 'children' list of # gaps in the child indices. This cannot be represented in the
# BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename(). # 'children' list of BlockdevOptionsQuorum, as returned by
# .bdrv_refresh_filename().
# #
# Warning: The data in a new quorum child MUST be consistent with that of # Warning: The data in a new quorum child MUST be consistent
# the rest of the array. # with that of the rest of the array.
# #
# Since: 2.7 # Since: 2.7
# #
@ -5280,7 +5334,8 @@
{ 'command': 'x-blockdev-change', { 'command': 'x-blockdev-change',
'data' : { 'parent': 'str', 'data' : { 'parent': 'str',
'*child': 'str', '*child': 'str',
'*node': 'str' } } '*node': 'str' },
'features': [ 'unstable' ] }
## ##
# @x-blockdev-set-iothread: # @x-blockdev-set-iothread:
@ -5297,8 +5352,9 @@
# @force: true if the node and its children should be moved when a BlockBackend # @force: true if the node and its children should be moved when a BlockBackend
# is already attached # is already attached
# #
# Note: this command is experimental and intended for test cases that need # Features:
# control over IOThreads only. # @unstable: This command is experimental and intended for test cases that
# need control over IOThreads only.
# #
# Since: 2.12 # Since: 2.12
# #
@ -5320,7 +5376,8 @@
{ 'command': 'x-blockdev-set-iothread', { 'command': 'x-blockdev-set-iothread',
'data' : { 'node-name': 'str', 'data' : { 'node-name': 'str',
'iothread': 'StrOrNull', 'iothread': 'StrOrNull',
'*force': 'bool' } } '*force': 'bool' },
'features': [ 'unstable' ] }
## ##
# @QuorumOpType: # @QuorumOpType:

View File

@ -452,14 +452,20 @@
# procedure starts. The VM RAM is saved with running VM. # procedure starts. The VM RAM is saved with running VM.
# (since 6.0) # (since 6.0)
# #
# Features:
# @unstable: Members @x-colo and @x-ignore-shared are experimental.
#
# Since: 1.2 # Since: 1.2
## ##
{ 'enum': 'MigrationCapability', { 'enum': 'MigrationCapability',
'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks', 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
'compress', 'events', 'postcopy-ram', 'x-colo', 'release-ram', 'compress', 'events', 'postcopy-ram',
{ 'name': 'x-colo', 'features': [ 'unstable' ] },
'release-ram',
'block', 'return-path', 'pause-before-switchover', 'multifd', 'block', 'return-path', 'pause-before-switchover', 'multifd',
'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate', 'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate',
'x-ignore-shared', 'validate-uuid', 'background-snapshot'] } { 'name': 'x-ignore-shared', 'features': [ 'unstable' ] },
'validate-uuid', 'background-snapshot'] }
## ##
# @MigrationCapabilityStatus: # @MigrationCapabilityStatus:
@ -743,6 +749,9 @@
# block device name if there is one, and to their node name # block device name if there is one, and to their node name
# otherwise. (Since 5.2) # otherwise. (Since 5.2)
# #
# Features:
# @unstable: Member @x-checkpoint-delay is experimental.
#
# Since: 2.4 # Since: 2.4
## ##
{ 'enum': 'MigrationParameter', { 'enum': 'MigrationParameter',
@ -753,7 +762,9 @@
'cpu-throttle-initial', 'cpu-throttle-increment', 'cpu-throttle-initial', 'cpu-throttle-increment',
'cpu-throttle-tailslow', 'cpu-throttle-tailslow',
'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth', 'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth',
'downtime-limit', 'x-checkpoint-delay', 'block-incremental', 'downtime-limit',
{ 'name': 'x-checkpoint-delay', 'features': [ 'unstable' ] },
'block-incremental',
'multifd-channels', 'multifd-channels',
'xbzrle-cache-size', 'max-postcopy-bandwidth', 'xbzrle-cache-size', 'max-postcopy-bandwidth',
'max-cpu-throttle', 'multifd-compression', 'max-cpu-throttle', 'multifd-compression',
@ -903,6 +914,9 @@
# block device name if there is one, and to their node name # block device name if there is one, and to their node name
# otherwise. (Since 5.2) # otherwise. (Since 5.2)
# #
# Features:
# @unstable: Member @x-checkpoint-delay is experimental.
#
# Since: 2.4 # Since: 2.4
## ##
# TODO either fuse back into MigrationParameters, or make # TODO either fuse back into MigrationParameters, or make
@ -925,7 +939,8 @@
'*tls-authz': 'StrOrNull', '*tls-authz': 'StrOrNull',
'*max-bandwidth': 'size', '*max-bandwidth': 'size',
'*downtime-limit': 'uint64', '*downtime-limit': 'uint64',
'*x-checkpoint-delay': 'uint32', '*x-checkpoint-delay': { 'type': 'uint32',
'features': [ 'unstable' ] },
'*block-incremental': 'bool', '*block-incremental': 'bool',
'*multifd-channels': 'uint8', '*multifd-channels': 'uint8',
'*xbzrle-cache-size': 'size', '*xbzrle-cache-size': 'size',
@ -1099,6 +1114,9 @@
# block device name if there is one, and to their node name # block device name if there is one, and to their node name
# otherwise. (Since 5.2) # otherwise. (Since 5.2)
# #
# Features:
# @unstable: Member @x-checkpoint-delay is experimental.
#
# Since: 2.4 # Since: 2.4
## ##
{ 'struct': 'MigrationParameters', { 'struct': 'MigrationParameters',
@ -1119,7 +1137,8 @@
'*tls-authz': 'str', '*tls-authz': 'str',
'*max-bandwidth': 'size', '*max-bandwidth': 'size',
'*downtime-limit': 'uint64', '*downtime-limit': 'uint64',
'*x-checkpoint-delay': 'uint32', '*x-checkpoint-delay': { 'type': 'uint32',
'features': [ 'unstable' ] },
'*block-incremental': 'bool', '*block-incremental': 'bool',
'*multifd-channels': 'uint8', '*multifd-channels': 'uint8',
'*xbzrle-cache-size': 'size', '*xbzrle-cache-size': 'size',
@ -1351,6 +1370,9 @@
# If sent to the Secondary, the Secondary side will run failover work, # If sent to the Secondary, the Secondary side will run failover work,
# then takes over server operation to become the service VM. # then takes over server operation to become the service VM.
# #
# Features:
# @unstable: This command is experimental.
#
# Since: 2.8 # Since: 2.8
# #
# Example: # Example:
@ -1359,7 +1381,8 @@
# <- { "return": {} } # <- { "return": {} }
# #
## ##
{ 'command': 'x-colo-lost-heartbeat' } { 'command': 'x-colo-lost-heartbeat',
'features': [ 'unstable' ] }
## ##
# @migrate_cancel: # @migrate_cancel:

View File

@ -185,6 +185,9 @@
# available during the preconfig state (i.e. when the --preconfig command # available during the preconfig state (i.e. when the --preconfig command
# line option was in use). # line option was in use).
# #
# Features:
# @unstable: This command is experimental.
#
# Since 3.0 # Since 3.0
# #
# Returns: nothing # Returns: nothing
@ -195,7 +198,8 @@
# <- { "return": {} } # <- { "return": {} }
# #
## ##
{ 'command': 'x-exit-preconfig', 'allow-preconfig': true } { 'command': 'x-exit-preconfig', 'allow-preconfig': true,
'features': [ 'unstable' ] }
## ##
# @human-monitor-command: # @human-monitor-command:

View File

@ -559,10 +559,8 @@
# for ramblock-id. Disable this for 4.0 # for ramblock-id. Disable this for 4.0
# machine types or older to allow # machine types or older to allow
# migration with newer QEMU versions. # migration with newer QEMU versions.
# This option is considered stable # (default: false generally,
# despite the x- prefix. (default: # but true for machine types <= 4.0)
# false generally, but true for machine
# types <= 4.0)
# #
# Note: prealloc=true and reserve=false cannot be set at the same time. With # Note: prealloc=true and reserve=false cannot be set at the same time. With
# reserve=true, the behavior depends on the operating system: for example, # reserve=true, the behavior depends on the operating system: for example,
@ -785,6 +783,9 @@
## ##
# @ObjectType: # @ObjectType:
# #
# Features:
# @unstable: Member @x-remote-object is experimental.
#
# Since: 6.0 # Since: 6.0
## ##
{ 'enum': 'ObjectType', { 'enum': 'ObjectType',
@ -836,7 +837,7 @@
'tls-creds-psk', 'tls-creds-psk',
'tls-creds-x509', 'tls-creds-x509',
'tls-cipher-suites', 'tls-cipher-suites',
'x-remote-object' { 'name': 'x-remote-object', 'features': [ 'unstable' ] }
] } ] }
## ##