2014-06-05 13:45:30 +02:00
|
|
|
# -*- Mode: Python -*-
|
2017-01-13 15:41:23 +01:00
|
|
|
|
|
|
|
##
|
2017-08-24 21:14:08 +02:00
|
|
|
# == Block core (VM unrelated)
|
2017-01-13 15:41:23 +01:00
|
|
|
##
|
2014-06-05 13:45:30 +02:00
|
|
|
|
|
|
|
{ 'include': 'common.json' }
|
2017-08-24 21:14:06 +02:00
|
|
|
{ 'include': 'crypto.json' }
|
2018-05-16 16:03:10 +02:00
|
|
|
{ 'include': 'job.json' }
|
2017-08-24 21:13:56 +02:00
|
|
|
{ 'include': 'sockets.json' }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @SnapshotInfo:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @id: unique snapshot id
|
|
|
|
#
|
|
|
|
# @name: user chosen name
|
|
|
|
#
|
|
|
|
# @vm-state-size: size of the VM state
|
|
|
|
#
|
|
|
|
# @date-sec: UTC date of the snapshot in seconds
|
|
|
|
#
|
|
|
|
# @date-nsec: fractional part in nano seconds to be used with date-sec
|
|
|
|
#
|
|
|
|
# @vm-clock-sec: VM clock relative to boot in seconds
|
|
|
|
#
|
|
|
|
# @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
|
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
#
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'SnapshotInfo',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
|
|
|
|
'date-sec': 'int', 'date-nsec': 'int',
|
|
|
|
'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
|
|
|
|
|
2017-06-23 18:24:18 +02:00
|
|
|
##
|
|
|
|
# @ImageInfoSpecificQCow2EncryptionBase:
|
|
|
|
#
|
|
|
|
# @format: The encryption format
|
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'struct': 'ImageInfoSpecificQCow2EncryptionBase',
|
|
|
|
'data': { 'format': 'BlockdevQcow2EncryptionFormat'}}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @ImageInfoSpecificQCow2Encryption:
|
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'union': 'ImageInfoSpecificQCow2Encryption',
|
|
|
|
'base': 'ImageInfoSpecificQCow2EncryptionBase',
|
|
|
|
'discriminator': 'format',
|
2018-06-18 10:40:06 +02:00
|
|
|
'data': { 'luks': 'QCryptoBlockInfoLUKS' } }
|
2017-06-23 18:24:18 +02:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @ImageInfoSpecificQCow2:
|
|
|
|
#
|
|
|
|
# @compat: compatibility level
|
|
|
|
#
|
2019-01-15 19:02:40 +01:00
|
|
|
# @data-file: the filename of the external data file that is stored in the
|
|
|
|
# image and used as a default for opening the image (since: 4.0)
|
|
|
|
#
|
2019-02-22 14:29:38 +01:00
|
|
|
# @data-file-raw: True if the external data file must stay valid as a
|
|
|
|
# standalone (read-only) raw image without looking at qcow2
|
|
|
|
# metadata (since: 4.0)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @lazy-refcounts: on or off; only valid for compat >= 1.1
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @corrupt: true if the image has been marked corrupt; only valid for
|
2014-09-30 21:31:28 +02:00
|
|
|
# compat >= 1.1 (since 2.2)
|
|
|
|
#
|
2015-02-10 21:28:44 +01:00
|
|
|
# @refcount-bits: width of a refcount entry in bits (since 2.3)
|
|
|
|
#
|
2017-06-23 18:24:18 +02:00
|
|
|
# @encrypt: details about encryption parameters; only set if image
|
|
|
|
# is encrypted (since 2.10)
|
|
|
|
#
|
2019-02-08 16:06:07 +01:00
|
|
|
# @bitmaps: A list of qcow2 bitmap details (since 4.0)
|
|
|
|
#
|
qcow2: introduce compression type feature
The patch adds some preparation parts for incompatible compression type
feature to qcow2 allowing the use different compression methods for
image clusters (de)compressing.
It is implied that the compression type is set on the image creation and
can be changed only later by image conversion, thus compression type
defines the only compression algorithm used for the image, and thus,
for all image clusters.
The goal of the feature is to add support of other compression methods
to qcow2. For example, ZSTD which is more effective on compression than ZLIB.
The default compression is ZLIB. Images created with ZLIB compression type
are backward compatible with older qemu versions.
Adding of the compression type breaks a number of tests because now the
compression type is reported on image creation and there are some changes
in the qcow2 header in size and offsets.
The tests are fixed in the following ways:
* filter out compression_type for many tests
* fix header size, feature table size and backing file offset
affected tests: 031, 036, 061, 080
header_size +=8: 1 byte compression type
7 bytes padding
feature_table += 48: incompatible feature compression type
backing_file_offset += 56 (8 + 48 -> header_change + feature_table_change)
* add "compression type" for test output matching when it isn't filtered
affected tests: 049, 060, 061, 065, 082, 085, 144, 182, 185, 198, 206,
242, 255, 274, 280
Signed-off-by: Denis Plotnikov <dplotnikov@virtuozzo.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
QAPI part:
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200507082521.29210-2-dplotnikov@virtuozzo.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-05-07 10:25:18 +02:00
|
|
|
# @compression-type: the image cluster compression method (since 5.1)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 1.7
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'ImageInfoSpecificQCow2',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': {
|
|
|
|
'compat': 'str',
|
2019-01-15 19:02:40 +01:00
|
|
|
'*data-file': 'str',
|
2019-02-22 14:29:38 +01:00
|
|
|
'*data-file-raw': 'bool',
|
2014-09-30 21:31:28 +02:00
|
|
|
'*lazy-refcounts': 'bool',
|
2015-02-10 21:28:44 +01:00
|
|
|
'*corrupt': 'bool',
|
2017-06-23 18:24:18 +02:00
|
|
|
'refcount-bits': 'int',
|
2019-02-08 16:06:07 +01:00
|
|
|
'*encrypt': 'ImageInfoSpecificQCow2Encryption',
|
qcow2: introduce compression type feature
The patch adds some preparation parts for incompatible compression type
feature to qcow2 allowing the use different compression methods for
image clusters (de)compressing.
It is implied that the compression type is set on the image creation and
can be changed only later by image conversion, thus compression type
defines the only compression algorithm used for the image, and thus,
for all image clusters.
The goal of the feature is to add support of other compression methods
to qcow2. For example, ZSTD which is more effective on compression than ZLIB.
The default compression is ZLIB. Images created with ZLIB compression type
are backward compatible with older qemu versions.
Adding of the compression type breaks a number of tests because now the
compression type is reported on image creation and there are some changes
in the qcow2 header in size and offsets.
The tests are fixed in the following ways:
* filter out compression_type for many tests
* fix header size, feature table size and backing file offset
affected tests: 031, 036, 061, 080
header_size +=8: 1 byte compression type
7 bytes padding
feature_table += 48: incompatible feature compression type
backing_file_offset += 56 (8 + 48 -> header_change + feature_table_change)
* add "compression type" for test output matching when it isn't filtered
affected tests: 049, 060, 061, 065, 082, 085, 144, 182, 185, 198, 206,
242, 255, 274, 280
Signed-off-by: Denis Plotnikov <dplotnikov@virtuozzo.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
QAPI part:
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200507082521.29210-2-dplotnikov@virtuozzo.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-05-07 10:25:18 +02:00
|
|
|
'*bitmaps': ['Qcow2BitmapInfo'],
|
|
|
|
'compression-type': 'Qcow2CompressionType'
|
2014-06-05 13:45:31 +02:00
|
|
|
} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @ImageInfoSpecificVmdk:
|
|
|
|
#
|
|
|
|
# @create-type: The create type of VMDK image
|
|
|
|
#
|
|
|
|
# @cid: Content id of image
|
|
|
|
#
|
|
|
|
# @parent-cid: Parent VMDK image's cid
|
|
|
|
#
|
|
|
|
# @extents: List of extent files
|
|
|
|
#
|
|
|
|
# Since: 1.7
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'ImageInfoSpecificVmdk',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': {
|
|
|
|
'create-type': 'str',
|
|
|
|
'cid': 'int',
|
|
|
|
'parent-cid': 'int',
|
|
|
|
'extents': ['ImageInfo']
|
|
|
|
} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @ImageInfoSpecific:
|
|
|
|
#
|
|
|
|
# A discriminated record of image format specific information structures.
|
|
|
|
#
|
|
|
|
# Since: 1.7
|
|
|
|
##
|
|
|
|
{ 'union': 'ImageInfoSpecific',
|
|
|
|
'data': {
|
|
|
|
'qcow2': 'ImageInfoSpecificQCow2',
|
2016-07-22 14:53:35 +02:00
|
|
|
'vmdk': 'ImageInfoSpecificVmdk',
|
|
|
|
# If we need to add block driver specific parameters for
|
|
|
|
# LUKS in future, then we'll subclass QCryptoBlockInfoLUKS
|
|
|
|
# to define a ImageInfoSpecificLUKS
|
|
|
|
'luks': 'QCryptoBlockInfoLUKS'
|
2014-06-05 13:45:31 +02:00
|
|
|
} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @ImageInfo:
|
|
|
|
#
|
|
|
|
# Information about a QEMU image file
|
|
|
|
#
|
|
|
|
# @filename: name of the image file
|
|
|
|
#
|
|
|
|
# @format: format of the image file
|
|
|
|
#
|
|
|
|
# @virtual-size: maximum capacity in bytes of the image
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @actual-size: actual size on disk in bytes of the image
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @dirty-flag: true if image is not cleanly closed
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @cluster-size: size of a cluster in bytes
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @encrypted: true if the image is encrypted
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @compressed: true if the image is compressed (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @backing-filename: name of the backing file
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @full-backing-filename: full path of the backing file
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @backing-filename-format: the format of the backing file
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @snapshots: list of VM snapshots
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @backing-image: info of the backing image (since 1.6)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @format-specific: structure supplying additional format-specific
|
2020-02-13 18:56:26 +01:00
|
|
|
# information (since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
#
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'ImageInfo',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
|
|
|
|
'*actual-size': 'int', 'virtual-size': 'int',
|
|
|
|
'*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
|
|
|
|
'*backing-filename': 'str', '*full-backing-filename': 'str',
|
|
|
|
'*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
|
|
|
|
'*backing-image': 'ImageInfo',
|
2014-11-21 17:43:57 +01:00
|
|
|
'*format-specific': 'ImageInfoSpecific' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @ImageCheck:
|
|
|
|
#
|
|
|
|
# Information about a QEMU image file check
|
|
|
|
#
|
|
|
|
# @filename: name of the image file checked
|
|
|
|
#
|
|
|
|
# @format: format of the image file checked
|
|
|
|
#
|
|
|
|
# @check-errors: number of unexpected errors occurred during check
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @image-end-offset: offset (in bytes) where the image ends, this
|
2014-06-05 13:45:31 +02:00
|
|
|
# field is present if the driver for the image format
|
|
|
|
# supports it
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @corruptions: number of corruptions found during the check if any
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @leaks: number of leaks found during the check if any
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @corruptions-fixed: number of corruptions fixed during the check
|
2014-06-05 13:45:31 +02:00
|
|
|
# if any
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @leaks-fixed: number of leaks fixed during the check if any
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @total-clusters: total number of clusters, this field is present
|
2014-06-05 13:45:31 +02:00
|
|
|
# if the driver for the image format supports it
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @allocated-clusters: total number of allocated clusters, this
|
2014-06-05 13:45:31 +02:00
|
|
|
# field is present if the driver for the image format
|
|
|
|
# supports it
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @fragmented-clusters: total number of fragmented clusters, this
|
2014-06-05 13:45:31 +02:00
|
|
|
# field is present if the driver for the image format
|
|
|
|
# supports it
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @compressed-clusters: total number of compressed clusters, this
|
2014-06-05 13:45:31 +02:00
|
|
|
# field is present if the driver for the image format
|
|
|
|
# supports it
|
|
|
|
#
|
|
|
|
# Since: 1.4
|
|
|
|
#
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'ImageCheck',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
|
|
|
|
'*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
|
|
|
|
'*corruptions-fixed': 'int', '*leaks-fixed': 'int',
|
|
|
|
'*total-clusters': 'int', '*allocated-clusters': 'int',
|
|
|
|
'*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
|
|
|
|
|
2016-01-26 04:59:02 +01:00
|
|
|
##
|
|
|
|
# @MapEntry:
|
|
|
|
#
|
|
|
|
# Mapping information from a virtual block range to a host file range
|
|
|
|
#
|
|
|
|
# @start: the start byte of the mapped virtual range
|
|
|
|
#
|
|
|
|
# @length: the number of bytes of the mapped virtual range
|
|
|
|
#
|
|
|
|
# @data: whether the mapped range has data
|
|
|
|
#
|
|
|
|
# @zero: whether the virtual blocks are zeroed
|
|
|
|
#
|
|
|
|
# @depth: the depth of the mapping
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @offset: the offset in file that the virtual sectors are mapped to
|
2016-01-26 04:59:02 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @filename: filename that is referred to by @offset
|
2016-01-26 04:59:02 +01:00
|
|
|
#
|
|
|
|
# Since: 2.6
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'struct': 'MapEntry',
|
|
|
|
'data': {'start': 'int', 'length': 'int', 'data': 'bool',
|
|
|
|
'zero': 'bool', 'depth': 'int', '*offset': 'int',
|
|
|
|
'*filename': 'str' } }
|
|
|
|
|
2014-05-22 13:28:45 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevCacheInfo:
|
2014-05-22 13:28:45 +02:00
|
|
|
#
|
|
|
|
# Cache mode information for a block device
|
|
|
|
#
|
|
|
|
# @writeback: true if writeback mode is enabled
|
|
|
|
# @direct: true if the host page cache is bypassed (O_DIRECT)
|
|
|
|
# @no-flush: true if flush requests are ignored for the device
|
|
|
|
#
|
|
|
|
# Since: 2.3
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevCacheInfo',
|
2014-05-22 13:28:45 +02:00
|
|
|
'data': { 'writeback': 'bool',
|
|
|
|
'direct': 'bool',
|
|
|
|
'no-flush': 'bool' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @BlockDeviceInfo:
|
|
|
|
#
|
|
|
|
# Information about the backing device for a block device.
|
|
|
|
#
|
|
|
|
# @file: the filename of the backing device
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @node-name: the name of the block driver node (Since 2.0)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @ro: true if the backing device was open read-only
|
|
|
|
#
|
|
|
|
# @drv: the name of the block format used to open the backing device. As of
|
|
|
|
# 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
|
|
|
|
# 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
|
block: add generic full disk encryption driver
Add a block driver that is capable of supporting any full disk
encryption format. This utilizes the previously added block
encryption code, and at this time supports the LUKS format.
The driver code is capable of supporting any format supported
by the QCryptoBlock module, so it registers one block driver
for each format. This patch only registers the "luks" driver
since the "qcow" driver is there only for back-compatibility
with existing qcow built-in encryption.
New LUKS compatible volumes can be formatted using qemu-img
with defaults for all settings.
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0 demo.luks 10G
Alternatively the cryptographic settings can be explicitly
set
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0,cipher-alg=aes-256,\
cipher-mode=cbc,ivgen-alg=plain64,hash-alg=sha256 \
demo.luks 10G
And query its size
$ qemu-img info demo.img
image: demo.img
file format: luks
virtual size: 10G (10737418240 bytes)
disk size: 132K
encrypted: yes
Note that it was not necessary to provide the password
when querying info for the volume. The password is only
required when performing I/O on the volume
All volumes created by this new 'luks' driver should be
capable of being opened by the kernel dm-crypt driver.
The only algorithms listed in the LUKS spec that are
not currently supported by this impl are sha512 and
ripemd160 hashes and cast6 cipher.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
[ kwolf - Added #include to resolve conflict with da34e65c ]
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2016-03-21 15:11:47 +01:00
|
|
|
# 'http', 'https', 'luks', 'nbd', 'parallels', 'qcow',
|
block/curl: Drop TFTP "support"
Because TFTP does not support byte ranges, it was never usable with our
curl block driver. Since apparently nobody has ever complained loudly
enough for someone to take care of the issue until now, it seems
reasonable to assume that nobody has ever actually used it.
Therefore, it should be safe to just drop it from curl's protocol list.
[Jeff Cody: Below is additional summary pulled, with some rewording,
from followup emails between Max and Markus, to explain what
worked and what didn't]
TFTP would sometimes work, to a limited extent, for images <= the curl
"readahead" size, so long as reads started at offset zero. By default,
that readahead size is 256KB.
Reads starting at a non-zero offset would also have returned data from a
zero offset. It can become more complicated still, with mixed reads at
zero offset and non-zero offsets, due to data buffering.
In short, TFTP could only have worked before in very specific scenarios
with unrealistic expectations and constraints.
Signed-off-by: Max Reitz <mreitz@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Jeff Cody <jcody@redhat.com>
Message-id: 20161102175539.4375-4-mreitz@redhat.com
Signed-off-by: Jeff Cody <jcody@redhat.com>
2016-11-02 18:55:37 +01:00
|
|
|
# 'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat'
|
2014-09-16 16:24:24 +02:00
|
|
|
# 2.2: 'archipelago' added, 'cow' dropped
|
2015-03-17 17:02:20 +01:00
|
|
|
# 2.3: 'host_floppy' deprecated
|
2015-10-19 17:53:07 +02:00
|
|
|
# 2.5: 'host_floppy' dropped
|
block: add generic full disk encryption driver
Add a block driver that is capable of supporting any full disk
encryption format. This utilizes the previously added block
encryption code, and at this time supports the LUKS format.
The driver code is capable of supporting any format supported
by the QCryptoBlock module, so it registers one block driver
for each format. This patch only registers the "luks" driver
since the "qcow" driver is there only for back-compatibility
with existing qcow built-in encryption.
New LUKS compatible volumes can be formatted using qemu-img
with defaults for all settings.
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0 demo.luks 10G
Alternatively the cryptographic settings can be explicitly
set
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0,cipher-alg=aes-256,\
cipher-mode=cbc,ivgen-alg=plain64,hash-alg=sha256 \
demo.luks 10G
And query its size
$ qemu-img info demo.img
image: demo.img
file format: luks
virtual size: 10G (10737418240 bytes)
disk size: 132K
encrypted: yes
Note that it was not necessary to provide the password
when querying info for the volume. The password is only
required when performing I/O on the volume
All volumes created by this new 'luks' driver should be
capable of being opened by the kernel dm-crypt driver.
The only algorithms listed in the LUKS spec that are
not currently supported by this impl are sha512 and
ripemd160 hashes and cast6 cipher.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
[ kwolf - Added #include to resolve conflict with da34e65c ]
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2016-03-21 15:11:47 +01:00
|
|
|
# 2.6: 'luks' added
|
block/curl: Drop TFTP "support"
Because TFTP does not support byte ranges, it was never usable with our
curl block driver. Since apparently nobody has ever complained loudly
enough for someone to take care of the issue until now, it seems
reasonable to assume that nobody has ever actually used it.
Therefore, it should be safe to just drop it from curl's protocol list.
[Jeff Cody: Below is additional summary pulled, with some rewording,
from followup emails between Max and Markus, to explain what
worked and what didn't]
TFTP would sometimes work, to a limited extent, for images <= the curl
"readahead" size, so long as reads started at offset zero. By default,
that readahead size is 256KB.
Reads starting at a non-zero offset would also have returned data from a
zero offset. It can become more complicated still, with mixed reads at
zero offset and non-zero offsets, due to data buffering.
In short, TFTP could only have worked before in very specific scenarios
with unrealistic expectations and constraints.
Signed-off-by: Max Reitz <mreitz@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Jeff Cody <jcody@redhat.com>
Message-id: 20161102175539.4375-4-mreitz@redhat.com
Signed-off-by: Jeff Cody <jcody@redhat.com>
2016-11-02 18:55:37 +01:00
|
|
|
# 2.8: 'replication' added, 'tftp' dropped
|
2017-03-08 21:02:16 +01:00
|
|
|
# 2.9: 'archipelago' dropped
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @backing_file: the name of the backing file (for copy-on-write)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @backing_file_depth: number of files in the backing file chain (since: 1.2)
|
|
|
|
#
|
|
|
|
# @encrypted: true if the backing device is encrypted
|
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# @encryption_key_missing: always false
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @detect_zeroes: detect and optimize zero writes (Since 2.1)
|
|
|
|
#
|
|
|
|
# @bps: total throughput limit in bytes per second is specified
|
|
|
|
#
|
|
|
|
# @bps_rd: read throughput limit in bytes per second is specified
|
|
|
|
#
|
|
|
|
# @bps_wr: write throughput limit in bytes per second is specified
|
|
|
|
#
|
|
|
|
# @iops: total I/O operations per second is specified
|
|
|
|
#
|
|
|
|
# @iops_rd: read I/O operations per second is specified
|
|
|
|
#
|
|
|
|
# @iops_wr: write I/O operations per second is specified
|
|
|
|
#
|
|
|
|
# @image: the info of image used (since: 1.6)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_max: total throughput limit during bursts,
|
2016-02-18 11:27:04 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_rd_max: read throughput limit during bursts,
|
2016-02-18 11:27:04 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_wr_max: write throughput limit during bursts,
|
2016-02-18 11:27:04 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_max: total I/O operations per second during bursts,
|
2016-02-18 11:27:04 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_rd_max: read I/O operations per second during bursts,
|
2016-02-18 11:27:04 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_wr_max: write I/O operations per second during bursts,
|
2016-02-18 11:27:04 +01:00
|
|
|
# in bytes (Since 1.7)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_max_length: maximum length of the @bps_max burst
|
2016-02-18 11:27:04 +01:00
|
|
|
# period, in seconds. (Since 2.6)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_rd_max_length: maximum length of the @bps_rd_max
|
2016-02-18 11:27:04 +01:00
|
|
|
# burst period, in seconds. (Since 2.6)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_wr_max_length: maximum length of the @bps_wr_max
|
2016-02-18 11:27:04 +01:00
|
|
|
# burst period, in seconds. (Since 2.6)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_max_length: maximum length of the @iops burst
|
2016-02-18 11:27:04 +01:00
|
|
|
# period, in seconds. (Since 2.6)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_rd_max_length: maximum length of the @iops_rd_max
|
2016-02-18 11:27:04 +01:00
|
|
|
# burst period, in seconds. (Since 2.6)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_wr_max_length: maximum length of the @iops_wr_max
|
2016-02-18 11:27:04 +01:00
|
|
|
# burst period, in seconds. (Since 2.6)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_size: an I/O size in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @group: throttle group name (Since 2.4)
|
2015-06-08 18:17:46 +02:00
|
|
|
#
|
2014-05-22 13:28:45 +02:00
|
|
|
# @cache: the cache mode used for the block device (since: 2.3)
|
|
|
|
#
|
block: add event when disk usage exceeds threshold
Managing applications, like oVirt (http://www.ovirt.org), make extensive
use of thin-provisioned disk images.
To let the guest run smoothly and be not unnecessarily paused, oVirt sets
a disk usage threshold (so called 'high water mark') based on the occupation
of the device, and automatically extends the image once the threshold
is reached or exceeded.
In order to detect the crossing of the threshold, oVirt has no choice but
aggressively polling the QEMU monitor using the query-blockstats command.
This lead to unnecessary system load, and is made even worse under scale:
deployments with hundreds of VMs are no longer rare.
To fix this, this patch adds:
* A new monitor command `block-set-write-threshold', to set a mark for
a given block device.
* A new event `BLOCK_WRITE_THRESHOLD', to report if a block device
usage exceeds the threshold.
* A new `write_threshold' field into the `BlockDeviceInfo' structure,
to report the configured threshold.
This will allow the managing application to use smarter and more
efficient monitoring, greatly reducing the need of polling.
[Updated qemu-iotests 067 output to add the new 'write_threshold'
property. --Stefan]
[Changed g_assert_false() to !g_assert() to fix the build on older glib
versions. --Kevin]
Signed-off-by: Francesco Romani <fromani@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1421068273-692-1-git-send-email-fromani@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2015-01-12 14:11:13 +01:00
|
|
|
# @write_threshold: configured write threshold for the device.
|
|
|
|
# 0 if disabled. (Since 2.3)
|
|
|
|
#
|
2019-07-29 22:35:56 +02:00
|
|
|
# @dirty-bitmaps: dirty bitmaps information (only present if node
|
|
|
|
# has one or more dirty bitmaps) (Since 4.2)
|
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# Features:
|
|
|
|
# @deprecated: Member @encryption_key_missing is deprecated. It is
|
|
|
|
# always false.
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 0.14.0
|
|
|
|
#
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockDeviceInfo',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
|
|
|
|
'*backing_file': 'str', 'backing_file_depth': 'int',
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
'encrypted': 'bool',
|
|
|
|
'encryption_key_missing': { 'type': 'bool',
|
|
|
|
'features': [ 'deprecated' ] },
|
2014-06-05 13:45:31 +02:00
|
|
|
'detect_zeroes': 'BlockdevDetectZeroesOptions',
|
|
|
|
'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
|
|
|
|
'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
|
|
|
|
'image': 'ImageInfo',
|
|
|
|
'*bps_max': 'int', '*bps_rd_max': 'int',
|
|
|
|
'*bps_wr_max': 'int', '*iops_max': 'int',
|
|
|
|
'*iops_rd_max': 'int', '*iops_wr_max': 'int',
|
2016-02-18 11:27:04 +01:00
|
|
|
'*bps_max_length': 'int', '*bps_rd_max_length': 'int',
|
|
|
|
'*bps_wr_max_length': 'int', '*iops_max_length': 'int',
|
|
|
|
'*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
|
2015-06-08 18:17:46 +02:00
|
|
|
'*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
|
2019-07-29 22:35:56 +02:00
|
|
|
'write_threshold': 'int', '*dirty-bitmaps': ['BlockDirtyInfo'] } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockDeviceIoStatus:
|
|
|
|
#
|
|
|
|
# An enumeration of block device I/O status.
|
|
|
|
#
|
|
|
|
# @ok: The last I/O operation has succeeded
|
|
|
|
#
|
|
|
|
# @failed: The last I/O operation has failed
|
|
|
|
#
|
|
|
|
# @nospace: The last I/O operation has failed due to a no-space condition
|
|
|
|
#
|
|
|
|
# Since: 1.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockDeviceMapEntry:
|
|
|
|
#
|
|
|
|
# Entry in the metadata map of the device (returned by "qemu-img map")
|
|
|
|
#
|
|
|
|
# @start: Offset in the image of the first byte described by this entry
|
|
|
|
# (in bytes)
|
|
|
|
#
|
|
|
|
# @length: Length of the range described by this entry (in bytes)
|
|
|
|
#
|
|
|
|
# @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
|
|
|
|
# before reaching one for which the range is allocated. The value is
|
|
|
|
# in the range 0 to the depth of the image chain - 1.
|
|
|
|
#
|
|
|
|
# @zero: the sectors in this range read as zeros
|
|
|
|
#
|
|
|
|
# @data: reading the image will actually read data from a file (in particular,
|
|
|
|
# if @offset is present this means that the sectors are not simply
|
|
|
|
# preallocated, but contain actual data in raw format)
|
|
|
|
#
|
|
|
|
# @offset: if present, the image file stores the data for this range in
|
|
|
|
# raw format at the given offset.
|
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 1.7
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockDeviceMapEntry',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
|
|
|
|
'data': 'bool', '*offset': 'int' } }
|
|
|
|
|
2015-05-12 21:53:01 +02:00
|
|
|
##
|
|
|
|
# @DirtyBitmapStatus:
|
|
|
|
#
|
|
|
|
# An enumeration of possible states that a dirty bitmap can report to the user.
|
|
|
|
#
|
2019-02-19 23:49:43 +01:00
|
|
|
# @frozen: The bitmap is currently in-use by some operation and is immutable.
|
|
|
|
# If the bitmap was @active prior to the operation, new writes by the
|
|
|
|
# guest are being recorded in a temporary buffer, and will not be lost.
|
|
|
|
# Generally, bitmaps are cleared on successful use in an operation and
|
|
|
|
# the temporary buffer is committed into the bitmap. On failure, the
|
|
|
|
# temporary buffer is merged back into the bitmap without first
|
|
|
|
# clearing it.
|
|
|
|
# Please refer to the documentation for each bitmap-using operation,
|
|
|
|
# See also @blockdev-backup, @drive-backup.
|
|
|
|
#
|
|
|
|
# @disabled: The bitmap is not currently recording new writes by the guest.
|
|
|
|
# This is requested explicitly via @block-dirty-bitmap-disable.
|
|
|
|
# It can still be cleared, deleted, or used for backup operations.
|
2015-05-12 21:53:01 +02:00
|
|
|
#
|
|
|
|
# @active: The bitmap is actively monitoring for new writes, and can be cleared,
|
|
|
|
# deleted, or used for backup operations.
|
|
|
|
#
|
2019-02-19 23:49:43 +01:00
|
|
|
# @locked: The bitmap is currently in-use by some operation and is immutable.
|
|
|
|
# If the bitmap was @active prior to the operation, it is still
|
|
|
|
# recording new writes. If the bitmap was @disabled, it is not
|
|
|
|
# recording new writes. (Since 2.12)
|
2018-03-13 20:34:00 +01:00
|
|
|
#
|
2019-03-12 17:05:49 +01:00
|
|
|
# @inconsistent: This is a persistent dirty bitmap that was marked in-use on
|
|
|
|
# disk, and is unusable by QEMU. It can only be deleted.
|
|
|
|
# Please rely on the inconsistent field in @BlockDirtyInfo
|
|
|
|
# instead, as the status field is deprecated. (Since 4.0)
|
|
|
|
#
|
2015-05-12 21:53:01 +02:00
|
|
|
# Since: 2.4
|
|
|
|
##
|
|
|
|
{ 'enum': 'DirtyBitmapStatus',
|
2019-03-12 17:05:49 +01:00
|
|
|
'data': ['active', 'disabled', 'frozen', 'locked', 'inconsistent'] }
|
2015-05-12 21:53:01 +02:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @BlockDirtyInfo:
|
|
|
|
#
|
|
|
|
# Block dirty bitmap information.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @name: the name of the dirty bitmap (Since 2.4)
|
2015-04-18 01:49:50 +02:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# @count: number of dirty bytes according to the dirty bitmap
|
|
|
|
#
|
|
|
|
# @granularity: granularity of the dirty bitmap in bytes (since 1.4)
|
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# @status: current status of the dirty bitmap (since 2.4)
|
2019-03-12 17:05:48 +01:00
|
|
|
#
|
|
|
|
# @recording: true if the bitmap is recording new writes from the guest.
|
|
|
|
# Replaces `active` and `disabled` statuses. (since 4.0)
|
|
|
|
#
|
|
|
|
# @busy: true if the bitmap is in-use by some operation (NBD or jobs)
|
|
|
|
# and cannot be modified via QMP or used by another operation.
|
|
|
|
# Replaces `locked` and `frozen` statuses. (since 4.0)
|
2015-04-18 01:50:00 +02:00
|
|
|
#
|
2019-03-12 17:05:49 +01:00
|
|
|
# @persistent: true if the bitmap was stored on disk, is scheduled to be stored
|
|
|
|
# on disk, or both. (since 4.0)
|
2015-04-18 01:50:00 +02:00
|
|
|
#
|
2019-03-12 17:05:49 +01:00
|
|
|
# @inconsistent: true if this is a persistent bitmap that was improperly
|
|
|
|
# stored. Implies @persistent to be true; @recording and
|
|
|
|
# @busy to be false. This bitmap cannot be used. To remove
|
|
|
|
# it, use @block-dirty-bitmap-remove. (Since 4.0)
|
2019-02-19 23:49:43 +01:00
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# Features:
|
|
|
|
# @deprecated: Member @status is deprecated. Use @recording and
|
|
|
|
# @locked instead.
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 1.3
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockDirtyInfo',
|
2015-04-18 01:50:00 +02:00
|
|
|
'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
'recording': 'bool', 'busy': 'bool',
|
|
|
|
'status': { 'type': 'DirtyBitmapStatus',
|
|
|
|
'features': [ 'deprecated' ] },
|
2019-03-12 17:05:49 +01:00
|
|
|
'persistent': 'bool', '*inconsistent': 'bool' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2019-02-08 16:06:07 +01:00
|
|
|
##
|
|
|
|
# @Qcow2BitmapInfoFlags:
|
|
|
|
#
|
|
|
|
# An enumeration of flags that a bitmap can report to the user.
|
|
|
|
#
|
|
|
|
# @in-use: This flag is set by any process actively modifying the qcow2 file,
|
|
|
|
# and cleared when the updated bitmap is flushed to the qcow2 image.
|
|
|
|
# The presence of this flag in an offline image means that the bitmap
|
|
|
|
# was not saved correctly after its last usage, and may contain
|
|
|
|
# inconsistent data.
|
|
|
|
#
|
|
|
|
# @auto: The bitmap must reflect all changes of the virtual disk by any
|
|
|
|
# application that would write to this qcow2 file.
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'Qcow2BitmapInfoFlags',
|
|
|
|
'data': ['in-use', 'auto'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @Qcow2BitmapInfo:
|
|
|
|
#
|
|
|
|
# Qcow2 bitmap information.
|
|
|
|
#
|
|
|
|
# @name: the name of the bitmap
|
|
|
|
#
|
|
|
|
# @granularity: granularity of the bitmap in bytes
|
|
|
|
#
|
|
|
|
# @flags: flags of the bitmap
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'Qcow2BitmapInfo',
|
|
|
|
'data': {'name': 'str', 'granularity': 'uint32',
|
|
|
|
'flags': ['Qcow2BitmapInfoFlags'] } }
|
|
|
|
|
2018-03-09 17:52:12 +01:00
|
|
|
##
|
|
|
|
# @BlockLatencyHistogramInfo:
|
|
|
|
#
|
|
|
|
# Block latency histogram.
|
|
|
|
#
|
|
|
|
# @boundaries: list of interval boundary values in nanoseconds, all greater
|
|
|
|
# than zero and in ascending order.
|
|
|
|
# For example, the list [10, 50, 100] produces the following
|
|
|
|
# histogram intervals: [0, 10), [10, 50), [50, 100), [100, +inf).
|
|
|
|
#
|
|
|
|
# @bins: list of io request counts corresponding to histogram intervals.
|
|
|
|
# len(@bins) = len(@boundaries) + 1
|
|
|
|
# For the example above, @bins may be something like [3, 1, 5, 2],
|
|
|
|
# and corresponding histogram looks like:
|
|
|
|
#
|
2020-02-13 18:56:24 +01:00
|
|
|
# | 5| *
|
|
|
|
# | 4| *
|
|
|
|
# | 3| * *
|
|
|
|
# | 2| * * *
|
|
|
|
# | 1| * * * *
|
|
|
|
# | +------------------
|
|
|
|
# | 10 50 100
|
2018-03-09 17:52:12 +01:00
|
|
|
#
|
2019-03-05 13:53:17 +01:00
|
|
|
# Since: 4.0
|
2018-03-09 17:52:12 +01:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockLatencyHistogramInfo',
|
|
|
|
'data': {'boundaries': ['uint64'], 'bins': ['uint64'] } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @BlockInfo:
|
|
|
|
#
|
|
|
|
# Block device information. This structure describes a virtual device and
|
|
|
|
# the backing device associated with it.
|
|
|
|
#
|
|
|
|
# @device: The device name associated with the virtual device.
|
|
|
|
#
|
2017-07-11 13:27:38 +02:00
|
|
|
# @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
|
|
|
|
# device. (since 2.10)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# @type: This field is returned only for compatibility reasons, it should
|
|
|
|
# not be used (always returns 'unknown')
|
|
|
|
#
|
|
|
|
# @removable: True if the device supports removable media.
|
|
|
|
#
|
|
|
|
# @locked: True if the guest has locked this device from having its media
|
|
|
|
# removed
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @tray_open: True if the device's tray is open
|
2016-01-29 20:49:13 +01:00
|
|
|
# (only present if it has a tray)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @dirty-bitmaps: dirty bitmaps information (only present if the
|
2014-06-05 13:45:31 +02:00
|
|
|
# driver has one or more dirty bitmaps) (Since 2.0)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @io-status: @BlockDeviceIoStatus. Only present if the device
|
2014-06-05 13:45:31 +02:00
|
|
|
# supports it and the VM is configured to stop on errors
|
2017-05-09 12:56:01 +02:00
|
|
|
# (supported device models: virtio-blk, IDE, SCSI except
|
|
|
|
# scsi-generic)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @inserted: @BlockDeviceInfo describing the device if media is
|
2014-06-05 13:45:31 +02:00
|
|
|
# present
|
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# Features:
|
|
|
|
# @deprecated: Member @dirty-bitmaps is deprecated. Use @inserted
|
|
|
|
# member @dirty-bitmaps instead.
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockInfo',
|
2017-07-11 13:27:38 +02:00
|
|
|
'data': {'device': 'str', '*qdev': 'str', 'type': 'str', 'removable': 'bool',
|
2014-06-05 13:45:31 +02:00
|
|
|
'locked': 'bool', '*inserted': 'BlockDeviceInfo',
|
|
|
|
'*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
'*dirty-bitmaps': { 'type': ['BlockDirtyInfo'],
|
|
|
|
'features': [ 'deprecated' ] } } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2017-07-05 14:57:30 +02:00
|
|
|
##
|
|
|
|
# @BlockMeasureInfo:
|
|
|
|
#
|
|
|
|
# Image file size calculation information. This structure describes the size
|
|
|
|
# requirements for creating a new image file.
|
|
|
|
#
|
|
|
|
# The size requirements depend on the new image file format. File size always
|
|
|
|
# equals virtual disk size for the 'raw' format, even for sparse POSIX files.
|
|
|
|
# Compact formats such as 'qcow2' represent unallocated and zero regions
|
|
|
|
# efficiently so file size may be smaller than virtual disk size.
|
|
|
|
#
|
|
|
|
# The values are upper bounds that are guaranteed to fit the new image file.
|
qcow2: Expose bitmaps' size during measure
It's useful to know how much space can be occupied by qcow2 persistent
bitmaps, even though such metadata is unrelated to the guest-visible
data. Report this value as an additional QMP field, present when
measuring an existing image and output format that both support
bitmaps. Update iotest 178 and 190 to updated output, as well as new
coverage in 190 demonstrating non-zero values made possible with the
recently-added qemu-img bitmap command (see 3b51ab4b).
The new 'bitmaps size:' field is displayed automatically as part of
'qemu-img measure' any time it is present in QMP (that is, any time
both the source image being measured and destination format support
bitmaps, even if the measurement is 0 because there are no bitmaps
present). If the field is absent, it means that no bitmaps can be
copied (source, destination, or both lack bitmaps, including when
measuring based on size rather than on a source image). This behavior
is compatible with an upcoming patch adding 'qemu-img convert
--bitmaps': that command will fail in the same situations where this
patch omits the field.
The addition of a new field demonstrates why we should always
zero-initialize qapi C structs; while the qcow2 driver still fully
populates all fields, the raw and crypto drivers had to be tweaked to
avoid uninitialized data.
Consideration was also given towards having a 'qemu-img measure
--bitmaps' which errors out when bitmaps are not possible, and
otherwise sums the bitmaps into the existing allocation totals rather
than displaying as a separate field, as a potential convenience
factor. But this was ultimately decided to be more complexity than
necessary when the QMP interface was sufficient enough with bitmaps
remaining a separate field.
See also: https://bugzilla.redhat.com/1779904
Reported-by: Nir Soffer <nsoffer@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200521192137.1120211-3-eblake@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2020-05-21 21:21:34 +02:00
|
|
|
# Subsequent modification, such as internal snapshot or further bitmap
|
|
|
|
# creation, may require additional space and is not covered here.
|
2017-07-05 14:57:30 +02:00
|
|
|
#
|
qcow2: Expose bitmaps' size during measure
It's useful to know how much space can be occupied by qcow2 persistent
bitmaps, even though such metadata is unrelated to the guest-visible
data. Report this value as an additional QMP field, present when
measuring an existing image and output format that both support
bitmaps. Update iotest 178 and 190 to updated output, as well as new
coverage in 190 demonstrating non-zero values made possible with the
recently-added qemu-img bitmap command (see 3b51ab4b).
The new 'bitmaps size:' field is displayed automatically as part of
'qemu-img measure' any time it is present in QMP (that is, any time
both the source image being measured and destination format support
bitmaps, even if the measurement is 0 because there are no bitmaps
present). If the field is absent, it means that no bitmaps can be
copied (source, destination, or both lack bitmaps, including when
measuring based on size rather than on a source image). This behavior
is compatible with an upcoming patch adding 'qemu-img convert
--bitmaps': that command will fail in the same situations where this
patch omits the field.
The addition of a new field demonstrates why we should always
zero-initialize qapi C structs; while the qcow2 driver still fully
populates all fields, the raw and crypto drivers had to be tweaked to
avoid uninitialized data.
Consideration was also given towards having a 'qemu-img measure
--bitmaps' which errors out when bitmaps are not possible, and
otherwise sums the bitmaps into the existing allocation totals rather
than displaying as a separate field, as a potential convenience
factor. But this was ultimately decided to be more complexity than
necessary when the QMP interface was sufficient enough with bitmaps
remaining a separate field.
See also: https://bugzilla.redhat.com/1779904
Reported-by: Nir Soffer <nsoffer@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200521192137.1120211-3-eblake@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2020-05-21 21:21:34 +02:00
|
|
|
# @required: Size required for a new image file, in bytes, when copying just
|
|
|
|
# allocated guest-visible contents.
|
2017-07-05 14:57:30 +02:00
|
|
|
#
|
|
|
|
# @fully-allocated: Image file size, in bytes, once data has been written
|
qcow2: Expose bitmaps' size during measure
It's useful to know how much space can be occupied by qcow2 persistent
bitmaps, even though such metadata is unrelated to the guest-visible
data. Report this value as an additional QMP field, present when
measuring an existing image and output format that both support
bitmaps. Update iotest 178 and 190 to updated output, as well as new
coverage in 190 demonstrating non-zero values made possible with the
recently-added qemu-img bitmap command (see 3b51ab4b).
The new 'bitmaps size:' field is displayed automatically as part of
'qemu-img measure' any time it is present in QMP (that is, any time
both the source image being measured and destination format support
bitmaps, even if the measurement is 0 because there are no bitmaps
present). If the field is absent, it means that no bitmaps can be
copied (source, destination, or both lack bitmaps, including when
measuring based on size rather than on a source image). This behavior
is compatible with an upcoming patch adding 'qemu-img convert
--bitmaps': that command will fail in the same situations where this
patch omits the field.
The addition of a new field demonstrates why we should always
zero-initialize qapi C structs; while the qcow2 driver still fully
populates all fields, the raw and crypto drivers had to be tweaked to
avoid uninitialized data.
Consideration was also given towards having a 'qemu-img measure
--bitmaps' which errors out when bitmaps are not possible, and
otherwise sums the bitmaps into the existing allocation totals rather
than displaying as a separate field, as a potential convenience
factor. But this was ultimately decided to be more complexity than
necessary when the QMP interface was sufficient enough with bitmaps
remaining a separate field.
See also: https://bugzilla.redhat.com/1779904
Reported-by: Nir Soffer <nsoffer@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200521192137.1120211-3-eblake@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2020-05-21 21:21:34 +02:00
|
|
|
# to all sectors, when copying just guest-visible contents.
|
|
|
|
#
|
|
|
|
# @bitmaps: Additional size required if all the top-level bitmap metadata
|
|
|
|
# in the source image were to be copied to the destination,
|
|
|
|
# present only when source and destination both support
|
|
|
|
# persistent bitmaps. (since 5.1)
|
2017-07-05 14:57:30 +02:00
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockMeasureInfo',
|
qcow2: Expose bitmaps' size during measure
It's useful to know how much space can be occupied by qcow2 persistent
bitmaps, even though such metadata is unrelated to the guest-visible
data. Report this value as an additional QMP field, present when
measuring an existing image and output format that both support
bitmaps. Update iotest 178 and 190 to updated output, as well as new
coverage in 190 demonstrating non-zero values made possible with the
recently-added qemu-img bitmap command (see 3b51ab4b).
The new 'bitmaps size:' field is displayed automatically as part of
'qemu-img measure' any time it is present in QMP (that is, any time
both the source image being measured and destination format support
bitmaps, even if the measurement is 0 because there are no bitmaps
present). If the field is absent, it means that no bitmaps can be
copied (source, destination, or both lack bitmaps, including when
measuring based on size rather than on a source image). This behavior
is compatible with an upcoming patch adding 'qemu-img convert
--bitmaps': that command will fail in the same situations where this
patch omits the field.
The addition of a new field demonstrates why we should always
zero-initialize qapi C structs; while the qcow2 driver still fully
populates all fields, the raw and crypto drivers had to be tweaked to
avoid uninitialized data.
Consideration was also given towards having a 'qemu-img measure
--bitmaps' which errors out when bitmaps are not possible, and
otherwise sums the bitmaps into the existing allocation totals rather
than displaying as a separate field, as a potential convenience
factor. But this was ultimately decided to be more complexity than
necessary when the QMP interface was sufficient enough with bitmaps
remaining a separate field.
See also: https://bugzilla.redhat.com/1779904
Reported-by: Nir Soffer <nsoffer@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200521192137.1120211-3-eblake@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2020-05-21 21:21:34 +02:00
|
|
|
'data': {'required': 'int', 'fully-allocated': 'int', '*bitmaps': 'int'} }
|
2017-07-05 14:57:30 +02:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @query-block:
|
|
|
|
#
|
|
|
|
# Get a list of BlockInfo for all virtual block devices.
|
|
|
|
#
|
2017-07-18 17:24:05 +02:00
|
|
|
# Returns: a list of @BlockInfo describing each virtual block device. Filter
|
2020-02-13 18:56:26 +01:00
|
|
|
# nodes that were created implicitly are skipped over.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
2016-06-23 13:58:48 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-block" }
|
|
|
|
# <- {
|
|
|
|
# "return":[
|
|
|
|
# {
|
|
|
|
# "io-status": "ok",
|
|
|
|
# "device":"ide0-hd0",
|
|
|
|
# "locked":false,
|
|
|
|
# "removable":false,
|
|
|
|
# "inserted":{
|
|
|
|
# "ro":false,
|
|
|
|
# "drv":"qcow2",
|
|
|
|
# "encrypted":false,
|
|
|
|
# "file":"disks/test.qcow2",
|
|
|
|
# "backing_file_depth":1,
|
|
|
|
# "bps":1000000,
|
|
|
|
# "bps_rd":0,
|
|
|
|
# "bps_wr":0,
|
|
|
|
# "iops":1000000,
|
|
|
|
# "iops_rd":0,
|
|
|
|
# "iops_wr":0,
|
|
|
|
# "bps_max": 8000000,
|
|
|
|
# "bps_rd_max": 0,
|
|
|
|
# "bps_wr_max": 0,
|
|
|
|
# "iops_max": 0,
|
|
|
|
# "iops_rd_max": 0,
|
|
|
|
# "iops_wr_max": 0,
|
|
|
|
# "iops_size": 0,
|
|
|
|
# "detect_zeroes": "on",
|
|
|
|
# "write_threshold": 0,
|
|
|
|
# "image":{
|
|
|
|
# "filename":"disks/test.qcow2",
|
|
|
|
# "format":"qcow2",
|
|
|
|
# "virtual-size":2048000,
|
|
|
|
# "backing_file":"base.qcow2",
|
|
|
|
# "full-backing-filename":"disks/base.qcow2",
|
|
|
|
# "backing-filename-format":"qcow2",
|
|
|
|
# "snapshots":[
|
|
|
|
# {
|
|
|
|
# "id": "1",
|
|
|
|
# "name": "snapshot1",
|
|
|
|
# "vm-state-size": 0,
|
|
|
|
# "date-sec": 10000200,
|
|
|
|
# "date-nsec": 12,
|
|
|
|
# "vm-clock-sec": 206,
|
|
|
|
# "vm-clock-nsec": 30
|
|
|
|
# }
|
|
|
|
# ],
|
|
|
|
# "backing-image":{
|
|
|
|
# "filename":"disks/base.qcow2",
|
|
|
|
# "format":"qcow2",
|
|
|
|
# "virtual-size":2048000
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# },
|
2017-07-11 13:27:38 +02:00
|
|
|
# "qdev": "ide_disk",
|
2016-06-23 13:58:48 +02:00
|
|
|
# "type":"unknown"
|
|
|
|
# },
|
|
|
|
# {
|
|
|
|
# "io-status": "ok",
|
|
|
|
# "device":"ide1-cd0",
|
|
|
|
# "locked":false,
|
|
|
|
# "removable":true,
|
2017-07-11 13:27:38 +02:00
|
|
|
# "qdev": "/machine/unattached/device[23]",
|
|
|
|
# "tray_open": false,
|
2016-06-23 13:58:48 +02:00
|
|
|
# "type":"unknown"
|
|
|
|
# },
|
|
|
|
# {
|
|
|
|
# "device":"floppy0",
|
|
|
|
# "locked":false,
|
|
|
|
# "removable":true,
|
2017-07-11 13:27:38 +02:00
|
|
|
# "qdev": "/machine/unattached/device[20]",
|
2016-06-23 13:58:48 +02:00
|
|
|
# "type":"unknown"
|
|
|
|
# },
|
|
|
|
# {
|
|
|
|
# "device":"sd0",
|
|
|
|
# "locked":false,
|
|
|
|
# "removable":true,
|
|
|
|
# "type":"unknown"
|
|
|
|
# }
|
|
|
|
# ]
|
|
|
|
# }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'query-block', 'returns': ['BlockInfo'] }
|
|
|
|
|
2015-10-28 16:33:05 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockDeviceTimedStats:
|
|
|
|
#
|
|
|
|
# Statistics of a block device during a given interval of time.
|
|
|
|
#
|
|
|
|
# @interval_length: Interval used for calculating the statistics,
|
|
|
|
# in seconds.
|
|
|
|
#
|
|
|
|
# @min_rd_latency_ns: Minimum latency of read operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @min_wr_latency_ns: Minimum latency of write operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @min_flush_latency_ns: Minimum latency of flush operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @max_rd_latency_ns: Maximum latency of read operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @max_wr_latency_ns: Maximum latency of write operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @max_flush_latency_ns: Maximum latency of flush operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @avg_rd_latency_ns: Average latency of read operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @avg_wr_latency_ns: Average latency of write operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
|
|
|
# @avg_flush_latency_ns: Average latency of flush operations in the
|
|
|
|
# defined interval, in nanoseconds.
|
|
|
|
#
|
2015-10-28 16:33:06 +01:00
|
|
|
# @avg_rd_queue_depth: Average number of pending read operations
|
|
|
|
# in the defined interval.
|
|
|
|
#
|
|
|
|
# @avg_wr_queue_depth: Average number of pending write operations
|
|
|
|
# in the defined interval.
|
|
|
|
#
|
2015-10-28 16:33:05 +01:00
|
|
|
# Since: 2.5
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockDeviceTimedStats',
|
|
|
|
'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
|
|
|
|
'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
|
|
|
|
'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
|
|
|
|
'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
|
2015-10-28 16:33:06 +01:00
|
|
|
'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
|
|
|
|
'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
|
2015-10-28 16:33:05 +01:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @BlockDeviceStats:
|
|
|
|
#
|
|
|
|
# Statistics of a virtual block device or a block backing device.
|
|
|
|
#
|
|
|
|
# @rd_bytes: The number of bytes read by the device.
|
|
|
|
#
|
|
|
|
# @wr_bytes: The number of bytes written by the device.
|
|
|
|
#
|
2019-09-23 14:17:30 +02:00
|
|
|
# @unmap_bytes: The number of bytes unmapped by the device (Since 4.2)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# @rd_operations: The number of read operations performed by the device.
|
|
|
|
#
|
|
|
|
# @wr_operations: The number of write operations performed by the device.
|
|
|
|
#
|
|
|
|
# @flush_operations: The number of cache flush operations performed by the
|
|
|
|
# device (since 0.15.0)
|
|
|
|
#
|
2019-09-23 14:17:30 +02:00
|
|
|
# @unmap_operations: The number of unmap operations performed by the device
|
|
|
|
# (Since 4.2)
|
|
|
|
#
|
2019-09-23 14:17:29 +02:00
|
|
|
# @rd_total_time_ns: Total time spent on reads in nanoseconds (since 0.15.0).
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-09-23 14:17:29 +02:00
|
|
|
# @wr_total_time_ns: Total time spent on writes in nanoseconds (since 0.15.0).
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-09-23 14:17:29 +02:00
|
|
|
# @flush_total_time_ns: Total time spent on cache flushes in nanoseconds
|
|
|
|
# (since 0.15.0).
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-09-23 14:17:30 +02:00
|
|
|
# @unmap_total_time_ns: Total time spent on unmap operations in nanoseconds
|
|
|
|
# (Since 4.2)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# @wr_highest_offset: The offset after the greatest byte written to the
|
|
|
|
# device. The intended use of this information is for
|
|
|
|
# growable sparse files (like qcow2) that are used on top
|
|
|
|
# of a physical device.
|
|
|
|
#
|
2015-02-02 14:52:18 +01:00
|
|
|
# @rd_merged: Number of read requests that have been merged into another
|
|
|
|
# request (Since 2.3).
|
|
|
|
#
|
|
|
|
# @wr_merged: Number of write requests that have been merged into another
|
|
|
|
# request (Since 2.3).
|
|
|
|
#
|
2019-09-23 14:17:30 +02:00
|
|
|
# @unmap_merged: Number of unmap requests that have been merged into another
|
|
|
|
# request (Since 4.2)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @idle_time_ns: Time since the last I/O operation, in
|
2015-10-28 16:33:02 +01:00
|
|
|
# nanoseconds. If the field is absent it means that
|
|
|
|
# there haven't been any operations yet (Since 2.5).
|
|
|
|
#
|
2015-10-28 16:33:03 +01:00
|
|
|
# @failed_rd_operations: The number of failed read operations
|
|
|
|
# performed by the device (Since 2.5)
|
|
|
|
#
|
|
|
|
# @failed_wr_operations: The number of failed write operations
|
|
|
|
# performed by the device (Since 2.5)
|
|
|
|
#
|
|
|
|
# @failed_flush_operations: The number of failed flush operations
|
|
|
|
# performed by the device (Since 2.5)
|
|
|
|
#
|
2019-09-23 14:17:30 +02:00
|
|
|
# @failed_unmap_operations: The number of failed unmap operations performed
|
|
|
|
# by the device (Since 4.2)
|
|
|
|
#
|
2015-10-28 16:33:03 +01:00
|
|
|
# @invalid_rd_operations: The number of invalid read operations
|
|
|
|
# performed by the device (Since 2.5)
|
|
|
|
#
|
|
|
|
# @invalid_wr_operations: The number of invalid write operations
|
|
|
|
# performed by the device (Since 2.5)
|
|
|
|
#
|
|
|
|
# @invalid_flush_operations: The number of invalid flush operations
|
|
|
|
# performed by the device (Since 2.5)
|
|
|
|
#
|
2019-09-23 14:17:30 +02:00
|
|
|
# @invalid_unmap_operations: The number of invalid unmap operations performed
|
|
|
|
# by the device (Since 4.2)
|
|
|
|
#
|
2015-10-28 16:33:04 +01:00
|
|
|
# @account_invalid: Whether invalid operations are included in the
|
|
|
|
# last access statistics (Since 2.5)
|
|
|
|
#
|
|
|
|
# @account_failed: Whether failed operations are included in the
|
|
|
|
# latency and last access statistics (Since 2.5)
|
|
|
|
#
|
2015-10-28 16:33:05 +01:00
|
|
|
# @timed_stats: Statistics specific to the set of previously defined
|
|
|
|
# intervals of time (Since 2.5)
|
|
|
|
#
|
2019-03-05 13:53:17 +01:00
|
|
|
# @rd_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
|
2018-03-09 17:52:12 +01:00
|
|
|
#
|
2019-03-05 13:53:17 +01:00
|
|
|
# @wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
|
2018-03-09 17:52:12 +01:00
|
|
|
#
|
2019-03-05 13:53:17 +01:00
|
|
|
# @flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
|
2018-03-09 17:52:12 +01:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockDeviceStats',
|
2019-09-23 14:17:30 +02:00
|
|
|
'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'unmap_bytes' : 'int',
|
2019-09-23 14:17:29 +02:00
|
|
|
'rd_operations': 'int', 'wr_operations': 'int',
|
2019-09-23 14:17:30 +02:00
|
|
|
'flush_operations': 'int', 'unmap_operations': 'int',
|
2019-09-23 14:17:29 +02:00
|
|
|
'rd_total_time_ns': 'int', 'wr_total_time_ns': 'int',
|
2019-09-23 14:17:30 +02:00
|
|
|
'flush_total_time_ns': 'int', 'unmap_total_time_ns': 'int',
|
2019-09-23 14:17:29 +02:00
|
|
|
'wr_highest_offset': 'int',
|
2019-09-23 14:17:30 +02:00
|
|
|
'rd_merged': 'int', 'wr_merged': 'int', 'unmap_merged': 'int',
|
2019-09-23 14:17:29 +02:00
|
|
|
'*idle_time_ns': 'int',
|
2015-10-28 16:33:03 +01:00
|
|
|
'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
|
2019-09-23 14:17:30 +02:00
|
|
|
'failed_flush_operations': 'int', 'failed_unmap_operations': 'int',
|
2019-09-23 14:17:29 +02:00
|
|
|
'invalid_rd_operations': 'int', 'invalid_wr_operations': 'int',
|
2019-09-23 14:17:30 +02:00
|
|
|
'invalid_flush_operations': 'int', 'invalid_unmap_operations': 'int',
|
2015-10-28 16:33:05 +01:00
|
|
|
'account_invalid': 'bool', 'account_failed': 'bool',
|
2018-03-09 17:52:12 +01:00
|
|
|
'timed_stats': ['BlockDeviceTimedStats'],
|
2019-03-05 13:53:17 +01:00
|
|
|
'*rd_latency_histogram': 'BlockLatencyHistogramInfo',
|
|
|
|
'*wr_latency_histogram': 'BlockLatencyHistogramInfo',
|
|
|
|
'*flush_latency_histogram': 'BlockLatencyHistogramInfo' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2019-09-23 14:17:37 +02:00
|
|
|
##
|
|
|
|
# @BlockStatsSpecificFile:
|
|
|
|
#
|
|
|
|
# File driver statistics
|
|
|
|
#
|
|
|
|
# @discard-nb-ok: The number of successful discard operations performed by
|
|
|
|
# the driver.
|
|
|
|
#
|
|
|
|
# @discard-nb-failed: The number of failed discard operations performed by
|
|
|
|
# the driver.
|
|
|
|
#
|
|
|
|
# @discard-bytes-ok: The number of bytes discarded by the driver.
|
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockStatsSpecificFile',
|
|
|
|
'data': {
|
|
|
|
'discard-nb-ok': 'uint64',
|
|
|
|
'discard-nb-failed': 'uint64',
|
|
|
|
'discard-bytes-ok': 'uint64' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockStatsSpecific:
|
|
|
|
#
|
|
|
|
# Block driver specific statistics
|
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'union': 'BlockStatsSpecific',
|
|
|
|
'base': { 'driver': 'BlockdevDriver' },
|
|
|
|
'discriminator': 'driver',
|
|
|
|
'data': {
|
|
|
|
'file': 'BlockStatsSpecificFile',
|
|
|
|
'host_device': 'BlockStatsSpecificFile' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @BlockStats:
|
|
|
|
#
|
|
|
|
# Statistics of a virtual block device or a block backing device.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @device: If the stats are for a virtual block device, the name
|
2014-06-05 13:45:31 +02:00
|
|
|
# corresponding to the virtual block device.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @node-name: The node name of the device. (Since 2.3)
|
2014-10-31 04:32:56 +01:00
|
|
|
#
|
2018-07-27 16:07:07 +02:00
|
|
|
# @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
|
|
|
|
# device. (since 3.0)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# @stats: A @BlockDeviceStats for the device.
|
|
|
|
#
|
2019-09-23 14:17:37 +02:00
|
|
|
# @driver-specific: Optional driver-specific stats. (Since 4.2)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @parent: This describes the file block device if it has one.
|
2016-06-23 14:00:14 +02:00
|
|
|
# Contains recursively the statistics of the underlying
|
|
|
|
# protocol (e.g. the host file for a qcow2 image). If there is
|
|
|
|
# no underlying protocol, this field is omitted
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @backing: This describes the backing block device if it has one.
|
2014-06-05 13:45:31 +02:00
|
|
|
# (Since 2.0)
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockStats',
|
2018-07-27 16:07:07 +02:00
|
|
|
'data': {'*device': 'str', '*qdev': 'str', '*node-name': 'str',
|
2014-10-31 04:32:56 +01:00
|
|
|
'stats': 'BlockDeviceStats',
|
2019-09-23 14:17:37 +02:00
|
|
|
'*driver-specific': 'BlockStatsSpecific',
|
2014-06-05 13:45:31 +02:00
|
|
|
'*parent': 'BlockStats',
|
|
|
|
'*backing': 'BlockStats'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-blockstats:
|
|
|
|
#
|
|
|
|
# Query the @BlockStats for all virtual block devices.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @query-nodes: If true, the command will query all the block nodes
|
2014-10-31 04:32:57 +01:00
|
|
|
# that have a node name, in a list which will include "parent"
|
|
|
|
# information, but not "backing".
|
|
|
|
# If false or omitted, the behavior is as before - query all the
|
|
|
|
# device backends, recursively including their "parent" and
|
2017-07-18 17:24:05 +02:00
|
|
|
# "backing". Filter nodes that were created implicitly are
|
|
|
|
# skipped over in this mode. (Since 2.3)
|
2014-10-31 04:32:57 +01:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Returns: A list of @BlockStats for each virtual block devices.
|
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
2016-06-23 14:00:14 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-blockstats" }
|
|
|
|
# <- {
|
|
|
|
# "return":[
|
|
|
|
# {
|
|
|
|
# "device":"ide0-hd0",
|
|
|
|
# "parent":{
|
|
|
|
# "stats":{
|
|
|
|
# "wr_highest_offset":3686448128,
|
|
|
|
# "wr_bytes":9786368,
|
|
|
|
# "wr_operations":751,
|
|
|
|
# "rd_bytes":122567168,
|
|
|
|
# "rd_operations":36772
|
|
|
|
# "wr_total_times_ns":313253456
|
|
|
|
# "rd_total_times_ns":3465673657
|
|
|
|
# "flush_total_times_ns":49653
|
|
|
|
# "flush_operations":61,
|
|
|
|
# "rd_merged":0,
|
|
|
|
# "wr_merged":0,
|
|
|
|
# "idle_time_ns":2953431879,
|
|
|
|
# "account_invalid":true,
|
|
|
|
# "account_failed":false
|
|
|
|
# }
|
|
|
|
# },
|
|
|
|
# "stats":{
|
|
|
|
# "wr_highest_offset":2821110784,
|
|
|
|
# "wr_bytes":9786368,
|
|
|
|
# "wr_operations":692,
|
|
|
|
# "rd_bytes":122739200,
|
|
|
|
# "rd_operations":36604
|
|
|
|
# "flush_operations":51,
|
|
|
|
# "wr_total_times_ns":313253456
|
|
|
|
# "rd_total_times_ns":3465673657
|
|
|
|
# "flush_total_times_ns":49653,
|
|
|
|
# "rd_merged":0,
|
|
|
|
# "wr_merged":0,
|
|
|
|
# "idle_time_ns":2953431879,
|
|
|
|
# "account_invalid":true,
|
|
|
|
# "account_failed":false
|
2018-07-27 16:07:07 +02:00
|
|
|
# },
|
|
|
|
# "qdev": "/machine/unattached/device[23]"
|
2016-06-23 14:00:14 +02:00
|
|
|
# },
|
|
|
|
# {
|
|
|
|
# "device":"ide1-cd0",
|
|
|
|
# "stats":{
|
|
|
|
# "wr_highest_offset":0,
|
|
|
|
# "wr_bytes":0,
|
|
|
|
# "wr_operations":0,
|
|
|
|
# "rd_bytes":0,
|
|
|
|
# "rd_operations":0
|
|
|
|
# "flush_operations":0,
|
|
|
|
# "wr_total_times_ns":0
|
|
|
|
# "rd_total_times_ns":0
|
|
|
|
# "flush_total_times_ns":0,
|
|
|
|
# "rd_merged":0,
|
|
|
|
# "wr_merged":0,
|
|
|
|
# "account_invalid":false,
|
|
|
|
# "account_failed":false
|
2018-07-27 16:07:07 +02:00
|
|
|
# },
|
|
|
|
# "qdev": "/machine/unattached/device[24]"
|
2016-06-23 14:00:14 +02:00
|
|
|
# },
|
|
|
|
# {
|
|
|
|
# "device":"floppy0",
|
|
|
|
# "stats":{
|
|
|
|
# "wr_highest_offset":0,
|
|
|
|
# "wr_bytes":0,
|
|
|
|
# "wr_operations":0,
|
|
|
|
# "rd_bytes":0,
|
|
|
|
# "rd_operations":0
|
|
|
|
# "flush_operations":0,
|
|
|
|
# "wr_total_times_ns":0
|
|
|
|
# "rd_total_times_ns":0
|
|
|
|
# "flush_total_times_ns":0,
|
|
|
|
# "rd_merged":0,
|
|
|
|
# "wr_merged":0,
|
|
|
|
# "account_invalid":false,
|
|
|
|
# "account_failed":false
|
2018-07-27 16:07:07 +02:00
|
|
|
# },
|
|
|
|
# "qdev": "/machine/unattached/device[16]"
|
2016-06-23 14:00:14 +02:00
|
|
|
# },
|
|
|
|
# {
|
|
|
|
# "device":"sd0",
|
|
|
|
# "stats":{
|
|
|
|
# "wr_highest_offset":0,
|
|
|
|
# "wr_bytes":0,
|
|
|
|
# "wr_operations":0,
|
|
|
|
# "rd_bytes":0,
|
|
|
|
# "rd_operations":0
|
|
|
|
# "flush_operations":0,
|
|
|
|
# "wr_total_times_ns":0
|
|
|
|
# "rd_total_times_ns":0
|
|
|
|
# "flush_total_times_ns":0,
|
|
|
|
# "rd_merged":0,
|
|
|
|
# "wr_merged":0,
|
|
|
|
# "account_invalid":false,
|
|
|
|
# "account_failed":false
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# ]
|
|
|
|
# }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2014-10-31 04:32:57 +01:00
|
|
|
{ 'command': 'query-blockstats',
|
|
|
|
'data': { '*query-nodes': 'bool' },
|
|
|
|
'returns': ['BlockStats'] }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevOnError:
|
|
|
|
#
|
|
|
|
# An enumeration of possible behaviors for errors on I/O operations.
|
|
|
|
# The exact meaning depends on whether the I/O was initiated by a guest
|
|
|
|
# or by a block job
|
|
|
|
#
|
|
|
|
# @report: for guest operations, report the error to the guest;
|
|
|
|
# for jobs, cancel the job
|
|
|
|
#
|
|
|
|
# @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
|
2020-02-14 21:08:06 +01:00
|
|
|
# or BLOCK_JOB_ERROR). The backup, mirror and commit block jobs retry
|
|
|
|
# the failing request later and may still complete successfully. The
|
|
|
|
# stream block job continues to stream and will complete with an
|
|
|
|
# error.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @enospc: same as @stop on ENOSPC, same as @report otherwise.
|
|
|
|
#
|
|
|
|
# @stop: for guest operations, stop the virtual machine;
|
|
|
|
# for jobs, pause the job
|
|
|
|
#
|
2016-06-29 17:41:35 +02:00
|
|
|
# @auto: inherit the error handling policy of the backend (since: 2.7)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 1.3
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevOnError',
|
2016-06-29 17:41:35 +02:00
|
|
|
'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @MirrorSyncMode:
|
|
|
|
#
|
|
|
|
# An enumeration of possible behaviors for the initial synchronization
|
|
|
|
# phase of storage mirroring.
|
|
|
|
#
|
|
|
|
# @top: copies data in the topmost image to the destination
|
|
|
|
#
|
|
|
|
# @full: copies data from all images to the destination
|
|
|
|
#
|
|
|
|
# @none: only copy data written from now on
|
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# @incremental: only copy data described by the dirty bitmap. (since: 2.4)
|
|
|
|
#
|
|
|
|
# @bitmap: only copy data described by the dirty bitmap. (since: 4.2)
|
|
|
|
# Behavior on completion is determined by the BitmapSyncMode.
|
2015-04-18 01:49:58 +02:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 1.3
|
|
|
|
##
|
|
|
|
{ 'enum': 'MirrorSyncMode',
|
2019-07-29 22:35:52 +02:00
|
|
|
'data': ['top', 'full', 'none', 'incremental', 'bitmap'] }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2019-07-29 22:35:52 +02:00
|
|
|
##
|
|
|
|
# @BitmapSyncMode:
|
|
|
|
#
|
|
|
|
# An enumeration of possible behaviors for the synchronization of a bitmap
|
|
|
|
# when used for data copy operations.
|
|
|
|
#
|
|
|
|
# @on-success: The bitmap is only synced when the operation is successful.
|
|
|
|
# This is the behavior always used for 'INCREMENTAL' backups.
|
|
|
|
#
|
2019-07-29 22:35:53 +02:00
|
|
|
# @never: The bitmap is never synchronized with the operation, and is
|
|
|
|
# treated solely as a read-only manifest of blocks to copy.
|
|
|
|
#
|
2019-07-29 22:35:53 +02:00
|
|
|
# @always: The bitmap is always synchronized with the operation,
|
|
|
|
# regardless of whether or not the operation was successful.
|
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'enum': 'BitmapSyncMode',
|
2019-07-29 22:35:53 +02:00
|
|
|
'data': ['on-success', 'never', 'always'] }
|
2019-07-29 22:35:52 +02:00
|
|
|
|
2018-06-13 20:18:21 +02:00
|
|
|
##
|
|
|
|
# @MirrorCopyMode:
|
|
|
|
#
|
|
|
|
# An enumeration whose values tell the mirror block job when to
|
|
|
|
# trigger writes to the target.
|
|
|
|
#
|
|
|
|
# @background: copy data in background only.
|
|
|
|
#
|
|
|
|
# @write-blocking: when data is written to the source, write it
|
|
|
|
# (synchronously) to the target as well. In
|
|
|
|
# addition, data is copied in background just like in
|
|
|
|
# @background mode.
|
|
|
|
#
|
|
|
|
# Since: 3.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'MirrorCopyMode',
|
|
|
|
'data': ['background', 'write-blocking'] }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @BlockJobInfo:
|
|
|
|
#
|
|
|
|
# Information about a long-running block device operation.
|
|
|
|
#
|
|
|
|
# @type: the job type ('stream' for image streaming)
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. Originally the device name but other
|
|
|
|
# values are allowed since QEMU 2.7
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2018-05-16 13:04:34 +02:00
|
|
|
# @len: Estimated @offset value at the completion of the job. This value can
|
|
|
|
# arbitrarily change while the job is running, in both directions.
|
|
|
|
#
|
|
|
|
# @offset: Progress made until now. The unit is arbitrary and the value can
|
|
|
|
# only meaningfully be used for the ratio of @offset to @len. The
|
|
|
|
# value is monotonically increasing.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @busy: false if the job is known to be in a quiescent state, with
|
|
|
|
# no pending I/O. Since 1.3.
|
|
|
|
#
|
|
|
|
# @paused: whether the job is paused or, if @busy is true, will
|
|
|
|
# pause itself as soon as possible. Since 1.3.
|
|
|
|
#
|
|
|
|
# @speed: the rate limit, bytes per second
|
|
|
|
#
|
|
|
|
# @io-status: the status of the job (since 1.3)
|
|
|
|
#
|
2014-10-24 15:57:34 +02:00
|
|
|
# @ready: true if the job may be completed (since 2.2)
|
|
|
|
#
|
blockjobs: add status enum
We're about to add several new states, and booleans are becoming
unwieldly and difficult to reason about. It would help to have a
more explicit bookkeeping of the state of blockjobs. To this end,
add a new "status" field and add our existing states in a redundant
manner alongside the bools they are replacing:
UNDEFINED: Placeholder, default state. Not currently visible to QMP
unless changes occur in the future to allow creating jobs
without starting them via QMP.
CREATED: replaces !!job->co && paused && !busy
RUNNING: replaces effectively (!paused && busy)
PAUSED: Nearly redundant with info->paused, which shows pause_count.
This reports the actual status of the job, which almost always
matches the paused request status. It differs in that it is
strictly only true when the job has actually gone dormant.
READY: replaces job->ready.
STANDBY: Paused, but job->ready is true.
New state additions in coming commits will not be quite so redundant:
WAITING: Waiting on transaction. This job has finished all the work
it can until the transaction converges, fails, or is canceled.
PENDING: Pending authorization from user. This job has finished all the
work it can until the job or transaction is finalized via
block_job_finalize. This implies the transaction has converged
and left the WAITING phase.
ABORTING: Job has encountered an error condition and is in the process
of aborting.
CONCLUDED: Job has ceased all operations and has a return code available
for query and may be dismissed via block_job_dismiss.
NULL: Job has been dismissed and (should) be destroyed. Should never
be visible to QMP.
Some of these states appear somewhat superfluous, but it helps define the
expected flow of a job; so some of the states wind up being synchronous
empty transitions. Importantly, jobs can be in only one of these states
at any given time, which helps code and external users alike reason about
the current condition of a job unambiguously.
Signed-off-by: John Snow <jsnow@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-03-10 09:27:29 +01:00
|
|
|
# @status: Current job state/status (since 2.12)
|
|
|
|
#
|
2018-03-10 09:27:44 +01:00
|
|
|
# @auto-finalize: Job will finalize itself when PENDING, moving to
|
|
|
|
# the CONCLUDED state. (since 2.12)
|
|
|
|
#
|
|
|
|
# @auto-dismiss: Job will dismiss itself when CONCLUDED, moving to the NULL
|
|
|
|
# state and disappearing from the query list. (since 2.12)
|
|
|
|
#
|
2018-05-09 01:36:59 +02:00
|
|
|
# @error: Error information if the job did not complete successfully.
|
|
|
|
# Not set if the job completed successfully. (since 2.12.1)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 1.1
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockJobInfo',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': {'type': 'str', 'device': 'str', 'len': 'int',
|
|
|
|
'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
|
blockjobs: add status enum
We're about to add several new states, and booleans are becoming
unwieldly and difficult to reason about. It would help to have a
more explicit bookkeeping of the state of blockjobs. To this end,
add a new "status" field and add our existing states in a redundant
manner alongside the bools they are replacing:
UNDEFINED: Placeholder, default state. Not currently visible to QMP
unless changes occur in the future to allow creating jobs
without starting them via QMP.
CREATED: replaces !!job->co && paused && !busy
RUNNING: replaces effectively (!paused && busy)
PAUSED: Nearly redundant with info->paused, which shows pause_count.
This reports the actual status of the job, which almost always
matches the paused request status. It differs in that it is
strictly only true when the job has actually gone dormant.
READY: replaces job->ready.
STANDBY: Paused, but job->ready is true.
New state additions in coming commits will not be quite so redundant:
WAITING: Waiting on transaction. This job has finished all the work
it can until the transaction converges, fails, or is canceled.
PENDING: Pending authorization from user. This job has finished all the
work it can until the job or transaction is finalized via
block_job_finalize. This implies the transaction has converged
and left the WAITING phase.
ABORTING: Job has encountered an error condition and is in the process
of aborting.
CONCLUDED: Job has ceased all operations and has a return code available
for query and may be dismissed via block_job_dismiss.
NULL: Job has been dismissed and (should) be destroyed. Should never
be visible to QMP.
Some of these states appear somewhat superfluous, but it helps define the
expected flow of a job; so some of the states wind up being synchronous
empty transitions. Importantly, jobs can be in only one of these states
at any given time, which helps code and external users alike reason about
the current condition of a job unambiguously.
Signed-off-by: John Snow <jsnow@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-03-10 09:27:29 +01:00
|
|
|
'io-status': 'BlockDeviceIoStatus', 'ready': 'bool',
|
2018-04-13 17:19:31 +02:00
|
|
|
'status': 'JobStatus',
|
2018-05-09 01:36:59 +02:00
|
|
|
'auto-finalize': 'bool', 'auto-dismiss': 'bool',
|
|
|
|
'*error': 'str' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-block-jobs:
|
|
|
|
#
|
|
|
|
# Return information about long-running block device operations.
|
|
|
|
#
|
|
|
|
# Returns: a list of @BlockJobInfo for each active block job
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
##
|
|
|
|
{ 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @block_passwd:
|
|
|
|
#
|
|
|
|
# This command sets the password of a block device that has not been open
|
|
|
|
# with a password and requires one.
|
|
|
|
#
|
2017-06-23 18:24:16 +02:00
|
|
|
# This command is now obsolete and will always return an error since 2.10
|
2016-06-23 14:01:09 +02:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2018-12-08 12:16:04 +01:00
|
|
|
{ 'command': 'block_passwd',
|
|
|
|
'data': { '*device': 'str',
|
|
|
|
'*node-name': 'str',
|
|
|
|
'password': 'str' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @block_resize:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Resize a block image while a guest is running.
|
|
|
|
#
|
|
|
|
# Either @device or @node-name must be set but not both.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @device: the name of the device to get the image resized
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @node-name: graph node name to get the image resized (Since 2.0)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @size: new image size in bytes
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @device is not a valid block device, DeviceNotFound
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 0.14.0
|
2016-06-23 14:01:52 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "block_resize",
|
|
|
|
# "arguments": { "device": "scratch", "size": 1073741824 } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2018-12-08 12:16:04 +01:00
|
|
|
{ 'command': 'block_resize',
|
|
|
|
'data': { '*device': 'str',
|
|
|
|
'*node-name': 'str',
|
|
|
|
'size': 'int' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @NewImageMode:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# An enumeration that tells QEMU how to set the backing file path in
|
|
|
|
# a new image file.
|
|
|
|
#
|
|
|
|
# @existing: QEMU should look for an existing image file.
|
|
|
|
#
|
|
|
|
# @absolute-paths: QEMU should create a new image with absolute paths
|
2020-02-13 18:56:26 +01:00
|
|
|
# for the backing file. If there is no backing file available, the new
|
|
|
|
# image will not be backed either.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'NewImageMode',
|
|
|
|
'data': [ 'existing', 'absolute-paths' ] }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevSnapshotSync:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Either @device or @node-name must be set but not both.
|
|
|
|
#
|
2019-06-03 22:22:35 +02:00
|
|
|
# @device: the name of the device to take a snapshot of.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @node-name: graph node name to generate the snapshot from (Since 2.0)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-06-03 22:22:35 +02:00
|
|
|
# @snapshot-file: the target of the new overlay image. If the file
|
2020-02-13 18:56:26 +01:00
|
|
|
# exists, or if it is a device, the overlay will be created in the
|
|
|
|
# existing file/device. Otherwise, a new file will be created.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @snapshot-node-name: the graph node name of the new image (Since 2.0)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-06-03 22:22:35 +02:00
|
|
|
# @format: the format of the overlay image, default is 'qcow2'.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @mode: whether and how QEMU should create a new image, default is
|
2014-06-05 13:45:31 +02:00
|
|
|
# 'absolute-paths'.
|
|
|
|
##
|
2015-10-26 13:27:14 +01:00
|
|
|
{ 'struct': 'BlockdevSnapshotSync',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { '*device': 'str', '*node-name': 'str',
|
|
|
|
'snapshot-file': 'str', '*snapshot-node-name': 'str',
|
|
|
|
'*format': 'str', '*mode': 'NewImageMode' } }
|
|
|
|
|
2015-10-26 13:27:16 +01:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevSnapshot:
|
2015-10-26 13:27:16 +01:00
|
|
|
#
|
2019-06-03 22:22:35 +02:00
|
|
|
# @node: device or node name that will have a snapshot taken.
|
2015-10-26 13:27:16 +01:00
|
|
|
#
|
|
|
|
# @overlay: reference to the existing block device that will become
|
2019-06-03 22:22:35 +02:00
|
|
|
# the overlay of @node, as part of taking the snapshot.
|
2015-10-26 13:27:16 +01:00
|
|
|
# It must not have a current backing file (this can be
|
2018-02-24 16:40:33 +01:00
|
|
|
# achieved by passing "backing": null to blockdev-add).
|
2015-10-26 13:27:16 +01:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.5
|
2015-10-26 13:27:16 +01:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevSnapshot',
|
|
|
|
'data': { 'node': 'str', 'overlay': 'str' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2019-07-29 22:35:52 +02:00
|
|
|
# @BackupCommon:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @job-id: identifier for the newly-created block job. If
|
2016-07-05 16:28:58 +02:00
|
|
|
# omitted, the device name will be used. (Since 2.7)
|
|
|
|
#
|
2016-06-23 14:20:24 +02:00
|
|
|
# @device: the device name or node-name of a root node which should be copied.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @sync: what parts of the disk image should be copied to the destination
|
2015-04-18 01:49:58 +02:00
|
|
|
# (all the disk, only the sectors allocated in the topmost image, from a
|
|
|
|
# dirty bitmap, or only new I/O).
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# @speed: the maximum speed, in bytes per second. The default is 0,
|
|
|
|
# for unlimited.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-07-29 22:35:55 +02:00
|
|
|
# @bitmap: The name of a dirty bitmap to use.
|
2019-07-29 22:35:52 +02:00
|
|
|
# Must be present if sync is "bitmap" or "incremental".
|
2019-07-29 22:35:55 +02:00
|
|
|
# Can be present if sync is "full" or "top".
|
2019-07-29 22:35:52 +02:00
|
|
|
# Must not be present otherwise.
|
|
|
|
# (Since 2.4 (drive-backup), 3.1 (blockdev-backup))
|
|
|
|
#
|
|
|
|
# @bitmap-mode: Specifies the type of data the bitmap should contain after
|
2019-07-29 22:35:55 +02:00
|
|
|
# the operation concludes.
|
|
|
|
# Must be present if a bitmap was provided,
|
2019-07-29 22:35:52 +02:00
|
|
|
# Must NOT be present otherwise. (Since 4.2)
|
2015-04-18 01:49:58 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @compress: true to compress data, if the target format supports it.
|
2016-09-16 17:42:25 +02:00
|
|
|
# (default: false) (since 2.8)
|
2016-07-22 10:17:52 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @on-source-error: the action to take on an error on the source,
|
2014-06-05 13:45:31 +02:00
|
|
|
# default 'report'. 'stop' and 'enospc' can only be used
|
|
|
|
# if the block device supports io-status (see BlockInfo).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @on-target-error: the action to take on an error on the target,
|
2014-06-05 13:45:31 +02:00
|
|
|
# default 'report' (no limitations, since this applies to
|
|
|
|
# a different block device than @device).
|
|
|
|
#
|
2018-03-10 09:27:44 +01:00
|
|
|
# @auto-finalize: When false, this job will wait in a PENDING state after it has
|
2018-09-06 15:02:24 +02:00
|
|
|
# finished its work, waiting for @block-job-finalize before
|
|
|
|
# making any block graph changes.
|
|
|
|
# When true, this job will automatically
|
|
|
|
# perform its abort or commit actions.
|
2018-03-10 09:27:44 +01:00
|
|
|
# Defaults to true. (Since 2.12)
|
|
|
|
#
|
|
|
|
# @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
|
2018-09-06 15:02:24 +02:00
|
|
|
# has completely ceased all work, and awaits @block-job-dismiss.
|
2018-03-10 09:27:44 +01:00
|
|
|
# When true, this job will automatically disappear from the query
|
|
|
|
# list without user intervention.
|
|
|
|
# Defaults to true. (Since 2.12)
|
|
|
|
#
|
block/backup: use backup-top instead of write notifiers
Drop write notifiers and use filter node instead.
= Changes =
1. Add filter-node-name argument for backup qmp api. We have to do it
in this commit, as 257 needs to be fixed.
2. There are no more write notifiers here, so is_write_notifier
parameter is dropped from block-copy paths.
3. To sync with in-flight requests at job finish we now have drained
removing of the filter, we don't need rw-lock.
4. Block-copy is now using BdrvChildren instead of BlockBackends
5. As backup-top owns these children, we also move block-copy state
into backup-top's ownership.
= Iotest changes =
56: op-blocker doesn't shoot now, as we set it on source, but then
check on filter, when trying to start second backup.
To keep the test we instead can catch another collision: both jobs will
get 'drive0' job-id, as job-id parameter is unspecified. To prevent
interleaving with file-posix locks (as they are dependent on config)
let's use another target for second backup.
Also, it's obvious now that we'd like to drop this op-blocker at all
and add a test-case for two backups from one node (to different
destinations) actually works. But not in these series.
141: Output changed: prepatch, "Node is in use" comes from bdrv_has_blk
check inside qmp_blockdev_del. But we've dropped block-copy blk
objects, so no more blk objects on source bs (job blk is on backup-top
filter bs). New message is from op-blocker, which is the next check in
qmp_blockdev_add.
257: The test wants to emulate guest write during backup. They should
go to filter node, not to original source node, of course. Therefore we
need to specify filter node name and use it.
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Message-id: 20191001131409.14202-6-vsementsov@virtuozzo.com
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2019-10-01 15:14:09 +02:00
|
|
|
# @filter-node-name: the node name that should be assigned to the
|
|
|
|
# filter driver that the backup job inserts into the graph
|
|
|
|
# above node specified by @drive. If this option is not given,
|
|
|
|
# a node name is autogenerated. (Since: 4.2)
|
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Note: @on-source-error and @on-target-error only affect background
|
2020-02-13 18:56:26 +01:00
|
|
|
# I/O. If an error occurs during a guest write request, the device's
|
|
|
|
# rerror/werror actions will be used.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# Since: 4.2
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2019-07-29 22:35:52 +02:00
|
|
|
{ 'struct': 'BackupCommon',
|
|
|
|
'data': { '*job-id': 'str', 'device': 'str',
|
|
|
|
'sync': 'MirrorSyncMode', '*speed': 'int',
|
2019-07-29 22:35:52 +02:00
|
|
|
'*bitmap': 'str', '*bitmap-mode': 'BitmapSyncMode',
|
|
|
|
'*compress': 'bool',
|
2014-06-05 13:45:31 +02:00
|
|
|
'*on-source-error': 'BlockdevOnError',
|
2018-03-10 09:27:44 +01:00
|
|
|
'*on-target-error': 'BlockdevOnError',
|
block/backup: use backup-top instead of write notifiers
Drop write notifiers and use filter node instead.
= Changes =
1. Add filter-node-name argument for backup qmp api. We have to do it
in this commit, as 257 needs to be fixed.
2. There are no more write notifiers here, so is_write_notifier
parameter is dropped from block-copy paths.
3. To sync with in-flight requests at job finish we now have drained
removing of the filter, we don't need rw-lock.
4. Block-copy is now using BdrvChildren instead of BlockBackends
5. As backup-top owns these children, we also move block-copy state
into backup-top's ownership.
= Iotest changes =
56: op-blocker doesn't shoot now, as we set it on source, but then
check on filter, when trying to start second backup.
To keep the test we instead can catch another collision: both jobs will
get 'drive0' job-id, as job-id parameter is unspecified. To prevent
interleaving with file-posix locks (as they are dependent on config)
let's use another target for second backup.
Also, it's obvious now that we'd like to drop this op-blocker at all
and add a test-case for two backups from one node (to different
destinations) actually works. But not in these series.
141: Output changed: prepatch, "Node is in use" comes from bdrv_has_blk
check inside qmp_blockdev_del. But we've dropped block-copy blk
objects, so no more blk objects on source bs (job blk is on backup-top
filter bs). New message is from op-blocker, which is the next check in
qmp_blockdev_add.
257: The test wants to emulate guest write during backup. They should
go to filter node, not to original source node, of course. Therefore we
need to specify filter node name and use it.
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Message-id: 20191001131409.14202-6-vsementsov@virtuozzo.com
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2019-10-01 15:14:09 +02:00
|
|
|
'*auto-finalize': 'bool', '*auto-dismiss': 'bool',
|
|
|
|
'*filter-node-name': 'str' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2014-12-18 11:37:05 +01:00
|
|
|
##
|
2019-07-29 22:35:52 +02:00
|
|
|
# @DriveBackup:
|
2016-07-22 10:17:53 +02:00
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# @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.
|
2014-12-18 11:37:05 +01:00
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# @format: the format of the new destination, default is to
|
|
|
|
# probe if @mode is 'existing', else the format of the source
|
2014-12-18 11:37:05 +01:00
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# @mode: whether and how QEMU should create a new image, default is
|
|
|
|
# 'absolute-paths'.
|
2018-03-10 09:27:44 +01:00
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# Since: 1.6
|
|
|
|
##
|
|
|
|
{ 'struct': 'DriveBackup',
|
|
|
|
'base': 'BackupCommon',
|
|
|
|
'data': { 'target': 'str',
|
|
|
|
'*format': 'str',
|
|
|
|
'*mode': 'NewImageMode' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevBackup:
|
2018-03-10 09:27:44 +01:00
|
|
|
#
|
2019-07-29 22:35:52 +02:00
|
|
|
# @target: the device name or node-name of the backup target node.
|
2014-12-18 11:37:05 +01:00
|
|
|
#
|
|
|
|
# Since: 2.3
|
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevBackup',
|
2019-07-29 22:35:52 +02:00
|
|
|
'base': 'BackupCommon',
|
|
|
|
'data': { 'target': 'str' } }
|
2014-12-18 11:37:05 +01:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @blockdev-snapshot-sync:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-06-03 22:22:35 +02:00
|
|
|
# Takes a synchronous snapshot of a block device.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2015-10-26 13:27:14 +01:00
|
|
|
# For the arguments, see the documentation of BlockdevSnapshotSync.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @device is not a valid block device, DeviceNotFound
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 0.14.0
|
2016-06-23 14:04:28 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "blockdev-snapshot-sync",
|
|
|
|
# "arguments": { "device": "ide-hd0",
|
|
|
|
# "snapshot-file":
|
|
|
|
# "/some/place/my-image",
|
|
|
|
# "format": "qcow2" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'blockdev-snapshot-sync',
|
2015-10-26 13:27:14 +01:00
|
|
|
'data': 'BlockdevSnapshotSync' }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2015-10-26 13:27:16 +01:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @blockdev-snapshot:
|
2015-10-26 13:27:16 +01:00
|
|
|
#
|
2019-06-03 22:22:35 +02:00
|
|
|
# Takes a snapshot of a block device.
|
2015-10-26 13:27:16 +01:00
|
|
|
#
|
2019-06-03 22:22:35 +02:00
|
|
|
# Take a snapshot, by installing 'node' as the backing image of
|
2016-06-23 14:08:19 +02:00
|
|
|
# 'overlay'. Additionally, if 'node' is associated with a block
|
|
|
|
# device, the block device changes to using 'overlay' as its new active
|
|
|
|
# image.
|
|
|
|
#
|
2015-10-26 13:27:16 +01:00
|
|
|
# For the arguments, see the documentation of BlockdevSnapshot.
|
|
|
|
#
|
2020-03-10 12:38:31 +01:00
|
|
|
# Features:
|
|
|
|
# @allow-write-only-overlay: If present, the check whether this operation is safe
|
|
|
|
# was relaxed so that it can be used to change
|
|
|
|
# backing file of a destination of a blockdev-mirror.
|
|
|
|
# (since 5.0)
|
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.5
|
2016-06-23 14:08:19 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "blockdev-add",
|
2017-05-23 19:44:20 +02:00
|
|
|
# "arguments": { "driver": "qcow2",
|
|
|
|
# "node-name": "node1534",
|
|
|
|
# "file": { "driver": "file",
|
|
|
|
# "filename": "hd1.qcow2" },
|
2018-02-24 16:40:33 +01:00
|
|
|
# "backing": null } }
|
2016-06-23 14:08:19 +02:00
|
|
|
#
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
# -> { "execute": "blockdev-snapshot",
|
|
|
|
# "arguments": { "node": "ide-hd0",
|
|
|
|
# "overlay": "node1534" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2015-10-26 13:27:16 +01:00
|
|
|
##
|
|
|
|
{ 'command': 'blockdev-snapshot',
|
2020-03-10 12:38:31 +01:00
|
|
|
'data': 'BlockdevSnapshot',
|
|
|
|
'features': [ 'allow-write-only-overlay' ] }
|
2015-10-26 13:27:16 +01:00
|
|
|
|
2014-07-01 09:52:16 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @change-backing-file:
|
2014-07-01 09:52:16 +02:00
|
|
|
#
|
|
|
|
# Change the backing file in the image file metadata. This does not
|
|
|
|
# cause QEMU to reopen the image file to reparse the backing filename
|
|
|
|
# (it may, however, perform a reopen to change permissions from
|
|
|
|
# r/o -> r/w -> r/o, if needed). The new backing file string is written
|
|
|
|
# into the image file metadata, and the QEMU internal strings are
|
|
|
|
# updated.
|
|
|
|
#
|
|
|
|
# @image-node-name: The name of the block driver state node of the
|
2016-06-23 14:09:20 +02:00
|
|
|
# image to modify. The "device" argument is used
|
|
|
|
# to verify "image-node-name" is in the chain
|
|
|
|
# described by "device".
|
2014-07-01 09:52:16 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @device: The device name or node-name of the root node that owns
|
|
|
|
# image-node-name.
|
2014-07-01 09:52:16 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @backing-file: The string to write as the backing file. This
|
|
|
|
# string is not validated, so care should be taken
|
|
|
|
# when specifying the string or the image chain may
|
|
|
|
# not be able to be reopened again.
|
2014-07-01 09:52:16 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success
|
|
|
|
# - If "device" does not exist or cannot be determined, DeviceNotFound
|
2016-06-23 14:09:20 +02:00
|
|
|
#
|
2014-07-01 09:52:16 +02:00
|
|
|
# Since: 2.1
|
|
|
|
##
|
|
|
|
{ 'command': 'change-backing-file',
|
|
|
|
'data': { 'device': 'str', 'image-node-name': 'str',
|
|
|
|
'backing-file': 'str' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @block-commit:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Live commit of data from overlay image nodes into backing nodes - i.e.,
|
|
|
|
# writes data between 'top' and 'base' into 'base'.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @job-id: identifier for the newly-created block job. If
|
2016-07-05 16:29:00 +02:00
|
|
|
# omitted, the device name will be used. (Since 2.7)
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @device: the device name or node-name of a root node
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-06-27 17:18:20 +02:00
|
|
|
# @base-node: The node name of the backing image to write data into.
|
|
|
|
# If not specified, this is the deepest backing image.
|
|
|
|
# (since: 3.1)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-06-27 17:18:20 +02:00
|
|
|
# @base: Same as @base-node, except that it is a file name rather than a node
|
|
|
|
# name. This must be the exact filename string that was used to open the
|
|
|
|
# node; other strings, even if addressing the same file, are not
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# accepted
|
2017-06-27 17:18:20 +02:00
|
|
|
#
|
|
|
|
# @top-node: The node name of the backing image within the image chain
|
|
|
|
# which contains the topmost data to be committed down. If
|
|
|
|
# not specified, this is the active layer. (since: 3.1)
|
|
|
|
#
|
|
|
|
# @top: Same as @top-node, except that it is a file name rather than a node
|
|
|
|
# name. This must be the exact filename string that was used to open the
|
|
|
|
# node; other strings, even if addressing the same file, are not
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# accepted
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @backing-file: The backing file string to write into the overlay
|
|
|
|
# image of 'top'. If 'top' is the active layer,
|
|
|
|
# specifying a backing file string is an error. This
|
|
|
|
# filename is not validated.
|
|
|
|
#
|
|
|
|
# If a pathname string is such that it cannot be
|
|
|
|
# resolved by QEMU, that means that subsequent QMP or
|
|
|
|
# HMP commands must use node-names for the image in
|
|
|
|
# question, as filename lookup methods will fail.
|
|
|
|
#
|
|
|
|
# If not specified, QEMU will automatically determine
|
|
|
|
# the backing file string to use, or error out if
|
|
|
|
# there is no obvious choice. Care should be taken
|
|
|
|
# when specifying the string, to specify a valid
|
|
|
|
# filename or protocol.
|
|
|
|
# (Since 2.1)
|
|
|
|
#
|
|
|
|
# If top == base, that is an error.
|
|
|
|
# If top == active, the job will not be completed by itself,
|
|
|
|
# user needs to complete the job with the block-job-complete
|
|
|
|
# command after getting the ready event. (Since 2.0)
|
|
|
|
#
|
|
|
|
# If the base image is smaller than top, then the base image
|
|
|
|
# will be resized to be the same size as top. If top is
|
|
|
|
# smaller than the base image, the base will not be
|
|
|
|
# truncated. If you want the base image size to match the
|
|
|
|
# size of the smaller top, you can safely truncate it
|
|
|
|
# yourself once the commit operation successfully completes.
|
|
|
|
#
|
|
|
|
# @speed: the maximum speed, in bytes per second
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-14 21:08:11 +01:00
|
|
|
# @on-error: the action to take on an error. 'ignore' means that the request
|
|
|
|
# should be retried. (default: report; Since: 5.0)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @filter-node-name: the node name that should be assigned to the
|
2017-02-20 18:10:05 +01:00
|
|
|
# filter driver that the commit job inserts into the graph
|
|
|
|
# above @top. If this option is not given, a node name is
|
|
|
|
# autogenerated. (Since: 2.9)
|
|
|
|
#
|
2018-09-06 15:02:21 +02:00
|
|
|
# @auto-finalize: When false, this job will wait in a PENDING state after it has
|
|
|
|
# finished its work, waiting for @block-job-finalize before
|
|
|
|
# making any block graph changes.
|
|
|
|
# When true, this job will automatically
|
|
|
|
# perform its abort or commit actions.
|
|
|
|
# Defaults to true. (Since 3.1)
|
|
|
|
#
|
|
|
|
# @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
|
|
|
|
# has completely ceased all work, and awaits @block-job-dismiss.
|
|
|
|
# When true, this job will automatically disappear from the query
|
|
|
|
# list without user intervention.
|
|
|
|
# Defaults to true. (Since 3.1)
|
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# Features:
|
|
|
|
# @deprecated: Members @base and @top are deprecated. Use @base-node
|
|
|
|
# and @top-node instead.
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success
|
|
|
|
# - If @device does not exist, DeviceNotFound
|
|
|
|
# - Any other error returns a GenericError.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
#
|
2016-06-23 14:10:29 +02:00
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "block-commit",
|
|
|
|
# "arguments": { "device": "virtio0",
|
|
|
|
# "top": "/tmp/snap1.qcow2" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'block-commit',
|
2017-06-27 17:18:20 +02:00
|
|
|
'data': { '*job-id': 'str', 'device': 'str', '*base-node': 'str',
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
'*base': { 'type': 'str', 'features': [ 'deprecated' ] },
|
|
|
|
'*top-node': 'str',
|
|
|
|
'*top': { 'type': 'str', 'features': [ 'deprecated' ] },
|
2017-02-20 18:10:05 +01:00
|
|
|
'*backing-file': 'str', '*speed': 'int',
|
2020-02-14 21:08:11 +01:00
|
|
|
'*on-error': 'BlockdevOnError',
|
2018-09-06 15:02:21 +02:00
|
|
|
'*filter-node-name': 'str',
|
|
|
|
'*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @drive-backup:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Start a point-in-time copy of a block device to a new destination. The
|
|
|
|
# status of ongoing drive-backup operations can be checked with
|
|
|
|
# query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
|
|
|
|
# The operation can be stopped before it has completed using the
|
|
|
|
# block-job-cancel command.
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @device is not a valid block device, GenericError
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 1.6
|
2016-06-23 14:11:47 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "drive-backup",
|
|
|
|
# "arguments": { "device": "drive0",
|
|
|
|
# "sync": "full",
|
|
|
|
# "target": "backup.img" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-07-22 10:17:50 +02:00
|
|
|
{ 'command': 'drive-backup', 'boxed': true,
|
|
|
|
'data': 'DriveBackup' }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2014-12-18 11:37:05 +01:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @blockdev-backup:
|
2014-12-18 11:37:05 +01:00
|
|
|
#
|
|
|
|
# Start a point-in-time copy of a block device to a new destination. The
|
|
|
|
# status of ongoing blockdev-backup operations can be checked with
|
|
|
|
# query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
|
|
|
|
# The operation can be stopped before it has completed using the
|
|
|
|
# block-job-cancel command.
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @device is not a valid block device, DeviceNotFound
|
2016-07-22 10:17:51 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.3
|
2016-06-23 14:13:07 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# -> { "execute": "blockdev-backup",
|
|
|
|
# "arguments": { "device": "src-id",
|
|
|
|
# "sync": "full",
|
|
|
|
# "target": "tgt-id" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2014-12-18 11:37:05 +01:00
|
|
|
##
|
2016-07-22 10:17:51 +02:00
|
|
|
{ 'command': 'blockdev-backup', 'boxed': true,
|
|
|
|
'data': 'BlockdevBackup' }
|
2014-12-18 11:37:05 +01:00
|
|
|
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @query-named-block-nodes:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Get the named block driver list
|
|
|
|
#
|
2020-01-20 09:50:49 +01:00
|
|
|
# @flat: Omit the nested data about backing image ("backing-image" key) if true.
|
|
|
|
# Default is false (Since 5.0)
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Returns: the list of BlockDeviceInfo
|
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.0
|
2016-06-23 14:13:48 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-named-block-nodes" }
|
|
|
|
# <- { "return": [ { "ro":false,
|
|
|
|
# "drv":"qcow2",
|
|
|
|
# "encrypted":false,
|
|
|
|
# "file":"disks/test.qcow2",
|
|
|
|
# "node-name": "my-node",
|
|
|
|
# "backing_file_depth":1,
|
|
|
|
# "bps":1000000,
|
|
|
|
# "bps_rd":0,
|
|
|
|
# "bps_wr":0,
|
|
|
|
# "iops":1000000,
|
|
|
|
# "iops_rd":0,
|
|
|
|
# "iops_wr":0,
|
|
|
|
# "bps_max": 8000000,
|
|
|
|
# "bps_rd_max": 0,
|
|
|
|
# "bps_wr_max": 0,
|
|
|
|
# "iops_max": 0,
|
|
|
|
# "iops_rd_max": 0,
|
|
|
|
# "iops_wr_max": 0,
|
|
|
|
# "iops_size": 0,
|
|
|
|
# "write_threshold": 0,
|
|
|
|
# "image":{
|
|
|
|
# "filename":"disks/test.qcow2",
|
|
|
|
# "format":"qcow2",
|
|
|
|
# "virtual-size":2048000,
|
|
|
|
# "backing_file":"base.qcow2",
|
|
|
|
# "full-backing-filename":"disks/base.qcow2",
|
|
|
|
# "backing-filename-format":"qcow2",
|
|
|
|
# "snapshots":[
|
|
|
|
# {
|
|
|
|
# "id": "1",
|
|
|
|
# "name": "snapshot1",
|
|
|
|
# "vm-state-size": 0,
|
|
|
|
# "date-sec": 10000200,
|
|
|
|
# "date-nsec": 12,
|
|
|
|
# "vm-clock-sec": 206,
|
|
|
|
# "vm-clock-nsec": 30
|
|
|
|
# }
|
|
|
|
# ],
|
|
|
|
# "backing-image":{
|
|
|
|
# "filename":"disks/base.qcow2",
|
|
|
|
# "format":"qcow2",
|
|
|
|
# "virtual-size":2048000
|
|
|
|
# }
|
|
|
|
# } } ] }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2020-01-20 09:50:49 +01:00
|
|
|
{ 'command': 'query-named-block-nodes',
|
|
|
|
'returns': [ 'BlockDeviceInfo' ],
|
|
|
|
'data': { '*flat': 'bool' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2018-12-21 18:09:07 +01:00
|
|
|
##
|
|
|
|
# @XDbgBlockGraphNodeType:
|
|
|
|
#
|
|
|
|
# @block-backend: corresponds to BlockBackend
|
|
|
|
#
|
|
|
|
# @block-job: corresonds to BlockJob
|
|
|
|
#
|
|
|
|
# @block-driver: corresponds to BlockDriverState
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'XDbgBlockGraphNodeType',
|
|
|
|
'data': [ 'block-backend', 'block-job', 'block-driver' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @XDbgBlockGraphNode:
|
|
|
|
#
|
|
|
|
# @id: Block graph node identifier. This @id is generated only for
|
|
|
|
# x-debug-query-block-graph and does not relate to any other identifiers in
|
|
|
|
# Qemu.
|
|
|
|
#
|
|
|
|
# @type: Type of graph node. Can be one of block-backend, block-job or
|
|
|
|
# block-driver-state.
|
|
|
|
#
|
|
|
|
# @name: Human readable name of the node. Corresponds to node-name for
|
|
|
|
# block-driver-state nodes; is not guaranteed to be unique in the whole
|
|
|
|
# graph (with block-jobs and block-backends).
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'XDbgBlockGraphNode',
|
|
|
|
'data': { 'id': 'uint64', 'type': 'XDbgBlockGraphNodeType', 'name': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockPermission:
|
|
|
|
#
|
|
|
|
# Enum of base block permissions.
|
|
|
|
#
|
|
|
|
# @consistent-read: A user that has the "permission" of consistent reads is
|
|
|
|
# guaranteed that their view of the contents of the block
|
|
|
|
# device is complete and self-consistent, representing the
|
|
|
|
# contents of a disk at a specific point.
|
|
|
|
# For most block devices (including their backing files) this
|
|
|
|
# is true, but the property cannot be maintained in a few
|
|
|
|
# situations like for intermediate nodes of a commit block
|
|
|
|
# job.
|
|
|
|
#
|
|
|
|
# @write: This permission is required to change the visible disk contents.
|
|
|
|
#
|
|
|
|
# @write-unchanged: This permission (which is weaker than BLK_PERM_WRITE) is
|
|
|
|
# both enough and required for writes to the block node when
|
|
|
|
# the caller promises that the visible disk content doesn't
|
|
|
|
# change.
|
|
|
|
# As the BLK_PERM_WRITE permission is strictly stronger,
|
|
|
|
# either is sufficient to perform an unchanging write.
|
|
|
|
#
|
|
|
|
# @resize: This permission is required to change the size of a block node.
|
|
|
|
#
|
|
|
|
# @graph-mod: This permission is required to change the node that this
|
|
|
|
# BdrvChild points to.
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockPermission',
|
|
|
|
'data': [ 'consistent-read', 'write', 'write-unchanged', 'resize',
|
|
|
|
'graph-mod' ] }
|
|
|
|
##
|
|
|
|
# @XDbgBlockGraphEdge:
|
|
|
|
#
|
|
|
|
# Block Graph edge description for x-debug-query-block-graph.
|
|
|
|
#
|
|
|
|
# @parent: parent id
|
|
|
|
#
|
|
|
|
# @child: child id
|
|
|
|
#
|
|
|
|
# @name: name of the relation (examples are 'file' and 'backing')
|
|
|
|
#
|
|
|
|
# @perm: granted permissions for the parent operating on the child
|
|
|
|
#
|
|
|
|
# @shared-perm: permissions that can still be granted to other users of the
|
|
|
|
# child while it is still attached to this parent
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'XDbgBlockGraphEdge',
|
|
|
|
'data': { 'parent': 'uint64', 'child': 'uint64',
|
|
|
|
'name': 'str', 'perm': [ 'BlockPermission' ],
|
|
|
|
'shared-perm': [ 'BlockPermission' ] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @XDbgBlockGraph:
|
|
|
|
#
|
|
|
|
# Block Graph - list of nodes and list of edges.
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'XDbgBlockGraph',
|
|
|
|
'data': { 'nodes': ['XDbgBlockGraphNode'], 'edges': ['XDbgBlockGraphEdge'] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @x-debug-query-block-graph:
|
|
|
|
#
|
|
|
|
# Get the block graph.
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph' }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @drive-mirror:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2016-06-23 14:17:31 +02:00
|
|
|
# Start mirroring a block device's writes to a new destination. target
|
|
|
|
# specifies the target of the new image. If the file exists, or if it
|
|
|
|
# is a device, it will be used as the new destination for writes. If
|
|
|
|
# it does not exist, a new file will be created. format specifies the
|
|
|
|
# format of the mirror image, default is to probe if mode='existing',
|
|
|
|
# else the format of the source.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @device is not a valid block device, GenericError
|
2016-07-15 00:37:58 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 1.3
|
2016-06-23 14:17:31 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "drive-mirror",
|
|
|
|
# "arguments": { "device": "ide-hd0",
|
|
|
|
# "target": "/some/place/my-image",
|
|
|
|
# "sync": "full",
|
|
|
|
# "format": "qcow2" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2016-07-15 00:37:58 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'drive-mirror', 'boxed': true,
|
|
|
|
'data': 'DriveMirror' }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @DriveMirror:
|
2016-07-15 00:37:58 +02:00
|
|
|
#
|
|
|
|
# A set of parameters describing drive mirror setup.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @job-id: identifier for the newly-created block job. If
|
2016-07-05 16:28:57 +02:00
|
|
|
# omitted, the device name will be used. (Since 2.7)
|
|
|
|
#
|
2016-06-23 14:20:24 +02:00
|
|
|
# @device: the device name or node-name of a root node whose writes should be
|
|
|
|
# mirrored.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @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.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @format: the format of the new destination, default is to
|
2014-06-05 13:45:31 +02:00
|
|
|
# probe if @mode is 'existing', else the format of the source
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @node-name: the new block driver state node name in the graph
|
2014-06-16 12:00:55 +02:00
|
|
|
# (Since 2.1)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @replaces: with sync=full graph node name to be replaced by the new
|
2014-06-27 18:25:25 +02:00
|
|
|
# image when a whole image copy is done. This can be used to repair
|
|
|
|
# broken Quorum files. (Since 2.1)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @mode: whether and how QEMU should create a new image, default is
|
2014-06-05 13:45:31 +02:00
|
|
|
# 'absolute-paths'.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @speed: the maximum speed, in bytes per second
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @sync: what parts of the disk image should be copied to the destination
|
|
|
|
# (all the disk, only the sectors allocated in the topmost image, or
|
|
|
|
# only new I/O).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @granularity: granularity of the dirty bitmap, default is 64K
|
2014-06-05 13:45:31 +02:00
|
|
|
# if the image format doesn't have clusters, 4K if the clusters
|
|
|
|
# are smaller than that, else the cluster size. Must be a
|
|
|
|
# power of 2 between 512 and 64M (since 1.4).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @buf-size: maximum amount of data in flight from source to
|
2014-06-05 13:45:31 +02:00
|
|
|
# target (since 1.4).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @on-source-error: the action to take on an error on the source,
|
2014-06-05 13:45:31 +02:00
|
|
|
# default 'report'. 'stop' and 'enospc' can only be used
|
|
|
|
# if the block device supports io-status (see BlockInfo).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @on-target-error: the action to take on an error on the target,
|
2014-06-05 13:45:31 +02:00
|
|
|
# default 'report' (no limitations, since this applies to
|
|
|
|
# a different block device than @device).
|
2017-03-15 13:57:06 +01:00
|
|
|
# @unmap: Whether to try to unmap target sectors where source has
|
2015-06-08 07:56:08 +02:00
|
|
|
# only zero. If true, and target unallocated sectors will read as zero,
|
|
|
|
# target image sectors will be unmapped; otherwise, zeroes will be
|
|
|
|
# written. Both will result in identical contents.
|
|
|
|
# Default is true. (Since 2.4)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2018-06-13 20:18:22 +02:00
|
|
|
# @copy-mode: when to copy data to the destination; defaults to 'background'
|
|
|
|
# (Since: 3.0)
|
|
|
|
#
|
2018-09-06 15:02:22 +02:00
|
|
|
# @auto-finalize: When false, this job will wait in a PENDING state after it has
|
|
|
|
# finished its work, waiting for @block-job-finalize before
|
|
|
|
# making any block graph changes.
|
|
|
|
# When true, this job will automatically
|
|
|
|
# perform its abort or commit actions.
|
|
|
|
# Defaults to true. (Since 3.1)
|
|
|
|
#
|
|
|
|
# @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
|
|
|
|
# has completely ceased all work, and awaits @block-job-dismiss.
|
|
|
|
# When true, this job will automatically disappear from the query
|
|
|
|
# list without user intervention.
|
|
|
|
# Defaults to true. (Since 3.1)
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 1.3
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-07-15 00:37:58 +02:00
|
|
|
{ 'struct': 'DriveMirror',
|
2016-07-05 16:28:57 +02:00
|
|
|
'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
|
|
|
|
'*format': 'str', '*node-name': 'str', '*replaces': 'str',
|
2014-06-05 13:45:31 +02:00
|
|
|
'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
|
|
|
|
'*speed': 'int', '*granularity': 'uint32',
|
|
|
|
'*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
|
2015-06-08 07:56:08 +02:00
|
|
|
'*on-target-error': 'BlockdevOnError',
|
2018-09-06 15:02:22 +02:00
|
|
|
'*unmap': 'bool', '*copy-mode': 'MirrorCopyMode',
|
|
|
|
'*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2015-04-18 01:49:52 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockDirtyBitmap:
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
|
|
|
# @node: name of device/node which the bitmap is tracking
|
|
|
|
#
|
|
|
|
# @name: name of the dirty bitmap
|
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.4
|
2015-04-18 01:49:52 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockDirtyBitmap',
|
2015-04-18 01:49:52 +02:00
|
|
|
'data': { 'node': 'str', 'name': 'str' } }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockDirtyBitmapAdd:
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
|
|
|
# @node: name of device/node which the bitmap is tracking
|
|
|
|
#
|
2019-11-14 03:46:33 +01:00
|
|
|
# @name: name of the dirty bitmap (must be less than 1024 bytes)
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @granularity: the bitmap granularity, default is 64k for
|
2015-04-18 01:49:52 +02:00
|
|
|
# block-dirty-bitmap-add
|
|
|
|
#
|
2017-06-28 14:05:23 +02:00
|
|
|
# @persistent: the bitmap is persistent, i.e. it will be saved to the
|
|
|
|
# corresponding block device image file on its close. For now only
|
|
|
|
# Qcow2 disks support persistent bitmaps. Default is false for
|
|
|
|
# block-dirty-bitmap-add. (Since: 2.10)
|
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# @disabled: the bitmap is created in the disabled state, which means that
|
|
|
|
# it will not track drive changes. The bitmap may be enabled with
|
|
|
|
# block-dirty-bitmap-enable. Default is false. (Since: 4.0)
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.4
|
2015-04-18 01:49:52 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockDirtyBitmapAdd',
|
2017-06-28 14:05:23 +02:00
|
|
|
'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32',
|
2019-10-03 01:24:11 +02:00
|
|
|
'*persistent': 'bool', '*disabled': 'bool' } }
|
2015-04-18 01:49:52 +02:00
|
|
|
|
2019-05-29 01:33:31 +02:00
|
|
|
##
|
|
|
|
# @BlockDirtyBitmapMergeSource:
|
|
|
|
#
|
|
|
|
# @local: name of the bitmap, attached to the same node as target bitmap.
|
|
|
|
#
|
|
|
|
# @external: bitmap with specified node
|
|
|
|
#
|
|
|
|
# Since: 4.1
|
|
|
|
##
|
|
|
|
{ 'alternate': 'BlockDirtyBitmapMergeSource',
|
|
|
|
'data': { 'local': 'str',
|
|
|
|
'external': 'BlockDirtyBitmap' } }
|
|
|
|
|
2018-06-11 20:53:32 +02:00
|
|
|
##
|
|
|
|
# @BlockDirtyBitmapMerge:
|
|
|
|
#
|
2019-05-29 01:33:31 +02:00
|
|
|
# @node: name of device/node which the @target bitmap is tracking
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2018-12-21 10:35:21 +01:00
|
|
|
# @target: name of the destination dirty bitmap
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2019-05-29 01:33:31 +02:00
|
|
|
# @bitmaps: name(s) of the source dirty bitmap(s) at @node and/or fully
|
|
|
|
# specifed BlockDirtyBitmap elements. The latter are supported
|
|
|
|
# since 4.1.
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# Since: 4.0
|
2018-06-11 20:53:32 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockDirtyBitmapMerge',
|
2019-05-29 01:33:31 +02:00
|
|
|
'data': { 'node': 'str', 'target': 'str',
|
|
|
|
'bitmaps': ['BlockDirtyBitmapMergeSource'] } }
|
2018-06-11 20:53:32 +02:00
|
|
|
|
2015-04-18 01:49:52 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @block-dirty-bitmap-add:
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
2016-06-23 14:19:37 +02:00
|
|
|
# Create a dirty bitmap with a name on the node, and start tracking the writes.
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @node is not a valid block device or node, DeviceNotFound
|
|
|
|
# - If @name is already taken, GenericError with an explanation
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.4
|
2016-06-23 14:19:37 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "block-dirty-bitmap-add",
|
|
|
|
# "arguments": { "node": "drive0", "name": "bitmap0" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2015-04-18 01:49:52 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'block-dirty-bitmap-add',
|
|
|
|
'data': 'BlockDirtyBitmapAdd' }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @block-dirty-bitmap-remove:
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
2016-06-23 14:23:39 +02:00
|
|
|
# Stop write tracking and remove the dirty bitmap that was created
|
2017-06-28 14:05:29 +02:00
|
|
|
# with block-dirty-bitmap-add. If the bitmap is persistent, remove it from its
|
|
|
|
# storage too.
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @node is not a valid block device or node, DeviceNotFound
|
|
|
|
# - If @name is not found, GenericError with an explanation
|
|
|
|
# - if @name is frozen by an operation, GenericError
|
2015-04-18 01:49:52 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.4
|
2016-06-23 14:23:39 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "block-dirty-bitmap-remove",
|
|
|
|
# "arguments": { "node": "drive0", "name": "bitmap0" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2015-04-18 01:49:52 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'block-dirty-bitmap-remove',
|
|
|
|
'data': 'BlockDirtyBitmap' }
|
|
|
|
|
2015-04-18 01:49:59 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @block-dirty-bitmap-clear:
|
2015-04-18 01:49:59 +02:00
|
|
|
#
|
2016-06-23 14:25:54 +02:00
|
|
|
# Clear (reset) a dirty bitmap on the device, so that an incremental
|
|
|
|
# backup from this point in time forward will only backup clusters
|
|
|
|
# modified after this clear operation.
|
2015-04-18 01:49:59 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @node is not a valid block device, DeviceNotFound
|
|
|
|
# - If @name is not found, GenericError with an explanation
|
2015-04-18 01:49:59 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.4
|
2016-06-23 14:25:54 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "block-dirty-bitmap-clear",
|
|
|
|
# "arguments": { "node": "drive0", "name": "bitmap0" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2015-04-18 01:49:59 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'block-dirty-bitmap-clear',
|
|
|
|
'data': 'BlockDirtyBitmap' }
|
|
|
|
|
2018-06-11 20:53:32 +02:00
|
|
|
##
|
2018-12-21 10:35:22 +01:00
|
|
|
# @block-dirty-bitmap-enable:
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
|
|
|
# Enables a dirty bitmap so that it will begin tracking disk changes.
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @node is not a valid block device, DeviceNotFound
|
|
|
|
# - If @name is not found, GenericError with an explanation
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# Since: 4.0
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# -> { "execute": "block-dirty-bitmap-enable",
|
2018-06-11 20:53:32 +02:00
|
|
|
# "arguments": { "node": "drive0", "name": "bitmap0" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
2018-12-21 10:35:22 +01:00
|
|
|
{ 'command': 'block-dirty-bitmap-enable',
|
2018-06-11 20:53:32 +02:00
|
|
|
'data': 'BlockDirtyBitmap' }
|
|
|
|
|
|
|
|
##
|
2018-12-21 10:35:22 +01:00
|
|
|
# @block-dirty-bitmap-disable:
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
|
|
|
# Disables a dirty bitmap so that it will stop tracking disk changes.
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @node is not a valid block device, DeviceNotFound
|
|
|
|
# - If @name is not found, GenericError with an explanation
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# Since: 4.0
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# -> { "execute": "block-dirty-bitmap-disable",
|
2018-06-11 20:53:32 +02:00
|
|
|
# "arguments": { "node": "drive0", "name": "bitmap0" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
2018-12-21 10:35:22 +01:00
|
|
|
{ 'command': 'block-dirty-bitmap-disable',
|
2018-06-11 20:53:32 +02:00
|
|
|
'data': 'BlockDirtyBitmap' }
|
|
|
|
|
2018-06-11 20:53:32 +02:00
|
|
|
##
|
2018-12-21 10:35:22 +01:00
|
|
|
# @block-dirty-bitmap-merge:
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2018-12-21 10:35:21 +01:00
|
|
|
# Merge dirty bitmaps listed in @bitmaps to the @target dirty bitmap.
|
2019-02-19 23:49:43 +01:00
|
|
|
# Dirty bitmaps in @bitmaps will be unchanged, except if it also appears
|
|
|
|
# as the @target bitmap. Any bits already set in @target will still be
|
|
|
|
# set after the merge, i.e., this operation does not clear the target.
|
2018-12-21 10:35:21 +01:00
|
|
|
# On error, @target is unchanged.
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2019-02-19 23:49:43 +01:00
|
|
|
# The resulting bitmap will count as dirty any clusters that were dirty in any
|
|
|
|
# of the source bitmaps. This can be used to achieve backup checkpoints, or in
|
|
|
|
# simpler usages, to copy bitmaps.
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @node is not a valid block device, DeviceNotFound
|
|
|
|
# - If any bitmap in @bitmaps or @target is not found, GenericError
|
|
|
|
# - If any of the bitmaps have different sizes or granularities,
|
|
|
|
# GenericError
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# Since: 4.0
|
2018-06-11 20:53:32 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
2018-12-21 10:35:22 +01:00
|
|
|
# -> { "execute": "block-dirty-bitmap-merge",
|
2018-12-21 10:35:21 +01:00
|
|
|
# "arguments": { "node": "drive0", "target": "bitmap0",
|
|
|
|
# "bitmaps": ["bitmap1"] } }
|
2018-06-11 20:53:32 +02:00
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
2018-12-21 10:35:22 +01:00
|
|
|
{ 'command': 'block-dirty-bitmap-merge',
|
2018-06-11 20:53:32 +02:00
|
|
|
'data': 'BlockDirtyBitmapMerge' }
|
|
|
|
|
2017-06-28 14:05:25 +02:00
|
|
|
##
|
|
|
|
# @BlockDirtyBitmapSha256:
|
|
|
|
#
|
|
|
|
# SHA256 hash of dirty bitmap data
|
|
|
|
#
|
|
|
|
# @sha256: ASCII representation of SHA256 bitmap hash
|
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockDirtyBitmapSha256',
|
|
|
|
'data': {'sha256': 'str'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @x-debug-block-dirty-bitmap-sha256:
|
|
|
|
#
|
2019-02-19 23:49:43 +01:00
|
|
|
# Get bitmap SHA256.
|
2017-06-28 14:05:25 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - BlockDirtyBitmapSha256 on success
|
|
|
|
# - If @node is not a valid block device, DeviceNotFound
|
|
|
|
# - If @name is not found or if hashing has failed, GenericError with an
|
|
|
|
# explanation
|
2017-06-28 14:05:25 +02:00
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'command': 'x-debug-block-dirty-bitmap-sha256',
|
|
|
|
'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256' }
|
|
|
|
|
2015-12-24 05:45:05 +01:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @blockdev-mirror:
|
2015-12-24 05:45:05 +01:00
|
|
|
#
|
|
|
|
# Start mirroring a block device's writes to a new destination.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @job-id: identifier for the newly-created block job. If
|
2016-07-05 16:28:57 +02:00
|
|
|
# omitted, the device name will be used. (Since 2.7)
|
|
|
|
#
|
2016-06-23 14:20:24 +02:00
|
|
|
# @device: The device name or node-name of a root node whose writes should be
|
|
|
|
# mirrored.
|
2015-12-24 05:45:05 +01:00
|
|
|
#
|
|
|
|
# @target: the id or node-name of the block device to mirror to. This mustn't be
|
|
|
|
# attached to guest.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @replaces: with sync=full graph node name to be replaced by the new
|
2015-12-24 05:45:05 +01:00
|
|
|
# image when a whole image copy is done. This can be used to repair
|
|
|
|
# broken Quorum files.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @speed: the maximum speed, in bytes per second
|
2015-12-24 05:45:05 +01:00
|
|
|
#
|
|
|
|
# @sync: what parts of the disk image should be copied to the destination
|
|
|
|
# (all the disk, only the sectors allocated in the topmost image, or
|
|
|
|
# only new I/O).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @granularity: granularity of the dirty bitmap, default is 64K
|
2015-12-24 05:45:05 +01:00
|
|
|
# if the image format doesn't have clusters, 4K if the clusters
|
|
|
|
# are smaller than that, else the cluster size. Must be a
|
|
|
|
# power of 2 between 512 and 64M
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @buf-size: maximum amount of data in flight from source to
|
2015-12-24 05:45:05 +01:00
|
|
|
# target
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @on-source-error: the action to take on an error on the source,
|
2015-12-24 05:45:05 +01:00
|
|
|
# default 'report'. 'stop' and 'enospc' can only be used
|
|
|
|
# if the block device supports io-status (see BlockInfo).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @on-target-error: the action to take on an error on the target,
|
2015-12-24 05:45:05 +01:00
|
|
|
# default 'report' (no limitations, since this applies to
|
|
|
|
# a different block device than @device).
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @filter-node-name: the node name that should be assigned to the
|
2017-02-20 18:10:05 +01:00
|
|
|
# filter driver that the mirror job inserts into the graph
|
|
|
|
# above @device. If this option is not given, a node name is
|
|
|
|
# autogenerated. (Since: 2.9)
|
|
|
|
#
|
2018-06-13 20:18:22 +02:00
|
|
|
# @copy-mode: when to copy data to the destination; defaults to 'background'
|
|
|
|
# (Since: 3.0)
|
|
|
|
#
|
2018-09-06 15:02:22 +02:00
|
|
|
# @auto-finalize: When false, this job will wait in a PENDING state after it has
|
|
|
|
# finished its work, waiting for @block-job-finalize before
|
|
|
|
# making any block graph changes.
|
|
|
|
# When true, this job will automatically
|
|
|
|
# perform its abort or commit actions.
|
|
|
|
# Defaults to true. (Since 3.1)
|
|
|
|
#
|
|
|
|
# @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
|
|
|
|
# has completely ceased all work, and awaits @block-job-dismiss.
|
|
|
|
# When true, this job will automatically disappear from the query
|
|
|
|
# list without user intervention.
|
|
|
|
# Defaults to true. (Since 3.1)
|
2015-12-24 05:45:05 +01:00
|
|
|
# Returns: nothing on success.
|
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.6
|
2016-06-23 15:32:39 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "blockdev-mirror",
|
|
|
|
# "arguments": { "device": "ide-hd0",
|
|
|
|
# "target": "target0",
|
|
|
|
# "sync": "full" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2015-12-24 05:45:05 +01:00
|
|
|
##
|
|
|
|
{ 'command': 'blockdev-mirror',
|
2016-07-05 16:28:57 +02:00
|
|
|
'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
|
2015-12-24 05:45:05 +01:00
|
|
|
'*replaces': 'str',
|
|
|
|
'sync': 'MirrorSyncMode',
|
|
|
|
'*speed': 'int', '*granularity': 'uint32',
|
|
|
|
'*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
|
2017-02-20 18:10:05 +01:00
|
|
|
'*on-target-error': 'BlockdevOnError',
|
2018-06-13 20:18:22 +02:00
|
|
|
'*filter-node-name': 'str',
|
2018-09-06 15:02:22 +02:00
|
|
|
'*copy-mode': 'MirrorCopyMode',
|
|
|
|
'*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
|
2015-12-24 05:45:05 +01:00
|
|
|
|
2016-07-14 05:50:21 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockIOThrottle:
|
2016-07-14 05:50:21 +02:00
|
|
|
#
|
|
|
|
# A set of parameters describing block throttling.
|
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# @device: Block device name
|
2016-09-20 13:38:48 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @id: The name or QOM path of the guest device (since: 2.8)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @bps: total throughput limit in bytes per second
|
|
|
|
#
|
|
|
|
# @bps_rd: read throughput limit in bytes per second
|
|
|
|
#
|
|
|
|
# @bps_wr: write throughput limit in bytes per second
|
|
|
|
#
|
|
|
|
# @iops: total I/O operations per second
|
|
|
|
#
|
2016-02-18 11:27:08 +01:00
|
|
|
# @iops_rd: read I/O operations per second
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @iops_wr: write I/O operations per second
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_max: total throughput limit during bursts,
|
2020-02-13 18:56:26 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_rd_max: read throughput limit during bursts,
|
2020-02-13 18:56:26 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_wr_max: write throughput limit during bursts,
|
2020-02-13 18:56:26 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_max: total I/O operations per second during bursts,
|
2020-02-13 18:56:26 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_rd_max: read I/O operations per second during bursts,
|
2020-02-13 18:56:26 +01:00
|
|
|
# in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_wr_max: write I/O operations per second during bursts,
|
2020-02-13 18:56:26 +01:00
|
|
|
# in bytes (Since 1.7)
|
2016-02-18 11:27:03 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_max_length: maximum length of the @bps_max burst
|
2020-02-13 18:56:26 +01:00
|
|
|
# period, in seconds. It must only
|
|
|
|
# be set if @bps_max is set as well.
|
|
|
|
# Defaults to 1. (Since 2.6)
|
2016-02-18 11:27:03 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_rd_max_length: maximum length of the @bps_rd_max
|
2020-02-13 18:56:26 +01:00
|
|
|
# burst period, in seconds. It must only
|
|
|
|
# be set if @bps_rd_max is set as well.
|
|
|
|
# Defaults to 1. (Since 2.6)
|
2016-02-18 11:27:03 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @bps_wr_max_length: maximum length of the @bps_wr_max
|
2020-02-13 18:56:26 +01:00
|
|
|
# burst period, in seconds. It must only
|
|
|
|
# be set if @bps_wr_max is set as well.
|
|
|
|
# Defaults to 1. (Since 2.6)
|
2016-02-18 11:27:03 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_max_length: maximum length of the @iops burst
|
2020-02-13 18:56:26 +01:00
|
|
|
# period, in seconds. It must only
|
|
|
|
# be set if @iops_max is set as well.
|
|
|
|
# Defaults to 1. (Since 2.6)
|
2016-02-18 11:27:03 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_rd_max_length: maximum length of the @iops_rd_max
|
2020-02-13 18:56:26 +01:00
|
|
|
# burst period, in seconds. It must only
|
|
|
|
# be set if @iops_rd_max is set as well.
|
|
|
|
# Defaults to 1. (Since 2.6)
|
2016-02-18 11:27:03 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_wr_max_length: maximum length of the @iops_wr_max
|
2020-02-13 18:56:26 +01:00
|
|
|
# burst period, in seconds. It must only
|
|
|
|
# be set if @iops_wr_max is set as well.
|
|
|
|
# Defaults to 1. (Since 2.6)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @iops_size: an I/O size in bytes (Since 1.7)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @group: throttle group name (Since 2.4)
|
2015-06-08 18:17:44 +02:00
|
|
|
#
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
# Features:
|
|
|
|
# @deprecated: Member @device is deprecated. Use @id instead.
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 1.1
|
|
|
|
##
|
2016-07-14 05:50:21 +02:00
|
|
|
{ 'struct': 'BlockIOThrottle',
|
qapi: Mark deprecated QMP parts with feature 'deprecated'
Add feature 'deprecated' to the deprecated QMP commands, so their
deprecation becomes visible in output of query-qmp-schema. Looks like
this:
{"name": "query-cpus",
"ret-type": "[164]",
"meta-type": "command",
"arg-type": "0",
---> "features": ["deprecated"]}
Management applications could conceivably use this for static
checking.
The deprecated commands are change, cpu-add, migrate-set-cache-size,
migrate_set_downtime, migrate_set_speed, query-cpus, query-events,
query-migrate-cache-size.
The deprecated command arguments are block-commit arguments @base and
@top, and block_set_io_throttle, blockdev-change-medium,
blockdev-close-tray, blockdev-open-tray, eject argument @device.
The deprecated command results are query-cpus-fast result @arch,
query-block result @dirty-bitmaps, query-named-block-nodes result
@encryption_key_missing and result @dirty-bitmaps's member @status.
Same for query-block result @inserted, which mirrors
query-named-block-nodes.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200317115459.31821-27-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2020-03-17 12:54:51 +01:00
|
|
|
'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] },
|
|
|
|
'*id': 'str', 'bps': 'int', 'bps_rd': 'int',
|
2016-09-20 13:38:48 +02:00
|
|
|
'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
|
2014-06-05 13:45:31 +02:00
|
|
|
'*bps_max': 'int', '*bps_rd_max': 'int',
|
|
|
|
'*bps_wr_max': 'int', '*iops_max': 'int',
|
|
|
|
'*iops_rd_max': 'int', '*iops_wr_max': 'int',
|
2016-02-18 11:27:03 +01:00
|
|
|
'*bps_max_length': 'int', '*bps_rd_max_length': 'int',
|
|
|
|
'*bps_wr_max_length': 'int', '*iops_max_length': 'int',
|
|
|
|
'*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
|
2015-06-08 18:17:44 +02:00
|
|
|
'*iops_size': 'int', '*group': 'str' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
block: convert ThrottleGroup to object with QOM
ThrottleGroup is converted to an object. This will allow the future
throttle block filter drive easy creation and configuration of throttle
groups in QMP and cli.
A new QAPI struct, ThrottleLimits, is introduced to provide a shared
struct for all throttle configuration needs in QMP.
ThrottleGroups can be created via CLI as
-object throttle-group,id=foo,x-iops-total=100,x-..
where x-* are individual limit properties. Since we can't add non-scalar
properties in -object this interface must be used instead. However,
setting these properties must be disabled after initialization because
certain combinations of limits are forbidden and thus configuration
changes should be done in one transaction. The individual properties
will go away when support for non-scalar values in CLI is implemented
and thus are marked as experimental.
ThrottleGroup also has a `limits` property that uses the ThrottleLimits
struct. It can be used to create ThrottleGroups or set the
configuration in existing groups as follows:
{ "execute": "object-add",
"arguments": {
"qom-type": "throttle-group",
"id": "foo",
"props" : {
"limits": {
"iops-total": 100
}
}
}
}
{ "execute" : "qom-set",
"arguments" : {
"path" : "foo",
"property" : "limits",
"value" : {
"iops-total" : 99
}
}
}
This also means a group's configuration can be fetched with qom-get.
Signed-off-by: Manos Pitsidianakis <el13635@mail.ntua.gr>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Alberto Garcia <berto@igalia.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2017-08-25 15:20:26 +02:00
|
|
|
##
|
|
|
|
# @ThrottleLimits:
|
|
|
|
#
|
|
|
|
# Limit parameters for throttling.
|
|
|
|
# Since some limit combinations are illegal, limits should always be set in one
|
|
|
|
# transaction. All fields are optional. When setting limits, if a field is
|
|
|
|
# missing the current value is not changed.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @iops-total: limit total I/O operations per second
|
|
|
|
# @iops-total-max: I/O operations burst
|
|
|
|
# @iops-total-max-length: length of the iops-total-max burst period, in seconds
|
|
|
|
# It must only be set if @iops-total-max is set as well.
|
|
|
|
# @iops-read: limit read operations per second
|
|
|
|
# @iops-read-max: I/O operations read burst
|
|
|
|
# @iops-read-max-length: length of the iops-read-max burst period, in seconds
|
|
|
|
# It must only be set if @iops-read-max is set as well.
|
|
|
|
# @iops-write: limit write operations per second
|
|
|
|
# @iops-write-max: I/O operations write burst
|
|
|
|
# @iops-write-max-length: length of the iops-write-max burst period, in seconds
|
|
|
|
# It must only be set if @iops-write-max is set as well.
|
|
|
|
# @bps-total: limit total bytes per second
|
|
|
|
# @bps-total-max: total bytes burst
|
|
|
|
# @bps-total-max-length: length of the bps-total-max burst period, in seconds.
|
|
|
|
# It must only be set if @bps-total-max is set as well.
|
|
|
|
# @bps-read: limit read bytes per second
|
|
|
|
# @bps-read-max: total bytes read burst
|
|
|
|
# @bps-read-max-length: length of the bps-read-max burst period, in seconds
|
|
|
|
# It must only be set if @bps-read-max is set as well.
|
|
|
|
# @bps-write: limit write bytes per second
|
|
|
|
# @bps-write-max: total bytes write burst
|
|
|
|
# @bps-write-max-length: length of the bps-write-max burst period, in seconds
|
|
|
|
# It must only be set if @bps-write-max is set as well.
|
|
|
|
# @iops-size: when limiting by iops max size of an I/O in bytes
|
block: convert ThrottleGroup to object with QOM
ThrottleGroup is converted to an object. This will allow the future
throttle block filter drive easy creation and configuration of throttle
groups in QMP and cli.
A new QAPI struct, ThrottleLimits, is introduced to provide a shared
struct for all throttle configuration needs in QMP.
ThrottleGroups can be created via CLI as
-object throttle-group,id=foo,x-iops-total=100,x-..
where x-* are individual limit properties. Since we can't add non-scalar
properties in -object this interface must be used instead. However,
setting these properties must be disabled after initialization because
certain combinations of limits are forbidden and thus configuration
changes should be done in one transaction. The individual properties
will go away when support for non-scalar values in CLI is implemented
and thus are marked as experimental.
ThrottleGroup also has a `limits` property that uses the ThrottleLimits
struct. It can be used to create ThrottleGroups or set the
configuration in existing groups as follows:
{ "execute": "object-add",
"arguments": {
"qom-type": "throttle-group",
"id": "foo",
"props" : {
"limits": {
"iops-total": 100
}
}
}
}
{ "execute" : "qom-set",
"arguments" : {
"path" : "foo",
"property" : "limits",
"value" : {
"iops-total" : 99
}
}
}
This also means a group's configuration can be fetched with qom-get.
Signed-off-by: Manos Pitsidianakis <el13635@mail.ntua.gr>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Alberto Garcia <berto@igalia.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2017-08-25 15:20:26 +02:00
|
|
|
#
|
|
|
|
# Since: 2.11
|
|
|
|
##
|
|
|
|
{ 'struct': 'ThrottleLimits',
|
|
|
|
'data': { '*iops-total' : 'int', '*iops-total-max' : 'int',
|
|
|
|
'*iops-total-max-length' : 'int', '*iops-read' : 'int',
|
|
|
|
'*iops-read-max' : 'int', '*iops-read-max-length' : 'int',
|
|
|
|
'*iops-write' : 'int', '*iops-write-max' : 'int',
|
|
|
|
'*iops-write-max-length' : 'int', '*bps-total' : 'int',
|
|
|
|
'*bps-total-max' : 'int', '*bps-total-max-length' : 'int',
|
|
|
|
'*bps-read' : 'int', '*bps-read-max' : 'int',
|
|
|
|
'*bps-read-max-length' : 'int', '*bps-write' : 'int',
|
|
|
|
'*bps-write-max' : 'int', '*bps-write-max-length' : 'int',
|
|
|
|
'*iops-size' : 'int' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @block-stream:
|
|
|
|
#
|
|
|
|
# Copy data from a backing file into a block device.
|
|
|
|
#
|
|
|
|
# The block streaming operation is performed in the background until the entire
|
|
|
|
# backing file has been copied. This command returns immediately once streaming
|
|
|
|
# has started. The status of ongoing block streaming operations can be checked
|
|
|
|
# with query-block-jobs. The operation can be stopped before it has completed
|
|
|
|
# using the block-job-cancel command.
|
|
|
|
#
|
2016-10-28 09:08:11 +02:00
|
|
|
# The node that receives the data is called the top image, can be located in
|
|
|
|
# any part of the chain (but always above the base image; see below) and can be
|
|
|
|
# specified using its device or node name. Earlier qemu versions only allowed
|
|
|
|
# 'device' to name the top level node; presence of the 'base-node' parameter
|
|
|
|
# during introspection can be used as a witness of the enhanced semantics
|
|
|
|
# of 'device'.
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# If a base file is specified then sectors are not copied from that base file and
|
|
|
|
# its backing chain. When streaming completes the image file will have the base
|
|
|
|
# file as its backing file. This can be used to stream a subset of the backing
|
|
|
|
# file chain instead of flattening the entire image.
|
|
|
|
#
|
|
|
|
# On successful completion the image file is updated to drop the backing file
|
|
|
|
# and the BLOCK_JOB_COMPLETED event is emitted.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @job-id: identifier for the newly-created block job. If
|
2016-07-05 16:28:59 +02:00
|
|
|
# omitted, the device name will be used. (Since 2.7)
|
|
|
|
#
|
2016-10-28 09:08:11 +02:00
|
|
|
# @device: the device or node name of the top image
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @base: the common backing file name.
|
|
|
|
# It cannot be set if @base-node is also set.
|
2016-10-28 09:08:19 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @base-node: the node name of the backing file.
|
2020-02-13 18:56:26 +01:00
|
|
|
# It cannot be set if @base is also set. (Since 2.8)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @backing-file: The backing file string to write into the top
|
2020-02-13 18:56:26 +01:00
|
|
|
# image. This filename is not validated.
|
block: add backing-file option to block-stream
On some image chains, QEMU may not always be able to resolve the
filenames properly, when updating the backing file of an image
after a block job.
For instance, certain relative pathnames may fail, or drives may
have been specified originally by file descriptor (e.g. /dev/fd/???),
or a relative protocol pathname may have been used.
In these instances, QEMU may lack the information to be able to make
the correct choice, but the user or management layer most likely does
have that knowledge.
With this extension to the block-stream api, the user is able to change
the backing file of the active layer as part of the block-stream
operation.
This allows the change to be 'safe', in the sense that if the attempt
to write the active image metadata fails, then the block-stream
operation returns failure, without disrupting the guest.
If a backing file string is not specified in the command, the backing
file string to use is determined in the same manner as it was
previously.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
2014-06-25 21:40:11 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# If a pathname string is such that it cannot be
|
|
|
|
# resolved by QEMU, that means that subsequent QMP or
|
|
|
|
# HMP commands must use node-names for the image in
|
|
|
|
# question, as filename lookup methods will fail.
|
block: add backing-file option to block-stream
On some image chains, QEMU may not always be able to resolve the
filenames properly, when updating the backing file of an image
after a block job.
For instance, certain relative pathnames may fail, or drives may
have been specified originally by file descriptor (e.g. /dev/fd/???),
or a relative protocol pathname may have been used.
In these instances, QEMU may lack the information to be able to make
the correct choice, but the user or management layer most likely does
have that knowledge.
With this extension to the block-stream api, the user is able to change
the backing file of the active layer as part of the block-stream
operation.
This allows the change to be 'safe', in the sense that if the attempt
to write the active image metadata fails, then the block-stream
operation returns failure, without disrupting the guest.
If a backing file string is not specified in the command, the backing
file string to use is determined in the same manner as it was
previously.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
2014-06-25 21:40:11 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# If not specified, QEMU will automatically determine
|
|
|
|
# the backing file string to use, or error out if there
|
|
|
|
# is no obvious choice. Care should be taken when
|
|
|
|
# specifying the string, to specify a valid filename or
|
|
|
|
# protocol.
|
|
|
|
# (Since 2.1)
|
block: add backing-file option to block-stream
On some image chains, QEMU may not always be able to resolve the
filenames properly, when updating the backing file of an image
after a block job.
For instance, certain relative pathnames may fail, or drives may
have been specified originally by file descriptor (e.g. /dev/fd/???),
or a relative protocol pathname may have been used.
In these instances, QEMU may lack the information to be able to make
the correct choice, but the user or management layer most likely does
have that knowledge.
With this extension to the block-stream api, the user is able to change
the backing file of the active layer as part of the block-stream
operation.
This allows the change to be 'safe', in the sense that if the attempt
to write the active image metadata fails, then the block-stream
operation returns failure, without disrupting the guest.
If a backing file string is not specified in the command, the backing
file string to use is determined in the same manner as it was
previously.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
2014-06-25 21:40:11 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @speed: the maximum speed, in bytes per second
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @on-error: the action to take on an error (default report).
|
2014-06-05 13:45:31 +02:00
|
|
|
# 'stop' and 'enospc' can only be used if the block device
|
|
|
|
# supports io-status (see BlockInfo). Since 1.3.
|
|
|
|
#
|
2018-09-06 15:02:23 +02:00
|
|
|
# @auto-finalize: When false, this job will wait in a PENDING state after it has
|
|
|
|
# finished its work, waiting for @block-job-finalize before
|
|
|
|
# making any block graph changes.
|
|
|
|
# When true, this job will automatically
|
|
|
|
# perform its abort or commit actions.
|
|
|
|
# Defaults to true. (Since 3.1)
|
|
|
|
#
|
|
|
|
# @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
|
|
|
|
# has completely ceased all work, and awaits @block-job-dismiss.
|
|
|
|
# When true, this job will automatically disappear from the query
|
|
|
|
# list without user intervention.
|
|
|
|
# Defaults to true. (Since 3.1)
|
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success.
|
|
|
|
# - If @device does not exist, DeviceNotFound.
|
2016-06-23 14:52:13 +02:00
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# Since: 1.1
|
2016-06-23 14:52:13 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "block-stream",
|
|
|
|
# "arguments": { "device": "virtio0",
|
|
|
|
# "base": "/tmp/master.qcow2" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'block-stream',
|
2016-07-05 16:28:59 +02:00
|
|
|
'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
|
2016-10-28 09:08:19 +02:00
|
|
|
'*base-node': 'str', '*backing-file': 'str', '*speed': 'int',
|
2018-09-06 15:02:23 +02:00
|
|
|
'*on-error': 'BlockdevOnError',
|
|
|
|
'*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @block-job-set-speed:
|
|
|
|
#
|
|
|
|
# Set maximum speed for a background block operation.
|
|
|
|
#
|
|
|
|
# This command can only be issued when there is an active block job.
|
|
|
|
#
|
|
|
|
# Throttling can be disabled by setting the speed to 0.
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. This used to be a device name (hence
|
|
|
|
# the name of the parameter), but since QEMU 2.7 it can have
|
|
|
|
# other values.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @speed: the maximum speed, in bytes per second, or 0 for unlimited.
|
|
|
|
# Defaults to 0.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success
|
|
|
|
# - If no background operation is active on this device, DeviceNotActive
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
##
|
|
|
|
{ 'command': 'block-job-set-speed',
|
|
|
|
'data': { 'device': 'str', 'speed': 'int' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @block-job-cancel:
|
|
|
|
#
|
|
|
|
# Stop an active background block operation.
|
|
|
|
#
|
|
|
|
# This command returns immediately after marking the active background block
|
|
|
|
# operation for cancellation. It is an error to call this command if no
|
|
|
|
# operation is in progress.
|
|
|
|
#
|
|
|
|
# The operation will cancel as soon as possible and then emit the
|
|
|
|
# BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
|
|
|
|
# enumerated using query-block-jobs.
|
|
|
|
#
|
QAPI & interop: Clarify events emitted by 'block-job-cancel'
When you cancel an in-progress 'mirror' job (or "active `block-commit`")
with QMP `block-job-cancel`, it emits the event: BLOCK_JOB_CANCELLED.
However, when `block-job-cancel` is issued *after* `drive-mirror` has
indicated (via the event BLOCK_JOB_READY) that the source and
destination have reached synchronization:
[...] # Snip `drive-mirror` invocation & outputs
{
"execute":"block-job-cancel",
"arguments":{
"device":"virtio0"
}
}
{"return": {}}
It (`block-job-cancel`) will counterintuitively emit the event
'BLOCK_JOB_COMPLETED':
{
"timestamp":{
"seconds":1510678024,
"microseconds":526240
},
"event":"BLOCK_JOB_COMPLETED",
"data":{
"device":"virtio0",
"len":41126400,
"offset":41126400,
"speed":0,
"type":"mirror"
}
}
But this is expected behaviour, where the _COMPLETED event indicates
that synchronization has successfully ended (and the destination now has
a point-in-time copy, which is at the time of cancel).
So add a small note to this effect in 'block-core.json'. While at it,
also update the "Live disk synchronization -- drive-mirror and
blockdev-mirror" section in 'live-block-operations.rst'.
(Thanks: Max Reitz for reminding me of this caveat on IRC.)
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2017-11-21 12:52:53 +01:00
|
|
|
# Note that if you issue 'block-job-cancel' after 'drive-mirror' has indicated
|
|
|
|
# (via the event BLOCK_JOB_READY) that the source and destination are
|
|
|
|
# synchronized, then the event triggered by this command changes to
|
|
|
|
# BLOCK_JOB_COMPLETED, to indicate that the mirroring has ended and the
|
|
|
|
# destination now has a point-in-time copy tied to the time of the cancellation.
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
# For streaming, the image file retains its backing file unless the streaming
|
|
|
|
# operation happens to complete just as it is being cancelled. A new streaming
|
|
|
|
# operation can be started at a later time to finish copying all data from the
|
|
|
|
# backing file.
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. This used to be a device name (hence
|
|
|
|
# the name of the parameter), but since QEMU 2.7 it can have
|
|
|
|
# other values.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
block/mirror: change the semantic of 'force' of block-job-cancel
When doing drive mirror to a low speed shared storage, if there was heavy
BLK IO write workload in VM after the 'ready' event, drive mirror block job
can't be canceled immediately, it would keep running until the heavy BLK IO
workload stopped in the VM.
Libvirt depends on the current block-job-cancel semantics, which is that
when used without a flag after the 'ready' event, the command blocks
until data is in sync. However, these semantics are awkward in other
situations, for example, people may use drive mirror for realtime
backups while still wanting to use block live migration. Libvirt cannot
start a block live migration while another drive mirror is in progress,
but the user would rather abandon the backup attempt as broken and
proceed with the live migration than be stuck waiting for the current
drive mirror backup to finish.
The drive-mirror command already includes a 'force' flag, which libvirt
does not use, although it documented the flag as only being useful to
quit a job which is paused. However, since quitting a paused job has
the same effect as abandoning a backup in a non-paused job (namely, the
destination file is not in sync, and the command completes immediately),
we can just improve the documentation to make the force flag obviously
useful.
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: Jeff Cody <jcody@redhat.com>
Cc: Kevin Wolf <kwolf@redhat.com>
Cc: Max Reitz <mreitz@redhat.com>
Cc: Eric Blake <eblake@redhat.com>
Cc: John Snow <jsnow@redhat.com>
Reported-by: Huaitong Han <huanhuaitong@didichuxing.com>
Signed-off-by: Huaitong Han <huanhuaitong@didichuxing.com>
Signed-off-by: Liang Li <liliangleo@didichuxing.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-03-13 13:12:16 +01:00
|
|
|
# @force: If true, and the job has already emitted the event BLOCK_JOB_READY,
|
|
|
|
# abandon the job immediately (even if it is paused) instead of waiting
|
|
|
|
# for the destination to complete its final synchronization (since 1.3)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success
|
|
|
|
# - If no background operation is active on this device, DeviceNotActive
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
##
|
|
|
|
{ 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @block-job-pause:
|
|
|
|
#
|
|
|
|
# Pause an active background block operation.
|
|
|
|
#
|
|
|
|
# This command returns immediately after marking the active background block
|
|
|
|
# operation for pausing. It is an error to call this command if no
|
2018-05-16 12:55:48 +02:00
|
|
|
# operation is in progress or if the job is already paused.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# The operation will pause as soon as possible. No event is emitted when
|
|
|
|
# the operation is actually paused. Cancelling a paused job automatically
|
|
|
|
# resumes it.
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. This used to be a device name (hence
|
|
|
|
# the name of the parameter), but since QEMU 2.7 it can have
|
|
|
|
# other values.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success
|
|
|
|
# - If no background operation is active on this device, DeviceNotActive
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
##
|
|
|
|
{ 'command': 'block-job-pause', 'data': { 'device': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @block-job-resume:
|
|
|
|
#
|
|
|
|
# Resume an active background block operation.
|
|
|
|
#
|
|
|
|
# This command returns immediately after resuming a paused background block
|
|
|
|
# operation. It is an error to call this command if no operation is in
|
2018-05-16 12:55:48 +02:00
|
|
|
# progress or if the job is not paused.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# This command also clears the error status of the job.
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. This used to be a device name (hence
|
|
|
|
# the name of the parameter), but since QEMU 2.7 it can have
|
|
|
|
# other values.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success
|
|
|
|
# - If no background operation is active on this device, DeviceNotActive
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
##
|
|
|
|
{ 'command': 'block-job-resume', 'data': { 'device': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @block-job-complete:
|
|
|
|
#
|
|
|
|
# Manually trigger completion of an active background block operation. This
|
|
|
|
# is supported for drive mirroring, where it also switches the device to
|
|
|
|
# write to the target path only. The ability to complete is signaled with
|
|
|
|
# a BLOCK_JOB_READY event.
|
|
|
|
#
|
|
|
|
# This command completes an active background block operation synchronously.
|
|
|
|
# The ordering of this command's return with the BLOCK_JOB_COMPLETED event
|
|
|
|
# is not defined. Note that if an I/O error occurs during the processing of
|
|
|
|
# this command: 1) the command itself will fail; 2) the error will be processed
|
|
|
|
# according to the rerror/werror arguments that were specified when starting
|
|
|
|
# the operation.
|
|
|
|
#
|
|
|
|
# A cancelled or paused job cannot be completed.
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. This used to be a device name (hence
|
|
|
|
# the name of the parameter), but since QEMU 2.7 it can have
|
|
|
|
# other values.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:30 +01:00
|
|
|
# Returns: - Nothing on success
|
|
|
|
# - If no background operation is active on this device, DeviceNotActive
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
##
|
|
|
|
{ 'command': 'block-job-complete', 'data': { 'device': 'str' } }
|
|
|
|
|
2018-03-10 09:27:36 +01:00
|
|
|
##
|
|
|
|
# @block-job-dismiss:
|
|
|
|
#
|
|
|
|
# For jobs that have already concluded, remove them from the block-job-query
|
|
|
|
# list. This command only needs to be run for jobs which were started with
|
|
|
|
# QEMU 2.12+ job lifetime management semantics.
|
|
|
|
#
|
|
|
|
# This command will refuse to operate on any job that has not yet reached
|
2018-04-13 17:19:31 +02:00
|
|
|
# its terminal state, JOB_STATUS_CONCLUDED. For jobs that make use of the
|
2018-03-10 09:27:36 +01:00
|
|
|
# BLOCK_JOB_READY event, block-job-cancel or block-job-complete will still need
|
|
|
|
# to be used as appropriate.
|
|
|
|
#
|
|
|
|
# @id: The job identifier.
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'command': 'block-job-dismiss', 'data': { 'id': 'str' } }
|
|
|
|
|
2018-03-10 09:27:43 +01:00
|
|
|
##
|
|
|
|
# @block-job-finalize:
|
|
|
|
#
|
|
|
|
# Once a job that has manual=true reaches the pending state, it can be
|
|
|
|
# instructed to finalize any graph changes and do any necessary cleanup
|
|
|
|
# via this command.
|
|
|
|
# For jobs in a transaction, instructing one job to finalize will force
|
|
|
|
# ALL jobs in the transaction to finalize, so it is only necessary to instruct
|
|
|
|
# a single member job to finalize.
|
|
|
|
#
|
|
|
|
# @id: The job identifier.
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'command': 'block-job-finalize', 'data': { 'id': 'str' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevDiscardOptions:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Determines how to handle discard requests.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @ignore: Ignore the request
|
|
|
|
# @unmap: Forward as an unmap request
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevDiscardOptions',
|
|
|
|
'data': [ 'ignore', 'unmap' ] }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevDetectZeroesOptions:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Describes the operation mode for the automatic conversion of plain
|
|
|
|
# zero writes by the OS to driver specific optimized zero write commands.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @off: Disabled (default)
|
|
|
|
# @on: Enabled
|
|
|
|
# @unmap: Enabled and even try to unmap blocks if possible. This requires
|
|
|
|
# also that @BlockdevDiscardOptions is set to unmap for this device.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Since: 2.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevDetectZeroesOptions',
|
|
|
|
'data': [ 'off', 'on', 'unmap' ] }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevAioOptions:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Selects the AIO backend to handle I/O requests
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @threads: Use qemu's thread pool
|
|
|
|
# @native: Use native AIO backend (only Linux and Windows)
|
|
|
|
# @io_uring: Use linux io_uring (since 5.0)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevAioOptions',
|
2020-01-20 15:18:45 +01:00
|
|
|
'data': [ 'threads', 'native',
|
|
|
|
{ 'name': 'io_uring', 'if': 'defined(CONFIG_LINUX_IO_URING)' } ] }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevCacheOptions:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Includes cache-related options for block devices
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @direct: enables use of O_DIRECT (bypass the host page cache;
|
|
|
|
# default: false)
|
|
|
|
# @no-flush: ignore any flush requests for the device (default:
|
|
|
|
# false)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevCacheOptions',
|
2016-03-14 13:16:51 +01:00
|
|
|
'data': { '*direct': 'bool',
|
2014-06-05 13:45:31 +02:00
|
|
|
'*no-flush': 'bool' } }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevDriver:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Drivers that are supported in block device operations.
|
|
|
|
#
|
block/vxhs.c: Add support for a new block device type called "vxhs"
Source code for the qnio library that this code loads can be downloaded from:
https://github.com/VeritasHyperScale/libqnio.git
Sample command line using JSON syntax:
./x86_64-softmmu/qemu-system-x86_64 -name instance-00000008 -S -vnc 0.0.0.0:0
-k en-us -vga cirrus -device virtio-balloon-pci,id=balloon0,bus=pci.0,addr=0x5
-msg timestamp=on
'json:{"driver":"vxhs","vdisk-id":"c3e9095a-a5ee-4dce-afeb-2a59fb387410",
"server":{"host":"172.172.17.4","port":"9999"}}'
Sample command line using URI syntax:
qemu-img convert -f raw -O raw -n
/var/lib/nova/instances/_base/0c5eacd5ebea5ed914b6a3e7b18f1ce734c386ad
vxhs://192.168.0.1:9999/c6718f6b-0401-441d-a8c3-1f0064d75ee0
Sample command line using TLS credentials (run in secure mode):
./qemu-io --object
tls-creds-x509,id=tls0,dir=/etc/pki/qemu/vxhs,endpoint=client -c 'read
-v 66000 2.5k' 'json:{"server.host": "127.0.0.1", "server.port": "9999",
"vdisk-id": "/test.raw", "driver": "vxhs", "tls-creds":"tls0"}'
[Jeff: Modified trace-events with the correct string formatting]
Signed-off-by: Ashish Mittal <Ashish.Mittal@veritas.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Message-id: 1491277689-24949-2-git-send-email-Ashish.Mittal@veritas.com
2017-04-04 05:48:08 +02:00
|
|
|
# @vxhs: Since 2.10
|
2017-08-25 15:20:27 +02:00
|
|
|
# @throttle: Since 2.11
|
2018-01-16 07:09:01 +01:00
|
|
|
# @nvme: Since 2.12
|
2018-05-22 12:39:56 +02:00
|
|
|
# @copy-on-read: Since 3.0
|
2018-07-03 16:48:48 +02:00
|
|
|
# @blklogwrites: Since 3.0
|
2019-10-16 10:40:39 +02:00
|
|
|
# @blkreplay: Since 4.2
|
2019-12-02 13:15:04 +01:00
|
|
|
# @compress: Since 5.0
|
block/vxhs.c: Add support for a new block device type called "vxhs"
Source code for the qnio library that this code loads can be downloaded from:
https://github.com/VeritasHyperScale/libqnio.git
Sample command line using JSON syntax:
./x86_64-softmmu/qemu-system-x86_64 -name instance-00000008 -S -vnc 0.0.0.0:0
-k en-us -vga cirrus -device virtio-balloon-pci,id=balloon0,bus=pci.0,addr=0x5
-msg timestamp=on
'json:{"driver":"vxhs","vdisk-id":"c3e9095a-a5ee-4dce-afeb-2a59fb387410",
"server":{"host":"172.172.17.4","port":"9999"}}'
Sample command line using URI syntax:
qemu-img convert -f raw -O raw -n
/var/lib/nova/instances/_base/0c5eacd5ebea5ed914b6a3e7b18f1ce734c386ad
vxhs://192.168.0.1:9999/c6718f6b-0401-441d-a8c3-1f0064d75ee0
Sample command line using TLS credentials (run in secure mode):
./qemu-io --object
tls-creds-x509,id=tls0,dir=/etc/pki/qemu/vxhs,endpoint=client -c 'read
-v 66000 2.5k' 'json:{"server.host": "127.0.0.1", "server.port": "9999",
"vdisk-id": "/test.raw", "driver": "vxhs", "tls-creds":"tls0"}'
[Jeff: Modified trace-events with the correct string formatting]
Signed-off-by: Ashish Mittal <Ashish.Mittal@veritas.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Message-id: 1491277689-24949-2-git-send-email-Ashish.Mittal@veritas.com
2017-04-04 05:48:08 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevDriver',
|
2019-10-16 10:40:39 +02:00
|
|
|
'data': [ 'blkdebug', 'blklogwrites', 'blkreplay', 'blkverify', 'bochs',
|
2019-12-02 13:15:04 +01:00
|
|
|
'cloop', 'compress', 'copy-on-read', 'dmg', 'file', 'ftp', 'ftps',
|
|
|
|
'gluster', 'host_cdrom', 'host_device', 'http', 'https', 'iscsi',
|
|
|
|
'luks', 'nbd', 'nfs', 'null-aio', 'null-co', 'nvme', 'parallels',
|
|
|
|
'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'rbd',
|
2018-12-13 13:37:24 +01:00
|
|
|
{ 'name': 'replication', 'if': 'defined(CONFIG_REPLICATION)' },
|
|
|
|
'sheepdog',
|
2018-07-03 16:48:48 +02:00
|
|
|
'ssh', 'throttle', 'vdi', 'vhdx', 'vmdk', 'vpc', 'vvfat', 'vxhs' ] }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsFile:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2016-09-08 13:08:20 +02:00
|
|
|
# Driver specific block device options for the file backend.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @filename: path to the image file
|
|
|
|
# @pr-manager: the id for the object that will handle persistent reservations
|
|
|
|
# for this device (default: none, forward the commands via SG_IO;
|
|
|
|
# since 2.11)
|
|
|
|
# @aio: AIO backend (default: threads) (since: 2.8)
|
|
|
|
# @locking: whether to enable file locking. If set to 'auto', only enable
|
|
|
|
# when Open File Descriptor (OFD) locking API is available
|
|
|
|
# (default: auto, since 2.10)
|
|
|
|
# @drop-cache: invalidate page cache during live migration. This prevents
|
|
|
|
# stale data on the migration destination with cache.direct=off.
|
|
|
|
# Currently only supported on Linux hosts.
|
|
|
|
# (default: on, since: 4.0)
|
2018-04-27 18:23:12 +02:00
|
|
|
# @x-check-cache-dropped: whether to check that page cache was dropped on live
|
|
|
|
# migration. May cause noticeable delays if the image
|
|
|
|
# file is large, do not use in production.
|
2018-05-22 12:39:56 +02:00
|
|
|
# (default: off) (since: 3.0)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-06-06 17:38:02 +02:00
|
|
|
# Features:
|
|
|
|
# @dynamic-auto-read-only: If present, enabled auto-read-only means that the
|
|
|
|
# driver will open the image read-only at first,
|
|
|
|
# dynamically reopen the image file read-write when
|
|
|
|
# the first writer is attached to the node and reopen
|
|
|
|
# read-only when the last writer is detached. This
|
|
|
|
# allows giving QEMU write permissions only on demand
|
|
|
|
# when an operation actually needs write access.
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsFile',
|
2016-09-08 15:09:01 +02:00
|
|
|
'data': { 'filename': 'str',
|
scsi, file-posix: add support for persistent reservation management
It is a common requirement for virtual machine to send persistent
reservations, but this currently requires either running QEMU with
CAP_SYS_RAWIO, or using out-of-tree patches that let an unprivileged
QEMU bypass Linux's filter on SG_IO commands.
As an alternative mechanism, the next patches will introduce a
privileged helper to run persistent reservation commands without
expanding QEMU's attack surface unnecessarily.
The helper is invoked through a "pr-manager" QOM object, to which
file-posix.c passes SG_IO requests for PERSISTENT RESERVE OUT and
PERSISTENT RESERVE IN commands. For example:
$ qemu-system-x86_64
-device virtio-scsi \
-object pr-manager-helper,id=helper0,path=/var/run/qemu-pr-helper.sock
-drive if=none,id=hd,driver=raw,file.filename=/dev/sdb,file.pr-manager=helper0
-device scsi-block,drive=hd
or:
$ qemu-system-x86_64
-device virtio-scsi \
-object pr-manager-helper,id=helper0,path=/var/run/qemu-pr-helper.sock
-blockdev node-name=hd,driver=raw,file.driver=host_device,file.filename=/dev/sdb,file.pr-manager=helper0
-device scsi-block,drive=hd
Multiple pr-manager implementations are conceivable and possible, though
only one is implemented right now. For example, a pr-manager could:
- talk directly to the multipath daemon from a privileged QEMU
(i.e. QEMU links to libmpathpersist); this makes reservation work
properly with multipath, but still requires CAP_SYS_RAWIO
- use the Linux IOC_PR_* ioctls (they require CAP_SYS_ADMIN though)
- more interestingly, implement reservations directly in QEMU
through file system locks or a shared database (e.g. sqlite)
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2017-08-21 18:58:56 +02:00
|
|
|
'*pr-manager': 'str',
|
2017-05-02 18:35:50 +02:00
|
|
|
'*locking': 'OnOffAuto',
|
2018-04-27 18:23:12 +02:00
|
|
|
'*aio': 'BlockdevAioOptions',
|
2020-02-13 18:56:27 +01:00
|
|
|
'*drop-cache': {'type': 'bool',
|
|
|
|
'if': 'defined(CONFIG_LINUX)'},
|
2019-06-06 17:38:02 +02:00
|
|
|
'*x-check-cache-dropped': 'bool' },
|
|
|
|
'features': [ { 'name': 'dynamic-auto-read-only',
|
|
|
|
'if': 'defined(CONFIG_POSIX)' } ] }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2014-09-11 08:09:56 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsNull:
|
2014-09-11 08:09:56 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for the null backend.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @size: size of the device in bytes.
|
2017-03-15 13:57:06 +01:00
|
|
|
# @latency-ns: emulated latency (in nanoseconds) in processing
|
2015-04-01 03:45:38 +02:00
|
|
|
# requests. Default to zero which completes requests immediately.
|
|
|
|
# (Since 2.4)
|
2019-06-17 13:54:48 +02:00
|
|
|
# @read-zeroes: if true, reads from the device produce zeroes; if false, the
|
|
|
|
# buffer is left unchanged. (default: false; since: 4.1)
|
2014-09-11 08:09:56 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-09-11 08:09:56 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsNull',
|
2019-06-17 13:54:48 +02:00
|
|
|
'data': { '*size': 'int', '*latency-ns': 'uint64', '*read-zeroes': 'bool' } }
|
2014-09-11 08:09:56 +02:00
|
|
|
|
2018-01-16 07:09:01 +01:00
|
|
|
##
|
|
|
|
# @BlockdevOptionsNVMe:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for the NVMe backend.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @device: PCI controller address of the NVMe device in
|
|
|
|
# format hhhh:bb:ss.f (host:bus:slot.function)
|
2018-01-16 07:09:01 +01:00
|
|
|
# @namespace: namespace number of the device, starting from 1.
|
|
|
|
#
|
2019-12-06 15:38:11 +01:00
|
|
|
# Note that the PCI @device must have been unbound from any host
|
|
|
|
# kernel driver before instructing QEMU to add the blockdev.
|
|
|
|
#
|
2018-01-16 07:09:01 +01:00
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsNVMe',
|
|
|
|
'data': { 'device': 'str', 'namespace': 'int' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsVVFAT:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for the vvfat protocol.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @dir: directory to be exported as FAT image
|
|
|
|
# @fat-type: FAT type: 12, 16 or 32
|
|
|
|
# @floppy: whether to export a floppy image (true) or
|
|
|
|
# partitioned hard disk (false; default)
|
|
|
|
# @label: set the volume label, limited to 11 bytes. FAT16 and
|
|
|
|
# FAT32 traditionally have some restrictions on labels, which are
|
|
|
|
# ignored by most operating systems. Defaults to "QEMU VVFAT".
|
|
|
|
# (since 2.4)
|
|
|
|
# @rw: whether to allow write operations (default: false)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsVVFAT',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
|
2015-06-19 11:35:29 +02:00
|
|
|
'*label': 'str', '*rw': 'bool' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsGenericFormat:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for image format that have no option
|
|
|
|
# besides their data source.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @file: reference to or definition of the data source block device
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsGenericFormat',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'file': 'BlockdevRef' } }
|
|
|
|
|
block: add generic full disk encryption driver
Add a block driver that is capable of supporting any full disk
encryption format. This utilizes the previously added block
encryption code, and at this time supports the LUKS format.
The driver code is capable of supporting any format supported
by the QCryptoBlock module, so it registers one block driver
for each format. This patch only registers the "luks" driver
since the "qcow" driver is there only for back-compatibility
with existing qcow built-in encryption.
New LUKS compatible volumes can be formatted using qemu-img
with defaults for all settings.
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0 demo.luks 10G
Alternatively the cryptographic settings can be explicitly
set
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0,cipher-alg=aes-256,\
cipher-mode=cbc,ivgen-alg=plain64,hash-alg=sha256 \
demo.luks 10G
And query its size
$ qemu-img info demo.img
image: demo.img
file format: luks
virtual size: 10G (10737418240 bytes)
disk size: 132K
encrypted: yes
Note that it was not necessary to provide the password
when querying info for the volume. The password is only
required when performing I/O on the volume
All volumes created by this new 'luks' driver should be
capable of being opened by the kernel dm-crypt driver.
The only algorithms listed in the LUKS spec that are
not currently supported by this impl are sha512 and
ripemd160 hashes and cast6 cipher.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
[ kwolf - Added #include to resolve conflict with da34e65c ]
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2016-03-21 15:11:47 +01:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsLUKS:
|
block: add generic full disk encryption driver
Add a block driver that is capable of supporting any full disk
encryption format. This utilizes the previously added block
encryption code, and at this time supports the LUKS format.
The driver code is capable of supporting any format supported
by the QCryptoBlock module, so it registers one block driver
for each format. This patch only registers the "luks" driver
since the "qcow" driver is there only for back-compatibility
with existing qcow built-in encryption.
New LUKS compatible volumes can be formatted using qemu-img
with defaults for all settings.
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0 demo.luks 10G
Alternatively the cryptographic settings can be explicitly
set
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0,cipher-alg=aes-256,\
cipher-mode=cbc,ivgen-alg=plain64,hash-alg=sha256 \
demo.luks 10G
And query its size
$ qemu-img info demo.img
image: demo.img
file format: luks
virtual size: 10G (10737418240 bytes)
disk size: 132K
encrypted: yes
Note that it was not necessary to provide the password
when querying info for the volume. The password is only
required when performing I/O on the volume
All volumes created by this new 'luks' driver should be
capable of being opened by the kernel dm-crypt driver.
The only algorithms listed in the LUKS spec that are
not currently supported by this impl are sha512 and
ripemd160 hashes and cast6 cipher.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
[ kwolf - Added #include to resolve conflict with da34e65c ]
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2016-03-21 15:11:47 +01:00
|
|
|
#
|
|
|
|
# Driver specific block device options for LUKS.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @key-secret: the ID of a QCryptoSecret object providing
|
block: add generic full disk encryption driver
Add a block driver that is capable of supporting any full disk
encryption format. This utilizes the previously added block
encryption code, and at this time supports the LUKS format.
The driver code is capable of supporting any format supported
by the QCryptoBlock module, so it registers one block driver
for each format. This patch only registers the "luks" driver
since the "qcow" driver is there only for back-compatibility
with existing qcow built-in encryption.
New LUKS compatible volumes can be formatted using qemu-img
with defaults for all settings.
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0 demo.luks 10G
Alternatively the cryptographic settings can be explicitly
set
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0,cipher-alg=aes-256,\
cipher-mode=cbc,ivgen-alg=plain64,hash-alg=sha256 \
demo.luks 10G
And query its size
$ qemu-img info demo.img
image: demo.img
file format: luks
virtual size: 10G (10737418240 bytes)
disk size: 132K
encrypted: yes
Note that it was not necessary to provide the password
when querying info for the volume. The password is only
required when performing I/O on the volume
All volumes created by this new 'luks' driver should be
capable of being opened by the kernel dm-crypt driver.
The only algorithms listed in the LUKS spec that are
not currently supported by this impl are sha512 and
ripemd160 hashes and cast6 cipher.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
[ kwolf - Added #include to resolve conflict with da34e65c ]
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2016-03-21 15:11:47 +01:00
|
|
|
# the decryption key (since 2.6). Mandatory except when
|
|
|
|
# doing a metadata-only probe of the image.
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
block: add generic full disk encryption driver
Add a block driver that is capable of supporting any full disk
encryption format. This utilizes the previously added block
encryption code, and at this time supports the LUKS format.
The driver code is capable of supporting any format supported
by the QCryptoBlock module, so it registers one block driver
for each format. This patch only registers the "luks" driver
since the "qcow" driver is there only for back-compatibility
with existing qcow built-in encryption.
New LUKS compatible volumes can be formatted using qemu-img
with defaults for all settings.
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0 demo.luks 10G
Alternatively the cryptographic settings can be explicitly
set
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0,cipher-alg=aes-256,\
cipher-mode=cbc,ivgen-alg=plain64,hash-alg=sha256 \
demo.luks 10G
And query its size
$ qemu-img info demo.img
image: demo.img
file format: luks
virtual size: 10G (10737418240 bytes)
disk size: 132K
encrypted: yes
Note that it was not necessary to provide the password
when querying info for the volume. The password is only
required when performing I/O on the volume
All volumes created by this new 'luks' driver should be
capable of being opened by the kernel dm-crypt driver.
The only algorithms listed in the LUKS spec that are
not currently supported by this impl are sha512 and
ripemd160 hashes and cast6 cipher.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
[ kwolf - Added #include to resolve conflict with da34e65c ]
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2016-03-21 15:11:47 +01:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsLUKS',
|
|
|
|
'base': 'BlockdevOptionsGenericFormat',
|
|
|
|
'data': { '*key-secret': 'str' } }
|
|
|
|
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsGenericCOWFormat:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for image format that have no option
|
|
|
|
# besides their data source and an optional backing file.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @backing: reference to or definition of the backing file block
|
|
|
|
# device, null disables the backing file entirely.
|
|
|
|
# Defaults to the backing file stored the image file.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsGenericCOWFormat',
|
2014-06-05 13:45:31 +02:00
|
|
|
'base': 'BlockdevOptionsGenericFormat',
|
block: Use JSON null instead of "" to disable backing file
BlockdevRef is an alternate of BlockdevOptions (inline definition) and
str (reference to an existing block device by name). BlockdevRef
value "" is special: "no block device should be referenced." It's
actually interpreted that way in just one place: optional member
@backing of COW formats. Semantics:
* Present means "use this block device" as backing storage
* Absent means "default to the one stored in the image"
* Except "" means "don't use backing storage at all"
The first two are perfectly normal: when the parameter is absent, it
defaults to an implied value, but the value's meaning is the same.
The third one overloads the parameter with a second meaning. The
overloading is *implicit*, i.e. it's not visible in the types. Works
here, because "" is not a value block device ID.
Pressing argument values the schema accepts, but are semantically
invalid, into service to mean "do something else entirely" is not
general, as suitable invalid values need not exist. I also find it
ugly.
To clean this up, we could add a separate flag argument to suppress
@backing, or add a distinct value to @backing. This commit implements
the latter: add JSON null to the values of @backing, deprecate "".
Because we're so close to the 2.10 freeze, implement it in the
stupidest way possible: have qmp_blockdev_add() rewrite null to ""
before anything else can see the null. Works, because BlockdevRef
occurs only within arguments of blockdev-add. The proper way to do it
would be rewriting "" to null, preferably in a cleaner way, but that
requires fixing up code to work with null. Add a TODO comment for
that.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Daniel P. Berrange <berrange@redhat.com>
Acked-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2017-07-18 08:54:00 +02:00
|
|
|
'data': { '*backing': 'BlockdevRefOrNull' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2014-08-20 19:59:36 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @Qcow2OverlapCheckMode:
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
|
|
|
# General overlap check modes.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @none: Do not perform any checks
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @constant: Perform only checks which can be done in constant time and
|
|
|
|
# without reading anything from disk
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @cached: Perform only checks which can be done without reading anything
|
|
|
|
# from disk
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @all: Perform all available overlap checks
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-08-20 19:59:36 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'Qcow2OverlapCheckMode',
|
|
|
|
'data': [ 'none', 'constant', 'cached', 'all' ] }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @Qcow2OverlapCheckFlags:
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
|
|
|
# Structure of flags for each metadata structure. Setting a field to 'true'
|
|
|
|
# makes qemu guard that structure against unintended overwriting. The default
|
|
|
|
# value is chosen according to the template given.
|
|
|
|
#
|
|
|
|
# @template: Specifies a template mode which can be adjusted using the other
|
|
|
|
# flags, defaults to 'cached'
|
|
|
|
#
|
2018-07-05 17:15:15 +02:00
|
|
|
# @bitmap-directory: since 3.0
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-08-20 19:59:36 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'Qcow2OverlapCheckFlags',
|
2018-07-05 17:15:15 +02:00
|
|
|
'data': { '*template': 'Qcow2OverlapCheckMode',
|
|
|
|
'*main-header': 'bool',
|
|
|
|
'*active-l1': 'bool',
|
|
|
|
'*active-l2': 'bool',
|
|
|
|
'*refcount-table': 'bool',
|
|
|
|
'*refcount-block': 'bool',
|
|
|
|
'*snapshot-table': 'bool',
|
|
|
|
'*inactive-l1': 'bool',
|
|
|
|
'*inactive-l2': 'bool',
|
|
|
|
'*bitmap-directory': 'bool' } }
|
2014-08-20 19:59:36 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @Qcow2OverlapChecks:
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
|
|
|
# Specifies which metadata structures should be guarded against unintended
|
|
|
|
# overwriting.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @flags: set of flags for separate specification of each metadata structure
|
|
|
|
# type
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @mode: named mode which chooses a specific set of flags
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-08-20 19:59:36 +02:00
|
|
|
##
|
2015-05-04 17:05:13 +02:00
|
|
|
{ 'alternate': 'Qcow2OverlapChecks',
|
2014-08-20 19:59:36 +02:00
|
|
|
'data': { 'flags': 'Qcow2OverlapCheckFlags',
|
|
|
|
'mode': 'Qcow2OverlapCheckMode' } }
|
|
|
|
|
qcow: convert QCow to use QCryptoBlock for encryption
This converts the qcow driver to make use of the QCryptoBlock
APIs for encrypting image content. This is only wired up to
permit use of the legacy QCow encryption format. Users who wish
to have the strong LUKS format should switch to qcow2 instead.
With this change it is now required to use the QCryptoSecret
object for providing passwords, instead of the current block
password APIs / interactive prompting.
$QEMU \
-object secret,id=sec0,file=/home/berrange/encrypted.pw \
-drive file=/home/berrange/encrypted.qcow,encrypt.format=aes,\
encrypt.key-secret=sec0
Though note that running QEMU system emulators with the AES
encryption is no longer supported, so while the above syntax
is valid, QEMU will refuse to actually run the VM in this
particular example.
Likewise when creating images with the legacy AES-CBC format
qemu-img create -f qcow \
--object secret,id=sec0,file=/home/berrange/encrypted.pw \
-o encrypt.format=aes,encrypt.key-secret=sec0 \
/home/berrange/encrypted.qcow 64M
Reviewed-by: Max Reitz <mreitz@redhat.com>
Reviewed-by: Alberto Garcia <berto@igalia.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Message-id: 20170623162419.26068-10-berrange@redhat.com
Signed-off-by: Max Reitz <mreitz@redhat.com>
2017-06-23 18:24:08 +02:00
|
|
|
##
|
|
|
|
# @BlockdevQcowEncryptionFormat:
|
|
|
|
#
|
|
|
|
# @aes: AES-CBC with plain64 initialization vectors
|
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevQcowEncryptionFormat',
|
|
|
|
'data': [ 'aes' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevQcowEncryption:
|
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'union': 'BlockdevQcowEncryption',
|
|
|
|
'base': { 'format': 'BlockdevQcowEncryptionFormat' },
|
|
|
|
'discriminator': 'format',
|
|
|
|
'data': { 'aes': 'QCryptoBlockOptionsQCow' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevOptionsQcow:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for qcow.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @encrypt: Image decryption options. Mandatory for
|
|
|
|
# encrypted images, except when doing a metadata-only
|
|
|
|
# probe of the image.
|
qcow: convert QCow to use QCryptoBlock for encryption
This converts the qcow driver to make use of the QCryptoBlock
APIs for encrypting image content. This is only wired up to
permit use of the legacy QCow encryption format. Users who wish
to have the strong LUKS format should switch to qcow2 instead.
With this change it is now required to use the QCryptoSecret
object for providing passwords, instead of the current block
password APIs / interactive prompting.
$QEMU \
-object secret,id=sec0,file=/home/berrange/encrypted.pw \
-drive file=/home/berrange/encrypted.qcow,encrypt.format=aes,\
encrypt.key-secret=sec0
Though note that running QEMU system emulators with the AES
encryption is no longer supported, so while the above syntax
is valid, QEMU will refuse to actually run the VM in this
particular example.
Likewise when creating images with the legacy AES-CBC format
qemu-img create -f qcow \
--object secret,id=sec0,file=/home/berrange/encrypted.pw \
-o encrypt.format=aes,encrypt.key-secret=sec0 \
/home/berrange/encrypted.qcow 64M
Reviewed-by: Max Reitz <mreitz@redhat.com>
Reviewed-by: Alberto Garcia <berto@igalia.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Message-id: 20170623162419.26068-10-berrange@redhat.com
Signed-off-by: Max Reitz <mreitz@redhat.com>
2017-06-23 18:24:08 +02:00
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsQcow',
|
|
|
|
'base': 'BlockdevOptionsGenericCOWFormat',
|
|
|
|
'data': { '*encrypt': 'BlockdevQcowEncryption' } }
|
|
|
|
|
|
|
|
|
2017-06-23 18:24:10 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevQcow2EncryptionFormat:
|
2019-02-06 21:28:48 +01:00
|
|
|
# @aes: AES-CBC with plain64 initialization vectors
|
2017-06-23 18:24:10 +02:00
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevQcow2EncryptionFormat',
|
qcow2: add support for LUKS encryption format
This adds support for using LUKS as an encryption format
with the qcow2 file, using the new encrypt.format parameter
to request "luks" format. e.g.
# qemu-img create --object secret,data=123456,id=sec0 \
-f qcow2 -o encrypt.format=luks,encrypt.key-secret=sec0 \
test.qcow2 10G
The legacy "encryption=on" parameter still results in
creation of the old qcow2 AES format (and is equivalent
to the new 'encryption-format=aes'). e.g. the following are
equivalent:
# qemu-img create --object secret,data=123456,id=sec0 \
-f qcow2 -o encryption=on,encrypt.key-secret=sec0 \
test.qcow2 10G
# qemu-img create --object secret,data=123456,id=sec0 \
-f qcow2 -o encryption-format=aes,encrypt.key-secret=sec0 \
test.qcow2 10G
With the LUKS format it is necessary to store the LUKS
partition header and key material in the QCow2 file. This
data can be many MB in size, so cannot go into the QCow2
header region directly. Thus the spec defines a FDE
(Full Disk Encryption) header extension that specifies
the offset of a set of clusters to hold the FDE headers,
as well as the length of that region. The LUKS header is
thus stored in these extra allocated clusters before the
main image payload.
Aside from all the cryptographic differences implied by
use of the LUKS format, there is one further key difference
between the use of legacy AES and LUKS encryption in qcow2.
For LUKS, the initialiazation vectors are generated using
the host physical sector as the input, rather than the
guest virtual sector. This guarantees unique initialization
vectors for all sectors when qcow2 internal snapshots are
used, thus giving stronger protection against watermarking
attacks.
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Message-id: 20170623162419.26068-14-berrange@redhat.com
Reviewed-by: Alberto Garcia <berto@igalia.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2017-06-23 18:24:12 +02:00
|
|
|
'data': [ 'aes', 'luks' ] }
|
2017-06-23 18:24:10 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevQcow2Encryption:
|
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'union': 'BlockdevQcow2Encryption',
|
|
|
|
'base': { 'format': 'BlockdevQcow2EncryptionFormat' },
|
|
|
|
'discriminator': 'format',
|
qcow2: add support for LUKS encryption format
This adds support for using LUKS as an encryption format
with the qcow2 file, using the new encrypt.format parameter
to request "luks" format. e.g.
# qemu-img create --object secret,data=123456,id=sec0 \
-f qcow2 -o encrypt.format=luks,encrypt.key-secret=sec0 \
test.qcow2 10G
The legacy "encryption=on" parameter still results in
creation of the old qcow2 AES format (and is equivalent
to the new 'encryption-format=aes'). e.g. the following are
equivalent:
# qemu-img create --object secret,data=123456,id=sec0 \
-f qcow2 -o encryption=on,encrypt.key-secret=sec0 \
test.qcow2 10G
# qemu-img create --object secret,data=123456,id=sec0 \
-f qcow2 -o encryption-format=aes,encrypt.key-secret=sec0 \
test.qcow2 10G
With the LUKS format it is necessary to store the LUKS
partition header and key material in the QCow2 file. This
data can be many MB in size, so cannot go into the QCow2
header region directly. Thus the spec defines a FDE
(Full Disk Encryption) header extension that specifies
the offset of a set of clusters to hold the FDE headers,
as well as the length of that region. The LUKS header is
thus stored in these extra allocated clusters before the
main image payload.
Aside from all the cryptographic differences implied by
use of the LUKS format, there is one further key difference
between the use of legacy AES and LUKS encryption in qcow2.
For LUKS, the initialiazation vectors are generated using
the host physical sector as the input, rather than the
guest virtual sector. This guarantees unique initialization
vectors for all sectors when qcow2 internal snapshots are
used, thus giving stronger protection against watermarking
attacks.
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Message-id: 20170623162419.26068-14-berrange@redhat.com
Reviewed-by: Alberto Garcia <berto@igalia.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2017-06-23 18:24:12 +02:00
|
|
|
'data': { 'aes': 'QCryptoBlockOptionsQCow',
|
|
|
|
'luks': 'QCryptoBlockOptionsLUKS'} }
|
2017-06-23 18:24:10 +02:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsQcow2:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for qcow2.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @lazy-refcounts: whether to enable the lazy refcounts
|
|
|
|
# feature (default is taken from the image file)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @pass-discard-request: whether discard requests to the qcow2
|
|
|
|
# device should be forwarded to the data source
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @pass-discard-snapshot: whether discard requests for the data source
|
2014-06-05 13:45:31 +02:00
|
|
|
# should be issued when a snapshot operation (e.g.
|
|
|
|
# deleting a snapshot) frees clusters in the qcow2 file
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @pass-discard-other: whether discard requests for the data source
|
|
|
|
# should be issued on other occasions where a cluster
|
|
|
|
# gets freed
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @overlap-check: which overlap checks to perform for writes
|
|
|
|
# to the image, defaults to 'cached' (since 2.2)
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @cache-size: the maximum total size of the L2 table and
|
|
|
|
# refcount block caches in bytes (since 2.2)
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @l2-cache-size: the maximum size of the L2 table cache in
|
|
|
|
# bytes (since 2.2)
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @l2-cache-entry-size: the size of each entry in the L2 cache in
|
|
|
|
# bytes. It must be a power of two between 512
|
|
|
|
# and the cluster size. The default value is
|
|
|
|
# the cluster size (since 2.12)
|
2018-02-05 15:33:36 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @refcount-cache-size: the maximum size of the refcount block cache
|
|
|
|
# in bytes (since 2.2)
|
2014-08-20 19:59:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @cache-clean-interval: clean unused entries in the L2 and refcount
|
|
|
|
# caches. The interval is in seconds. The default value
|
|
|
|
# is 600 on supporting platforms, and 0 on other
|
|
|
|
# platforms. 0 disables this feature. (since 2.5)
|
2018-09-26 18:04:46 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @encrypt: Image decryption options. Mandatory for
|
|
|
|
# encrypted images, except when doing a metadata-only
|
|
|
|
# probe of the image. (since 2.10)
|
2015-08-04 14:14:40 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @data-file: reference to or definition of the external data file.
|
|
|
|
# This may only be specified for images that require an
|
|
|
|
# external data file. If it is not specified for such
|
|
|
|
# an image, the data file name is loaded from the image
|
|
|
|
# file. (since 4.0)
|
2019-01-29 17:13:57 +01:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsQcow2',
|
2014-06-05 13:45:31 +02:00
|
|
|
'base': 'BlockdevOptionsGenericCOWFormat',
|
|
|
|
'data': { '*lazy-refcounts': 'bool',
|
|
|
|
'*pass-discard-request': 'bool',
|
|
|
|
'*pass-discard-snapshot': 'bool',
|
2014-08-20 19:59:36 +02:00
|
|
|
'*pass-discard-other': 'bool',
|
|
|
|
'*overlap-check': 'Qcow2OverlapChecks',
|
|
|
|
'*cache-size': 'int',
|
|
|
|
'*l2-cache-size': 'int',
|
2018-02-05 15:33:36 +01:00
|
|
|
'*l2-cache-entry-size': 'int',
|
2015-08-04 14:14:40 +02:00
|
|
|
'*refcount-cache-size': 'int',
|
2017-06-23 18:24:10 +02:00
|
|
|
'*cache-clean-interval': 'int',
|
2019-01-29 17:13:57 +01:00
|
|
|
'*encrypt': 'BlockdevQcow2Encryption',
|
|
|
|
'*data-file': 'BlockdevRef' } }
|
2014-07-30 19:59:09 +02:00
|
|
|
|
2018-02-05 14:59:05 +01:00
|
|
|
##
|
|
|
|
# @SshHostKeyCheckMode:
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @none: Don't check the host key at all
|
|
|
|
# @hash: Compare the host key with a given hash
|
|
|
|
# @known_hosts: Check the host key against the known_hosts file
|
2018-02-05 14:59:05 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'enum': 'SshHostKeyCheckMode',
|
|
|
|
'data': [ 'none', 'hash', 'known_hosts' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @SshHostKeyCheckHashType:
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @md5: The given hash is an md5 hash
|
|
|
|
# @sha1: The given hash is an sha1 hash
|
2018-02-05 14:59:05 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'enum': 'SshHostKeyCheckHashType',
|
|
|
|
'data': [ 'md5', 'sha1' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @SshHostKeyHash:
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @type: The hash algorithm used for the hash
|
|
|
|
# @hash: The expected hash value
|
2018-02-05 14:59:05 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'SshHostKeyHash',
|
|
|
|
'data': { 'type': 'SshHostKeyCheckHashType',
|
|
|
|
'hash': 'str' }}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @SshHostKeyCheck:
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'union': 'SshHostKeyCheck',
|
|
|
|
'base': { 'mode': 'SshHostKeyCheckMode' },
|
|
|
|
'discriminator': 'mode',
|
2018-06-18 10:40:06 +02:00
|
|
|
'data': { 'hash': 'SshHostKeyHash' } }
|
2018-02-05 14:59:05 +01:00
|
|
|
|
2016-10-25 15:04:01 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsSsh:
|
2016-10-25 15:04:01 +02:00
|
|
|
#
|
|
|
|
# @server: host address
|
|
|
|
#
|
|
|
|
# @path: path to the image on the host
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @user: user as which to connect, defaults to current
|
2016-10-25 15:04:01 +02:00
|
|
|
# local user name
|
|
|
|
#
|
2018-02-05 14:59:05 +01:00
|
|
|
# @host-key-check: Defines how and what to check the host key against
|
|
|
|
# (default: known_hosts)
|
2016-10-25 15:04:01 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-10-25 15:04:01 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsSsh',
|
|
|
|
'data': { 'server': 'InetSocketAddress',
|
|
|
|
'path': 'str',
|
2018-02-05 14:59:05 +01:00
|
|
|
'*user': 'str',
|
|
|
|
'*host-key-check': 'SshHostKeyCheck' } }
|
2016-10-25 15:04:01 +02:00
|
|
|
|
2014-07-30 19:59:09 +02:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlkdebugEvent:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Trigger events supported by blkdebug.
|
2015-11-18 09:52:54 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @l1_shrink_write_table: write zeros to the l1 table to shrink image.
|
|
|
|
# (since 2.11)
|
2017-09-18 14:42:29 +02:00
|
|
|
#
|
|
|
|
# @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11)
|
|
|
|
#
|
2017-10-05 21:02:46 +02:00
|
|
|
# @cor_write: a write due to copy-on-read (since 2.11)
|
|
|
|
#
|
2019-05-16 16:27:49 +02:00
|
|
|
# @cluster_alloc_space: an allocation of file space for a cluster (since 4.1)
|
|
|
|
#
|
2019-05-07 22:35:05 +02:00
|
|
|
# @none: triggers once at creation of the blkdebug node (since 4.1)
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-11-18 09:52:54 +01:00
|
|
|
{ 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
|
blkdebug: Avoid '.' in enum values
Our qapi conventions document that '.' should only be used in
the prefix of downstream names. BlkdebugEvent was a lone
exception to this. Changing this is not backwards compatible
to the 'blockdev-add' QMP command; however, that command is
not yet fully stable. It can also be argued that the testsuite
is the biggest user of blkdebug, and that any other user can
be taught to deal with the change by paying attention to
introspection results.
Done with:
$ for str in \
l1_grow.{alloc,write,activate}_table \
l2_alloc.{cow_read,write} \
refblock_alloc.{hookup,write,write_blocks,write_table,switch_table} \
pwritev_rmw.{head,after_head,tail,after_tail}; do
str1=$(echo "$str" | sed 's/\./\\./')
str2=$(echo "$str" | sed 's/\./_/')
git grep -l "$str1" | xargs -r sed -i "s/$str1/$str2/g"
done
followed by a manual touchup to test 77 to keep the test working.
Reported-by: Markus Armbruster <armbru@redhat.com>
CC: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1447836791-369-21-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2015-11-18 09:52:55 +01:00
|
|
|
'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
|
|
|
|
'l1_grow_activate_table', 'l2_load', 'l2_update',
|
|
|
|
'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
|
2014-06-05 13:45:31 +02:00
|
|
|
'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
|
|
|
|
'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
|
|
|
|
'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
|
|
|
|
'refblock_load', 'refblock_update', 'refblock_update_part',
|
blkdebug: Avoid '.' in enum values
Our qapi conventions document that '.' should only be used in
the prefix of downstream names. BlkdebugEvent was a lone
exception to this. Changing this is not backwards compatible
to the 'blockdev-add' QMP command; however, that command is
not yet fully stable. It can also be argued that the testsuite
is the biggest user of blkdebug, and that any other user can
be taught to deal with the change by paying attention to
introspection results.
Done with:
$ for str in \
l1_grow.{alloc,write,activate}_table \
l2_alloc.{cow_read,write} \
refblock_alloc.{hookup,write,write_blocks,write_table,switch_table} \
pwritev_rmw.{head,after_head,tail,after_tail}; do
str1=$(echo "$str" | sed 's/\./\\./')
str2=$(echo "$str" | sed 's/\./_/')
git grep -l "$str1" | xargs -r sed -i "s/$str1/$str2/g"
done
followed by a manual touchup to test 77 to keep the test working.
Reported-by: Markus Armbruster <armbru@redhat.com>
CC: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1447836791-369-21-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2015-11-18 09:52:55 +01:00
|
|
|
'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
|
|
|
|
'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
|
|
|
|
'refblock_alloc_switch_table', 'cluster_alloc',
|
2014-06-05 13:45:31 +02:00
|
|
|
'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
|
blkdebug: Avoid '.' in enum values
Our qapi conventions document that '.' should only be used in
the prefix of downstream names. BlkdebugEvent was a lone
exception to this. Changing this is not backwards compatible
to the 'blockdev-add' QMP command; however, that command is
not yet fully stable. It can also be argued that the testsuite
is the biggest user of blkdebug, and that any other user can
be taught to deal with the change by paying attention to
introspection results.
Done with:
$ for str in \
l1_grow.{alloc,write,activate}_table \
l2_alloc.{cow_read,write} \
refblock_alloc.{hookup,write,write_blocks,write_table,switch_table} \
pwritev_rmw.{head,after_head,tail,after_tail}; do
str1=$(echo "$str" | sed 's/\./\\./')
str2=$(echo "$str" | sed 's/\./_/')
git grep -l "$str1" | xargs -r sed -i "s/$str1/$str2/g"
done
followed by a manual touchup to test 77 to keep the test working.
Reported-by: Markus Armbruster <armbru@redhat.com>
CC: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1447836791-369-21-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2015-11-18 09:52:55 +01:00
|
|
|
'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
|
|
|
|
'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
|
2017-09-18 14:42:29 +02:00
|
|
|
'pwritev_zero', 'pwritev_done', 'empty_image_prepare',
|
2017-10-05 21:02:46 +02:00
|
|
|
'l1_shrink_write_table', 'l1_shrink_free_l2_clusters',
|
2019-05-07 22:35:05 +02:00
|
|
|
'cor_write', 'cluster_alloc_space', 'none'] }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2019-05-07 22:35:04 +02:00
|
|
|
##
|
|
|
|
# @BlkdebugIOType:
|
|
|
|
#
|
|
|
|
# Kinds of I/O that blkdebug can inject errors in.
|
|
|
|
#
|
|
|
|
# @read: .bdrv_co_preadv()
|
|
|
|
#
|
|
|
|
# @write: .bdrv_co_pwritev()
|
|
|
|
#
|
|
|
|
# @write-zeroes: .bdrv_co_pwrite_zeroes()
|
|
|
|
#
|
|
|
|
# @discard: .bdrv_co_pdiscard()
|
|
|
|
#
|
|
|
|
# @flush: .bdrv_co_flush_to_disk()
|
|
|
|
#
|
2019-05-07 22:35:06 +02:00
|
|
|
# @block-status: .bdrv_co_block_status()
|
|
|
|
#
|
2019-05-07 22:35:04 +02:00
|
|
|
# Since: 4.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlkdebugIOType', 'prefix': 'BLKDEBUG_IO_TYPE',
|
2019-05-07 22:35:06 +02:00
|
|
|
'data': [ 'read', 'write', 'write-zeroes', 'discard', 'flush',
|
|
|
|
'block-status' ] }
|
2019-05-07 22:35:04 +02:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlkdebugInjectErrorOptions:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Describes a single error injection for blkdebug.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @event: trigger event
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @state: the state identifier blkdebug needs to be in to
|
|
|
|
# actually trigger the event; defaults to "any"
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @iotype: the type of I/O operations on which this error should
|
|
|
|
# be injected; defaults to "all read, write,
|
|
|
|
# write-zeroes, discard, and flush operations"
|
|
|
|
# (since: 4.1)
|
2019-05-07 22:35:04 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @errno: error identifier (errno) to be returned; defaults to
|
|
|
|
# EIO
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @sector: specifies the sector index which has to be affected
|
|
|
|
# in order to actually trigger the event; defaults to "any
|
|
|
|
# sector"
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @once: disables further events after this one has been
|
|
|
|
# triggered; defaults to false
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @immediately: fail immediately; defaults to false
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlkdebugInjectErrorOptions',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'event': 'BlkdebugEvent',
|
|
|
|
'*state': 'int',
|
2019-05-07 22:35:04 +02:00
|
|
|
'*iotype': 'BlkdebugIOType',
|
2014-06-05 13:45:31 +02:00
|
|
|
'*errno': 'int',
|
|
|
|
'*sector': 'int',
|
|
|
|
'*once': 'bool',
|
|
|
|
'*immediately': 'bool' } }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlkdebugSetStateOptions:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Describes a single state-change event for blkdebug.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @event: trigger event
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @state: the current state identifier blkdebug needs to be in;
|
|
|
|
# defaults to "any"
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @new_state: the state identifier blkdebug is supposed to assume if
|
|
|
|
# this event is triggered
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlkdebugSetStateOptions',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'event': 'BlkdebugEvent',
|
|
|
|
'*state': 'int',
|
|
|
|
'new_state': 'int' } }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsBlkdebug:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for blkdebug.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @image: underlying raw block device (or image file)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @config: filename of the configuration file
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @align: required alignment for requests in bytes, must be
|
|
|
|
# positive power of 2, or 0 for default
|
2017-04-29 21:14:18 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @max-transfer: maximum size for I/O transfers in bytes, must be
|
|
|
|
# positive multiple of @align and of the underlying
|
|
|
|
# file's request alignment (but need not be a power of
|
|
|
|
# 2), or 0 for default (since 2.10)
|
2017-04-29 21:14:18 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @opt-write-zero: preferred alignment for write zero requests in bytes,
|
|
|
|
# must be positive multiple of @align and of the
|
|
|
|
# underlying file's request alignment (but need not be a
|
|
|
|
# power of 2), or 0 for default (since 2.10)
|
2017-04-29 21:14:18 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @max-write-zero: maximum size for write zero requests in bytes, must be
|
|
|
|
# positive multiple of @align, of @opt-write-zero, and of
|
|
|
|
# the underlying file's request alignment (but need not
|
|
|
|
# be a power of 2), or 0 for default (since 2.10)
|
2017-04-29 21:14:18 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @opt-discard: preferred alignment for discard requests in bytes, must
|
|
|
|
# be positive multiple of @align and of the underlying
|
|
|
|
# file's request alignment (but need not be a power of
|
|
|
|
# 2), or 0 for default (since 2.10)
|
2017-04-29 21:14:18 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @max-discard: maximum size for discard requests in bytes, must be
|
|
|
|
# positive multiple of @align, of @opt-discard, and of
|
|
|
|
# the underlying file's request alignment (but need not
|
|
|
|
# be a power of 2), or 0 for default (since 2.10)
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @inject-error: array of error injection descriptions
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @set-state: array of state-change descriptions
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2019-11-08 13:34:53 +01:00
|
|
|
# @take-child-perms: Permissions to take on @image in addition to what
|
|
|
|
# is necessary anyway (which depends on how the
|
|
|
|
# blkdebug node is used). Defaults to none.
|
|
|
|
# (since 5.0)
|
|
|
|
#
|
|
|
|
# @unshare-child-perms: Permissions not to share on @image in addition
|
|
|
|
# to what cannot be shared anyway (which depends
|
|
|
|
# on how the blkdebug node is used). Defaults
|
|
|
|
# to none. (since 5.0)
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsBlkdebug',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'image': 'BlockdevRef',
|
|
|
|
'*config': 'str',
|
2017-04-29 21:14:18 +02:00
|
|
|
'*align': 'int', '*max-transfer': 'int32',
|
|
|
|
'*opt-write-zero': 'int32', '*max-write-zero': 'int32',
|
|
|
|
'*opt-discard': 'int32', '*max-discard': 'int32',
|
2014-06-05 13:45:31 +02:00
|
|
|
'*inject-error': ['BlkdebugInjectErrorOptions'],
|
2019-11-08 13:34:53 +01:00
|
|
|
'*set-state': ['BlkdebugSetStateOptions'],
|
|
|
|
'*take-child-perms': ['BlockPermission'],
|
|
|
|
'*unshare-child-perms': ['BlockPermission'] } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2018-07-03 16:48:48 +02:00
|
|
|
##
|
|
|
|
# @BlockdevOptionsBlklogwrites:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for blklogwrites.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @file: block device
|
2018-07-03 16:48:48 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @log: block device used to log writes to @file
|
2018-07-03 16:48:48 +02:00
|
|
|
#
|
|
|
|
# @log-sector-size: sector size used in logging writes to @file, determines
|
|
|
|
# granularity of offsets and sizes of writes (default: 512)
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @log-append: append to an existing log (default: false)
|
2018-07-06 16:01:36 +02:00
|
|
|
#
|
2018-07-04 16:59:36 +02:00
|
|
|
# @log-super-update-interval: interval of write requests after which the log
|
|
|
|
# super block is updated to disk (default: 4096)
|
|
|
|
#
|
2018-07-03 16:48:48 +02:00
|
|
|
# Since: 3.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsBlklogwrites',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'log': 'BlockdevRef',
|
2018-07-04 16:59:35 +02:00
|
|
|
'*log-sector-size': 'uint32',
|
2018-07-04 16:59:36 +02:00
|
|
|
'*log-append': 'bool',
|
|
|
|
'*log-super-update-interval': 'uint64' } }
|
2018-07-03 16:48:48 +02:00
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsBlkverify:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for blkverify.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @test: block device to be tested
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @raw: raw image used for verification
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsBlkverify',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'test': 'BlockdevRef',
|
|
|
|
'raw': 'BlockdevRef' } }
|
|
|
|
|
2019-10-16 10:40:39 +02:00
|
|
|
##
|
|
|
|
# @BlockdevOptionsBlkreplay:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for blkreplay.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @image: disk image which should be controlled with blkreplay
|
2019-10-16 10:40:39 +02:00
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsBlkreplay',
|
|
|
|
'data': { 'image': 'BlockdevRef' } }
|
|
|
|
|
2014-08-18 11:41:04 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @QuorumReadPattern:
|
2014-08-18 11:41:04 +02:00
|
|
|
#
|
|
|
|
# An enumeration of quorum read patterns.
|
|
|
|
#
|
|
|
|
# @quorum: read all the children and do a quorum vote on reads
|
|
|
|
#
|
|
|
|
# @fifo: read only from the first child that has not failed
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-08-18 11:41:04 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsQuorum:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for Quorum
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @blkverify: true if the driver must print content mismatch
|
2014-06-05 13:45:31 +02:00
|
|
|
# set to false by default
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @children: the children block devices to use
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# @vote-threshold: the vote limit under which a read will fail
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @rewrite-corrupted: rewrite corrupted data when quorum is reached
|
2014-06-11 15:24:10 +02:00
|
|
|
# (Since 2.1)
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @read-pattern: choose read pattern and set to quorum by default
|
2014-08-18 11:41:04 +02:00
|
|
|
# (Since 2.2)
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:27 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsQuorum',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { '*blkverify': 'bool',
|
|
|
|
'children': [ 'BlockdevRef' ],
|
2014-08-18 11:41:04 +02:00
|
|
|
'vote-threshold': 'int',
|
|
|
|
'*rewrite-corrupted': 'bool',
|
|
|
|
'*read-pattern': 'QuorumReadPattern' } }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2016-07-19 18:57:32 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsGluster:
|
2016-07-19 18:57:32 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for Gluster
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @volume: name of gluster volume where VM image resides
|
2016-07-19 18:57:32 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @path: absolute path to image file in gluster volume
|
2016-07-19 18:57:32 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @server: gluster servers description
|
2016-07-19 18:57:32 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @debug: libgfapi log level (default '4' which is Error)
|
|
|
|
# (Since 2.8)
|
2016-07-19 18:57:32 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @logfile: libgfapi log file (default /dev/stderr) (Since 2.8)
|
block/gluster: add support to choose libgfapi logfile
currently all the libgfapi logs defaults to '/dev/stderr' as it was hardcoded
in a call to glfs logging api. When the debug level is chosen to DEBUG/TRACE,
gfapi logs will be huge and fill/overflow the console view.
This patch provides a commandline option to mention log file path which helps
in logging to the specified file and also help in persisting the gfapi logs.
Usage:
-----
*URI Style:
---------
-drive file=gluster://hostname/volname/image.qcow2,file.debug=9,\
file.logfile=/var/log/qemu/qemu-gfapi.log
*JSON Style:
----------
'json:{
"driver":"qcow2",
"file":{
"driver":"gluster",
"volume":"volname",
"path":"image.qcow2",
"debug":"9",
"logfile":"/var/log/qemu/qemu-gfapi.log",
"server":[
{
"type":"tcp",
"host":"1.2.3.4",
"port":24007
},
{
"type":"unix",
"socket":"/var/run/glusterd.socket"
}
]
}
}'
Reviewed-by: Jeff Cody <jcody@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
2016-07-22 16:56:48 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-07-19 18:57:32 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsGluster',
|
|
|
|
'data': { 'volume': 'str',
|
|
|
|
'path': 'str',
|
2017-04-26 09:36:40 +02:00
|
|
|
'server': ['SocketAddress'],
|
2016-11-02 17:50:36 +01:00
|
|
|
'*debug': 'int',
|
block/gluster: add support to choose libgfapi logfile
currently all the libgfapi logs defaults to '/dev/stderr' as it was hardcoded
in a call to glfs logging api. When the debug level is chosen to DEBUG/TRACE,
gfapi logs will be huge and fill/overflow the console view.
This patch provides a commandline option to mention log file path which helps
in logging to the specified file and also help in persisting the gfapi logs.
Usage:
-----
*URI Style:
---------
-drive file=gluster://hostname/volname/image.qcow2,file.debug=9,\
file.logfile=/var/log/qemu/qemu-gfapi.log
*JSON Style:
----------
'json:{
"driver":"qcow2",
"file":{
"driver":"gluster",
"volume":"volname",
"path":"image.qcow2",
"debug":"9",
"logfile":"/var/log/qemu/qemu-gfapi.log",
"server":[
{
"type":"tcp",
"host":"1.2.3.4",
"port":24007
},
{
"type":"unix",
"socket":"/var/run/glusterd.socket"
}
]
}
}'
Reviewed-by: Jeff Cody <jcody@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
2016-07-22 16:56:48 +02:00
|
|
|
'*logfile': 'str' } }
|
2016-07-19 18:57:32 +02:00
|
|
|
|
2016-12-08 14:23:11 +01:00
|
|
|
##
|
|
|
|
# @IscsiTransport:
|
|
|
|
#
|
|
|
|
# An enumeration of libiscsi transport types
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'enum': 'IscsiTransport',
|
|
|
|
'data': [ 'tcp', 'iser' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @IscsiHeaderDigest:
|
|
|
|
#
|
|
|
|
# An enumeration of header digests supported by libiscsi
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'enum': 'IscsiHeaderDigest',
|
|
|
|
'prefix': 'QAPI_ISCSI_HEADER_DIGEST',
|
|
|
|
'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevOptionsIscsi:
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @transport: The iscsi transport type
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @portal: The address of the iscsi portal
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @target: The target iqn name
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @lun: LUN to connect to. Defaults to 0.
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @user: User name to log in with. If omitted, no CHAP
|
|
|
|
# authentication is performed.
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @password-secret: The ID of a QCryptoSecret object providing
|
2016-12-08 14:23:11 +01:00
|
|
|
# the password for the login. This option is required if
|
|
|
|
# @user is specified.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @initiator-name: The iqn name we want to identify to the target
|
|
|
|
# as. If this option is not specified, an initiator name is
|
|
|
|
# generated automatically.
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @header-digest: The desired header digest. Defaults to
|
|
|
|
# none-crc32c.
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @timeout: Timeout in seconds after which a request will
|
|
|
|
# timeout. 0 means no timeout and is the default.
|
2016-12-08 14:23:11 +01:00
|
|
|
#
|
|
|
|
# Driver specific block device options for iscsi
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsIscsi',
|
|
|
|
'data': { 'transport': 'IscsiTransport',
|
|
|
|
'portal': 'str',
|
|
|
|
'target': 'str',
|
|
|
|
'*lun': 'int',
|
|
|
|
'*user': 'str',
|
|
|
|
'*password-secret': 'str',
|
|
|
|
'*initiator-name': 'str',
|
|
|
|
'*header-digest': 'IscsiHeaderDigest',
|
|
|
|
'*timeout': 'int' } }
|
|
|
|
|
2017-02-27 18:36:46 +01:00
|
|
|
|
rbd: New parameter auth-client-required
Parameter auth-client-required lets you configure authentication
methods. We tried to provide that in v2.9.0, but backed out due to
interface design doubts (commit 464444fcc16).
This commit is similar to what we backed out, but simpler: we use a
list of enumeration values instead of a list of objects with a member
of enumeration type.
Let's review our reasons for backing out the first try, as stated in
the commit message:
* The implementation uses deprecated rados_conf_set() key
"auth_supported". No biggie.
Fixed: we use "auth-client-required".
* The implementation makes -drive silently ignore invalid parameters
"auth" and "auth-supported.*.X" where X isn't "auth". Fixable (in
fact I'm going to fix similar bugs around parameter server), so
again no biggie.
That fix is commit 2836284db60. This commit doesn't bring the bugs
back.
* BlockdevOptionsRbd member @password-secret applies only to
authentication method cephx. Should it be a variant member of
RbdAuthMethod?
We've had time to ponder, and we decided to stick to the way Ceph
configuration works: the key configured separately, and silently
ignored if the authentication method doesn't use it.
* BlockdevOptionsRbd member @user could apply to both methods cephx
and none, but I'm not sure it's actually used with none. If it
isn't, should it be a variant member of RbdAuthMethod?
Likewise.
* The client offers a *set* of authentication methods, not a list.
Should the methods be optional members of BlockdevOptionsRbd instead
of members of list @auth-supported? The latter begs the question
what multiple entries for the same method mean. Trivial question
now that RbdAuthMethod contains nothing but @type, but less so when
RbdAuthMethod acquires other members, such the ones discussed above.
Again, we decided to stick to the way Ceph configuration works, except
we make auth-client-required a list of enumeration values instead of a
string containing keywords separated by delimiters.
* How BlockdevOptionsRbd member @auth-supported interacts with
settings from a configuration file specified with @conf is
undocumented. I suspect it's untested, too.
Not actually true, the documentation for @conf says "Values in the
configuration file will be overridden by options specified via QAPI",
and we've tested this.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-06-14 21:14:42 +02:00
|
|
|
##
|
|
|
|
# @RbdAuthMode:
|
|
|
|
#
|
|
|
|
# Since: 3.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'RbdAuthMode',
|
|
|
|
'data': [ 'cephx', 'none' ] }
|
|
|
|
|
2017-02-27 07:16:41 +01:00
|
|
|
##
|
|
|
|
# @BlockdevOptionsRbd:
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @pool: Ceph pool name.
|
2017-02-27 07:16:41 +01:00
|
|
|
#
|
block/rbd: Add support for ceph namespaces
Starting from ceph Nautilus, RBD has support for namespaces, allowing
for finer grain ACLs on images inside a pool, and tenant isolation.
In the rbd cli tool documentation, the new image-spec and snap-spec are :
- [pool-name/[namespace-name/]]image-name
- [pool-name/[namespace-name/]]image-name@snap-name
When using an non namespace's enabled qemu, it complains about not
finding the image called namespace-name/image-name, thus we only need to
parse the image once again to find if there is a '/' in its name, and if
there is, use what is before it as the name of the namespace to later
pass it to rados_ioctx_set_namespace.
rados_ioctx_set_namespace if called with en empty string or a null
pointer as the namespace parameters pretty much does nothing, as it then
defaults to the default namespace.
The namespace is extracted inside qemu_rbd_parse_filename, stored in the
qdict, and used in qemu_rbd_connect to make it work with both qemu-img,
and qemu itself.
Signed-off-by: Florian Florensa <fflorensa@online.net>
Message-Id: <20200110111513.321728-2-fflorensa@online.net>
Reviewed-by: Jason Dillaman <dillaman@redhat.com>
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2020-01-10 12:15:13 +01:00
|
|
|
# @namespace: Rados namespace name in the Ceph pool. (Since 5.0)
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @image: Image name in the Ceph pool.
|
2017-02-27 07:16:41 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @conf: path to Ceph configuration file. Values
|
|
|
|
# in the configuration file will be overridden by
|
|
|
|
# options specified via QAPI.
|
2017-02-27 07:16:41 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @snapshot: Ceph snapshot name.
|
2017-02-27 07:16:41 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @user: Ceph id name.
|
2017-02-27 07:16:41 +01:00
|
|
|
#
|
rbd: New parameter auth-client-required
Parameter auth-client-required lets you configure authentication
methods. We tried to provide that in v2.9.0, but backed out due to
interface design doubts (commit 464444fcc16).
This commit is similar to what we backed out, but simpler: we use a
list of enumeration values instead of a list of objects with a member
of enumeration type.
Let's review our reasons for backing out the first try, as stated in
the commit message:
* The implementation uses deprecated rados_conf_set() key
"auth_supported". No biggie.
Fixed: we use "auth-client-required".
* The implementation makes -drive silently ignore invalid parameters
"auth" and "auth-supported.*.X" where X isn't "auth". Fixable (in
fact I'm going to fix similar bugs around parameter server), so
again no biggie.
That fix is commit 2836284db60. This commit doesn't bring the bugs
back.
* BlockdevOptionsRbd member @password-secret applies only to
authentication method cephx. Should it be a variant member of
RbdAuthMethod?
We've had time to ponder, and we decided to stick to the way Ceph
configuration works: the key configured separately, and silently
ignored if the authentication method doesn't use it.
* BlockdevOptionsRbd member @user could apply to both methods cephx
and none, but I'm not sure it's actually used with none. If it
isn't, should it be a variant member of RbdAuthMethod?
Likewise.
* The client offers a *set* of authentication methods, not a list.
Should the methods be optional members of BlockdevOptionsRbd instead
of members of list @auth-supported? The latter begs the question
what multiple entries for the same method mean. Trivial question
now that RbdAuthMethod contains nothing but @type, but less so when
RbdAuthMethod acquires other members, such the ones discussed above.
Again, we decided to stick to the way Ceph configuration works, except
we make auth-client-required a list of enumeration values instead of a
string containing keywords separated by delimiters.
* How BlockdevOptionsRbd member @auth-supported interacts with
settings from a configuration file specified with @conf is
undocumented. I suspect it's untested, too.
Not actually true, the documentation for @conf says "Values in the
configuration file will be overridden by options specified via QAPI",
and we've tested this.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-06-14 21:14:42 +02:00
|
|
|
# @auth-client-required: Acceptable authentication modes.
|
2020-02-13 18:56:26 +01:00
|
|
|
# This maps to Ceph configuration option
|
|
|
|
# "auth_client_required". (Since 3.0)
|
rbd: New parameter auth-client-required
Parameter auth-client-required lets you configure authentication
methods. We tried to provide that in v2.9.0, but backed out due to
interface design doubts (commit 464444fcc16).
This commit is similar to what we backed out, but simpler: we use a
list of enumeration values instead of a list of objects with a member
of enumeration type.
Let's review our reasons for backing out the first try, as stated in
the commit message:
* The implementation uses deprecated rados_conf_set() key
"auth_supported". No biggie.
Fixed: we use "auth-client-required".
* The implementation makes -drive silently ignore invalid parameters
"auth" and "auth-supported.*.X" where X isn't "auth". Fixable (in
fact I'm going to fix similar bugs around parameter server), so
again no biggie.
That fix is commit 2836284db60. This commit doesn't bring the bugs
back.
* BlockdevOptionsRbd member @password-secret applies only to
authentication method cephx. Should it be a variant member of
RbdAuthMethod?
We've had time to ponder, and we decided to stick to the way Ceph
configuration works: the key configured separately, and silently
ignored if the authentication method doesn't use it.
* BlockdevOptionsRbd member @user could apply to both methods cephx
and none, but I'm not sure it's actually used with none. If it
isn't, should it be a variant member of RbdAuthMethod?
Likewise.
* The client offers a *set* of authentication methods, not a list.
Should the methods be optional members of BlockdevOptionsRbd instead
of members of list @auth-supported? The latter begs the question
what multiple entries for the same method mean. Trivial question
now that RbdAuthMethod contains nothing but @type, but less so when
RbdAuthMethod acquires other members, such the ones discussed above.
Again, we decided to stick to the way Ceph configuration works, except
we make auth-client-required a list of enumeration values instead of a
string containing keywords separated by delimiters.
* How BlockdevOptionsRbd member @auth-supported interacts with
settings from a configuration file specified with @conf is
undocumented. I suspect it's untested, too.
Not actually true, the documentation for @conf says "Values in the
configuration file will be overridden by options specified via QAPI",
and we've tested this.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-06-14 21:14:42 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @key-secret: ID of a QCryptoSecret object providing a key
|
|
|
|
# for cephx authentication.
|
|
|
|
# This maps to Ceph configuration option
|
|
|
|
# "key". (Since 3.0)
|
2018-06-14 21:14:43 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @server: Monitor host address and port. This maps
|
|
|
|
# to the "mon_host" Ceph option.
|
2017-02-27 18:36:46 +01:00
|
|
|
#
|
2017-02-27 07:16:41 +01:00
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsRbd',
|
|
|
|
'data': { 'pool': 'str',
|
block/rbd: Add support for ceph namespaces
Starting from ceph Nautilus, RBD has support for namespaces, allowing
for finer grain ACLs on images inside a pool, and tenant isolation.
In the rbd cli tool documentation, the new image-spec and snap-spec are :
- [pool-name/[namespace-name/]]image-name
- [pool-name/[namespace-name/]]image-name@snap-name
When using an non namespace's enabled qemu, it complains about not
finding the image called namespace-name/image-name, thus we only need to
parse the image once again to find if there is a '/' in its name, and if
there is, use what is before it as the name of the namespace to later
pass it to rados_ioctx_set_namespace.
rados_ioctx_set_namespace if called with en empty string or a null
pointer as the namespace parameters pretty much does nothing, as it then
defaults to the default namespace.
The namespace is extracted inside qemu_rbd_parse_filename, stored in the
qdict, and used in qemu_rbd_connect to make it work with both qemu-img,
and qemu itself.
Signed-off-by: Florian Florensa <fflorensa@online.net>
Message-Id: <20200110111513.321728-2-fflorensa@online.net>
Reviewed-by: Jason Dillaman <dillaman@redhat.com>
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2020-01-10 12:15:13 +01:00
|
|
|
'*namespace': 'str',
|
2017-02-27 07:16:41 +01:00
|
|
|
'image': 'str',
|
|
|
|
'*conf': 'str',
|
|
|
|
'*snapshot': 'str',
|
|
|
|
'*user': 'str',
|
rbd: New parameter auth-client-required
Parameter auth-client-required lets you configure authentication
methods. We tried to provide that in v2.9.0, but backed out due to
interface design doubts (commit 464444fcc16).
This commit is similar to what we backed out, but simpler: we use a
list of enumeration values instead of a list of objects with a member
of enumeration type.
Let's review our reasons for backing out the first try, as stated in
the commit message:
* The implementation uses deprecated rados_conf_set() key
"auth_supported". No biggie.
Fixed: we use "auth-client-required".
* The implementation makes -drive silently ignore invalid parameters
"auth" and "auth-supported.*.X" where X isn't "auth". Fixable (in
fact I'm going to fix similar bugs around parameter server), so
again no biggie.
That fix is commit 2836284db60. This commit doesn't bring the bugs
back.
* BlockdevOptionsRbd member @password-secret applies only to
authentication method cephx. Should it be a variant member of
RbdAuthMethod?
We've had time to ponder, and we decided to stick to the way Ceph
configuration works: the key configured separately, and silently
ignored if the authentication method doesn't use it.
* BlockdevOptionsRbd member @user could apply to both methods cephx
and none, but I'm not sure it's actually used with none. If it
isn't, should it be a variant member of RbdAuthMethod?
Likewise.
* The client offers a *set* of authentication methods, not a list.
Should the methods be optional members of BlockdevOptionsRbd instead
of members of list @auth-supported? The latter begs the question
what multiple entries for the same method mean. Trivial question
now that RbdAuthMethod contains nothing but @type, but less so when
RbdAuthMethod acquires other members, such the ones discussed above.
Again, we decided to stick to the way Ceph configuration works, except
we make auth-client-required a list of enumeration values instead of a
string containing keywords separated by delimiters.
* How BlockdevOptionsRbd member @auth-supported interacts with
settings from a configuration file specified with @conf is
undocumented. I suspect it's untested, too.
Not actually true, the documentation for @conf says "Values in the
configuration file will be overridden by options specified via QAPI",
and we've tested this.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-06-14 21:14:42 +02:00
|
|
|
'*auth-client-required': ['RbdAuthMode'],
|
2018-06-14 21:14:43 +02:00
|
|
|
'*key-secret': 'str',
|
2017-03-28 10:56:07 +02:00
|
|
|
'*server': ['InetSocketAddressBase'] } }
|
2017-02-27 07:16:41 +01:00
|
|
|
|
2017-03-06 20:00:49 +01:00
|
|
|
##
|
|
|
|
# @BlockdevOptionsSheepdog:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for sheepdog
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @vdi: Virtual disk image name
|
|
|
|
# @server: The Sheepdog server to connect to
|
|
|
|
# @snap-id: Snapshot ID
|
|
|
|
# @tag: Snapshot tag name
|
2017-03-06 20:00:49 +01:00
|
|
|
#
|
|
|
|
# Only one of @snap-id and @tag may be present.
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsSheepdog',
|
2017-04-26 09:36:40 +02:00
|
|
|
'data': { 'server': 'SocketAddress',
|
2017-03-06 20:00:49 +01:00
|
|
|
'vdi': 'str',
|
|
|
|
'*snap-id': 'uint32',
|
|
|
|
'*tag': 'str' } }
|
|
|
|
|
2016-07-27 09:01:49 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @ReplicationMode:
|
2016-07-27 09:01:49 +02:00
|
|
|
#
|
|
|
|
# An enumeration of replication modes.
|
|
|
|
#
|
|
|
|
# @primary: Primary mode, the vm's state will be sent to secondary QEMU.
|
|
|
|
#
|
|
|
|
# @secondary: Secondary mode, receive the vm's state from primary QEMU.
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-07-27 09:01:49 +02:00
|
|
|
##
|
2018-12-13 13:37:24 +01:00
|
|
|
{ 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ],
|
|
|
|
'if': 'defined(CONFIG_REPLICATION)' }
|
2016-07-27 09:01:49 +02:00
|
|
|
|
2016-07-27 09:01:52 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsReplication:
|
2016-07-27 09:01:52 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for replication
|
|
|
|
#
|
|
|
|
# @mode: the replication mode
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @top-id: In secondary mode, node name or device ID of the root
|
2016-10-12 06:50:08 +02:00
|
|
|
# node who owns the replication node chain. Must not be given in
|
|
|
|
# primary mode.
|
2016-07-27 09:01:52 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-07-27 09:01:52 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsReplication',
|
|
|
|
'base': 'BlockdevOptionsGenericFormat',
|
|
|
|
'data': { 'mode': 'ReplicationMode',
|
2018-12-13 13:37:24 +01:00
|
|
|
'*top-id': 'str' },
|
|
|
|
'if': 'defined(CONFIG_REPLICATION)' }
|
2016-07-27 09:01:52 +02:00
|
|
|
|
2016-10-31 16:05:50 +01:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @NFSTransport:
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
|
|
|
# An enumeration of NFS transport types
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @inet: TCP transport
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-10-31 16:05:50 +01:00
|
|
|
##
|
|
|
|
{ 'enum': 'NFSTransport',
|
|
|
|
'data': [ 'inet' ] }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @NFSServer:
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
|
|
|
# Captures the address of the socket
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @type: transport type used for NFS (only TCP supported)
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @host: host address for NFS server
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-10-31 16:05:50 +01:00
|
|
|
##
|
|
|
|
{ 'struct': 'NFSServer',
|
|
|
|
'data': { 'type': 'NFSTransport',
|
|
|
|
'host': 'str' } }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsNfs:
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
|
|
|
# Driver specific block device option for NFS
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @server: host address
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @path: path of the image on the host
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @user: UID value to use when talking to the
|
|
|
|
# server (defaults to 65534 on Windows and getuid()
|
|
|
|
# on unix)
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @group: GID value to use when talking to the
|
|
|
|
# server (defaults to 65534 on Windows and getgid()
|
|
|
|
# in unix)
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @tcp-syn-count: number of SYNs during the session
|
|
|
|
# establishment (defaults to libnfs default)
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @readahead-size: set the readahead size in bytes (defaults
|
|
|
|
# to libnfs default)
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @page-cache-size: set the pagecache size in bytes (defaults
|
|
|
|
# to libnfs default)
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @debug: set the NFS debug level (max 2) (defaults
|
|
|
|
# to libnfs default)
|
2016-10-31 16:05:50 +01:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-10-31 16:05:50 +01:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsNfs',
|
|
|
|
'data': { 'server': 'NFSServer',
|
|
|
|
'path': 'str',
|
|
|
|
'*user': 'int',
|
|
|
|
'*group': 'int',
|
|
|
|
'*tcp-syn-count': 'int',
|
|
|
|
'*readahead-size': 'int',
|
|
|
|
'*page-cache-size': 'int',
|
2016-11-02 17:50:37 +01:00
|
|
|
'*debug': 'int' } }
|
2016-10-31 16:05:50 +01:00
|
|
|
|
2016-09-08 13:08:20 +02:00
|
|
|
##
|
2017-03-31 14:04:30 +02:00
|
|
|
# @BlockdevOptionsCurlBase:
|
2016-09-08 13:08:20 +02:00
|
|
|
#
|
2017-03-31 14:04:30 +02:00
|
|
|
# Driver specific block device options shared by all protocols supported by the
|
|
|
|
# curl backend.
|
2016-09-08 13:08:20 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @url: URL of the image file
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @readahead: Size of the read-ahead cache; must be a multiple of
|
|
|
|
# 512 (defaults to 256 kB)
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @timeout: Timeout for connections, in seconds (defaults to 5)
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @username: Username for authentication (defaults to none)
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @password-secret: ID of a QCryptoSecret object providing a password
|
|
|
|
# for authentication (defaults to no password)
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @proxy-username: Username for proxy authentication (defaults to none)
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @proxy-password-secret: ID of a QCryptoSecret object providing a password
|
|
|
|
# for proxy authentication (defaults to no password)
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsCurlBase',
|
|
|
|
'data': { 'url': 'str',
|
|
|
|
'*readahead': 'int',
|
|
|
|
'*timeout': 'int',
|
|
|
|
'*username': 'str',
|
|
|
|
'*password-secret': 'str',
|
|
|
|
'*proxy-username': 'str',
|
|
|
|
'*proxy-password-secret': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevOptionsCurlHttp:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for HTTP connections over the curl
|
|
|
|
# backend. URLs must start with "http://".
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @cookie: List of cookies to set; format is
|
|
|
|
# "name1=content1; name2=content2;" as explained by
|
|
|
|
# CURLOPT_COOKIE(3). Defaults to no cookies.
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2017-05-04 16:00:06 +02:00
|
|
|
# @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
|
|
|
|
# secure way. See @cookie for the format. (since 2.10)
|
|
|
|
#
|
2017-03-31 14:04:30 +02:00
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsCurlHttp',
|
|
|
|
'base': 'BlockdevOptionsCurlBase',
|
2017-05-04 16:00:06 +02:00
|
|
|
'data': { '*cookie': 'str',
|
|
|
|
'*cookie-secret': 'str'} }
|
2017-03-31 14:04:30 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevOptionsCurlHttps:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for HTTPS connections over the curl
|
|
|
|
# backend. URLs must start with "https://".
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @cookie: List of cookies to set; format is
|
|
|
|
# "name1=content1; name2=content2;" as explained by
|
|
|
|
# CURLOPT_COOKIE(3). Defaults to no cookies.
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @sslverify: Whether to verify the SSL certificate's validity (defaults to
|
|
|
|
# true)
|
2017-03-31 14:04:30 +02:00
|
|
|
#
|
2017-05-04 16:00:06 +02:00
|
|
|
# @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
|
|
|
|
# secure way. See @cookie for the format. (since 2.10)
|
|
|
|
#
|
2017-03-31 14:04:30 +02:00
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsCurlHttps',
|
|
|
|
'base': 'BlockdevOptionsCurlBase',
|
|
|
|
'data': { '*cookie': 'str',
|
2017-05-04 16:00:06 +02:00
|
|
|
'*sslverify': 'bool',
|
|
|
|
'*cookie-secret': 'str'} }
|
2017-03-31 14:04:30 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevOptionsCurlFtp:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for FTP connections over the curl
|
|
|
|
# backend. URLs must start with "ftp://".
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsCurlFtp',
|
|
|
|
'base': 'BlockdevOptionsCurlBase',
|
|
|
|
'data': { } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevOptionsCurlFtps:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for FTPS connections over the curl
|
|
|
|
# backend. URLs must start with "ftps://".
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @sslverify: Whether to verify the SSL certificate's validity (defaults to
|
|
|
|
# true)
|
2016-09-08 13:08:20 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-09-08 13:08:20 +02:00
|
|
|
##
|
2017-03-31 14:04:30 +02:00
|
|
|
{ 'struct': 'BlockdevOptionsCurlFtps',
|
|
|
|
'base': 'BlockdevOptionsCurlBase',
|
|
|
|
'data': { '*sslverify': 'bool' } }
|
2016-09-08 13:08:20 +02:00
|
|
|
|
2016-10-25 15:11:36 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsNbd:
|
2016-10-25 15:11:36 +02:00
|
|
|
#
|
|
|
|
# Driver specific block device options for NBD.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @server: NBD server address
|
2016-10-25 15:11:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @export: export name
|
2016-10-25 15:11:36 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @tls-creds: TLS credentials ID
|
2016-10-25 15:11:36 +02:00
|
|
|
#
|
2018-07-02 21:14:57 +02:00
|
|
|
# @x-dirty-bitmap: A "qemu:dirty-bitmap:NAME" string to query in place of
|
|
|
|
# traditional "base:allocation" block status (see
|
|
|
|
# NBD_OPT_LIST_META_CONTEXT in the NBD protocol) (since 3.0)
|
|
|
|
#
|
2019-06-18 13:43:23 +02:00
|
|
|
# @reconnect-delay: On an unexpected disconnect, the nbd client tries to
|
|
|
|
# connect again until succeeding or encountering a serious
|
|
|
|
# error. During the first @reconnect-delay seconds, all
|
|
|
|
# requests are paused and will be rerun on a successful
|
|
|
|
# reconnect. After that time, any delayed requests and all
|
|
|
|
# future requests before a successful reconnect will
|
|
|
|
# immediately fail. Default 0 (Since 4.2)
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-10-25 15:11:36 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsNbd',
|
2017-04-26 09:36:40 +02:00
|
|
|
'data': { 'server': 'SocketAddress',
|
2016-10-25 15:11:36 +02:00
|
|
|
'*export': 'str',
|
2018-07-02 21:14:57 +02:00
|
|
|
'*tls-creds': 'str',
|
2019-06-18 13:43:23 +02:00
|
|
|
'*x-dirty-bitmap': 'str',
|
|
|
|
'*reconnect-delay': 'uint32' } }
|
2016-10-25 15:11:36 +02:00
|
|
|
|
2016-10-31 11:27:40 +01:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptionsRaw:
|
2016-10-31 11:27:40 +01:00
|
|
|
#
|
|
|
|
# Driver specific block device options for the raw driver.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @offset: position where the block device starts
|
|
|
|
# @size: the assumed size of the device
|
2016-10-31 11:27:40 +01:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-10-31 11:27:40 +01:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsRaw',
|
|
|
|
'base': 'BlockdevOptionsGenericFormat',
|
|
|
|
'data': { '*offset': 'int', '*size': 'int' } }
|
|
|
|
|
block/vxhs.c: Add support for a new block device type called "vxhs"
Source code for the qnio library that this code loads can be downloaded from:
https://github.com/VeritasHyperScale/libqnio.git
Sample command line using JSON syntax:
./x86_64-softmmu/qemu-system-x86_64 -name instance-00000008 -S -vnc 0.0.0.0:0
-k en-us -vga cirrus -device virtio-balloon-pci,id=balloon0,bus=pci.0,addr=0x5
-msg timestamp=on
'json:{"driver":"vxhs","vdisk-id":"c3e9095a-a5ee-4dce-afeb-2a59fb387410",
"server":{"host":"172.172.17.4","port":"9999"}}'
Sample command line using URI syntax:
qemu-img convert -f raw -O raw -n
/var/lib/nova/instances/_base/0c5eacd5ebea5ed914b6a3e7b18f1ce734c386ad
vxhs://192.168.0.1:9999/c6718f6b-0401-441d-a8c3-1f0064d75ee0
Sample command line using TLS credentials (run in secure mode):
./qemu-io --object
tls-creds-x509,id=tls0,dir=/etc/pki/qemu/vxhs,endpoint=client -c 'read
-v 66000 2.5k' 'json:{"server.host": "127.0.0.1", "server.port": "9999",
"vdisk-id": "/test.raw", "driver": "vxhs", "tls-creds":"tls0"}'
[Jeff: Modified trace-events with the correct string formatting]
Signed-off-by: Ashish Mittal <Ashish.Mittal@veritas.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Message-id: 1491277689-24949-2-git-send-email-Ashish.Mittal@veritas.com
2017-04-04 05:48:08 +02:00
|
|
|
##
|
|
|
|
# @BlockdevOptionsVxHS:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for VxHS
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @vdisk-id: UUID of VxHS volume
|
|
|
|
# @server: vxhs server IP, port
|
|
|
|
# @tls-creds: TLS credentials ID
|
block/vxhs.c: Add support for a new block device type called "vxhs"
Source code for the qnio library that this code loads can be downloaded from:
https://github.com/VeritasHyperScale/libqnio.git
Sample command line using JSON syntax:
./x86_64-softmmu/qemu-system-x86_64 -name instance-00000008 -S -vnc 0.0.0.0:0
-k en-us -vga cirrus -device virtio-balloon-pci,id=balloon0,bus=pci.0,addr=0x5
-msg timestamp=on
'json:{"driver":"vxhs","vdisk-id":"c3e9095a-a5ee-4dce-afeb-2a59fb387410",
"server":{"host":"172.172.17.4","port":"9999"}}'
Sample command line using URI syntax:
qemu-img convert -f raw -O raw -n
/var/lib/nova/instances/_base/0c5eacd5ebea5ed914b6a3e7b18f1ce734c386ad
vxhs://192.168.0.1:9999/c6718f6b-0401-441d-a8c3-1f0064d75ee0
Sample command line using TLS credentials (run in secure mode):
./qemu-io --object
tls-creds-x509,id=tls0,dir=/etc/pki/qemu/vxhs,endpoint=client -c 'read
-v 66000 2.5k' 'json:{"server.host": "127.0.0.1", "server.port": "9999",
"vdisk-id": "/test.raw", "driver": "vxhs", "tls-creds":"tls0"}'
[Jeff: Modified trace-events with the correct string formatting]
Signed-off-by: Ashish Mittal <Ashish.Mittal@veritas.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Message-id: 1491277689-24949-2-git-send-email-Ashish.Mittal@veritas.com
2017-04-04 05:48:08 +02:00
|
|
|
#
|
|
|
|
# Since: 2.10
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsVxHS',
|
|
|
|
'data': { 'vdisk-id': 'str',
|
|
|
|
'server': 'InetSocketAddressBase',
|
|
|
|
'*tls-creds': 'str' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2017-08-25 15:20:27 +02:00
|
|
|
# @BlockdevOptionsThrottle:
|
|
|
|
#
|
|
|
|
# Driver specific block device options for the throttle driver
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @throttle-group: the name of the throttle-group object to use. It
|
|
|
|
# must already exist.
|
|
|
|
# @file: reference to or definition of the data source block device
|
2017-08-25 15:20:27 +02:00
|
|
|
# Since: 2.11
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevOptionsThrottle',
|
|
|
|
'data': { 'throttle-group': 'str',
|
|
|
|
'file' : 'BlockdevRef'
|
|
|
|
} }
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevOptions:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2016-03-17 23:48:40 +01:00
|
|
|
# Options for creating a block device. Many options are available for all
|
|
|
|
# block devices, independent of the block driver:
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @driver: block driver name
|
|
|
|
# @node-name: the node name of the new node (Since 2.0).
|
|
|
|
# This option is required on the top level of blockdev-add.
|
|
|
|
# Valid node names start with an alphabetic character and may
|
|
|
|
# contain only alphanumeric characters, '-', '.' and '_'. Their
|
|
|
|
# maximum length is 31 characters.
|
|
|
|
# @discard: discard-related options (default: ignore)
|
|
|
|
# @cache: cache-related options
|
|
|
|
# @read-only: whether the block device should be read-only (default: false).
|
|
|
|
# Note that some block drivers support only read-only access,
|
|
|
|
# either generally or in certain configurations. In this case,
|
|
|
|
# the default value does not work and the option must be
|
|
|
|
# specified explicitly.
|
block: Add auto-read-only option
If a management application builds the block graph node by node, the
protocol layer doesn't inherit its read-only option from the format
layer any more, so it must be set explicitly.
Backing files should work on read-only storage, but at the same time, a
block job like commit should be able to reopen them read-write if they
are on read-write storage. However, without option inheritance, reopen
only changes the read-only option for the root node (typically the
format layer), but not the protocol layer, so reopening fails (the
format layer wants to get write permissions, but the protocol layer is
still read-only).
A simple workaround for the problem in the management tool would be to
open the protocol layer always read-write and to make only the format
layer read-only for backing files. However, sometimes the file is
actually stored on read-only storage and we don't know whether the image
can be opened read-write (for example, for NBD it depends on the server
we're trying to connect to). This adds an option that makes QEMU try to
open the image read-write, but allows it to degrade to a read-only mode
without returning an error.
The documentation for this option is consciously phrased in a way that
allows QEMU to switch to a better model eventually: Instead of trying
when the image is first opened, making the read-only flag dynamic and
changing it automatically whenever the first BLK_PERM_WRITE user is
attached or the last one is detached would be much more useful
behaviour.
Unfortunately, this more useful behaviour is also a lot harder to
implement, and libvirt needs a solution now before it can switch to
-blockdev, so let's start with this easier approach for now.
Instead of adding a new auto-read-only option, turning the existing
read-only into an enum (with a bool alternate for compatibility) was
considered, but it complicated the implementation to the point that it
didn't seem to be worth it.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2018-10-05 18:57:40 +02:00
|
|
|
# @auto-read-only: if true and @read-only is false, QEMU may automatically
|
|
|
|
# decide not to open the image read-write as requested, but
|
|
|
|
# fall back to read-only instead (and switch between the modes
|
|
|
|
# later), e.g. depending on whether the image file is writable
|
|
|
|
# or whether a writing user is attached to the node
|
|
|
|
# (default: false, since 3.1)
|
2017-03-15 13:57:06 +01:00
|
|
|
# @detect-zeroes: detect and optimize zero writes (Since 2.1)
|
2016-03-17 23:48:40 +01:00
|
|
|
# (default: off)
|
2020-02-13 18:56:26 +01:00
|
|
|
# @force-share: force share all permission on added nodes.
|
|
|
|
# Requires read-only=true. (Since 2.10)
|
2016-03-17 23:48:40 +01:00
|
|
|
#
|
|
|
|
# Remaining options are determined by the block driver.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
{ 'union': 'BlockdevOptions',
|
2016-03-17 23:48:40 +01:00
|
|
|
'base': { 'driver': 'BlockdevDriver',
|
|
|
|
'*node-name': 'str',
|
|
|
|
'*discard': 'BlockdevDiscardOptions',
|
|
|
|
'*cache': 'BlockdevCacheOptions',
|
|
|
|
'*read-only': 'bool',
|
block: Add auto-read-only option
If a management application builds the block graph node by node, the
protocol layer doesn't inherit its read-only option from the format
layer any more, so it must be set explicitly.
Backing files should work on read-only storage, but at the same time, a
block job like commit should be able to reopen them read-write if they
are on read-write storage. However, without option inheritance, reopen
only changes the read-only option for the root node (typically the
format layer), but not the protocol layer, so reopening fails (the
format layer wants to get write permissions, but the protocol layer is
still read-only).
A simple workaround for the problem in the management tool would be to
open the protocol layer always read-write and to make only the format
layer read-only for backing files. However, sometimes the file is
actually stored on read-only storage and we don't know whether the image
can be opened read-write (for example, for NBD it depends on the server
we're trying to connect to). This adds an option that makes QEMU try to
open the image read-write, but allows it to degrade to a read-only mode
without returning an error.
The documentation for this option is consciously phrased in a way that
allows QEMU to switch to a better model eventually: Instead of trying
when the image is first opened, making the read-only flag dynamic and
changing it automatically whenever the first BLK_PERM_WRITE user is
attached or the last one is detached would be much more useful
behaviour.
Unfortunately, this more useful behaviour is also a lot harder to
implement, and libvirt needs a solution now before it can switch to
-blockdev, so let's start with this easier approach for now.
Instead of adding a new auto-read-only option, turning the existing
read-only into an enum (with a bool alternate for compatibility) was
considered, but it complicated the implementation to the point that it
didn't seem to be worth it.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2018-10-05 18:57:40 +02:00
|
|
|
'*auto-read-only': 'bool',
|
2017-05-02 18:35:37 +02:00
|
|
|
'*force-share': 'bool',
|
2016-03-17 23:48:40 +01:00
|
|
|
'*detect-zeroes': 'BlockdevDetectZeroesOptions' },
|
2014-06-05 13:45:31 +02:00
|
|
|
'discriminator': 'driver',
|
|
|
|
'data': {
|
2014-09-11 08:09:58 +02:00
|
|
|
'blkdebug': 'BlockdevOptionsBlkdebug',
|
2018-07-03 16:48:48 +02:00
|
|
|
'blklogwrites':'BlockdevOptionsBlklogwrites',
|
2014-09-11 08:09:58 +02:00
|
|
|
'blkverify': 'BlockdevOptionsBlkverify',
|
2019-10-16 10:40:39 +02:00
|
|
|
'blkreplay': 'BlockdevOptionsBlkreplay',
|
2014-09-11 08:09:58 +02:00
|
|
|
'bochs': 'BlockdevOptionsGenericFormat',
|
|
|
|
'cloop': 'BlockdevOptionsGenericFormat',
|
2019-12-02 13:15:04 +01:00
|
|
|
'compress': 'BlockdevOptionsGenericFormat',
|
2018-04-21 15:29:21 +02:00
|
|
|
'copy-on-read':'BlockdevOptionsGenericFormat',
|
2014-09-11 08:09:58 +02:00
|
|
|
'dmg': 'BlockdevOptionsGenericFormat',
|
2014-06-05 13:45:31 +02:00
|
|
|
'file': 'BlockdevOptionsFile',
|
2017-03-31 14:04:30 +02:00
|
|
|
'ftp': 'BlockdevOptionsCurlFtp',
|
|
|
|
'ftps': 'BlockdevOptionsCurlFtps',
|
2016-07-19 18:57:32 +02:00
|
|
|
'gluster': 'BlockdevOptionsGluster',
|
2014-06-05 13:45:31 +02:00
|
|
|
'host_cdrom': 'BlockdevOptionsFile',
|
2014-09-11 08:09:58 +02:00
|
|
|
'host_device':'BlockdevOptionsFile',
|
2017-03-31 14:04:30 +02:00
|
|
|
'http': 'BlockdevOptionsCurlHttp',
|
|
|
|
'https': 'BlockdevOptionsCurlHttps',
|
2016-12-08 14:23:11 +01:00
|
|
|
'iscsi': 'BlockdevOptionsIscsi',
|
block: add generic full disk encryption driver
Add a block driver that is capable of supporting any full disk
encryption format. This utilizes the previously added block
encryption code, and at this time supports the LUKS format.
The driver code is capable of supporting any format supported
by the QCryptoBlock module, so it registers one block driver
for each format. This patch only registers the "luks" driver
since the "qcow" driver is there only for back-compatibility
with existing qcow built-in encryption.
New LUKS compatible volumes can be formatted using qemu-img
with defaults for all settings.
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0 demo.luks 10G
Alternatively the cryptographic settings can be explicitly
set
$ qemu-img create --object secret,data=123456,id=sec0 \
-f luks -o key-secret=sec0,cipher-alg=aes-256,\
cipher-mode=cbc,ivgen-alg=plain64,hash-alg=sha256 \
demo.luks 10G
And query its size
$ qemu-img info demo.img
image: demo.img
file format: luks
virtual size: 10G (10737418240 bytes)
disk size: 132K
encrypted: yes
Note that it was not necessary to provide the password
when querying info for the volume. The password is only
required when performing I/O on the volume
All volumes created by this new 'luks' driver should be
capable of being opened by the kernel dm-crypt driver.
The only algorithms listed in the LUKS spec that are
not currently supported by this impl are sha512 and
ripemd160 hashes and cast6 cipher.
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
[ kwolf - Added #include to resolve conflict with da34e65c ]
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2016-03-21 15:11:47 +01:00
|
|
|
'luks': 'BlockdevOptionsLUKS',
|
2016-10-25 15:11:36 +02:00
|
|
|
'nbd': 'BlockdevOptionsNbd',
|
2016-10-31 16:05:50 +01:00
|
|
|
'nfs': 'BlockdevOptionsNfs',
|
2014-09-11 08:09:58 +02:00
|
|
|
'null-aio': 'BlockdevOptionsNull',
|
|
|
|
'null-co': 'BlockdevOptionsNull',
|
2018-01-16 07:09:01 +01:00
|
|
|
'nvme': 'BlockdevOptionsNVMe',
|
2014-06-05 13:45:31 +02:00
|
|
|
'parallels': 'BlockdevOptionsGenericFormat',
|
|
|
|
'qcow2': 'BlockdevOptionsQcow2',
|
qcow: convert QCow to use QCryptoBlock for encryption
This converts the qcow driver to make use of the QCryptoBlock
APIs for encrypting image content. This is only wired up to
permit use of the legacy QCow encryption format. Users who wish
to have the strong LUKS format should switch to qcow2 instead.
With this change it is now required to use the QCryptoSecret
object for providing passwords, instead of the current block
password APIs / interactive prompting.
$QEMU \
-object secret,id=sec0,file=/home/berrange/encrypted.pw \
-drive file=/home/berrange/encrypted.qcow,encrypt.format=aes,\
encrypt.key-secret=sec0
Though note that running QEMU system emulators with the AES
encryption is no longer supported, so while the above syntax
is valid, QEMU will refuse to actually run the VM in this
particular example.
Likewise when creating images with the legacy AES-CBC format
qemu-img create -f qcow \
--object secret,id=sec0,file=/home/berrange/encrypted.pw \
-o encrypt.format=aes,encrypt.key-secret=sec0 \
/home/berrange/encrypted.qcow 64M
Reviewed-by: Max Reitz <mreitz@redhat.com>
Reviewed-by: Alberto Garcia <berto@igalia.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Message-id: 20170623162419.26068-10-berrange@redhat.com
Signed-off-by: Max Reitz <mreitz@redhat.com>
2017-06-23 18:24:08 +02:00
|
|
|
'qcow': 'BlockdevOptionsQcow',
|
2014-06-05 13:45:31 +02:00
|
|
|
'qed': 'BlockdevOptionsGenericCOWFormat',
|
2014-09-11 08:09:58 +02:00
|
|
|
'quorum': 'BlockdevOptionsQuorum',
|
2016-10-31 11:27:40 +01:00
|
|
|
'raw': 'BlockdevOptionsRaw',
|
2017-02-27 07:16:41 +01:00
|
|
|
'rbd': 'BlockdevOptionsRbd',
|
2018-12-13 13:37:24 +01:00
|
|
|
'replication': { 'type': 'BlockdevOptionsReplication',
|
|
|
|
'if': 'defined(CONFIG_REPLICATION)' },
|
2017-03-06 20:00:49 +01:00
|
|
|
'sheepdog': 'BlockdevOptionsSheepdog',
|
2016-10-25 15:04:01 +02:00
|
|
|
'ssh': 'BlockdevOptionsSsh',
|
2017-08-25 15:20:27 +02:00
|
|
|
'throttle': 'BlockdevOptionsThrottle',
|
2014-06-05 13:45:31 +02:00
|
|
|
'vdi': 'BlockdevOptionsGenericFormat',
|
|
|
|
'vhdx': 'BlockdevOptionsGenericFormat',
|
|
|
|
'vmdk': 'BlockdevOptionsGenericCOWFormat',
|
|
|
|
'vpc': 'BlockdevOptionsGenericFormat',
|
block/vxhs.c: Add support for a new block device type called "vxhs"
Source code for the qnio library that this code loads can be downloaded from:
https://github.com/VeritasHyperScale/libqnio.git
Sample command line using JSON syntax:
./x86_64-softmmu/qemu-system-x86_64 -name instance-00000008 -S -vnc 0.0.0.0:0
-k en-us -vga cirrus -device virtio-balloon-pci,id=balloon0,bus=pci.0,addr=0x5
-msg timestamp=on
'json:{"driver":"vxhs","vdisk-id":"c3e9095a-a5ee-4dce-afeb-2a59fb387410",
"server":{"host":"172.172.17.4","port":"9999"}}'
Sample command line using URI syntax:
qemu-img convert -f raw -O raw -n
/var/lib/nova/instances/_base/0c5eacd5ebea5ed914b6a3e7b18f1ce734c386ad
vxhs://192.168.0.1:9999/c6718f6b-0401-441d-a8c3-1f0064d75ee0
Sample command line using TLS credentials (run in secure mode):
./qemu-io --object
tls-creds-x509,id=tls0,dir=/etc/pki/qemu/vxhs,endpoint=client -c 'read
-v 66000 2.5k' 'json:{"server.host": "127.0.0.1", "server.port": "9999",
"vdisk-id": "/test.raw", "driver": "vxhs", "tls-creds":"tls0"}'
[Jeff: Modified trace-events with the correct string formatting]
Signed-off-by: Ashish Mittal <Ashish.Mittal@veritas.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Message-id: 1491277689-24949-2-git-send-email-Ashish.Mittal@veritas.com
2017-04-04 05:48:08 +02:00
|
|
|
'vvfat': 'BlockdevOptionsVVFAT',
|
|
|
|
'vxhs': 'BlockdevOptionsVxHS'
|
2014-06-05 13:45:31 +02:00
|
|
|
} }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockdevRef:
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
|
|
|
# Reference to a block device.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @definition: defines a new block device inline
|
|
|
|
# @reference: references the ID of an existing block device
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2015-05-04 17:05:13 +02:00
|
|
|
{ 'alternate': 'BlockdevRef',
|
2014-06-05 13:45:31 +02:00
|
|
|
'data': { 'definition': 'BlockdevOptions',
|
|
|
|
'reference': 'str' } }
|
|
|
|
|
block: Use JSON null instead of "" to disable backing file
BlockdevRef is an alternate of BlockdevOptions (inline definition) and
str (reference to an existing block device by name). BlockdevRef
value "" is special: "no block device should be referenced." It's
actually interpreted that way in just one place: optional member
@backing of COW formats. Semantics:
* Present means "use this block device" as backing storage
* Absent means "default to the one stored in the image"
* Except "" means "don't use backing storage at all"
The first two are perfectly normal: when the parameter is absent, it
defaults to an implied value, but the value's meaning is the same.
The third one overloads the parameter with a second meaning. The
overloading is *implicit*, i.e. it's not visible in the types. Works
here, because "" is not a value block device ID.
Pressing argument values the schema accepts, but are semantically
invalid, into service to mean "do something else entirely" is not
general, as suitable invalid values need not exist. I also find it
ugly.
To clean this up, we could add a separate flag argument to suppress
@backing, or add a distinct value to @backing. This commit implements
the latter: add JSON null to the values of @backing, deprecate "".
Because we're so close to the 2.10 freeze, implement it in the
stupidest way possible: have qmp_blockdev_add() rewrite null to ""
before anything else can see the null. Works, because BlockdevRef
occurs only within arguments of blockdev-add. The proper way to do it
would be rewriting "" to null, preferably in a cleaner way, but that
requires fixing up code to work with null. Add a TODO comment for
that.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Daniel P. Berrange <berrange@redhat.com>
Acked-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2017-07-18 08:54:00 +02:00
|
|
|
##
|
|
|
|
# @BlockdevRefOrNull:
|
|
|
|
#
|
|
|
|
# Reference to a block device.
|
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# @definition: defines a new block device inline
|
|
|
|
# @reference: references the ID of an existing block device.
|
|
|
|
# An empty string means that no block device should
|
|
|
|
# be referenced. Deprecated; use null instead.
|
|
|
|
# @null: No block device should be referenced (since 2.10)
|
block: Use JSON null instead of "" to disable backing file
BlockdevRef is an alternate of BlockdevOptions (inline definition) and
str (reference to an existing block device by name). BlockdevRef
value "" is special: "no block device should be referenced." It's
actually interpreted that way in just one place: optional member
@backing of COW formats. Semantics:
* Present means "use this block device" as backing storage
* Absent means "default to the one stored in the image"
* Except "" means "don't use backing storage at all"
The first two are perfectly normal: when the parameter is absent, it
defaults to an implied value, but the value's meaning is the same.
The third one overloads the parameter with a second meaning. The
overloading is *implicit*, i.e. it's not visible in the types. Works
here, because "" is not a value block device ID.
Pressing argument values the schema accepts, but are semantically
invalid, into service to mean "do something else entirely" is not
general, as suitable invalid values need not exist. I also find it
ugly.
To clean this up, we could add a separate flag argument to suppress
@backing, or add a distinct value to @backing. This commit implements
the latter: add JSON null to the values of @backing, deprecate "".
Because we're so close to the 2.10 freeze, implement it in the
stupidest way possible: have qmp_blockdev_add() rewrite null to ""
before anything else can see the null. Works, because BlockdevRef
occurs only within arguments of blockdev-add. The proper way to do it
would be rewriting "" to null, preferably in a cleaner way, but that
requires fixing up code to work with null. Add a TODO comment for
that.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Daniel P. Berrange <berrange@redhat.com>
Acked-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2017-07-18 08:54:00 +02:00
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'alternate': 'BlockdevRefOrNull',
|
|
|
|
'data': { 'definition': 'BlockdevOptions',
|
|
|
|
'reference': 'str',
|
|
|
|
'null': 'null' } }
|
|
|
|
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
|
|
|
# @blockdev-add:
|
|
|
|
#
|
2015-10-19 17:53:09 +02:00
|
|
|
# Creates a new block device. If the @id option is given at the top level, a
|
|
|
|
# BlockBackend will be created; otherwise, @node-name is mandatory at the top
|
|
|
|
# level and no BlockBackend will be created.
|
2014-06-05 13:45:31 +02:00
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-06-23 14:54:05 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# 1.
|
|
|
|
# -> { "execute": "blockdev-add",
|
|
|
|
# "arguments": {
|
2017-01-25 02:14:11 +01:00
|
|
|
# "driver": "qcow2",
|
|
|
|
# "node-name": "test1",
|
|
|
|
# "file": {
|
|
|
|
# "driver": "file",
|
|
|
|
# "filename": "test.qcow2"
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# }
|
2016-06-23 14:54:05 +02:00
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
# 2.
|
|
|
|
# -> { "execute": "blockdev-add",
|
|
|
|
# "arguments": {
|
2017-01-25 02:14:11 +01:00
|
|
|
# "driver": "qcow2",
|
|
|
|
# "node-name": "node0",
|
|
|
|
# "discard": "unmap",
|
|
|
|
# "cache": {
|
|
|
|
# "direct": true
|
2016-06-23 14:54:05 +02:00
|
|
|
# },
|
|
|
|
# "file": {
|
2017-01-25 02:14:11 +01:00
|
|
|
# "driver": "file",
|
|
|
|
# "filename": "/tmp/test.qcow2"
|
2016-06-23 14:54:05 +02:00
|
|
|
# },
|
|
|
|
# "backing": {
|
2017-01-25 02:14:11 +01:00
|
|
|
# "driver": "raw",
|
|
|
|
# "file": {
|
|
|
|
# "driver": "file",
|
|
|
|
# "filename": "/dev/fdset/4"
|
2016-06-23 14:54:05 +02:00
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2014-06-05 13:45:31 +02:00
|
|
|
##
|
2016-10-07 17:05:04 +02:00
|
|
|
{ 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true }
|
2014-06-05 13:45:31 +02:00
|
|
|
|
2019-03-12 17:48:51 +01:00
|
|
|
##
|
|
|
|
# @x-blockdev-reopen:
|
|
|
|
#
|
|
|
|
# Reopens a block device using the given set of options. Any option
|
|
|
|
# not specified will be reset to its default value regardless of its
|
|
|
|
# previous status. If an option cannot be changed or a particular
|
|
|
|
# driver does not support reopening then the command will return an
|
|
|
|
# error.
|
|
|
|
#
|
|
|
|
# The top-level @node-name option (from BlockdevOptions) must be
|
|
|
|
# specified and is used to select the block device to be reopened.
|
|
|
|
# Other @node-name options must be either omitted or set to the
|
|
|
|
# current name of the appropriate node. This command won't change any
|
|
|
|
# node name and any attempt to do it will result in an error.
|
|
|
|
#
|
|
|
|
# In the case of options that refer to child nodes, the behavior of
|
|
|
|
# this command depends on the value:
|
|
|
|
#
|
|
|
|
# 1) A set of options (BlockdevOptions): the child is reopened with
|
|
|
|
# the specified set of options.
|
|
|
|
#
|
|
|
|
# 2) A reference to the current child: the child is reopened using
|
|
|
|
# its existing set of options.
|
|
|
|
#
|
|
|
|
# 3) A reference to a different node: the current child is replaced
|
|
|
|
# with the specified one.
|
|
|
|
#
|
|
|
|
# 4) NULL: the current child (if any) is detached.
|
|
|
|
#
|
|
|
|
# Options (1) and (2) are supported in all cases, but at the moment
|
|
|
|
# only @backing allows replacing or detaching an existing child.
|
|
|
|
#
|
|
|
|
# Unlike with blockdev-add, the @backing option must always be present
|
|
|
|
# unless the node being reopened does not have a backing file and its
|
|
|
|
# image does not have a default backing file name as part of its
|
|
|
|
# metadata.
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'command': 'x-blockdev-reopen',
|
|
|
|
'data': 'BlockdevOptions', 'boxed': true }
|
|
|
|
|
2015-11-02 15:51:55 +01:00
|
|
|
##
|
2017-03-21 17:53:28 +01:00
|
|
|
# @blockdev-del:
|
2015-11-02 15:51:55 +01:00
|
|
|
#
|
|
|
|
# Deletes a block device that has been added using blockdev-add.
|
2016-09-21 14:56:11 +02:00
|
|
|
# The command will fail if the node is attached to a device or is
|
|
|
|
# otherwise being used.
|
2015-11-02 15:51:55 +01:00
|
|
|
#
|
2017-01-13 15:41:22 +01:00
|
|
|
# @node-name: Name of the graph node to delete.
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# Since: 2.9
|
2016-06-23 14:55:00 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "blockdev-add",
|
|
|
|
# "arguments": {
|
2017-01-25 02:14:11 +01:00
|
|
|
# "driver": "qcow2",
|
|
|
|
# "node-name": "node0",
|
|
|
|
# "file": {
|
|
|
|
# "driver": "file",
|
|
|
|
# "filename": "test.qcow2"
|
|
|
|
# }
|
2016-06-23 14:55:00 +02:00
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2017-03-21 17:53:28 +01:00
|
|
|
# -> { "execute": "blockdev-del",
|
2016-06-23 14:55:00 +02:00
|
|
|
# "arguments": { "node-name": "node0" }
|
|
|
|
# }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2015-11-02 15:51:55 +01:00
|
|
|
##
|
2017-03-21 17:53:28 +01:00
|
|
|
{ 'command': 'blockdev-del', 'data': { 'node-name': 'str' } }
|
2015-11-02 15:51:55 +01:00
|
|
|
|
2018-01-16 16:04:21 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsFile:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for file.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @filename: Filename for the new image file
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @preallocation: Preallocation mode for the new image (default: off;
|
|
|
|
# allowed values: off,
|
|
|
|
# falloc (if defined CONFIG_POSIX_FALLOCATE),
|
|
|
|
# full (if defined CONFIG_POSIX))
|
|
|
|
# @nocow: Turn off copy-on-write (valid only on btrfs; default: off)
|
2018-01-16 16:04:21 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsFile',
|
|
|
|
'data': { 'filename': 'str',
|
|
|
|
'size': 'size',
|
|
|
|
'*preallocation': 'PreallocMode',
|
|
|
|
'*nocow': 'bool' } }
|
|
|
|
|
2018-01-31 16:27:38 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsGluster:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for gluster.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @location: Where to store the new image file
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @preallocation: Preallocation mode for the new image (default: off;
|
|
|
|
# allowed values: off,
|
|
|
|
# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE),
|
|
|
|
# full (if defined CONFIG_GLUSTERFS_ZEROFILL))
|
2018-01-31 16:27:38 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsGluster',
|
|
|
|
'data': { 'location': 'BlockdevOptionsGluster',
|
|
|
|
'size': 'size',
|
|
|
|
'*preallocation': 'PreallocMode' } }
|
|
|
|
|
2018-03-02 14:31:04 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsLUKS:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for LUKS.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @preallocation: Preallocation mode for the new image
|
|
|
|
# (since: 4.2)
|
|
|
|
# (default: off; allowed values: off, metadata, falloc, full)
|
2018-03-02 14:31:04 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsLUKS',
|
|
|
|
'base': 'QCryptoBlockCreateOptionsLUKS',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
2019-07-16 18:19:01 +02:00
|
|
|
'size': 'size',
|
|
|
|
'*preallocation': 'PreallocMode' } }
|
2018-03-02 14:31:04 +01:00
|
|
|
|
2018-01-31 16:27:38 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsNfs:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for NFS.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @location: Where to store the new image file
|
|
|
|
# @size: Size of the virtual disk in bytes
|
2018-01-31 16:27:38 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsNfs',
|
|
|
|
'data': { 'location': 'BlockdevOptionsNfs',
|
|
|
|
'size': 'size' } }
|
|
|
|
|
2018-03-06 12:13:58 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsParallels:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for parallels.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @cluster-size: Cluster size in bytes (default: 1 MB)
|
2018-03-06 12:13:58 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsParallels',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'size': 'size',
|
|
|
|
'*cluster-size': 'size' } }
|
|
|
|
|
2018-03-09 19:53:19 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsQcow:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for qcow.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @backing-file: File name of the backing file if a backing file
|
|
|
|
# should be used
|
|
|
|
# @encrypt: Encryption options if the image should be encrypted
|
2018-03-09 19:53:19 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsQcow',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'size': 'size',
|
|
|
|
'*backing-file': 'str',
|
|
|
|
'*encrypt': 'QCryptoBlockCreateOptions' } }
|
|
|
|
|
2017-11-24 16:01:07 +01:00
|
|
|
##
|
|
|
|
# @BlockdevQcow2Version:
|
|
|
|
#
|
|
|
|
# @v2: The original QCOW2 format as introduced in qemu 0.10 (version 2)
|
|
|
|
# @v3: The extended QCOW2 format as introduced in qemu 1.1 (version 3)
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevQcow2Version',
|
|
|
|
'data': [ 'v2', 'v3' ] }
|
|
|
|
|
|
|
|
|
qcow2: introduce compression type feature
The patch adds some preparation parts for incompatible compression type
feature to qcow2 allowing the use different compression methods for
image clusters (de)compressing.
It is implied that the compression type is set on the image creation and
can be changed only later by image conversion, thus compression type
defines the only compression algorithm used for the image, and thus,
for all image clusters.
The goal of the feature is to add support of other compression methods
to qcow2. For example, ZSTD which is more effective on compression than ZLIB.
The default compression is ZLIB. Images created with ZLIB compression type
are backward compatible with older qemu versions.
Adding of the compression type breaks a number of tests because now the
compression type is reported on image creation and there are some changes
in the qcow2 header in size and offsets.
The tests are fixed in the following ways:
* filter out compression_type for many tests
* fix header size, feature table size and backing file offset
affected tests: 031, 036, 061, 080
header_size +=8: 1 byte compression type
7 bytes padding
feature_table += 48: incompatible feature compression type
backing_file_offset += 56 (8 + 48 -> header_change + feature_table_change)
* add "compression type" for test output matching when it isn't filtered
affected tests: 049, 060, 061, 065, 082, 085, 144, 182, 185, 198, 206,
242, 255, 274, 280
Signed-off-by: Denis Plotnikov <dplotnikov@virtuozzo.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
QAPI part:
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200507082521.29210-2-dplotnikov@virtuozzo.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-05-07 10:25:18 +02:00
|
|
|
##
|
|
|
|
# @Qcow2CompressionType:
|
|
|
|
#
|
|
|
|
# Compression type used in qcow2 image file
|
|
|
|
#
|
|
|
|
# @zlib: zlib compression, see <http://zlib.net/>
|
2020-05-07 10:25:20 +02:00
|
|
|
# @zstd: zstd compression, see <http://github.com/facebook/zstd>
|
qcow2: introduce compression type feature
The patch adds some preparation parts for incompatible compression type
feature to qcow2 allowing the use different compression methods for
image clusters (de)compressing.
It is implied that the compression type is set on the image creation and
can be changed only later by image conversion, thus compression type
defines the only compression algorithm used for the image, and thus,
for all image clusters.
The goal of the feature is to add support of other compression methods
to qcow2. For example, ZSTD which is more effective on compression than ZLIB.
The default compression is ZLIB. Images created with ZLIB compression type
are backward compatible with older qemu versions.
Adding of the compression type breaks a number of tests because now the
compression type is reported on image creation and there are some changes
in the qcow2 header in size and offsets.
The tests are fixed in the following ways:
* filter out compression_type for many tests
* fix header size, feature table size and backing file offset
affected tests: 031, 036, 061, 080
header_size +=8: 1 byte compression type
7 bytes padding
feature_table += 48: incompatible feature compression type
backing_file_offset += 56 (8 + 48 -> header_change + feature_table_change)
* add "compression type" for test output matching when it isn't filtered
affected tests: 049, 060, 061, 065, 082, 085, 144, 182, 185, 198, 206,
242, 255, 274, 280
Signed-off-by: Denis Plotnikov <dplotnikov@virtuozzo.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
QAPI part:
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200507082521.29210-2-dplotnikov@virtuozzo.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-05-07 10:25:18 +02:00
|
|
|
#
|
|
|
|
# Since: 5.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'Qcow2CompressionType',
|
2020-05-07 10:25:20 +02:00
|
|
|
'data': [ 'zlib', { 'name': 'zstd', 'if': 'defined(CONFIG_ZSTD)' } ] }
|
qcow2: introduce compression type feature
The patch adds some preparation parts for incompatible compression type
feature to qcow2 allowing the use different compression methods for
image clusters (de)compressing.
It is implied that the compression type is set on the image creation and
can be changed only later by image conversion, thus compression type
defines the only compression algorithm used for the image, and thus,
for all image clusters.
The goal of the feature is to add support of other compression methods
to qcow2. For example, ZSTD which is more effective on compression than ZLIB.
The default compression is ZLIB. Images created with ZLIB compression type
are backward compatible with older qemu versions.
Adding of the compression type breaks a number of tests because now the
compression type is reported on image creation and there are some changes
in the qcow2 header in size and offsets.
The tests are fixed in the following ways:
* filter out compression_type for many tests
* fix header size, feature table size and backing file offset
affected tests: 031, 036, 061, 080
header_size +=8: 1 byte compression type
7 bytes padding
feature_table += 48: incompatible feature compression type
backing_file_offset += 56 (8 + 48 -> header_change + feature_table_change)
* add "compression type" for test output matching when it isn't filtered
affected tests: 049, 060, 061, 065, 082, 085, 144, 182, 185, 198, 206,
242, 255, 274, 280
Signed-off-by: Denis Plotnikov <dplotnikov@virtuozzo.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
QAPI part:
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200507082521.29210-2-dplotnikov@virtuozzo.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-05-07 10:25:18 +02:00
|
|
|
|
2017-11-24 16:01:07 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsQcow2:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for qcow2.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @data-file: Node to use as an external data file in which all guest
|
|
|
|
# data is stored so that only metadata remains in the qcow2
|
|
|
|
# file (since: 4.0)
|
|
|
|
# @data-file-raw: True if the external data file must stay valid as a
|
|
|
|
# standalone (read-only) raw image without looking at qcow2
|
|
|
|
# metadata (default: false; since: 4.0)
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @version: Compatibility level (default: v3)
|
|
|
|
# @backing-file: File name of the backing file if a backing file
|
|
|
|
# should be used
|
|
|
|
# @backing-fmt: Name of the block driver to use for the backing file
|
|
|
|
# @encrypt: Encryption options if the image should be encrypted
|
|
|
|
# @cluster-size: qcow2 cluster size in bytes (default: 65536)
|
|
|
|
# @preallocation: Preallocation mode for the new image (default: off;
|
|
|
|
# allowed values: off, falloc, full, metadata)
|
|
|
|
# @lazy-refcounts: True if refcounts may be updated lazily (default: off)
|
|
|
|
# @refcount-bits: Width of reference counts in bits (default: 16)
|
qcow2: introduce compression type feature
The patch adds some preparation parts for incompatible compression type
feature to qcow2 allowing the use different compression methods for
image clusters (de)compressing.
It is implied that the compression type is set on the image creation and
can be changed only later by image conversion, thus compression type
defines the only compression algorithm used for the image, and thus,
for all image clusters.
The goal of the feature is to add support of other compression methods
to qcow2. For example, ZSTD which is more effective on compression than ZLIB.
The default compression is ZLIB. Images created with ZLIB compression type
are backward compatible with older qemu versions.
Adding of the compression type breaks a number of tests because now the
compression type is reported on image creation and there are some changes
in the qcow2 header in size and offsets.
The tests are fixed in the following ways:
* filter out compression_type for many tests
* fix header size, feature table size and backing file offset
affected tests: 031, 036, 061, 080
header_size +=8: 1 byte compression type
7 bytes padding
feature_table += 48: incompatible feature compression type
backing_file_offset += 56 (8 + 48 -> header_change + feature_table_change)
* add "compression type" for test output matching when it isn't filtered
affected tests: 049, 060, 061, 065, 082, 085, 144, 182, 185, 198, 206,
242, 255, 274, 280
Signed-off-by: Denis Plotnikov <dplotnikov@virtuozzo.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
QAPI part:
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200507082521.29210-2-dplotnikov@virtuozzo.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-05-07 10:25:18 +02:00
|
|
|
# @compression-type: The image cluster compression method
|
|
|
|
# (default: zlib, since 5.1)
|
2017-11-24 16:01:07 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsQcow2',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
2019-01-14 16:57:27 +01:00
|
|
|
'*data-file': 'BlockdevRef',
|
2019-02-22 14:29:38 +01:00
|
|
|
'*data-file-raw': 'bool',
|
2017-11-24 16:01:07 +01:00
|
|
|
'size': 'size',
|
|
|
|
'*version': 'BlockdevQcow2Version',
|
|
|
|
'*backing-file': 'str',
|
|
|
|
'*backing-fmt': 'BlockdevDriver',
|
|
|
|
'*encrypt': 'QCryptoBlockCreateOptions',
|
|
|
|
'*cluster-size': 'size',
|
|
|
|
'*preallocation': 'PreallocMode',
|
|
|
|
'*lazy-refcounts': 'bool',
|
qcow2: introduce compression type feature
The patch adds some preparation parts for incompatible compression type
feature to qcow2 allowing the use different compression methods for
image clusters (de)compressing.
It is implied that the compression type is set on the image creation and
can be changed only later by image conversion, thus compression type
defines the only compression algorithm used for the image, and thus,
for all image clusters.
The goal of the feature is to add support of other compression methods
to qcow2. For example, ZSTD which is more effective on compression than ZLIB.
The default compression is ZLIB. Images created with ZLIB compression type
are backward compatible with older qemu versions.
Adding of the compression type breaks a number of tests because now the
compression type is reported on image creation and there are some changes
in the qcow2 header in size and offsets.
The tests are fixed in the following ways:
* filter out compression_type for many tests
* fix header size, feature table size and backing file offset
affected tests: 031, 036, 061, 080
header_size +=8: 1 byte compression type
7 bytes padding
feature_table += 48: incompatible feature compression type
backing_file_offset += 56 (8 + 48 -> header_change + feature_table_change)
* add "compression type" for test output matching when it isn't filtered
affected tests: 049, 060, 061, 065, 082, 085, 144, 182, 185, 198, 206,
242, 255, 274, 280
Signed-off-by: Denis Plotnikov <dplotnikov@virtuozzo.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
QAPI part:
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200507082521.29210-2-dplotnikov@virtuozzo.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-05-07 10:25:18 +02:00
|
|
|
'*refcount-bits': 'int',
|
|
|
|
'*compression-type':'Qcow2CompressionType' } }
|
2017-11-24 16:01:07 +01:00
|
|
|
|
2018-03-09 19:53:19 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsQed:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for qed.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @backing-file: File name of the backing file if a backing file
|
|
|
|
# should be used
|
|
|
|
# @backing-fmt: Name of the block driver to use for the backing file
|
|
|
|
# @cluster-size: Cluster size in bytes (default: 65536)
|
|
|
|
# @table-size: L1/L2 table size (in clusters)
|
2018-03-09 19:53:19 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsQed',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'size': 'size',
|
|
|
|
'*backing-file': 'str',
|
|
|
|
'*backing-fmt': 'BlockdevDriver',
|
|
|
|
'*cluster-size': 'size',
|
|
|
|
'*table-size': 'int' } }
|
|
|
|
|
2018-01-31 16:27:38 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsRbd:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for rbd/Ceph.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @location: Where to store the new image file. This location cannot
|
|
|
|
# point to a snapshot.
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @cluster-size: RBD object size
|
2018-01-31 16:27:38 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsRbd',
|
|
|
|
'data': { 'location': 'BlockdevOptionsRbd',
|
|
|
|
'size': 'size',
|
|
|
|
'*cluster-size' : 'size' } }
|
|
|
|
|
2018-05-15 17:36:32 +02:00
|
|
|
##
|
|
|
|
# @BlockdevVmdkSubformat:
|
|
|
|
#
|
|
|
|
# Subformat options for VMDK images
|
|
|
|
#
|
|
|
|
# @monolithicSparse: Single file image with sparse cluster allocation
|
|
|
|
#
|
|
|
|
# @monolithicFlat: Single flat data image and a descriptor file
|
|
|
|
#
|
|
|
|
# @twoGbMaxExtentSparse: Data is split into 2GB (per virtual LBA) sparse extent
|
|
|
|
# files, in addition to a descriptor file
|
|
|
|
#
|
|
|
|
# @twoGbMaxExtentFlat: Data is split into 2GB (per virtual LBA) flat extent
|
|
|
|
# files, in addition to a descriptor file
|
|
|
|
#
|
|
|
|
# @streamOptimized: Single file image sparse cluster allocation, optimized
|
|
|
|
# for streaming over network.
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevVmdkSubformat',
|
|
|
|
'data': [ 'monolithicSparse', 'monolithicFlat', 'twoGbMaxExtentSparse',
|
|
|
|
'twoGbMaxExtentFlat', 'streamOptimized'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevVmdkAdapterType:
|
|
|
|
#
|
|
|
|
# Adapter type info for VMDK images
|
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevVmdkAdapterType',
|
|
|
|
'data': [ 'ide', 'buslogic', 'lsilogic', 'legacyESX'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsVmdk:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for VMDK.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Where to store the new image file. This refers to the image
|
|
|
|
# file for monolithcSparse and streamOptimized format, or the
|
|
|
|
# descriptor file for other formats.
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @extents: Where to store the data extents. Required for monolithcFlat,
|
|
|
|
# twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For
|
|
|
|
# monolithicFlat, only one entry is required; for
|
|
|
|
# twoGbMaxExtent* formats, the number of entries required is
|
|
|
|
# calculated as extent_number = virtual_size / 2GB. Providing
|
|
|
|
# more extents than will be used is an error.
|
|
|
|
# @subformat: The subformat of the VMDK image. Default: "monolithicSparse".
|
|
|
|
# @backing-file: The path of backing file. Default: no backing file is used.
|
|
|
|
# @adapter-type: The adapter type used to fill in the descriptor. Default: ide.
|
|
|
|
# @hwversion: Hardware version. The meaningful options are "4" or "6".
|
|
|
|
# Default: "4".
|
|
|
|
# @zeroed-grain: Whether to enable zeroed-grain feature for sparse subformats.
|
|
|
|
# Default: false.
|
2018-05-15 17:36:32 +02:00
|
|
|
#
|
|
|
|
# Since: 4.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsVmdk',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'size': 'size',
|
|
|
|
'*extents': ['BlockdevRef'],
|
|
|
|
'*subformat': 'BlockdevVmdkSubformat',
|
|
|
|
'*backing-file': 'str',
|
|
|
|
'*adapter-type': 'BlockdevVmdkAdapterType',
|
|
|
|
'*hwversion': 'str',
|
|
|
|
'*zeroed-grain': 'bool' } }
|
|
|
|
|
|
|
|
|
2018-02-01 17:26:27 +01:00
|
|
|
##
|
|
|
|
# @SheepdogRedundancyType:
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @full: Create a fully replicated vdi with x copies
|
|
|
|
# @erasure-coded: Create an erasure coded vdi with x data strips and
|
|
|
|
# y parity strips
|
2018-02-01 17:26:27 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'enum': 'SheepdogRedundancyType',
|
|
|
|
'data': [ 'full', 'erasure-coded' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @SheepdogRedundancyFull:
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @copies: Number of copies to use (between 1 and 31)
|
2018-02-01 17:26:27 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'SheepdogRedundancyFull',
|
|
|
|
'data': { 'copies': 'int' }}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @SheepdogRedundancyErasureCoded:
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @data-strips: Number of data strips to use (one of {2,4,8,16})
|
|
|
|
# @parity-strips: Number of parity strips to use (between 1 and 15)
|
2018-02-01 17:26:27 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'SheepdogRedundancyErasureCoded',
|
|
|
|
'data': { 'data-strips': 'int',
|
|
|
|
'parity-strips': 'int' }}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @SheepdogRedundancy:
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'union': 'SheepdogRedundancy',
|
|
|
|
'base': { 'type': 'SheepdogRedundancyType' },
|
|
|
|
'discriminator': 'type',
|
|
|
|
'data': { 'full': 'SheepdogRedundancyFull',
|
|
|
|
'erasure-coded': 'SheepdogRedundancyErasureCoded' } }
|
|
|
|
|
2018-02-01 13:20:44 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsSheepdog:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for Sheepdog.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @location: Where to store the new image file
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @backing-file: File name of a base image
|
|
|
|
# @preallocation: Preallocation mode for the new image (default: off;
|
|
|
|
# allowed values: off, full)
|
|
|
|
# @redundancy: Redundancy of the image
|
|
|
|
# @object-size: Object size of the image
|
2018-02-01 13:20:44 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsSheepdog',
|
|
|
|
'data': { 'location': 'BlockdevOptionsSheepdog',
|
|
|
|
'size': 'size',
|
|
|
|
'*backing-file': 'str',
|
|
|
|
'*preallocation': 'PreallocMode',
|
|
|
|
'*redundancy': 'SheepdogRedundancy',
|
|
|
|
'*object-size': 'size' } }
|
|
|
|
|
2018-02-05 16:24:32 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsSsh:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for SSH.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @location: Where to store the new image file
|
|
|
|
# @size: Size of the virtual disk in bytes
|
2018-02-05 16:24:32 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsSsh',
|
|
|
|
'data': { 'location': 'BlockdevOptionsSsh',
|
|
|
|
'size': 'size' } }
|
|
|
|
|
2018-03-12 17:55:26 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsVdi:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for VDI.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @preallocation: Preallocation mode for the new image (default: off;
|
|
|
|
# allowed values: off, metadata)
|
2018-03-12 17:55:26 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsVdi',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'size': 'size',
|
2018-03-20 15:08:00 +01:00
|
|
|
'*preallocation': 'PreallocMode' } }
|
2018-03-12 17:55:26 +01:00
|
|
|
|
2018-03-09 19:53:19 +01:00
|
|
|
##
|
|
|
|
# @BlockdevVhdxSubformat:
|
|
|
|
#
|
|
|
|
# @dynamic: Growing image file
|
|
|
|
# @fixed: Preallocated fixed-size image file
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevVhdxSubformat',
|
|
|
|
'data': [ 'dynamic', 'fixed' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsVhdx:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for vhdx.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @log-size: Log size in bytes, must be a multiple of 1 MB
|
|
|
|
# (default: 1 MB)
|
|
|
|
# @block-size: Block size in bytes, must be a multiple of 1 MB and not
|
|
|
|
# larger than 256 MB (default: automatically choose a block
|
|
|
|
# size depending on the image size)
|
|
|
|
# @subformat: vhdx subformat (default: dynamic)
|
|
|
|
# @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-standard,
|
|
|
|
# but default. Do not set to 'off' when using 'qemu-img
|
|
|
|
# convert' with subformat=dynamic.
|
2018-03-09 19:53:19 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsVhdx',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'size': 'size',
|
|
|
|
'*log-size': 'size',
|
|
|
|
'*block-size': 'size',
|
|
|
|
'*subformat': 'BlockdevVhdxSubformat',
|
|
|
|
'*block-state-zero': 'bool' } }
|
|
|
|
|
2018-03-09 19:53:19 +01:00
|
|
|
##
|
|
|
|
# @BlockdevVpcSubformat:
|
|
|
|
#
|
|
|
|
# @dynamic: Growing image file
|
|
|
|
# @fixed: Preallocated fixed-size image file
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockdevVpcSubformat',
|
|
|
|
'data': [ 'dynamic', 'fixed' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevCreateOptionsVpc:
|
|
|
|
#
|
|
|
|
# Driver specific image creation options for vpc (VHD).
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @file: Node to create the image format on
|
|
|
|
# @size: Size of the virtual disk in bytes
|
|
|
|
# @subformat: vhdx subformat (default: dynamic)
|
|
|
|
# @force-size: Force use of the exact byte size instead of rounding to the
|
|
|
|
# next size that can be represented in CHS geometry
|
|
|
|
# (default: false)
|
2018-03-09 19:53:19 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevCreateOptionsVpc',
|
|
|
|
'data': { 'file': 'BlockdevRef',
|
|
|
|
'size': 'size',
|
|
|
|
'*subformat': 'BlockdevVpcSubformat',
|
|
|
|
'*force-size': 'bool' } }
|
|
|
|
|
2017-11-24 16:01:07 +01:00
|
|
|
##
|
|
|
|
# @BlockdevCreateOptions:
|
|
|
|
#
|
|
|
|
# Options for creating an image format on a given node.
|
|
|
|
#
|
2020-02-13 18:56:25 +01:00
|
|
|
# @driver: block driver to create the image format
|
2017-11-24 16:01:07 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'union': 'BlockdevCreateOptions',
|
|
|
|
'base': {
|
|
|
|
'driver': 'BlockdevDriver' },
|
|
|
|
'discriminator': 'driver',
|
|
|
|
'data': {
|
2018-01-16 16:04:21 +01:00
|
|
|
'file': 'BlockdevCreateOptionsFile',
|
2018-01-31 16:27:38 +01:00
|
|
|
'gluster': 'BlockdevCreateOptionsGluster',
|
2018-03-02 14:31:04 +01:00
|
|
|
'luks': 'BlockdevCreateOptionsLUKS',
|
2018-01-31 16:27:38 +01:00
|
|
|
'nfs': 'BlockdevCreateOptionsNfs',
|
2018-03-06 12:13:58 +01:00
|
|
|
'parallels': 'BlockdevCreateOptionsParallels',
|
2018-03-09 19:53:19 +01:00
|
|
|
'qcow': 'BlockdevCreateOptionsQcow',
|
2017-11-24 16:01:07 +01:00
|
|
|
'qcow2': 'BlockdevCreateOptionsQcow2',
|
2018-03-09 19:53:19 +01:00
|
|
|
'qed': 'BlockdevCreateOptionsQed',
|
2018-01-31 16:27:38 +01:00
|
|
|
'rbd': 'BlockdevCreateOptionsRbd',
|
2018-02-01 13:20:44 +01:00
|
|
|
'sheepdog': 'BlockdevCreateOptionsSheepdog',
|
2018-02-05 16:24:32 +01:00
|
|
|
'ssh': 'BlockdevCreateOptionsSsh',
|
2018-03-12 17:55:28 +01:00
|
|
|
'vdi': 'BlockdevCreateOptionsVdi',
|
2018-03-09 19:53:19 +01:00
|
|
|
'vhdx': 'BlockdevCreateOptionsVhdx',
|
2018-05-15 17:36:32 +02:00
|
|
|
'vmdk': 'BlockdevCreateOptionsVmdk',
|
2018-06-18 10:40:06 +02:00
|
|
|
'vpc': 'BlockdevCreateOptionsVpc'
|
2017-11-24 16:01:07 +01:00
|
|
|
} }
|
|
|
|
|
2018-01-09 16:50:57 +01:00
|
|
|
##
|
2018-05-25 18:24:51 +02:00
|
|
|
# @blockdev-create:
|
2018-01-09 16:50:57 +01:00
|
|
|
#
|
2018-01-18 14:33:04 +01:00
|
|
|
# Starts a job to create an image format on a given node. The job is
|
|
|
|
# automatically finalized, but a manual job-dismiss is required.
|
2018-01-09 16:50:57 +01:00
|
|
|
#
|
2018-01-18 14:33:04 +01:00
|
|
|
# @job-id: Identifier for the newly created job.
|
|
|
|
#
|
|
|
|
# @options: Options for the image creation.
|
|
|
|
#
|
|
|
|
# Since: 3.0
|
2018-01-09 16:50:57 +01:00
|
|
|
##
|
2018-05-25 18:24:51 +02:00
|
|
|
{ 'command': 'blockdev-create',
|
2018-01-18 14:33:04 +01:00
|
|
|
'data': { 'job-id': 'str',
|
|
|
|
'options': 'BlockdevCreateOptions' } }
|
2018-01-09 16:50:57 +01:00
|
|
|
|
2014-06-18 08:43:30 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BlockErrorAction:
|
2014-06-18 08:43:30 +02:00
|
|
|
#
|
|
|
|
# An enumeration of action that has been taken when a DISK I/O occurs
|
|
|
|
#
|
|
|
|
# @ignore: error has been ignored
|
|
|
|
#
|
|
|
|
# @report: error has been reported to the device
|
|
|
|
#
|
|
|
|
# @stop: error caused VM to be stopped
|
|
|
|
#
|
|
|
|
# Since: 2.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockErrorAction',
|
|
|
|
'data': [ 'ignore', 'report', 'stop' ] }
|
2014-06-18 08:43:45 +02:00
|
|
|
|
|
|
|
|
2014-06-18 08:43:46 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BLOCK_IMAGE_CORRUPTED:
|
2014-06-18 08:43:46 +02:00
|
|
|
#
|
2016-06-23 15:51:26 +02:00
|
|
|
# Emitted when a disk image is being marked corrupt. The image can be
|
|
|
|
# identified by its device or node name. The 'device' field is always
|
|
|
|
# present for compatibility reasons, but it can be empty ("") if the
|
|
|
|
# image does not have a device name associated.
|
2014-06-18 08:43:46 +02:00
|
|
|
#
|
2015-04-08 11:29:20 +02:00
|
|
|
# @device: device name. This is always present for compatibility
|
|
|
|
# reasons, but it can be empty ("") if the image does not
|
|
|
|
# have a device name associated.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @node-name: node name (Since: 2.4)
|
2014-06-18 08:43:46 +02:00
|
|
|
#
|
|
|
|
# @msg: informative message for human consumption, such as the kind of
|
2014-06-25 01:34:00 +02:00
|
|
|
# corruption being detected. It should not be parsed by machine as it is
|
|
|
|
# not guaranteed to be stable
|
2014-06-18 08:43:46 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @offset: if the corruption resulted from an image access, this is
|
2015-05-07 16:58:26 +02:00
|
|
|
# the host's access offset into the image
|
2014-06-18 08:43:46 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @size: if the corruption resulted from an image access, this is
|
2014-06-18 08:43:46 +02:00
|
|
|
# the access size
|
|
|
|
#
|
2016-06-23 15:51:26 +02:00
|
|
|
# @fatal: if set, the image is marked corrupt and therefore unusable after this
|
2020-02-13 18:56:26 +01:00
|
|
|
# event and must be repaired (Since 2.2; before, every
|
|
|
|
# BLOCK_IMAGE_CORRUPTED event was fatal)
|
2014-09-05 16:07:15 +02:00
|
|
|
#
|
2016-06-23 15:52:10 +02:00
|
|
|
# Note: If action is "stop", a STOP event will eventually follow the
|
|
|
|
# BLOCK_IO_ERROR event.
|
|
|
|
#
|
2016-06-23 15:51:26 +02:00
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "BLOCK_IMAGE_CORRUPTED",
|
|
|
|
# "data": { "device": "ide0-hd0", "node-name": "node0",
|
|
|
|
# "msg": "Prevented active L1 table overwrite", "offset": 196608,
|
|
|
|
# "size": 65536 },
|
|
|
|
# "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
|
|
|
|
#
|
2014-06-18 08:43:46 +02:00
|
|
|
# Since: 1.7
|
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_IMAGE_CORRUPTED',
|
2015-04-08 11:29:20 +02:00
|
|
|
'data': { 'device' : 'str',
|
|
|
|
'*node-name' : 'str',
|
|
|
|
'msg' : 'str',
|
|
|
|
'*offset' : 'int',
|
|
|
|
'*size' : 'int',
|
|
|
|
'fatal' : 'bool' } }
|
2014-06-18 08:43:46 +02:00
|
|
|
|
2014-06-18 08:43:45 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BLOCK_IO_ERROR:
|
2014-06-18 08:43:45 +02:00
|
|
|
#
|
|
|
|
# Emitted when a disk I/O error occurs
|
|
|
|
#
|
2016-09-29 16:47:58 +02:00
|
|
|
# @device: device name. This is always present for compatibility
|
|
|
|
# reasons, but it can be empty ("") if the image does not
|
|
|
|
# have a device name associated.
|
|
|
|
#
|
|
|
|
# @node-name: node name. Note that errors may be reported for the root node
|
|
|
|
# that is directly attached to a guest device rather than for the
|
2018-03-05 15:59:35 +01:00
|
|
|
# node where the error occurred. The node name is not present if
|
|
|
|
# the drive is empty. (Since: 2.8)
|
2014-06-18 08:43:45 +02:00
|
|
|
#
|
|
|
|
# @operation: I/O operation
|
|
|
|
#
|
|
|
|
# @action: action that has been taken
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @nospace: true if I/O error was caused due to a no-space
|
2014-08-29 22:07:27 +02:00
|
|
|
# condition. This key is only present if query-block's
|
|
|
|
# io-status is present, please see query-block documentation
|
|
|
|
# for more information (since: 2.2)
|
|
|
|
#
|
2014-09-11 16:25:48 +02:00
|
|
|
# @reason: human readable string describing the error cause.
|
|
|
|
# (This field is a debugging aid for humans, it should not
|
2020-02-13 18:56:26 +01:00
|
|
|
# be parsed by applications) (since: 2.2)
|
2014-09-11 16:25:48 +02:00
|
|
|
#
|
2014-06-18 08:43:45 +02:00
|
|
|
# Note: If action is "stop", a STOP event will eventually follow the
|
2020-02-13 18:56:26 +01:00
|
|
|
# BLOCK_IO_ERROR event
|
2014-06-18 08:43:45 +02:00
|
|
|
#
|
|
|
|
# Since: 0.13.0
|
2016-06-23 15:52:10 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "BLOCK_IO_ERROR",
|
|
|
|
# "data": { "device": "ide0-hd1",
|
|
|
|
# "node-name": "#block212",
|
|
|
|
# "operation": "write",
|
|
|
|
# "action": "stop" },
|
|
|
|
# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
|
|
|
|
#
|
2014-06-18 08:43:45 +02:00
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_IO_ERROR',
|
2018-03-05 15:59:35 +01:00
|
|
|
'data': { 'device': 'str', '*node-name': 'str',
|
|
|
|
'operation': 'IoOperationType',
|
2014-09-11 16:25:48 +02:00
|
|
|
'action': 'BlockErrorAction', '*nospace': 'bool',
|
|
|
|
'reason': 'str' } }
|
2014-06-18 08:43:45 +02:00
|
|
|
|
2014-06-18 08:43:47 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BLOCK_JOB_COMPLETED:
|
2014-06-18 08:43:47 +02:00
|
|
|
#
|
|
|
|
# Emitted when a block job has completed
|
|
|
|
#
|
|
|
|
# @type: job type
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. Originally the device name but other
|
|
|
|
# values are allowed since QEMU 2.7
|
2014-06-18 08:43:47 +02:00
|
|
|
#
|
|
|
|
# @len: maximum progress value
|
|
|
|
#
|
|
|
|
# @offset: current progress value. On success this is equal to len.
|
|
|
|
# On failure this is less than len
|
|
|
|
#
|
|
|
|
# @speed: rate limit, bytes per second
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @error: error message. Only present on failure. This field
|
2014-06-18 08:43:47 +02:00
|
|
|
# contains a human-readable error message. There are no semantics
|
|
|
|
# other than that streaming has failed and clients should not try to
|
|
|
|
# interpret the error string
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
2016-06-23 15:52:56 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "BLOCK_JOB_COMPLETED",
|
|
|
|
# "data": { "type": "stream", "device": "virtio-disk0",
|
|
|
|
# "len": 10737418240, "offset": 10737418240,
|
|
|
|
# "speed": 0 },
|
|
|
|
# "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
|
|
|
|
#
|
2014-06-18 08:43:47 +02:00
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_JOB_COMPLETED',
|
2018-04-12 18:01:07 +02:00
|
|
|
'data': { 'type' : 'JobType',
|
2014-06-18 08:43:47 +02:00
|
|
|
'device': 'str',
|
|
|
|
'len' : 'int',
|
|
|
|
'offset': 'int',
|
|
|
|
'speed' : 'int',
|
|
|
|
'*error': 'str' } }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BLOCK_JOB_CANCELLED:
|
2014-06-18 08:43:47 +02:00
|
|
|
#
|
|
|
|
# Emitted when a block job has been cancelled
|
|
|
|
#
|
|
|
|
# @type: job type
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. Originally the device name but other
|
|
|
|
# values are allowed since QEMU 2.7
|
2014-06-18 08:43:47 +02:00
|
|
|
#
|
|
|
|
# @len: maximum progress value
|
|
|
|
#
|
|
|
|
# @offset: current progress value. On success this is equal to len.
|
|
|
|
# On failure this is less than len
|
|
|
|
#
|
|
|
|
# @speed: rate limit, bytes per second
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
2016-06-23 15:53:50 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "BLOCK_JOB_CANCELLED",
|
|
|
|
# "data": { "type": "stream", "device": "virtio-disk0",
|
|
|
|
# "len": 10737418240, "offset": 134217728,
|
|
|
|
# "speed": 0 },
|
|
|
|
# "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
|
|
|
|
#
|
2014-06-18 08:43:47 +02:00
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_JOB_CANCELLED',
|
2018-04-12 18:01:07 +02:00
|
|
|
'data': { 'type' : 'JobType',
|
2014-06-18 08:43:47 +02:00
|
|
|
'device': 'str',
|
|
|
|
'len' : 'int',
|
|
|
|
'offset': 'int',
|
|
|
|
'speed' : 'int' } }
|
|
|
|
|
2014-06-18 08:43:45 +02:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BLOCK_JOB_ERROR:
|
2014-06-18 08:43:45 +02:00
|
|
|
#
|
|
|
|
# Emitted when a block job encounters an error
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. Originally the device name but other
|
|
|
|
# values are allowed since QEMU 2.7
|
2014-06-18 08:43:45 +02:00
|
|
|
#
|
|
|
|
# @operation: I/O operation
|
|
|
|
#
|
|
|
|
# @action: action that has been taken
|
|
|
|
#
|
|
|
|
# Since: 1.3
|
2016-06-23 15:54:20 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "BLOCK_JOB_ERROR",
|
|
|
|
# "data": { "device": "ide0-hd1",
|
|
|
|
# "operation": "write",
|
|
|
|
# "action": "stop" },
|
|
|
|
# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
|
|
|
|
#
|
2014-06-18 08:43:45 +02:00
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_JOB_ERROR',
|
|
|
|
'data': { 'device' : 'str',
|
|
|
|
'operation': 'IoOperationType',
|
2014-06-27 19:24:14 +02:00
|
|
|
'action' : 'BlockErrorAction' } }
|
2014-06-18 08:43:47 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BLOCK_JOB_READY:
|
2014-06-18 08:43:47 +02:00
|
|
|
#
|
|
|
|
# Emitted when a block job is ready to complete
|
|
|
|
#
|
2014-06-27 19:24:13 +02:00
|
|
|
# @type: job type
|
|
|
|
#
|
2016-07-05 16:29:02 +02:00
|
|
|
# @device: The job identifier. Originally the device name but other
|
|
|
|
# values are allowed since QEMU 2.7
|
2014-06-18 08:43:47 +02:00
|
|
|
#
|
2014-06-27 19:24:13 +02:00
|
|
|
# @len: maximum progress value
|
|
|
|
#
|
|
|
|
# @offset: current progress value. On success this is equal to len.
|
|
|
|
# On failure this is less than len
|
|
|
|
#
|
|
|
|
# @speed: rate limit, bytes per second
|
|
|
|
#
|
2014-06-18 08:43:47 +02:00
|
|
|
# Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
|
2020-02-13 18:56:26 +01:00
|
|
|
# event
|
2014-06-18 08:43:47 +02:00
|
|
|
#
|
|
|
|
# Since: 1.3
|
2016-06-23 15:54:49 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "BLOCK_JOB_READY",
|
|
|
|
# "data": { "device": "drive0", "type": "mirror", "speed": 0,
|
|
|
|
# "len": 2097152, "offset": 2097152 }
|
|
|
|
# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
|
|
|
|
#
|
2014-06-18 08:43:47 +02:00
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_JOB_READY',
|
2018-04-12 18:01:07 +02:00
|
|
|
'data': { 'type' : 'JobType',
|
2014-06-27 19:24:13 +02:00
|
|
|
'device': 'str',
|
|
|
|
'len' : 'int',
|
|
|
|
'offset': 'int',
|
|
|
|
'speed' : 'int' } }
|
2014-09-10 11:05:47 +02:00
|
|
|
|
2018-03-10 09:27:42 +01:00
|
|
|
##
|
|
|
|
# @BLOCK_JOB_PENDING:
|
|
|
|
#
|
|
|
|
# Emitted when a block job is awaiting explicit authorization to finalize graph
|
|
|
|
# changes via @block-job-finalize. If this job is part of a transaction, it will
|
|
|
|
# not emit this event until the transaction has converged first.
|
|
|
|
#
|
|
|
|
# @type: job type
|
|
|
|
#
|
|
|
|
# @id: The job identifier.
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "BLOCK_JOB_WAITING",
|
|
|
|
# "data": { "device": "drive0", "type": "mirror" },
|
|
|
|
# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_JOB_PENDING',
|
2018-04-12 18:01:07 +02:00
|
|
|
'data': { 'type' : 'JobType',
|
2018-03-10 09:27:42 +01:00
|
|
|
'id' : 'str' } }
|
|
|
|
|
2016-11-17 16:54:51 +01:00
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @PreallocMode:
|
2014-09-10 11:05:47 +02:00
|
|
|
#
|
|
|
|
# Preallocation mode of QEMU image file
|
|
|
|
#
|
|
|
|
# @off: no preallocation
|
|
|
|
# @metadata: preallocate only for metadata
|
|
|
|
# @falloc: like @full preallocation but allocate disk space by
|
2019-07-11 15:29:35 +02:00
|
|
|
# posix_fallocate() rather than writing data.
|
|
|
|
# @full: preallocate all data by writing it to the device to ensure
|
|
|
|
# disk space is really available. This data may or may not be
|
|
|
|
# zero, depending on the image format and storage.
|
|
|
|
# @full preallocation also sets up metadata correctly.
|
2014-09-10 11:05:47 +02:00
|
|
|
#
|
2016-11-17 16:54:55 +01:00
|
|
|
# Since: 2.2
|
2014-09-10 11:05:47 +02:00
|
|
|
##
|
|
|
|
{ 'enum': 'PreallocMode',
|
|
|
|
'data': [ 'off', 'metadata', 'falloc', 'full' ] }
|
block: add event when disk usage exceeds threshold
Managing applications, like oVirt (http://www.ovirt.org), make extensive
use of thin-provisioned disk images.
To let the guest run smoothly and be not unnecessarily paused, oVirt sets
a disk usage threshold (so called 'high water mark') based on the occupation
of the device, and automatically extends the image once the threshold
is reached or exceeded.
In order to detect the crossing of the threshold, oVirt has no choice but
aggressively polling the QEMU monitor using the query-blockstats command.
This lead to unnecessary system load, and is made even worse under scale:
deployments with hundreds of VMs are no longer rare.
To fix this, this patch adds:
* A new monitor command `block-set-write-threshold', to set a mark for
a given block device.
* A new event `BLOCK_WRITE_THRESHOLD', to report if a block device
usage exceeds the threshold.
* A new `write_threshold' field into the `BlockDeviceInfo' structure,
to report the configured threshold.
This will allow the managing application to use smarter and more
efficient monitoring, greatly reducing the need of polling.
[Updated qemu-iotests 067 output to add the new 'write_threshold'
property. --Stefan]
[Changed g_assert_false() to !g_assert() to fix the build on older glib
versions. --Kevin]
Signed-off-by: Francesco Romani <fromani@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1421068273-692-1-git-send-email-fromani@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2015-01-12 14:11:13 +01:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @BLOCK_WRITE_THRESHOLD:
|
block: add event when disk usage exceeds threshold
Managing applications, like oVirt (http://www.ovirt.org), make extensive
use of thin-provisioned disk images.
To let the guest run smoothly and be not unnecessarily paused, oVirt sets
a disk usage threshold (so called 'high water mark') based on the occupation
of the device, and automatically extends the image once the threshold
is reached or exceeded.
In order to detect the crossing of the threshold, oVirt has no choice but
aggressively polling the QEMU monitor using the query-blockstats command.
This lead to unnecessary system load, and is made even worse under scale:
deployments with hundreds of VMs are no longer rare.
To fix this, this patch adds:
* A new monitor command `block-set-write-threshold', to set a mark for
a given block device.
* A new event `BLOCK_WRITE_THRESHOLD', to report if a block device
usage exceeds the threshold.
* A new `write_threshold' field into the `BlockDeviceInfo' structure,
to report the configured threshold.
This will allow the managing application to use smarter and more
efficient monitoring, greatly reducing the need of polling.
[Updated qemu-iotests 067 output to add the new 'write_threshold'
property. --Stefan]
[Changed g_assert_false() to !g_assert() to fix the build on older glib
versions. --Kevin]
Signed-off-by: Francesco Romani <fromani@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1421068273-692-1-git-send-email-fromani@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2015-01-12 14:11:13 +01:00
|
|
|
#
|
|
|
|
# Emitted when writes on block device reaches or exceeds the
|
|
|
|
# configured write threshold. For thin-provisioned devices, this
|
|
|
|
# means the device should be extended to avoid pausing for
|
|
|
|
# disk exhaustion.
|
|
|
|
# The event is one shot. Once triggered, it needs to be
|
2017-05-12 21:30:15 +02:00
|
|
|
# re-registered with another block-set-write-threshold command.
|
block: add event when disk usage exceeds threshold
Managing applications, like oVirt (http://www.ovirt.org), make extensive
use of thin-provisioned disk images.
To let the guest run smoothly and be not unnecessarily paused, oVirt sets
a disk usage threshold (so called 'high water mark') based on the occupation
of the device, and automatically extends the image once the threshold
is reached or exceeded.
In order to detect the crossing of the threshold, oVirt has no choice but
aggressively polling the QEMU monitor using the query-blockstats command.
This lead to unnecessary system load, and is made even worse under scale:
deployments with hundreds of VMs are no longer rare.
To fix this, this patch adds:
* A new monitor command `block-set-write-threshold', to set a mark for
a given block device.
* A new event `BLOCK_WRITE_THRESHOLD', to report if a block device
usage exceeds the threshold.
* A new `write_threshold' field into the `BlockDeviceInfo' structure,
to report the configured threshold.
This will allow the managing application to use smarter and more
efficient monitoring, greatly reducing the need of polling.
[Updated qemu-iotests 067 output to add the new 'write_threshold'
property. --Stefan]
[Changed g_assert_false() to !g_assert() to fix the build on older glib
versions. --Kevin]
Signed-off-by: Francesco Romani <fromani@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1421068273-692-1-git-send-email-fromani@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2015-01-12 14:11:13 +01:00
|
|
|
#
|
|
|
|
# @node-name: graph node name on which the threshold was exceeded.
|
|
|
|
#
|
|
|
|
# @amount-exceeded: amount of data which exceeded the threshold, in bytes.
|
|
|
|
#
|
|
|
|
# @write-threshold: last configured threshold, in bytes.
|
|
|
|
#
|
|
|
|
# Since: 2.3
|
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_WRITE_THRESHOLD',
|
|
|
|
'data': { 'node-name': 'str',
|
|
|
|
'amount-exceeded': 'uint64',
|
|
|
|
'write-threshold': 'uint64' } }
|
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @block-set-write-threshold:
|
block: add event when disk usage exceeds threshold
Managing applications, like oVirt (http://www.ovirt.org), make extensive
use of thin-provisioned disk images.
To let the guest run smoothly and be not unnecessarily paused, oVirt sets
a disk usage threshold (so called 'high water mark') based on the occupation
of the device, and automatically extends the image once the threshold
is reached or exceeded.
In order to detect the crossing of the threshold, oVirt has no choice but
aggressively polling the QEMU monitor using the query-blockstats command.
This lead to unnecessary system load, and is made even worse under scale:
deployments with hundreds of VMs are no longer rare.
To fix this, this patch adds:
* A new monitor command `block-set-write-threshold', to set a mark for
a given block device.
* A new event `BLOCK_WRITE_THRESHOLD', to report if a block device
usage exceeds the threshold.
* A new `write_threshold' field into the `BlockDeviceInfo' structure,
to report the configured threshold.
This will allow the managing application to use smarter and more
efficient monitoring, greatly reducing the need of polling.
[Updated qemu-iotests 067 output to add the new 'write_threshold'
property. --Stefan]
[Changed g_assert_false() to !g_assert() to fix the build on older glib
versions. --Kevin]
Signed-off-by: Francesco Romani <fromani@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1421068273-692-1-git-send-email-fromani@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2015-01-12 14:11:13 +01:00
|
|
|
#
|
2016-06-23 15:04:41 +02:00
|
|
|
# Change the write threshold for a block drive. An event will be
|
|
|
|
# delivered if a write to this block drive crosses the configured
|
|
|
|
# threshold. The threshold is an offset, thus must be
|
|
|
|
# non-negative. Default is no write threshold. Setting the threshold
|
|
|
|
# to zero disables it.
|
|
|
|
#
|
block: add event when disk usage exceeds threshold
Managing applications, like oVirt (http://www.ovirt.org), make extensive
use of thin-provisioned disk images.
To let the guest run smoothly and be not unnecessarily paused, oVirt sets
a disk usage threshold (so called 'high water mark') based on the occupation
of the device, and automatically extends the image once the threshold
is reached or exceeded.
In order to detect the crossing of the threshold, oVirt has no choice but
aggressively polling the QEMU monitor using the query-blockstats command.
This lead to unnecessary system load, and is made even worse under scale:
deployments with hundreds of VMs are no longer rare.
To fix this, this patch adds:
* A new monitor command `block-set-write-threshold', to set a mark for
a given block device.
* A new event `BLOCK_WRITE_THRESHOLD', to report if a block device
usage exceeds the threshold.
* A new `write_threshold' field into the `BlockDeviceInfo' structure,
to report the configured threshold.
This will allow the managing application to use smarter and more
efficient monitoring, greatly reducing the need of polling.
[Updated qemu-iotests 067 output to add the new 'write_threshold'
property. --Stefan]
[Changed g_assert_false() to !g_assert() to fix the build on older glib
versions. --Kevin]
Signed-off-by: Francesco Romani <fromani@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1421068273-692-1-git-send-email-fromani@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2015-01-12 14:11:13 +01:00
|
|
|
# This is useful to transparently resize thin-provisioned drives without
|
|
|
|
# the guest OS noticing.
|
|
|
|
#
|
|
|
|
# @node-name: graph node name on which the threshold must be set.
|
|
|
|
#
|
|
|
|
# @write-threshold: configured threshold for the block device, bytes.
|
|
|
|
# Use 0 to disable the threshold.
|
|
|
|
#
|
|
|
|
# Since: 2.3
|
2016-06-23 15:04:41 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "block-set-write-threshold",
|
|
|
|
# "arguments": { "node-name": "mydev",
|
|
|
|
# "write-threshold": 17179869184 } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
block: add event when disk usage exceeds threshold
Managing applications, like oVirt (http://www.ovirt.org), make extensive
use of thin-provisioned disk images.
To let the guest run smoothly and be not unnecessarily paused, oVirt sets
a disk usage threshold (so called 'high water mark') based on the occupation
of the device, and automatically extends the image once the threshold
is reached or exceeded.
In order to detect the crossing of the threshold, oVirt has no choice but
aggressively polling the QEMU monitor using the query-blockstats command.
This lead to unnecessary system load, and is made even worse under scale:
deployments with hundreds of VMs are no longer rare.
To fix this, this patch adds:
* A new monitor command `block-set-write-threshold', to set a mark for
a given block device.
* A new event `BLOCK_WRITE_THRESHOLD', to report if a block device
usage exceeds the threshold.
* A new `write_threshold' field into the `BlockDeviceInfo' structure,
to report the configured threshold.
This will allow the managing application to use smarter and more
efficient monitoring, greatly reducing the need of polling.
[Updated qemu-iotests 067 output to add the new 'write_threshold'
property. --Stefan]
[Changed g_assert_false() to !g_assert() to fix the build on older glib
versions. --Kevin]
Signed-off-by: Francesco Romani <fromani@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-id: 1421068273-692-1-git-send-email-fromani@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2015-01-12 14:11:13 +01:00
|
|
|
##
|
|
|
|
{ 'command': 'block-set-write-threshold',
|
|
|
|
'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }
|
2016-05-10 09:36:39 +02:00
|
|
|
|
|
|
|
##
|
2016-11-17 16:54:55 +01:00
|
|
|
# @x-blockdev-change:
|
2016-05-10 09:36:39 +02:00
|
|
|
#
|
|
|
|
# Dynamically reconfigure the block driver state graph. It can be used
|
|
|
|
# to add, remove, insert or replace a graph node. Currently only the
|
|
|
|
# Quorum driver implements this feature to add or remove its child. This
|
|
|
|
# is useful to fix a broken quorum child.
|
|
|
|
#
|
|
|
|
# If @node is specified, it will be inserted under @parent. @child
|
|
|
|
# may not be specified in this case. If both @parent and @child are
|
|
|
|
# specified but @node is not, @child will be detached from @parent.
|
|
|
|
#
|
|
|
|
# @parent: the id or name of the parent node.
|
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @child: the name of a child under the given parent node.
|
2016-05-10 09:36:39 +02:00
|
|
|
#
|
2017-03-15 13:57:06 +01:00
|
|
|
# @node: the name of the node that will be added.
|
2016-05-10 09:36:39 +02:00
|
|
|
#
|
|
|
|
# Note: this command is experimental, and its API is not stable. It
|
2020-02-13 18:56:26 +01:00
|
|
|
# does not support all kinds of operations, all kinds of children, nor
|
|
|
|
# all block drivers.
|
2016-05-10 09:36:39 +02:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# FIXME Removing children from a quorum node means introducing gaps in the
|
|
|
|
# child indices. This cannot be represented in the 'children' list of
|
|
|
|
# BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename().
|
2017-12-15 11:54:22 +01:00
|
|
|
#
|
2020-02-13 18:56:26 +01:00
|
|
|
# Warning: The data in a new quorum child MUST be consistent with that of
|
|
|
|
# the rest of the array.
|
2016-05-10 09:36:39 +02:00
|
|
|
#
|
|
|
|
# Since: 2.7
|
2016-06-23 15:28:23 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# 1. Add a new node to a quorum
|
|
|
|
# -> { "execute": "blockdev-add",
|
|
|
|
# "arguments": {
|
2017-05-23 19:44:20 +02:00
|
|
|
# "driver": "raw",
|
|
|
|
# "node-name": "new_node",
|
|
|
|
# "file": { "driver": "file",
|
|
|
|
# "filename": "test.raw" } } }
|
2016-06-23 15:28:23 +02:00
|
|
|
# <- { "return": {} }
|
|
|
|
# -> { "execute": "x-blockdev-change",
|
|
|
|
# "arguments": { "parent": "disk1",
|
|
|
|
# "node": "new_node" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
# 2. Delete a quorum's node
|
|
|
|
# -> { "execute": "x-blockdev-change",
|
|
|
|
# "arguments": { "parent": "disk1",
|
|
|
|
# "child": "children.1" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2016-05-10 09:36:39 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'x-blockdev-change',
|
|
|
|
'data' : { 'parent': 'str',
|
|
|
|
'*child': 'str',
|
|
|
|
'*node': 'str' } }
|
2017-12-06 15:45:49 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @x-blockdev-set-iothread:
|
|
|
|
#
|
|
|
|
# Move @node and its children into the @iothread. If @iothread is null then
|
|
|
|
# move @node and its children into the main loop.
|
|
|
|
#
|
|
|
|
# The node must not be attached to a BlockBackend.
|
|
|
|
#
|
|
|
|
# @node-name: the name of the block driver node
|
|
|
|
#
|
|
|
|
# @iothread: the name of the IOThread object or null for the main loop
|
|
|
|
#
|
2017-12-07 21:13:17 +01:00
|
|
|
# @force: true if the node and its children should be moved when a BlockBackend
|
|
|
|
# is already attached
|
|
|
|
#
|
2017-12-06 15:45:49 +01:00
|
|
|
# Note: this command is experimental and intended for test cases that need
|
2020-02-13 18:56:26 +01:00
|
|
|
# control over IOThreads only.
|
2017-12-06 15:45:49 +01:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# 1. Move a node into an IOThread
|
|
|
|
# -> { "execute": "x-blockdev-set-iothread",
|
|
|
|
# "arguments": { "node-name": "disk1",
|
|
|
|
# "iothread": "iothread0" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
# 2. Move a node into the main loop
|
|
|
|
# -> { "execute": "x-blockdev-set-iothread",
|
|
|
|
# "arguments": { "node-name": "disk1",
|
|
|
|
# "iothread": null } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'x-blockdev-set-iothread',
|
|
|
|
'data' : { 'node-name': 'str',
|
2017-12-07 21:13:17 +01:00
|
|
|
'iothread': 'StrOrNull',
|
|
|
|
'*force': 'bool' } }
|
2020-02-24 15:29:52 +01:00
|
|
|
|
2020-02-24 15:29:57 +01:00
|
|
|
##
|
|
|
|
# @NbdServerOptions:
|
|
|
|
#
|
|
|
|
# @addr: Address on which to listen.
|
|
|
|
# @tls-creds: ID of the TLS credentials object (since 2.6).
|
|
|
|
# @tls-authz: ID of the QAuthZ authorization object used to validate
|
|
|
|
# the client's x509 distinguished name. This object is
|
|
|
|
# is only resolved at time of use, so can be deleted and
|
|
|
|
# recreated on the fly while the NBD server is active.
|
|
|
|
# If missing, it will default to denying access (since 4.0).
|
|
|
|
#
|
|
|
|
# Keep this type consistent with the nbd-server-start arguments. The only
|
|
|
|
# intended difference is using SocketAddress instead of SocketAddressLegacy.
|
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'NbdServerOptions',
|
|
|
|
'data': { 'addr': 'SocketAddress',
|
|
|
|
'*tls-creds': 'str',
|
|
|
|
'*tls-authz': 'str'} }
|
|
|
|
|
2020-02-24 15:29:52 +01:00
|
|
|
##
|
|
|
|
# @nbd-server-start:
|
|
|
|
#
|
|
|
|
# Start an NBD server listening on the given host and port. Block
|
|
|
|
# devices can then be exported using @nbd-server-add. The NBD
|
|
|
|
# server will present them as named exports; for example, another
|
|
|
|
# QEMU instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
|
|
|
|
#
|
|
|
|
# @addr: Address on which to listen.
|
|
|
|
# @tls-creds: ID of the TLS credentials object (since 2.6).
|
|
|
|
# @tls-authz: ID of the QAuthZ authorization object used to validate
|
|
|
|
# the client's x509 distinguished name. This object is
|
|
|
|
# is only resolved at time of use, so can be deleted and
|
|
|
|
# recreated on the fly while the NBD server is active.
|
|
|
|
# If missing, it will default to denying access (since 4.0).
|
|
|
|
#
|
|
|
|
# Returns: error if the server is already running.
|
|
|
|
#
|
2020-02-24 15:29:57 +01:00
|
|
|
# Keep this type consistent with the NbdServerOptions type. The only intended
|
|
|
|
# difference is using SocketAddressLegacy instead of SocketAddress.
|
|
|
|
#
|
2020-02-24 15:29:52 +01:00
|
|
|
# Since: 1.3.0
|
|
|
|
##
|
|
|
|
{ 'command': 'nbd-server-start',
|
|
|
|
'data': { 'addr': 'SocketAddressLegacy',
|
|
|
|
'*tls-creds': 'str',
|
|
|
|
'*tls-authz': 'str'} }
|
|
|
|
|
|
|
|
##
|
2020-02-24 15:29:58 +01:00
|
|
|
# @BlockExportNbd:
|
2020-02-24 15:29:52 +01:00
|
|
|
#
|
2020-02-24 15:29:58 +01:00
|
|
|
# An NBD block export.
|
2020-02-24 15:29:52 +01:00
|
|
|
#
|
|
|
|
# @device: The device name or node name of the node to be exported
|
|
|
|
#
|
|
|
|
# @name: Export name. If unspecified, the @device parameter is used as the
|
|
|
|
# export name. (Since 2.12)
|
|
|
|
#
|
|
|
|
# @description: Free-form description of the export, up to 4096 bytes.
|
|
|
|
# (Since 5.0)
|
|
|
|
#
|
|
|
|
# @writable: Whether clients should be able to write to the device via the
|
|
|
|
# NBD connection (default false).
|
|
|
|
#
|
|
|
|
# @bitmap: Also export the dirty bitmap reachable from @device, so the
|
|
|
|
# NBD client can use NBD_OPT_SET_META_CONTEXT with
|
|
|
|
# "qemu:dirty-bitmap:NAME" to inspect the bitmap. (since 4.0)
|
|
|
|
#
|
2020-02-24 15:29:58 +01:00
|
|
|
# Since: 5.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockExportNbd',
|
|
|
|
'data': {'device': 'str', '*name': 'str', '*description': 'str',
|
|
|
|
'*writable': 'bool', '*bitmap': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @nbd-server-add:
|
|
|
|
#
|
|
|
|
# Export a block node to QEMU's embedded NBD server.
|
|
|
|
#
|
2020-02-24 15:29:52 +01:00
|
|
|
# Returns: error if the server is not running, or export with the same name
|
|
|
|
# already exists.
|
|
|
|
#
|
|
|
|
# Since: 1.3.0
|
|
|
|
##
|
|
|
|
{ 'command': 'nbd-server-add',
|
2020-02-24 15:29:58 +01:00
|
|
|
'data': 'BlockExportNbd', 'boxed': true }
|
2020-02-24 15:29:52 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @NbdServerRemoveMode:
|
|
|
|
#
|
|
|
|
# Mode for removing an NBD export.
|
|
|
|
#
|
|
|
|
# @safe: Remove export if there are no existing connections, fail otherwise.
|
|
|
|
#
|
|
|
|
# @hard: Drop all connections immediately and remove export.
|
|
|
|
#
|
|
|
|
# Potential additional modes to be added in the future:
|
|
|
|
#
|
|
|
|
# hide: Just hide export from new clients, leave existing connections as is.
|
|
|
|
# Remove export after all clients are disconnected.
|
|
|
|
#
|
|
|
|
# soft: Hide export from new clients, answer with ESHUTDOWN for all further
|
|
|
|
# requests from existing clients.
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{'enum': 'NbdServerRemoveMode', 'data': ['safe', 'hard']}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @nbd-server-remove:
|
|
|
|
#
|
|
|
|
# Remove NBD export by name.
|
|
|
|
#
|
|
|
|
# @name: Export name.
|
|
|
|
#
|
|
|
|
# @mode: Mode of command operation. See @NbdServerRemoveMode description.
|
|
|
|
# Default is 'safe'.
|
|
|
|
#
|
|
|
|
# Returns: error if
|
|
|
|
# - the server is not running
|
|
|
|
# - export is not found
|
|
|
|
# - mode is 'safe' and there are existing connections
|
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'command': 'nbd-server-remove',
|
|
|
|
'data': {'name': 'str', '*mode': 'NbdServerRemoveMode'} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @nbd-server-stop:
|
|
|
|
#
|
|
|
|
# Stop QEMU's embedded NBD server, and unregister all devices previously
|
|
|
|
# added via @nbd-server-add.
|
|
|
|
#
|
|
|
|
# Since: 1.3.0
|
|
|
|
##
|
|
|
|
{ 'command': 'nbd-server-stop' }
|
|
|
|
|
2020-02-24 15:29:59 +01:00
|
|
|
##
|
|
|
|
# @BlockExportType:
|
|
|
|
#
|
|
|
|
# An enumeration of block export types
|
|
|
|
#
|
|
|
|
# @nbd: NBD export
|
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockExportType',
|
|
|
|
'data': [ 'nbd' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockExport:
|
|
|
|
#
|
|
|
|
# Describes a block export, i.e. how single node should be exported on an
|
|
|
|
# external interface.
|
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'union': 'BlockExport',
|
|
|
|
'base': { 'type': 'BlockExportType' },
|
|
|
|
'discriminator': 'type',
|
|
|
|
'data': {
|
|
|
|
'nbd': 'BlockExportNbd'
|
|
|
|
} }
|
|
|
|
|
2020-02-24 15:29:52 +01:00
|
|
|
##
|
|
|
|
# @QuorumOpType:
|
|
|
|
#
|
|
|
|
# An enumeration of the quorum operation types
|
|
|
|
#
|
|
|
|
# @read: read operation
|
|
|
|
#
|
|
|
|
# @write: write operation
|
|
|
|
#
|
|
|
|
# @flush: flush operation
|
|
|
|
#
|
|
|
|
# Since: 2.6
|
|
|
|
##
|
|
|
|
{ 'enum': 'QuorumOpType',
|
|
|
|
'data': [ 'read', 'write', 'flush' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @QUORUM_FAILURE:
|
|
|
|
#
|
|
|
|
# Emitted by the Quorum block driver if it fails to establish a quorum
|
|
|
|
#
|
|
|
|
# @reference: device name if defined else node name
|
|
|
|
#
|
|
|
|
# @sector-num: number of the first sector of the failed read operation
|
|
|
|
#
|
|
|
|
# @sectors-count: failed read operation sector count
|
|
|
|
#
|
|
|
|
# Note: This event is rate-limited.
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "event": "QUORUM_FAILURE",
|
|
|
|
# "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
|
|
|
|
# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'event': 'QUORUM_FAILURE',
|
|
|
|
'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @QUORUM_REPORT_BAD:
|
|
|
|
#
|
|
|
|
# Emitted to report a corruption of a Quorum file
|
|
|
|
#
|
|
|
|
# @type: quorum operation type (Since 2.6)
|
|
|
|
#
|
|
|
|
# @error: error message. Only present on failure. This field
|
|
|
|
# contains a human-readable error message. There are no semantics other
|
|
|
|
# than that the block layer reported an error and clients should not
|
|
|
|
# try to interpret the error string.
|
|
|
|
#
|
|
|
|
# @node-name: the graph node name of the block driver state
|
|
|
|
#
|
|
|
|
# @sector-num: number of the first sector of the failed read operation
|
|
|
|
#
|
|
|
|
# @sectors-count: failed read operation sector count
|
|
|
|
#
|
|
|
|
# Note: This event is rate-limited.
|
|
|
|
#
|
|
|
|
# Since: 2.0
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# 1. Read operation
|
|
|
|
#
|
|
|
|
# { "event": "QUORUM_REPORT_BAD",
|
|
|
|
# "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5,
|
|
|
|
# "type": "read" },
|
|
|
|
# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
|
|
|
|
#
|
|
|
|
# 2. Flush operation
|
|
|
|
#
|
|
|
|
# { "event": "QUORUM_REPORT_BAD",
|
|
|
|
# "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120,
|
|
|
|
# "type": "flush", "error": "Broken pipe" },
|
|
|
|
# "timestamp": { "seconds": 1456406829, "microseconds": 291763 } }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'event': 'QUORUM_REPORT_BAD',
|
|
|
|
'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str',
|
|
|
|
'sector-num': 'int', 'sectors-count': 'int' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockdevSnapshotInternal:
|
|
|
|
#
|
|
|
|
# @device: the device name or node-name of a root node to generate the snapshot
|
|
|
|
# from
|
|
|
|
#
|
|
|
|
# @name: the name of the internal snapshot to be created
|
|
|
|
#
|
|
|
|
# Notes: In transaction, if @name is empty, or any snapshot matching @name
|
|
|
|
# exists, the operation will fail. Only some image formats support it,
|
|
|
|
# for example, qcow2, rbd, and sheepdog.
|
|
|
|
#
|
|
|
|
# Since: 1.7
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockdevSnapshotInternal',
|
|
|
|
'data': { 'device': 'str', 'name': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @blockdev-snapshot-internal-sync:
|
|
|
|
#
|
|
|
|
# Synchronously take an internal snapshot of a block device, when the
|
|
|
|
# format of the image used supports it. If the name is an empty
|
|
|
|
# string, or a snapshot with name already exists, the operation will
|
|
|
|
# fail.
|
|
|
|
#
|
|
|
|
# For the arguments, see the documentation of BlockdevSnapshotInternal.
|
|
|
|
#
|
|
|
|
# Returns: - nothing on success
|
|
|
|
# - If @device is not a valid block device, GenericError
|
|
|
|
# - If any snapshot matching @name exists, or @name is empty,
|
|
|
|
# GenericError
|
|
|
|
# - If the format of the image used does not support it,
|
|
|
|
# BlockFormatFeatureNotSupported
|
|
|
|
#
|
|
|
|
# Since: 1.7
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "blockdev-snapshot-internal-sync",
|
|
|
|
# "arguments": { "device": "ide-hd0",
|
|
|
|
# "name": "snapshot0" }
|
|
|
|
# }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'blockdev-snapshot-internal-sync',
|
|
|
|
'data': 'BlockdevSnapshotInternal' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @blockdev-snapshot-delete-internal-sync:
|
|
|
|
#
|
|
|
|
# Synchronously delete an internal snapshot of a block device, when the format
|
|
|
|
# of the image used support it. The snapshot is identified by name or id or
|
|
|
|
# both. One of the name or id is required. Return SnapshotInfo for the
|
|
|
|
# successfully deleted snapshot.
|
|
|
|
#
|
|
|
|
# @device: the device name or node-name of a root node to delete the snapshot
|
|
|
|
# from
|
|
|
|
#
|
|
|
|
# @id: optional the snapshot's ID to be deleted
|
|
|
|
#
|
|
|
|
# @name: optional the snapshot's name to be deleted
|
|
|
|
#
|
|
|
|
# Returns: - SnapshotInfo on success
|
|
|
|
# - If @device is not a valid block device, GenericError
|
|
|
|
# - If snapshot not found, GenericError
|
|
|
|
# - If the format of the image used does not support it,
|
|
|
|
# BlockFormatFeatureNotSupported
|
|
|
|
# - If @id and @name are both not specified, GenericError
|
|
|
|
#
|
|
|
|
# Since: 1.7
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "blockdev-snapshot-delete-internal-sync",
|
|
|
|
# "arguments": { "device": "ide-hd0",
|
|
|
|
# "name": "snapshot0" }
|
|
|
|
# }
|
|
|
|
# <- { "return": {
|
|
|
|
# "id": "1",
|
|
|
|
# "name": "snapshot0",
|
|
|
|
# "vm-state-size": 0,
|
|
|
|
# "date-sec": 1000012,
|
|
|
|
# "date-nsec": 10,
|
|
|
|
# "vm-clock-sec": 100,
|
|
|
|
# "vm-clock-nsec": 20
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'blockdev-snapshot-delete-internal-sync',
|
|
|
|
'data': { 'device': 'str', '*id': 'str', '*name': 'str'},
|
|
|
|
'returns': 'SnapshotInfo' }
|