3 # QAPI block core definitions (vm unrelated)
5 # QAPI common definitions
6 { 'include': 'common.json' }
11 # @id: unique snapshot id
13 # @name: user chosen name
15 # @vm-state-size: size of the VM state
17 # @date-sec: UTC date of the snapshot in seconds
19 # @date-nsec: fractional part in nano seconds to be used with date-sec
21 # @vm-clock-sec: VM clock relative to boot in seconds
23 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
29 { 'type': 'SnapshotInfo',
30 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
31 'date-sec': 'int', 'date-nsec': 'int',
32 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
35 # @ImageInfoSpecificQCow2:
37 # @compat: compatibility level
39 # @lazy-refcounts: #optional on or off; only valid for compat >= 1.1
43 { 'type': 'ImageInfoSpecificQCow2',
46 '*lazy-refcounts': 'bool'
50 # @ImageInfoSpecificVmdk:
52 # @create-type: The create type of VMDK image
54 # @cid: Content id of image
56 # @parent-cid: Parent VMDK image's cid
58 # @extents: List of extent files
62 { 'type': 'ImageInfoSpecificVmdk',
67 'extents': ['ImageInfo']
73 # A discriminated record of image format specific information structures.
78 { 'union': 'ImageInfoSpecific',
80 'qcow2': 'ImageInfoSpecificQCow2',
81 'vmdk': 'ImageInfoSpecificVmdk'
87 # Information about a QEMU image file
89 # @filename: name of the image file
91 # @format: format of the image file
93 # @virtual-size: maximum capacity in bytes of the image
95 # @actual-size: #optional actual size on disk in bytes of the image
97 # @dirty-flag: #optional true if image is not cleanly closed
99 # @cluster-size: #optional size of a cluster in bytes
101 # @encrypted: #optional true if the image is encrypted
103 # @compressed: #optional true if the image is compressed (Since 1.7)
105 # @backing-filename: #optional name of the backing file
107 # @full-backing-filename: #optional full path of the backing file
109 # @backing-filename-format: #optional the format of the backing file
111 # @snapshots: #optional list of VM snapshots
113 # @backing-image: #optional info of the backing image (since 1.6)
115 # @format-specific: #optional structure supplying additional format-specific
116 # information (since 1.7)
122 { 'type': 'ImageInfo',
123 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
124 '*actual-size': 'int', 'virtual-size': 'int',
125 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
126 '*backing-filename': 'str', '*full-backing-filename': 'str',
127 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
128 '*backing-image': 'ImageInfo',
129 '*format-specific': 'ImageInfoSpecific' } }
134 # Information about a QEMU image file check
136 # @filename: name of the image file checked
138 # @format: format of the image file checked
140 # @check-errors: number of unexpected errors occurred during check
142 # @image-end-offset: #optional offset (in bytes) where the image ends, this
143 # field is present if the driver for the image format
146 # @corruptions: #optional number of corruptions found during the check if any
148 # @leaks: #optional number of leaks found during the check if any
150 # @corruptions-fixed: #optional number of corruptions fixed during the check
153 # @leaks-fixed: #optional number of leaks fixed during the check if any
155 # @total-clusters: #optional total number of clusters, this field is present
156 # if the driver for the image format supports it
158 # @allocated-clusters: #optional total number of allocated clusters, this
159 # field is present if the driver for the image format
162 # @fragmented-clusters: #optional total number of fragmented clusters, this
163 # field is present if the driver for the image format
166 # @compressed-clusters: #optional total number of compressed clusters, this
167 # field is present if the driver for the image format
174 { 'type': 'ImageCheck',
175 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
176 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
177 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
178 '*total-clusters': 'int', '*allocated-clusters': 'int',
179 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
184 # Information about the backing device for a block device.
186 # @file: the filename of the backing device
188 # @node-name: #optional the name of the block driver node (Since 2.0)
190 # @ro: true if the backing device was open read-only
192 # @drv: the name of the block format used to open the backing device. As of
193 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
194 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
195 # 'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
196 # 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
198 # @backing_file: #optional the name of the backing file (for copy-on-write)
200 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
202 # @encrypted: true if the backing device is encrypted
204 # @encryption_key_missing: true if the backing device is encrypted but an
205 # valid encryption key is missing
207 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
209 # @bps: total throughput limit in bytes per second is specified
211 # @bps_rd: read throughput limit in bytes per second is specified
213 # @bps_wr: write throughput limit in bytes per second is specified
215 # @iops: total I/O operations per second is specified
217 # @iops_rd: read I/O operations per second is specified
219 # @iops_wr: write I/O operations per second is specified
221 # @image: the info of image used (since: 1.6)
223 # @bps_max: #optional total max in bytes (Since 1.7)
225 # @bps_rd_max: #optional read max in bytes (Since 1.7)
227 # @bps_wr_max: #optional write max in bytes (Since 1.7)
229 # @iops_max: #optional total I/O operations max (Since 1.7)
231 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
233 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
235 # @iops_size: #optional an I/O size in bytes (Since 1.7)
240 { 'type': 'BlockDeviceInfo',
241 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
242 '*backing_file': 'str', 'backing_file_depth': 'int',
243 'encrypted': 'bool', 'encryption_key_missing': 'bool',
244 'detect_zeroes': 'BlockdevDetectZeroesOptions',
245 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
246 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
247 'image': 'ImageInfo',
248 '*bps_max': 'int', '*bps_rd_max': 'int',
249 '*bps_wr_max': 'int', '*iops_max': 'int',
250 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
251 '*iops_size': 'int' } }
254 # @BlockDeviceIoStatus:
256 # An enumeration of block device I/O status.
258 # @ok: The last I/O operation has succeeded
260 # @failed: The last I/O operation has failed
262 # @nospace: The last I/O operation has failed due to a no-space condition
266 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
269 # @BlockDeviceMapEntry:
271 # Entry in the metadata map of the device (returned by "qemu-img map")
273 # @start: Offset in the image of the first byte described by this entry
276 # @length: Length of the range described by this entry (in bytes)
278 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
279 # before reaching one for which the range is allocated. The value is
280 # in the range 0 to the depth of the image chain - 1.
282 # @zero: the sectors in this range read as zeros
284 # @data: reading the image will actually read data from a file (in particular,
285 # if @offset is present this means that the sectors are not simply
286 # preallocated, but contain actual data in raw format)
288 # @offset: if present, the image file stores the data for this range in
289 # raw format at the given offset.
293 { 'type': 'BlockDeviceMapEntry',
294 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
295 'data': 'bool', '*offset': 'int' } }
300 # Block dirty bitmap information.
302 # @count: number of dirty bytes according to the dirty bitmap
304 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
308 { 'type': 'BlockDirtyInfo',
309 'data': {'count': 'int', 'granularity': 'int'} }
314 # Block device information. This structure describes a virtual device and
315 # the backing device associated with it.
317 # @device: The device name associated with the virtual device.
319 # @type: This field is returned only for compatibility reasons, it should
320 # not be used (always returns 'unknown')
322 # @removable: True if the device supports removable media.
324 # @locked: True if the guest has locked this device from having its media
327 # @tray_open: #optional True if the device has a tray and it is open
328 # (only present if removable is true)
330 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
331 # driver has one or more dirty bitmaps) (Since 2.0)
333 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
334 # supports it and the VM is configured to stop on errors
336 # @inserted: #optional @BlockDeviceInfo describing the device if media is
341 { 'type': 'BlockInfo',
342 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
343 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
344 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
345 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
350 # Get a list of BlockInfo for all virtual block devices.
352 # Returns: a list of @BlockInfo describing each virtual block device
356 { 'command': 'query-block', 'returns': ['BlockInfo'] }
361 # Statistics of a virtual block device or a block backing device.
363 # @rd_bytes: The number of bytes read by the device.
365 # @wr_bytes: The number of bytes written by the device.
367 # @rd_operations: The number of read operations performed by the device.
369 # @wr_operations: The number of write operations performed by the device.
371 # @flush_operations: The number of cache flush operations performed by the
372 # device (since 0.15.0)
374 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
377 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
379 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
381 # @wr_highest_offset: The offset after the greatest byte written to the
382 # device. The intended use of this information is for
383 # growable sparse files (like qcow2) that are used on top
384 # of a physical device.
388 { 'type': 'BlockDeviceStats',
389 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
390 'wr_operations': 'int', 'flush_operations': 'int',
391 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
392 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int' } }
397 # Statistics of a virtual block device or a block backing device.
399 # @device: #optional If the stats are for a virtual block device, the name
400 # corresponding to the virtual block device.
402 # @stats: A @BlockDeviceStats for the device.
404 # @parent: #optional This describes the file block device if it has one.
406 # @backing: #optional This describes the backing block device if it has one.
411 { 'type': 'BlockStats',
412 'data': {'*device': 'str', 'stats': 'BlockDeviceStats',
413 '*parent': 'BlockStats',
414 '*backing': 'BlockStats'} }
419 # Query the @BlockStats for all virtual block devices.
421 # Returns: A list of @BlockStats for each virtual block devices.
425 { 'command': 'query-blockstats', 'returns': ['BlockStats'] }
430 # An enumeration of possible behaviors for errors on I/O operations.
431 # The exact meaning depends on whether the I/O was initiated by a guest
434 # @report: for guest operations, report the error to the guest;
435 # for jobs, cancel the job
437 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
438 # or BLOCK_JOB_ERROR)
440 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
442 # @stop: for guest operations, stop the virtual machine;
443 # for jobs, pause the job
447 { 'enum': 'BlockdevOnError',
448 'data': ['report', 'ignore', 'enospc', 'stop'] }
453 # An enumeration of possible behaviors for the initial synchronization
454 # phase of storage mirroring.
456 # @top: copies data in the topmost image to the destination
458 # @full: copies data from all images to the destination
460 # @none: only copy data written from now on
464 { 'enum': 'MirrorSyncMode',
465 'data': ['top', 'full', 'none'] }
470 # Type of a block job.
472 # @commit: block commit job type, see "block-commit"
474 # @stream: block stream job type, see "block-stream"
476 # @mirror: drive mirror job type, see "drive-mirror"
478 # @backup: drive backup job type, see "drive-backup"
482 { 'enum': 'BlockJobType',
483 'data': ['commit', 'stream', 'mirror', 'backup'] }
488 # Information about a long-running block device operation.
490 # @type: the job type ('stream' for image streaming)
492 # @device: the block device name
494 # @len: the maximum progress value
496 # @busy: false if the job is known to be in a quiescent state, with
497 # no pending I/O. Since 1.3.
499 # @paused: whether the job is paused or, if @busy is true, will
500 # pause itself as soon as possible. Since 1.3.
502 # @offset: the current progress value
504 # @speed: the rate limit, bytes per second
506 # @io-status: the status of the job (since 1.3)
510 { 'type': 'BlockJobInfo',
511 'data': {'type': 'str', 'device': 'str', 'len': 'int',
512 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
513 'io-status': 'BlockDeviceIoStatus'} }
518 # Return information about long-running block device operations.
520 # Returns: a list of @BlockJobInfo for each active block job
524 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
529 # This command sets the password of a block device that has not been open
530 # with a password and requires one.
532 # The two cases where this can happen are a block device is created through
533 # QEMU's initial command line or a block device is changed through the legacy
536 # In the event that the block device is created through the initial command
537 # line, the VM will start in the stopped state regardless of whether '-S' is
538 # used. The intention is for a management tool to query the block devices to
539 # determine which ones are encrypted, set the passwords with this command, and
540 # then start the guest with the @cont command.
542 # Either @device or @node-name must be set but not both.
544 # @device: #optional the name of the block backend device to set the password on
546 # @node-name: #optional graph node name to set the password on (Since 2.0)
548 # @password: the password to use for the device
550 # Returns: nothing on success
551 # If @device is not a valid block device, DeviceNotFound
552 # If @device is not encrypted, DeviceNotEncrypted
554 # Notes: Not all block formats support encryption and some that do are not
555 # able to validate that a password is correct. Disk corruption may
556 # occur if an invalid password is specified.
560 { 'command': 'block_passwd', 'data': {'*device': 'str',
561 '*node-name': 'str', 'password': 'str'} }
566 # Resize a block image while a guest is running.
568 # Either @device or @node-name must be set but not both.
570 # @device: #optional the name of the device to get the image resized
572 # @node-name: #optional graph node name to get the image resized (Since 2.0)
574 # @size: new image size in bytes
576 # Returns: nothing on success
577 # If @device is not a valid block device, DeviceNotFound
581 { 'command': 'block_resize', 'data': { '*device': 'str',
588 # An enumeration that tells QEMU how to set the backing file path in
591 # @existing: QEMU should look for an existing image file.
593 # @absolute-paths: QEMU should create a new image with absolute paths
594 # for the backing file. If there is no backing file available, the new
595 # image will not be backed either.
599 { 'enum': 'NewImageMode',
600 'data': [ 'existing', 'absolute-paths' ] }
605 # Either @device or @node-name must be set but not both.
607 # @device: #optional the name of the device to generate the snapshot from.
609 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
611 # @snapshot-file: the target of the new image. A new file will be created.
613 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
615 # @format: #optional the format of the snapshot image, default is 'qcow2'.
617 # @mode: #optional whether and how QEMU should create a new image, default is
620 { 'type': 'BlockdevSnapshot',
621 'data': { '*device': 'str', '*node-name': 'str',
622 'snapshot-file': 'str', '*snapshot-node-name': 'str',
623 '*format': 'str', '*mode': 'NewImageMode' } }
628 # @device: the name of the device which should be copied.
630 # @target: the target of the new image. If the file exists, or if it
631 # is a device, the existing file/device will be used as the new
632 # destination. If it does not exist, a new file will be created.
634 # @format: #optional the format of the new destination, default is to
635 # probe if @mode is 'existing', else the format of the source
637 # @sync: what parts of the disk image should be copied to the destination
638 # (all the disk, only the sectors allocated in the topmost image, or
641 # @mode: #optional whether and how QEMU should create a new image, default is
644 # @speed: #optional the maximum speed, in bytes per second
646 # @on-source-error: #optional the action to take on an error on the source,
647 # default 'report'. 'stop' and 'enospc' can only be used
648 # if the block device supports io-status (see BlockInfo).
650 # @on-target-error: #optional the action to take on an error on the target,
651 # default 'report' (no limitations, since this applies to
652 # a different block device than @device).
654 # Note that @on-source-error and @on-target-error only affect background I/O.
655 # If an error occurs during a guest write request, the device's rerror/werror
656 # actions will be used.
660 { 'type': 'DriveBackup',
661 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
662 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
664 '*on-source-error': 'BlockdevOnError',
665 '*on-target-error': 'BlockdevOnError' } }
668 # @blockdev-snapshot-sync
670 # Generates a synchronous snapshot of a block device.
672 # For the arguments, see the documentation of BlockdevSnapshot.
674 # Returns: nothing on success
675 # If @device is not a valid block device, DeviceNotFound
679 { 'command': 'blockdev-snapshot-sync',
680 'data': 'BlockdevSnapshot' }
685 # Live commit of data from overlay image nodes into backing nodes - i.e.,
686 # writes data between 'top' and 'base' into 'base'.
688 # @device: the name of the device
690 # @base: #optional The file name of the backing image to write data into.
691 # If not specified, this is the deepest backing image
693 # @top: #optional The file name of the backing image within the image chain,
694 # which contains the topmost data to be committed down. If
695 # not specified, this is the active layer.
697 # If top == base, that is an error.
698 # If top == active, the job will not be completed by itself,
699 # user needs to complete the job with the block-job-complete
700 # command after getting the ready event. (Since 2.0)
702 # If the base image is smaller than top, then the base image
703 # will be resized to be the same size as top. If top is
704 # smaller than the base image, the base will not be
705 # truncated. If you want the base image size to match the
706 # size of the smaller top, you can safely truncate it
707 # yourself once the commit operation successfully completes.
710 # @speed: #optional the maximum speed, in bytes per second
712 # Returns: Nothing on success
713 # If commit or stream is already active on this device, DeviceInUse
714 # If @device does not exist, DeviceNotFound
715 # If image commit is not supported by this device, NotSupported
716 # If @base or @top is invalid, a generic error is returned
717 # If @speed is invalid, InvalidParameter
722 { 'command': 'block-commit',
723 'data': { 'device': 'str', '*base': 'str', '*top': 'str',
729 # Start a point-in-time copy of a block device to a new destination. The
730 # status of ongoing drive-backup operations can be checked with
731 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
732 # The operation can be stopped before it has completed using the
733 # block-job-cancel command.
735 # For the arguments, see the documentation of DriveBackup.
737 # Returns: nothing on success
738 # If @device is not a valid block device, DeviceNotFound
742 { 'command': 'drive-backup', 'data': 'DriveBackup' }
745 # @query-named-block-nodes
747 # Get the named block driver list
749 # Returns: the list of BlockDeviceInfo
753 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
758 # Start mirroring a block device's writes to a new destination.
760 # @device: the name of the device whose writes should be mirrored.
762 # @target: the target of the new image. If the file exists, or if it
763 # is a device, the existing file/device will be used as the new
764 # destination. If it does not exist, a new file will be created.
766 # @format: #optional the format of the new destination, default is to
767 # probe if @mode is 'existing', else the format of the source
769 # @node-name: #optional the new block driver state node name in the graph
772 # @replaces: #optional with sync=full graph node name to be replaced by the new
773 # image when a whole image copy is done. This can be used to repair
774 # broken Quorum files. (Since 2.1)
776 # @mode: #optional whether and how QEMU should create a new image, default is
779 # @speed: #optional the maximum speed, in bytes per second
781 # @sync: what parts of the disk image should be copied to the destination
782 # (all the disk, only the sectors allocated in the topmost image, or
785 # @granularity: #optional granularity of the dirty bitmap, default is 64K
786 # if the image format doesn't have clusters, 4K if the clusters
787 # are smaller than that, else the cluster size. Must be a
788 # power of 2 between 512 and 64M (since 1.4).
790 # @buf-size: #optional maximum amount of data in flight from source to
791 # target (since 1.4).
793 # @on-source-error: #optional the action to take on an error on the source,
794 # default 'report'. 'stop' and 'enospc' can only be used
795 # if the block device supports io-status (see BlockInfo).
797 # @on-target-error: #optional the action to take on an error on the target,
798 # default 'report' (no limitations, since this applies to
799 # a different block device than @device).
801 # Returns: nothing on success
802 # If @device is not a valid block device, DeviceNotFound
806 { 'command': 'drive-mirror',
807 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
808 '*node-name': 'str', '*replaces': 'str',
809 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
810 '*speed': 'int', '*granularity': 'uint32',
811 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
812 '*on-target-error': 'BlockdevOnError' } }
815 # @block_set_io_throttle:
817 # Change I/O throttle limits for a block drive.
819 # @device: The name of the device
821 # @bps: total throughput limit in bytes per second
823 # @bps_rd: read throughput limit in bytes per second
825 # @bps_wr: write throughput limit in bytes per second
827 # @iops: total I/O operations per second
829 # @ops_rd: read I/O operations per second
831 # @iops_wr: write I/O operations per second
833 # @bps_max: #optional total max in bytes (Since 1.7)
835 # @bps_rd_max: #optional read max in bytes (Since 1.7)
837 # @bps_wr_max: #optional write max in bytes (Since 1.7)
839 # @iops_max: #optional total I/O operations max (Since 1.7)
841 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
843 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
845 # @iops_size: #optional an I/O size in bytes (Since 1.7)
847 # Returns: Nothing on success
848 # If @device is not a valid block device, DeviceNotFound
852 { 'command': 'block_set_io_throttle',
853 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
854 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
855 '*bps_max': 'int', '*bps_rd_max': 'int',
856 '*bps_wr_max': 'int', '*iops_max': 'int',
857 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
858 '*iops_size': 'int' } }
863 # Copy data from a backing file into a block device.
865 # The block streaming operation is performed in the background until the entire
866 # backing file has been copied. This command returns immediately once streaming
867 # has started. The status of ongoing block streaming operations can be checked
868 # with query-block-jobs. The operation can be stopped before it has completed
869 # using the block-job-cancel command.
871 # If a base file is specified then sectors are not copied from that base file and
872 # its backing chain. When streaming completes the image file will have the base
873 # file as its backing file. This can be used to stream a subset of the backing
874 # file chain instead of flattening the entire image.
876 # On successful completion the image file is updated to drop the backing file
877 # and the BLOCK_JOB_COMPLETED event is emitted.
879 # @device: the device name
881 # @base: #optional the common backing file name
883 # @speed: #optional the maximum speed, in bytes per second
885 # @on-error: #optional the action to take on an error (default report).
886 # 'stop' and 'enospc' can only be used if the block device
887 # supports io-status (see BlockInfo). Since 1.3.
889 # Returns: Nothing on success
890 # If @device does not exist, DeviceNotFound
894 { 'command': 'block-stream',
895 'data': { 'device': 'str', '*base': 'str', '*speed': 'int',
896 '*on-error': 'BlockdevOnError' } }
899 # @block-job-set-speed:
901 # Set maximum speed for a background block operation.
903 # This command can only be issued when there is an active block job.
905 # Throttling can be disabled by setting the speed to 0.
907 # @device: the device name
909 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
912 # Returns: Nothing on success
913 # If no background operation is active on this device, DeviceNotActive
917 { 'command': 'block-job-set-speed',
918 'data': { 'device': 'str', 'speed': 'int' } }
923 # Stop an active background block operation.
925 # This command returns immediately after marking the active background block
926 # operation for cancellation. It is an error to call this command if no
927 # operation is in progress.
929 # The operation will cancel as soon as possible and then emit the
930 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
931 # enumerated using query-block-jobs.
933 # For streaming, the image file retains its backing file unless the streaming
934 # operation happens to complete just as it is being cancelled. A new streaming
935 # operation can be started at a later time to finish copying all data from the
938 # @device: the device name
940 # @force: #optional whether to allow cancellation of a paused job (default
943 # Returns: Nothing on success
944 # If no background operation is active on this device, DeviceNotActive
948 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
953 # Pause an active background block operation.
955 # This command returns immediately after marking the active background block
956 # operation for pausing. It is an error to call this command if no
957 # operation is in progress. Pausing an already paused job has no cumulative
958 # effect; a single block-job-resume command will resume the job.
960 # The operation will pause as soon as possible. No event is emitted when
961 # the operation is actually paused. Cancelling a paused job automatically
964 # @device: the device name
966 # Returns: Nothing on success
967 # If no background operation is active on this device, DeviceNotActive
971 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
976 # Resume an active background block operation.
978 # This command returns immediately after resuming a paused background block
979 # operation. It is an error to call this command if no operation is in
980 # progress. Resuming an already running job is not an error.
982 # This command also clears the error status of the job.
984 # @device: the device name
986 # Returns: Nothing on success
987 # If no background operation is active on this device, DeviceNotActive
991 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
994 # @block-job-complete:
996 # Manually trigger completion of an active background block operation. This
997 # is supported for drive mirroring, where it also switches the device to
998 # write to the target path only. The ability to complete is signaled with
999 # a BLOCK_JOB_READY event.
1001 # This command completes an active background block operation synchronously.
1002 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1003 # is not defined. Note that if an I/O error occurs during the processing of
1004 # this command: 1) the command itself will fail; 2) the error will be processed
1005 # according to the rerror/werror arguments that were specified when starting
1008 # A cancelled or paused job cannot be completed.
1010 # @device: the device name
1012 # Returns: Nothing on success
1013 # If no background operation is active on this device, DeviceNotActive
1017 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1020 # @BlockdevDiscardOptions
1022 # Determines how to handle discard requests.
1024 # @ignore: Ignore the request
1025 # @unmap: Forward as an unmap request
1029 { 'enum': 'BlockdevDiscardOptions',
1030 'data': [ 'ignore', 'unmap' ] }
1033 # @BlockdevDetectZeroesOptions
1035 # Describes the operation mode for the automatic conversion of plain
1036 # zero writes by the OS to driver specific optimized zero write commands.
1038 # @off: Disabled (default)
1040 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1041 # also that @BlockdevDiscardOptions is set to unmap for this device.
1045 { 'enum': 'BlockdevDetectZeroesOptions',
1046 'data': [ 'off', 'on', 'unmap' ] }
1049 # @BlockdevAioOptions
1051 # Selects the AIO backend to handle I/O requests
1053 # @threads: Use qemu's thread pool
1054 # @native: Use native AIO backend (only Linux and Windows)
1058 { 'enum': 'BlockdevAioOptions',
1059 'data': [ 'threads', 'native' ] }
1062 # @BlockdevCacheOptions
1064 # Includes cache-related options for block devices
1066 # @writeback: #optional enables writeback mode for any caches (default: true)
1067 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1069 # @no-flush: #optional ignore any flush requests for the device (default:
1074 { 'type': 'BlockdevCacheOptions',
1075 'data': { '*writeback': 'bool',
1077 '*no-flush': 'bool' } }
1082 # Drivers that are supported in block device operations.
1084 # @host_device, @host_cdrom, @host_floppy: Since 2.1
1088 { 'enum': 'BlockdevDriver',
1089 'data': [ 'file', 'host_device', 'host_cdrom', 'host_floppy',
1090 'http', 'https', 'ftp', 'ftps', 'tftp', 'vvfat', 'blkdebug',
1091 'blkverify', 'bochs', 'cloop', 'cow', 'dmg', 'parallels', 'qcow',
1092 'qcow2', 'qed', 'raw', 'vdi', 'vhdx', 'vmdk', 'vpc', 'quorum' ] }
1095 # @BlockdevOptionsBase
1097 # Options that are available for all block devices, independent of the block
1100 # @driver: block driver name
1101 # @id: #optional id by which the new block device can be referred to.
1102 # This is a required option on the top level of blockdev-add, and
1103 # currently not allowed on any other level.
1104 # @node-name: #optional the name of a block driver state node (Since 2.0)
1105 # @discard: #optional discard-related options (default: ignore)
1106 # @cache: #optional cache-related options
1107 # @aio: #optional AIO backend (default: threads)
1108 # @rerror: #optional how to handle read errors on the device
1110 # @werror: #optional how to handle write errors on the device
1112 # @read-only: #optional whether the block device should be read-only
1114 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
1119 { 'type': 'BlockdevOptionsBase',
1120 'data': { 'driver': 'BlockdevDriver',
1122 '*node-name': 'str',
1123 '*discard': 'BlockdevDiscardOptions',
1124 '*cache': 'BlockdevCacheOptions',
1125 '*aio': 'BlockdevAioOptions',
1126 '*rerror': 'BlockdevOnError',
1127 '*werror': 'BlockdevOnError',
1128 '*read-only': 'bool',
1129 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } }
1132 # @BlockdevOptionsFile
1134 # Driver specific block device options for the file backend and similar
1137 # @filename: path to the image file
1141 { 'type': 'BlockdevOptionsFile',
1142 'data': { 'filename': 'str' } }
1145 # @BlockdevOptionsVVFAT
1147 # Driver specific block device options for the vvfat protocol.
1149 # @dir: directory to be exported as FAT image
1150 # @fat-type: #optional FAT type: 12, 16 or 32
1151 # @floppy: #optional whether to export a floppy image (true) or
1152 # partitioned hard disk (false; default)
1153 # @rw: #optional whether to allow write operations (default: false)
1157 { 'type': 'BlockdevOptionsVVFAT',
1158 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1162 # @BlockdevOptionsGenericFormat
1164 # Driver specific block device options for image format that have no option
1165 # besides their data source.
1167 # @file: reference to or definition of the data source block device
1171 { 'type': 'BlockdevOptionsGenericFormat',
1172 'data': { 'file': 'BlockdevRef' } }
1175 # @BlockdevOptionsGenericCOWFormat
1177 # Driver specific block device options for image format that have no option
1178 # besides their data source and an optional backing file.
1180 # @backing: #optional reference to or definition of the backing file block
1181 # device (if missing, taken from the image file content). It is
1182 # allowed to pass an empty string here in order to disable the
1183 # default backing file.
1187 { 'type': 'BlockdevOptionsGenericCOWFormat',
1188 'base': 'BlockdevOptionsGenericFormat',
1189 'data': { '*backing': 'BlockdevRef' } }
1192 # @BlockdevOptionsQcow2
1194 # Driver specific block device options for qcow2.
1196 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1197 # feature (default is taken from the image file)
1199 # @pass-discard-request: #optional whether discard requests to the qcow2
1200 # device should be forwarded to the data source
1202 # @pass-discard-snapshot: #optional whether discard requests for the data source
1203 # should be issued when a snapshot operation (e.g.
1204 # deleting a snapshot) frees clusters in the qcow2 file
1206 # @pass-discard-other: #optional whether discard requests for the data source
1207 # should be issued on other occasions where a cluster
1212 { 'type': 'BlockdevOptionsQcow2',
1213 'base': 'BlockdevOptionsGenericCOWFormat',
1214 'data': { '*lazy-refcounts': 'bool',
1215 '*pass-discard-request': 'bool',
1216 '*pass-discard-snapshot': 'bool',
1217 '*pass-discard-other': 'bool' } }
1222 # Trigger events supported by blkdebug.
1224 { 'enum': 'BlkdebugEvent',
1225 'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table',
1226 'l1_grow.activate_table', 'l2_load', 'l2_update',
1227 'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write',
1228 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1229 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1230 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1231 'refblock_load', 'refblock_update', 'refblock_update_part',
1232 'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write',
1233 'refblock_alloc.write_blocks', 'refblock_alloc.write_table',
1234 'refblock_alloc.switch_table', 'cluster_alloc',
1235 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
1239 # @BlkdebugInjectErrorOptions
1241 # Describes a single error injection for blkdebug.
1243 # @event: trigger event
1245 # @state: #optional the state identifier blkdebug needs to be in to
1246 # actually trigger the event; defaults to "any"
1248 # @errno: #optional error identifier (errno) to be returned; defaults to
1251 # @sector: #optional specifies the sector index which has to be affected
1252 # in order to actually trigger the event; defaults to "any
1255 # @once: #optional disables further events after this one has been
1256 # triggered; defaults to false
1258 # @immediately: #optional fail immediately; defaults to false
1262 { 'type': 'BlkdebugInjectErrorOptions',
1263 'data': { 'event': 'BlkdebugEvent',
1268 '*immediately': 'bool' } }
1271 # @BlkdebugSetStateOptions
1273 # Describes a single state-change event for blkdebug.
1275 # @event: trigger event
1277 # @state: #optional the current state identifier blkdebug needs to be in;
1280 # @new_state: the state identifier blkdebug is supposed to assume if
1281 # this event is triggered
1285 { 'type': 'BlkdebugSetStateOptions',
1286 'data': { 'event': 'BlkdebugEvent',
1288 'new_state': 'int' } }
1291 # @BlockdevOptionsBlkdebug
1293 # Driver specific block device options for blkdebug.
1295 # @image: underlying raw block device (or image file)
1297 # @config: #optional filename of the configuration file
1299 # @align: #optional required alignment for requests in bytes
1301 # @inject-error: #optional array of error injection descriptions
1303 # @set-state: #optional array of state-change descriptions
1307 { 'type': 'BlockdevOptionsBlkdebug',
1308 'data': { 'image': 'BlockdevRef',
1311 '*inject-error': ['BlkdebugInjectErrorOptions'],
1312 '*set-state': ['BlkdebugSetStateOptions'] } }
1315 # @BlockdevOptionsBlkverify
1317 # Driver specific block device options for blkverify.
1319 # @test: block device to be tested
1321 # @raw: raw image used for verification
1325 { 'type': 'BlockdevOptionsBlkverify',
1326 'data': { 'test': 'BlockdevRef',
1327 'raw': 'BlockdevRef' } }
1330 # @BlockdevOptionsQuorum
1332 # Driver specific block device options for Quorum
1334 # @blkverify: #optional true if the driver must print content mismatch
1335 # set to false by default
1337 # @children: the children block devices to use
1339 # @vote-threshold: the vote limit under which a read will fail
1341 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
1346 { 'type': 'BlockdevOptionsQuorum',
1347 'data': { '*blkverify': 'bool',
1348 'children': [ 'BlockdevRef' ],
1349 'vote-threshold': 'int', '*rewrite-corrupted': 'bool' } }
1354 # Options for creating a block device.
1358 { 'union': 'BlockdevOptions',
1359 'base': 'BlockdevOptionsBase',
1360 'discriminator': 'driver',
1362 'file': 'BlockdevOptionsFile',
1363 'host_device':'BlockdevOptionsFile',
1364 'host_cdrom': 'BlockdevOptionsFile',
1365 'host_floppy':'BlockdevOptionsFile',
1366 'http': 'BlockdevOptionsFile',
1367 'https': 'BlockdevOptionsFile',
1368 'ftp': 'BlockdevOptionsFile',
1369 'ftps': 'BlockdevOptionsFile',
1370 'tftp': 'BlockdevOptionsFile',
1371 # TODO gluster: Wait for structured options
1372 # TODO iscsi: Wait for structured options
1373 # TODO nbd: Should take InetSocketAddress for 'host'?
1374 # TODO nfs: Wait for structured options
1375 # TODO rbd: Wait for structured options
1376 # TODO sheepdog: Wait for structured options
1377 # TODO ssh: Should take InetSocketAddress for 'host'?
1378 'vvfat': 'BlockdevOptionsVVFAT',
1379 'blkdebug': 'BlockdevOptionsBlkdebug',
1380 'blkverify': 'BlockdevOptionsBlkverify',
1381 'bochs': 'BlockdevOptionsGenericFormat',
1382 'cloop': 'BlockdevOptionsGenericFormat',
1383 'cow': 'BlockdevOptionsGenericCOWFormat',
1384 'dmg': 'BlockdevOptionsGenericFormat',
1385 'parallels': 'BlockdevOptionsGenericFormat',
1386 'qcow': 'BlockdevOptionsGenericCOWFormat',
1387 'qcow2': 'BlockdevOptionsQcow2',
1388 'qed': 'BlockdevOptionsGenericCOWFormat',
1389 'raw': 'BlockdevOptionsGenericFormat',
1390 'vdi': 'BlockdevOptionsGenericFormat',
1391 'vhdx': 'BlockdevOptionsGenericFormat',
1392 'vmdk': 'BlockdevOptionsGenericCOWFormat',
1393 'vpc': 'BlockdevOptionsGenericFormat',
1394 'quorum': 'BlockdevOptionsQuorum'
1400 # Reference to a block device.
1402 # @definition: defines a new block device inline
1403 # @reference: references the ID of an existing block device. An
1404 # empty string means that no block device should be
1409 { 'union': 'BlockdevRef',
1410 'discriminator': {},
1411 'data': { 'definition': 'BlockdevOptions',
1412 'reference': 'str' } }
1417 # Creates a new block device.
1419 # @options: block device options for the new device
1423 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }
1429 # An enumeration of action that has been taken when a DISK I/O occurs
1431 # @ignore: error has been ignored
1433 # @report: error has been reported to the device
1435 # @stop: error caused VM to be stopped
1439 { 'enum': 'BlockErrorAction',
1440 'data': [ 'ignore', 'report', 'stop' ] }
1444 # @BLOCK_IMAGE_CORRUPTED
1446 # Emitted when a disk image is being marked corrupt
1448 # @device: device name
1450 # @msg: informative message for human consumption, such as the kind of
1451 # corruption being detected. It should not be parsed by machine as it is
1452 # not guaranteed to be stable
1454 # @offset: #optional, if the corruption resulted from an image access, this is
1455 # the access offset into the image
1457 # @size: #optional, if the corruption resulted from an image access, this is
1462 { 'event': 'BLOCK_IMAGE_CORRUPTED',
1463 'data': { 'device' : 'str',
1471 # Emitted when a disk I/O error occurs
1473 # @device: device name
1475 # @operation: I/O operation
1477 # @action: action that has been taken
1479 # Note: If action is "stop", a STOP event will eventually follow the
1480 # BLOCK_IO_ERROR event
1484 { 'event': 'BLOCK_IO_ERROR',
1485 'data': { 'device': 'str', 'operation': 'IoOperationType',
1486 'action': 'BlockErrorAction' } }
1489 # @BLOCK_JOB_COMPLETED
1491 # Emitted when a block job has completed
1495 # @device: device name
1497 # @len: maximum progress value
1499 # @offset: current progress value. On success this is equal to len.
1500 # On failure this is less than len
1502 # @speed: rate limit, bytes per second
1504 # @error: #optional, error message. Only present on failure. This field
1505 # contains a human-readable error message. There are no semantics
1506 # other than that streaming has failed and clients should not try to
1507 # interpret the error string
1511 { 'event': 'BLOCK_JOB_COMPLETED',
1512 'data': { 'type' : 'BlockJobType',
1520 # @BLOCK_JOB_CANCELLED
1522 # Emitted when a block job has been cancelled
1526 # @device: device name
1528 # @len: maximum progress value
1530 # @offset: current progress value. On success this is equal to len.
1531 # On failure this is less than len
1533 # @speed: rate limit, bytes per second
1537 { 'event': 'BLOCK_JOB_CANCELLED',
1538 'data': { 'type' : 'BlockJobType',
1547 # Emitted when a block job encounters an error
1549 # @device: device name
1551 # @operation: I/O operation
1553 # @action: action that has been taken
1557 { 'event': 'BLOCK_JOB_ERROR',
1558 'data': { 'device' : 'str',
1559 'operation': 'IoOperationType',
1560 'action' : 'BlockErrorAction' } }
1565 # Emitted when a block job is ready to complete
1569 # @device: device name
1571 # @len: maximum progress value
1573 # @offset: current progress value. On success this is equal to len.
1574 # On failure this is less than len
1576 # @speed: rate limit, bytes per second
1578 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
1583 { 'event': 'BLOCK_JOB_READY',
1584 'data': { 'type' : 'BlockJobType',