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 { 'struct': '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
41 # @corrupt: #optional true if the image has been marked corrupt; only valid for
42 # compat >= 1.1 (since 2.2)
44 # @refcount-bits: width of a refcount entry in bits (since 2.3)
48 { 'struct': 'ImageInfoSpecificQCow2',
51 '*lazy-refcounts': 'bool',
53 'refcount-bits': 'int'
57 # @ImageInfoSpecificVmdk:
59 # @create-type: The create type of VMDK image
61 # @cid: Content id of image
63 # @parent-cid: Parent VMDK image's cid
65 # @extents: List of extent files
69 { 'struct': 'ImageInfoSpecificVmdk',
74 'extents': ['ImageInfo']
80 # A discriminated record of image format specific information structures.
85 { 'union': 'ImageInfoSpecific',
87 'qcow2': 'ImageInfoSpecificQCow2',
88 'vmdk': 'ImageInfoSpecificVmdk'
94 # Information about a QEMU image file
96 # @filename: name of the image file
98 # @format: format of the image file
100 # @virtual-size: maximum capacity in bytes of the image
102 # @actual-size: #optional actual size on disk in bytes of the image
104 # @dirty-flag: #optional true if image is not cleanly closed
106 # @cluster-size: #optional size of a cluster in bytes
108 # @encrypted: #optional true if the image is encrypted
110 # @compressed: #optional true if the image is compressed (Since 1.7)
112 # @backing-filename: #optional name of the backing file
114 # @full-backing-filename: #optional full path of the backing file
116 # @backing-filename-format: #optional the format of the backing file
118 # @snapshots: #optional list of VM snapshots
120 # @backing-image: #optional info of the backing image (since 1.6)
122 # @format-specific: #optional structure supplying additional format-specific
123 # information (since 1.7)
129 { 'struct': 'ImageInfo',
130 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
131 '*actual-size': 'int', 'virtual-size': 'int',
132 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
133 '*backing-filename': 'str', '*full-backing-filename': 'str',
134 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
135 '*backing-image': 'ImageInfo',
136 '*format-specific': 'ImageInfoSpecific' } }
141 # Information about a QEMU image file check
143 # @filename: name of the image file checked
145 # @format: format of the image file checked
147 # @check-errors: number of unexpected errors occurred during check
149 # @image-end-offset: #optional offset (in bytes) where the image ends, this
150 # field is present if the driver for the image format
153 # @corruptions: #optional number of corruptions found during the check if any
155 # @leaks: #optional number of leaks found during the check if any
157 # @corruptions-fixed: #optional number of corruptions fixed during the check
160 # @leaks-fixed: #optional number of leaks fixed during the check if any
162 # @total-clusters: #optional total number of clusters, this field is present
163 # if the driver for the image format supports it
165 # @allocated-clusters: #optional total number of allocated clusters, this
166 # field is present if the driver for the image format
169 # @fragmented-clusters: #optional total number of fragmented clusters, this
170 # field is present if the driver for the image format
173 # @compressed-clusters: #optional total number of compressed clusters, this
174 # field is present if the driver for the image format
181 { 'struct': 'ImageCheck',
182 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
183 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
184 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
185 '*total-clusters': 'int', '*allocated-clusters': 'int',
186 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
191 # Cache mode information for a block device
193 # @writeback: true if writeback mode is enabled
194 # @direct: true if the host page cache is bypassed (O_DIRECT)
195 # @no-flush: true if flush requests are ignored for the device
199 { 'struct': 'BlockdevCacheInfo',
200 'data': { 'writeback': 'bool',
202 'no-flush': 'bool' } }
207 # Information about the backing device for a block device.
209 # @file: the filename of the backing device
211 # @node-name: #optional the name of the block driver node (Since 2.0)
213 # @ro: true if the backing device was open read-only
215 # @drv: the name of the block format used to open the backing device. As of
216 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
217 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
218 # 'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
219 # 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
220 # 2.2: 'archipelago' added, 'cow' dropped
221 # 2.3: 'host_floppy' deprecated
223 # @backing_file: #optional the name of the backing file (for copy-on-write)
225 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
227 # @encrypted: true if the backing device is encrypted
229 # @encryption_key_missing: true if the backing device is encrypted but an
230 # valid encryption key is missing
232 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
234 # @bps: total throughput limit in bytes per second is specified
236 # @bps_rd: read throughput limit in bytes per second is specified
238 # @bps_wr: write throughput limit in bytes per second is specified
240 # @iops: total I/O operations per second is specified
242 # @iops_rd: read I/O operations per second is specified
244 # @iops_wr: write I/O operations per second is specified
246 # @image: the info of image used (since: 1.6)
248 # @bps_max: #optional total max in bytes (Since 1.7)
250 # @bps_rd_max: #optional read max in bytes (Since 1.7)
252 # @bps_wr_max: #optional write max in bytes (Since 1.7)
254 # @iops_max: #optional total I/O operations max (Since 1.7)
256 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
258 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
260 # @iops_size: #optional an I/O size in bytes (Since 1.7)
262 # @cache: the cache mode used for the block device (since: 2.3)
264 # @write_threshold: configured write threshold for the device.
265 # 0 if disabled. (Since 2.3)
270 { 'struct': 'BlockDeviceInfo',
271 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
272 '*backing_file': 'str', 'backing_file_depth': 'int',
273 'encrypted': 'bool', 'encryption_key_missing': 'bool',
274 'detect_zeroes': 'BlockdevDetectZeroesOptions',
275 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
276 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
277 'image': 'ImageInfo',
278 '*bps_max': 'int', '*bps_rd_max': 'int',
279 '*bps_wr_max': 'int', '*iops_max': 'int',
280 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
281 '*iops_size': 'int', 'cache': 'BlockdevCacheInfo',
282 'write_threshold': 'int' } }
285 # @BlockDeviceIoStatus:
287 # An enumeration of block device I/O status.
289 # @ok: The last I/O operation has succeeded
291 # @failed: The last I/O operation has failed
293 # @nospace: The last I/O operation has failed due to a no-space condition
297 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
300 # @BlockDeviceMapEntry:
302 # Entry in the metadata map of the device (returned by "qemu-img map")
304 # @start: Offset in the image of the first byte described by this entry
307 # @length: Length of the range described by this entry (in bytes)
309 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
310 # before reaching one for which the range is allocated. The value is
311 # in the range 0 to the depth of the image chain - 1.
313 # @zero: the sectors in this range read as zeros
315 # @data: reading the image will actually read data from a file (in particular,
316 # if @offset is present this means that the sectors are not simply
317 # preallocated, but contain actual data in raw format)
319 # @offset: if present, the image file stores the data for this range in
320 # raw format at the given offset.
324 { 'struct': 'BlockDeviceMapEntry',
325 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
326 'data': 'bool', '*offset': 'int' } }
329 # @DirtyBitmapStatus:
331 # An enumeration of possible states that a dirty bitmap can report to the user.
333 # @frozen: The bitmap is currently in-use by a backup operation or block job,
336 # @disabled: The bitmap is currently in-use by an internal operation and is
337 # read-only. It can still be deleted.
339 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
340 # deleted, or used for backup operations.
344 { 'enum': 'DirtyBitmapStatus',
345 'data': ['active', 'disabled', 'frozen'] }
350 # Block dirty bitmap information.
352 # @name: #optional the name of the dirty bitmap (Since 2.4)
354 # @count: number of dirty bytes according to the dirty bitmap
356 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
358 # @status: current status of the dirty bitmap (since 2.4)
362 { 'struct': 'BlockDirtyInfo',
363 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
364 'status': 'DirtyBitmapStatus'} }
369 # Block device information. This structure describes a virtual device and
370 # the backing device associated with it.
372 # @device: The device name associated with the virtual device.
374 # @type: This field is returned only for compatibility reasons, it should
375 # not be used (always returns 'unknown')
377 # @removable: True if the device supports removable media.
379 # @locked: True if the guest has locked this device from having its media
382 # @tray_open: #optional True if the device has a tray and it is open
383 # (only present if removable is true)
385 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
386 # driver has one or more dirty bitmaps) (Since 2.0)
388 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
389 # supports it and the VM is configured to stop on errors
390 # (supported device models: virtio-blk, ide, scsi-disk)
392 # @inserted: #optional @BlockDeviceInfo describing the device if media is
397 { 'struct': 'BlockInfo',
398 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
399 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
400 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
401 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
406 # Get a list of BlockInfo for all virtual block devices.
408 # Returns: a list of @BlockInfo describing each virtual block device
412 { 'command': 'query-block', 'returns': ['BlockInfo'] }
417 # Statistics of a virtual block device or a block backing device.
419 # @rd_bytes: The number of bytes read by the device.
421 # @wr_bytes: The number of bytes written by the device.
423 # @rd_operations: The number of read operations performed by the device.
425 # @wr_operations: The number of write operations performed by the device.
427 # @flush_operations: The number of cache flush operations performed by the
428 # device (since 0.15.0)
430 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
433 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
435 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
437 # @wr_highest_offset: The offset after the greatest byte written to the
438 # device. The intended use of this information is for
439 # growable sparse files (like qcow2) that are used on top
440 # of a physical device.
442 # @rd_merged: Number of read requests that have been merged into another
443 # request (Since 2.3).
445 # @wr_merged: Number of write requests that have been merged into another
446 # request (Since 2.3).
450 { 'struct': 'BlockDeviceStats',
451 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
452 'wr_operations': 'int', 'flush_operations': 'int',
453 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
454 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
455 'rd_merged': 'int', 'wr_merged': 'int' } }
460 # Statistics of a virtual block device or a block backing device.
462 # @device: #optional If the stats are for a virtual block device, the name
463 # corresponding to the virtual block device.
465 # @node-name: #optional The node name of the device. (Since 2.3)
467 # @stats: A @BlockDeviceStats for the device.
469 # @parent: #optional This describes the file block device if it has one.
471 # @backing: #optional This describes the backing block device if it has one.
476 { 'struct': 'BlockStats',
477 'data': {'*device': 'str', '*node-name': 'str',
478 'stats': 'BlockDeviceStats',
479 '*parent': 'BlockStats',
480 '*backing': 'BlockStats'} }
485 # Query the @BlockStats for all virtual block devices.
487 # @query-nodes: #optional If true, the command will query all the block nodes
488 # that have a node name, in a list which will include "parent"
489 # information, but not "backing".
490 # If false or omitted, the behavior is as before - query all the
491 # device backends, recursively including their "parent" and
492 # "backing". (Since 2.3)
494 # Returns: A list of @BlockStats for each virtual block devices.
498 { 'command': 'query-blockstats',
499 'data': { '*query-nodes': 'bool' },
500 'returns': ['BlockStats'] }
505 # An enumeration of possible behaviors for errors on I/O operations.
506 # The exact meaning depends on whether the I/O was initiated by a guest
509 # @report: for guest operations, report the error to the guest;
510 # for jobs, cancel the job
512 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
513 # or BLOCK_JOB_ERROR)
515 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
517 # @stop: for guest operations, stop the virtual machine;
518 # for jobs, pause the job
522 { 'enum': 'BlockdevOnError',
523 'data': ['report', 'ignore', 'enospc', 'stop'] }
528 # An enumeration of possible behaviors for the initial synchronization
529 # phase of storage mirroring.
531 # @top: copies data in the topmost image to the destination
533 # @full: copies data from all images to the destination
535 # @none: only copy data written from now on
537 # @dirty-bitmap: only copy data described by the dirty bitmap. Since: 2.4
541 { 'enum': 'MirrorSyncMode',
542 'data': ['top', 'full', 'none', 'dirty-bitmap'] }
547 # Type of a block job.
549 # @commit: block commit job type, see "block-commit"
551 # @stream: block stream job type, see "block-stream"
553 # @mirror: drive mirror job type, see "drive-mirror"
555 # @backup: drive backup job type, see "drive-backup"
559 { 'enum': 'BlockJobType',
560 'data': ['commit', 'stream', 'mirror', 'backup'] }
565 # Information about a long-running block device operation.
567 # @type: the job type ('stream' for image streaming)
569 # @device: the block device name
571 # @len: the maximum progress value
573 # @busy: false if the job is known to be in a quiescent state, with
574 # no pending I/O. Since 1.3.
576 # @paused: whether the job is paused or, if @busy is true, will
577 # pause itself as soon as possible. Since 1.3.
579 # @offset: the current progress value
581 # @speed: the rate limit, bytes per second
583 # @io-status: the status of the job (since 1.3)
585 # @ready: true if the job may be completed (since 2.2)
589 { 'struct': 'BlockJobInfo',
590 'data': {'type': 'str', 'device': 'str', 'len': 'int',
591 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
592 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
597 # Return information about long-running block device operations.
599 # Returns: a list of @BlockJobInfo for each active block job
603 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
608 # This command sets the password of a block device that has not been open
609 # with a password and requires one.
611 # The two cases where this can happen are a block device is created through
612 # QEMU's initial command line or a block device is changed through the legacy
615 # In the event that the block device is created through the initial command
616 # line, the VM will start in the stopped state regardless of whether '-S' is
617 # used. The intention is for a management tool to query the block devices to
618 # determine which ones are encrypted, set the passwords with this command, and
619 # then start the guest with the @cont command.
621 # Either @device or @node-name must be set but not both.
623 # @device: #optional the name of the block backend device to set the password on
625 # @node-name: #optional graph node name to set the password on (Since 2.0)
627 # @password: the password to use for the device
629 # Returns: nothing on success
630 # If @device is not a valid block device, DeviceNotFound
631 # If @device is not encrypted, DeviceNotEncrypted
633 # Notes: Not all block formats support encryption and some that do are not
634 # able to validate that a password is correct. Disk corruption may
635 # occur if an invalid password is specified.
639 { 'command': 'block_passwd', 'data': {'*device': 'str',
640 '*node-name': 'str', 'password': 'str'} }
645 # Resize a block image while a guest is running.
647 # Either @device or @node-name must be set but not both.
649 # @device: #optional the name of the device to get the image resized
651 # @node-name: #optional graph node name to get the image resized (Since 2.0)
653 # @size: new image size in bytes
655 # Returns: nothing on success
656 # If @device is not a valid block device, DeviceNotFound
660 { 'command': 'block_resize', 'data': { '*device': 'str',
667 # An enumeration that tells QEMU how to set the backing file path in
670 # @existing: QEMU should look for an existing image file.
672 # @absolute-paths: QEMU should create a new image with absolute paths
673 # for the backing file. If there is no backing file available, the new
674 # image will not be backed either.
678 { 'enum': 'NewImageMode',
679 'data': [ 'existing', 'absolute-paths' ] }
684 # Either @device or @node-name must be set but not both.
686 # @device: #optional the name of the device to generate the snapshot from.
688 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
690 # @snapshot-file: the target of the new image. A new file will be created.
692 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
694 # @format: #optional the format of the snapshot image, default is 'qcow2'.
696 # @mode: #optional whether and how QEMU should create a new image, default is
699 { 'struct': 'BlockdevSnapshot',
700 'data': { '*device': 'str', '*node-name': 'str',
701 'snapshot-file': 'str', '*snapshot-node-name': 'str',
702 '*format': 'str', '*mode': 'NewImageMode' } }
707 # @device: the name of the device which should be copied.
709 # @target: the target of the new image. If the file exists, or if it
710 # is a device, the existing file/device will be used as the new
711 # destination. If it does not exist, a new file will be created.
713 # @format: #optional the format of the new destination, default is to
714 # probe if @mode is 'existing', else the format of the source
716 # @sync: what parts of the disk image should be copied to the destination
717 # (all the disk, only the sectors allocated in the topmost image, from a
718 # dirty bitmap, or only new I/O).
720 # @mode: #optional whether and how QEMU should create a new image, default is
723 # @speed: #optional the maximum speed, in bytes per second
725 # @bitmap: #optional the name of dirty bitmap if sync is "dirty-bitmap".
726 # Must be present if sync is "dirty-bitmap", must NOT be present
727 # otherwise. (Since 2.4)
729 # @on-source-error: #optional the action to take on an error on the source,
730 # default 'report'. 'stop' and 'enospc' can only be used
731 # if the block device supports io-status (see BlockInfo).
733 # @on-target-error: #optional the action to take on an error on the target,
734 # default 'report' (no limitations, since this applies to
735 # a different block device than @device).
737 # Note that @on-source-error and @on-target-error only affect background I/O.
738 # If an error occurs during a guest write request, the device's rerror/werror
739 # actions will be used.
743 { 'struct': 'DriveBackup',
744 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
745 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
746 '*speed': 'int', '*bitmap': 'str',
747 '*on-source-error': 'BlockdevOnError',
748 '*on-target-error': 'BlockdevOnError' } }
753 # @device: the name of the device which should be copied.
755 # @target: the name of the backup target device.
757 # @sync: what parts of the disk image should be copied to the destination
758 # (all the disk, only the sectors allocated in the topmost image, or
761 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
764 # @on-source-error: #optional the action to take on an error on the source,
765 # default 'report'. 'stop' and 'enospc' can only be used
766 # if the block device supports io-status (see BlockInfo).
768 # @on-target-error: #optional the action to take on an error on the target,
769 # default 'report' (no limitations, since this applies to
770 # a different block device than @device).
772 # Note that @on-source-error and @on-target-error only affect background I/O.
773 # If an error occurs during a guest write request, the device's rerror/werror
774 # actions will be used.
778 { 'struct': 'BlockdevBackup',
779 'data': { 'device': 'str', 'target': 'str',
780 'sync': 'MirrorSyncMode',
782 '*on-source-error': 'BlockdevOnError',
783 '*on-target-error': 'BlockdevOnError' } }
786 # @blockdev-snapshot-sync
788 # Generates a synchronous snapshot of a block device.
790 # For the arguments, see the documentation of BlockdevSnapshot.
792 # Returns: nothing on success
793 # If @device is not a valid block device, DeviceNotFound
797 { 'command': 'blockdev-snapshot-sync',
798 'data': 'BlockdevSnapshot' }
801 # @change-backing-file
803 # Change the backing file in the image file metadata. This does not
804 # cause QEMU to reopen the image file to reparse the backing filename
805 # (it may, however, perform a reopen to change permissions from
806 # r/o -> r/w -> r/o, if needed). The new backing file string is written
807 # into the image file metadata, and the QEMU internal strings are
810 # @image-node-name: The name of the block driver state node of the
813 # @device: The name of the device that owns image-node-name.
815 # @backing-file: The string to write as the backing file. This
816 # string is not validated, so care should be taken
817 # when specifying the string or the image chain may
818 # not be able to be reopened again.
822 { 'command': 'change-backing-file',
823 'data': { 'device': 'str', 'image-node-name': 'str',
824 'backing-file': 'str' } }
829 # Live commit of data from overlay image nodes into backing nodes - i.e.,
830 # writes data between 'top' and 'base' into 'base'.
832 # @device: the name of the device
834 # @base: #optional The file name of the backing image to write data into.
835 # If not specified, this is the deepest backing image
837 # @top: #optional The file name of the backing image within the image chain,
838 # which contains the topmost data to be committed down. If
839 # not specified, this is the active layer.
841 # @backing-file: #optional The backing file string to write into the overlay
842 # image of 'top'. If 'top' is the active layer,
843 # specifying a backing file string is an error. This
844 # filename is not validated.
846 # If a pathname string is such that it cannot be
847 # resolved by QEMU, that means that subsequent QMP or
848 # HMP commands must use node-names for the image in
849 # question, as filename lookup methods will fail.
851 # If not specified, QEMU will automatically determine
852 # the backing file string to use, or error out if
853 # there is no obvious choice. Care should be taken
854 # when specifying the string, to specify a valid
855 # filename or protocol.
858 # If top == base, that is an error.
859 # If top == active, the job will not be completed by itself,
860 # user needs to complete the job with the block-job-complete
861 # command after getting the ready event. (Since 2.0)
863 # If the base image is smaller than top, then the base image
864 # will be resized to be the same size as top. If top is
865 # smaller than the base image, the base will not be
866 # truncated. If you want the base image size to match the
867 # size of the smaller top, you can safely truncate it
868 # yourself once the commit operation successfully completes.
870 # @speed: #optional the maximum speed, in bytes per second
872 # Returns: Nothing on success
873 # If commit or stream is already active on this device, DeviceInUse
874 # If @device does not exist, DeviceNotFound
875 # If image commit is not supported by this device, NotSupported
876 # If @base or @top is invalid, a generic error is returned
877 # If @speed is invalid, InvalidParameter
882 { 'command': 'block-commit',
883 'data': { 'device': 'str', '*base': 'str', '*top': 'str',
884 '*backing-file': 'str', '*speed': 'int' } }
889 # Start a point-in-time copy of a block device to a new destination. The
890 # status of ongoing drive-backup operations can be checked with
891 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
892 # The operation can be stopped before it has completed using the
893 # block-job-cancel command.
895 # For the arguments, see the documentation of DriveBackup.
897 # Returns: nothing on success
898 # If @device is not a valid block device, DeviceNotFound
902 { 'command': 'drive-backup', 'data': 'DriveBackup' }
907 # Start a point-in-time copy of a block device to a new destination. The
908 # status of ongoing blockdev-backup operations can be checked with
909 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
910 # The operation can be stopped before it has completed using the
911 # block-job-cancel command.
913 # For the arguments, see the documentation of BlockdevBackup.
917 { 'command': 'blockdev-backup', 'data': 'BlockdevBackup' }
921 # @query-named-block-nodes
923 # Get the named block driver list
925 # Returns: the list of BlockDeviceInfo
929 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
934 # Start mirroring a block device's writes to a new destination.
936 # @device: the name of the device whose writes should be mirrored.
938 # @target: the target of the new image. If the file exists, or if it
939 # is a device, the existing file/device will be used as the new
940 # destination. If it does not exist, a new file will be created.
942 # @format: #optional the format of the new destination, default is to
943 # probe if @mode is 'existing', else the format of the source
945 # @node-name: #optional the new block driver state node name in the graph
948 # @replaces: #optional with sync=full graph node name to be replaced by the new
949 # image when a whole image copy is done. This can be used to repair
950 # broken Quorum files. (Since 2.1)
952 # @mode: #optional whether and how QEMU should create a new image, default is
955 # @speed: #optional the maximum speed, in bytes per second
957 # @sync: what parts of the disk image should be copied to the destination
958 # (all the disk, only the sectors allocated in the topmost image, or
961 # @granularity: #optional granularity of the dirty bitmap, default is 64K
962 # if the image format doesn't have clusters, 4K if the clusters
963 # are smaller than that, else the cluster size. Must be a
964 # power of 2 between 512 and 64M (since 1.4).
966 # @buf-size: #optional maximum amount of data in flight from source to
967 # target (since 1.4).
969 # @on-source-error: #optional the action to take on an error on the source,
970 # default 'report'. 'stop' and 'enospc' can only be used
971 # if the block device supports io-status (see BlockInfo).
973 # @on-target-error: #optional the action to take on an error on the target,
974 # default 'report' (no limitations, since this applies to
975 # a different block device than @device).
977 # Returns: nothing on success
978 # If @device is not a valid block device, DeviceNotFound
982 { 'command': 'drive-mirror',
983 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
984 '*node-name': 'str', '*replaces': 'str',
985 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
986 '*speed': 'int', '*granularity': 'uint32',
987 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
988 '*on-target-error': 'BlockdevOnError' } }
993 # @node: name of device/node which the bitmap is tracking
995 # @name: name of the dirty bitmap
999 { 'struct': 'BlockDirtyBitmap',
1000 'data': { 'node': 'str', 'name': 'str' } }
1003 # @BlockDirtyBitmapAdd
1005 # @node: name of device/node which the bitmap is tracking
1007 # @name: name of the dirty bitmap
1009 # @granularity: #optional the bitmap granularity, default is 64k for
1010 # block-dirty-bitmap-add
1014 { 'struct': 'BlockDirtyBitmapAdd',
1015 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } }
1018 # @block-dirty-bitmap-add
1020 # Create a dirty bitmap with a name on the node
1022 # Returns: nothing on success
1023 # If @node is not a valid block device or node, DeviceNotFound
1024 # If @name is already taken, GenericError with an explanation
1028 { 'command': 'block-dirty-bitmap-add',
1029 'data': 'BlockDirtyBitmapAdd' }
1032 # @block-dirty-bitmap-remove
1034 # Remove a dirty bitmap on the node
1036 # Returns: nothing on success
1037 # If @node is not a valid block device or node, DeviceNotFound
1038 # If @name is not found, GenericError with an explanation
1039 # if @name is frozen by an operation, GenericError
1043 { 'command': 'block-dirty-bitmap-remove',
1044 'data': 'BlockDirtyBitmap' }
1047 # @block-dirty-bitmap-clear
1049 # Clear (reset) a dirty bitmap on the device
1051 # Returns: nothing on success
1052 # If @node is not a valid block device, DeviceNotFound
1053 # If @name is not found, GenericError with an explanation
1057 { 'command': 'block-dirty-bitmap-clear',
1058 'data': 'BlockDirtyBitmap' }
1061 # @block_set_io_throttle:
1063 # Change I/O throttle limits for a block drive.
1065 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1068 # If two or more devices are members of the same group, the limits
1069 # will apply to the combined I/O of the whole group in a round-robin
1070 # fashion. Therefore, setting new I/O limits to a device will affect
1073 # The name of the group can be specified using the 'group' parameter.
1074 # If the parameter is unset, it is assumed to be the current group of
1075 # that device. If it's not in any group yet, the name of the device
1076 # will be used as the name for its group.
1078 # The 'group' parameter can also be used to move a device to a
1079 # different group. In this case the limits specified in the parameters
1080 # will be applied to the new group only.
1082 # I/O limits can be disabled by setting all of them to 0. In this case
1083 # the device will be removed from its group and the rest of its
1084 # members will no be affected. The 'group' parameter is ignored.
1086 # @device: The name of the device
1088 # @bps: total throughput limit in bytes per second
1090 # @bps_rd: read throughput limit in bytes per second
1092 # @bps_wr: write throughput limit in bytes per second
1094 # @iops: total I/O operations per second
1096 # @ops_rd: read I/O operations per second
1098 # @iops_wr: write I/O operations per second
1100 # @bps_max: #optional total max in bytes (Since 1.7)
1102 # @bps_rd_max: #optional read max in bytes (Since 1.7)
1104 # @bps_wr_max: #optional write max in bytes (Since 1.7)
1106 # @iops_max: #optional total I/O operations max (Since 1.7)
1108 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
1110 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
1112 # @iops_size: #optional an I/O size in bytes (Since 1.7)
1114 # @group: #optional throttle group name (Since 2.4)
1116 # Returns: Nothing on success
1117 # If @device is not a valid block device, DeviceNotFound
1121 { 'command': 'block_set_io_throttle',
1122 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1123 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1124 '*bps_max': 'int', '*bps_rd_max': 'int',
1125 '*bps_wr_max': 'int', '*iops_max': 'int',
1126 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1127 '*iops_size': 'int', '*group': 'str' } }
1132 # Copy data from a backing file into a block device.
1134 # The block streaming operation is performed in the background until the entire
1135 # backing file has been copied. This command returns immediately once streaming
1136 # has started. The status of ongoing block streaming operations can be checked
1137 # with query-block-jobs. The operation can be stopped before it has completed
1138 # using the block-job-cancel command.
1140 # If a base file is specified then sectors are not copied from that base file and
1141 # its backing chain. When streaming completes the image file will have the base
1142 # file as its backing file. This can be used to stream a subset of the backing
1143 # file chain instead of flattening the entire image.
1145 # On successful completion the image file is updated to drop the backing file
1146 # and the BLOCK_JOB_COMPLETED event is emitted.
1148 # @device: the device name
1150 # @base: #optional the common backing file name
1152 # @backing-file: #optional The backing file string to write into the active
1153 # layer. This filename is not validated.
1155 # If a pathname string is such that it cannot be
1156 # resolved by QEMU, that means that subsequent QMP or
1157 # HMP commands must use node-names for the image in
1158 # question, as filename lookup methods will fail.
1160 # If not specified, QEMU will automatically determine
1161 # the backing file string to use, or error out if there
1162 # is no obvious choice. Care should be taken when
1163 # specifying the string, to specify a valid filename or
1167 # @speed: #optional the maximum speed, in bytes per second
1169 # @on-error: #optional the action to take on an error (default report).
1170 # 'stop' and 'enospc' can only be used if the block device
1171 # supports io-status (see BlockInfo). Since 1.3.
1173 # Returns: Nothing on success
1174 # If @device does not exist, DeviceNotFound
1178 { 'command': 'block-stream',
1179 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str',
1180 '*speed': 'int', '*on-error': 'BlockdevOnError' } }
1183 # @block-job-set-speed:
1185 # Set maximum speed for a background block operation.
1187 # This command can only be issued when there is an active block job.
1189 # Throttling can be disabled by setting the speed to 0.
1191 # @device: the device name
1193 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1196 # Returns: Nothing on success
1197 # If no background operation is active on this device, DeviceNotActive
1201 { 'command': 'block-job-set-speed',
1202 'data': { 'device': 'str', 'speed': 'int' } }
1205 # @block-job-cancel:
1207 # Stop an active background block operation.
1209 # This command returns immediately after marking the active background block
1210 # operation for cancellation. It is an error to call this command if no
1211 # operation is in progress.
1213 # The operation will cancel as soon as possible and then emit the
1214 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1215 # enumerated using query-block-jobs.
1217 # For streaming, the image file retains its backing file unless the streaming
1218 # operation happens to complete just as it is being cancelled. A new streaming
1219 # operation can be started at a later time to finish copying all data from the
1222 # @device: the device name
1224 # @force: #optional whether to allow cancellation of a paused job (default
1225 # false). Since 1.3.
1227 # Returns: Nothing on success
1228 # If no background operation is active on this device, DeviceNotActive
1232 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1237 # Pause an active background block operation.
1239 # This command returns immediately after marking the active background block
1240 # operation for pausing. It is an error to call this command if no
1241 # operation is in progress. Pausing an already paused job has no cumulative
1242 # effect; a single block-job-resume command will resume the job.
1244 # The operation will pause as soon as possible. No event is emitted when
1245 # the operation is actually paused. Cancelling a paused job automatically
1248 # @device: the device name
1250 # Returns: Nothing on success
1251 # If no background operation is active on this device, DeviceNotActive
1255 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1258 # @block-job-resume:
1260 # Resume an active background block operation.
1262 # This command returns immediately after resuming a paused background block
1263 # operation. It is an error to call this command if no operation is in
1264 # progress. Resuming an already running job is not an error.
1266 # This command also clears the error status of the job.
1268 # @device: the device name
1270 # Returns: Nothing on success
1271 # If no background operation is active on this device, DeviceNotActive
1275 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1278 # @block-job-complete:
1280 # Manually trigger completion of an active background block operation. This
1281 # is supported for drive mirroring, where it also switches the device to
1282 # write to the target path only. The ability to complete is signaled with
1283 # a BLOCK_JOB_READY event.
1285 # This command completes an active background block operation synchronously.
1286 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1287 # is not defined. Note that if an I/O error occurs during the processing of
1288 # this command: 1) the command itself will fail; 2) the error will be processed
1289 # according to the rerror/werror arguments that were specified when starting
1292 # A cancelled or paused job cannot be completed.
1294 # @device: the device name
1296 # Returns: Nothing on success
1297 # If no background operation is active on this device, DeviceNotActive
1301 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1304 # @BlockdevDiscardOptions
1306 # Determines how to handle discard requests.
1308 # @ignore: Ignore the request
1309 # @unmap: Forward as an unmap request
1313 { 'enum': 'BlockdevDiscardOptions',
1314 'data': [ 'ignore', 'unmap' ] }
1317 # @BlockdevDetectZeroesOptions
1319 # Describes the operation mode for the automatic conversion of plain
1320 # zero writes by the OS to driver specific optimized zero write commands.
1322 # @off: Disabled (default)
1324 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1325 # also that @BlockdevDiscardOptions is set to unmap for this device.
1329 { 'enum': 'BlockdevDetectZeroesOptions',
1330 'data': [ 'off', 'on', 'unmap' ] }
1333 # @BlockdevAioOptions
1335 # Selects the AIO backend to handle I/O requests
1337 # @threads: Use qemu's thread pool
1338 # @native: Use native AIO backend (only Linux and Windows)
1342 { 'enum': 'BlockdevAioOptions',
1343 'data': [ 'threads', 'native' ] }
1346 # @BlockdevCacheOptions
1348 # Includes cache-related options for block devices
1350 # @writeback: #optional enables writeback mode for any caches (default: true)
1351 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1353 # @no-flush: #optional ignore any flush requests for the device (default:
1358 { 'struct': 'BlockdevCacheOptions',
1359 'data': { '*writeback': 'bool',
1361 '*no-flush': 'bool' } }
1366 # Drivers that are supported in block device operations.
1368 # @host_device, @host_cdrom, @host_floppy: Since 2.1
1369 # @host_floppy: deprecated since 2.3
1373 { 'enum': 'BlockdevDriver',
1374 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1375 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
1376 'host_floppy', 'http', 'https', 'null-aio', 'null-co', 'parallels',
1377 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx',
1378 'vmdk', 'vpc', 'vvfat' ] }
1381 # @BlockdevOptionsBase
1383 # Options that are available for all block devices, independent of the block
1386 # @driver: block driver name
1387 # @id: #optional id by which the new block device can be referred to.
1388 # This is a required option on the top level of blockdev-add, and
1389 # currently not allowed on any other level.
1390 # @node-name: #optional the name of a block driver state node (Since 2.0)
1391 # @discard: #optional discard-related options (default: ignore)
1392 # @cache: #optional cache-related options
1393 # @aio: #optional AIO backend (default: threads)
1394 # @rerror: #optional how to handle read errors on the device
1396 # @werror: #optional how to handle write errors on the device
1398 # @read-only: #optional whether the block device should be read-only
1400 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
1405 { 'struct': 'BlockdevOptionsBase',
1406 'data': { 'driver': 'BlockdevDriver',
1408 '*node-name': 'str',
1409 '*discard': 'BlockdevDiscardOptions',
1410 '*cache': 'BlockdevCacheOptions',
1411 '*aio': 'BlockdevAioOptions',
1412 '*rerror': 'BlockdevOnError',
1413 '*werror': 'BlockdevOnError',
1414 '*read-only': 'bool',
1415 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } }
1418 # @BlockdevOptionsFile
1420 # Driver specific block device options for the file backend and similar
1423 # @filename: path to the image file
1427 { 'struct': 'BlockdevOptionsFile',
1428 'data': { 'filename': 'str' } }
1431 # @BlockdevOptionsNull
1433 # Driver specific block device options for the null backend.
1435 # @size: #optional size of the device in bytes.
1436 # @latency-ns: #optional emulated latency (in nanoseconds) in processing
1437 # requests. Default to zero which completes requests immediately.
1442 { 'struct': 'BlockdevOptionsNull',
1443 'data': { '*size': 'int', '*latency-ns': 'uint64' } }
1446 # @BlockdevOptionsVVFAT
1448 # Driver specific block device options for the vvfat protocol.
1450 # @dir: directory to be exported as FAT image
1451 # @fat-type: #optional FAT type: 12, 16 or 32
1452 # @floppy: #optional whether to export a floppy image (true) or
1453 # partitioned hard disk (false; default)
1454 # @rw: #optional whether to allow write operations (default: false)
1458 { 'struct': 'BlockdevOptionsVVFAT',
1459 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1463 # @BlockdevOptionsGenericFormat
1465 # Driver specific block device options for image format that have no option
1466 # besides their data source.
1468 # @file: reference to or definition of the data source block device
1472 { 'struct': 'BlockdevOptionsGenericFormat',
1473 'data': { 'file': 'BlockdevRef' } }
1476 # @BlockdevOptionsGenericCOWFormat
1478 # Driver specific block device options for image format that have no option
1479 # besides their data source and an optional backing file.
1481 # @backing: #optional reference to or definition of the backing file block
1482 # device (if missing, taken from the image file content). It is
1483 # allowed to pass an empty string here in order to disable the
1484 # default backing file.
1488 { 'struct': 'BlockdevOptionsGenericCOWFormat',
1489 'base': 'BlockdevOptionsGenericFormat',
1490 'data': { '*backing': 'BlockdevRef' } }
1493 # @Qcow2OverlapCheckMode
1495 # General overlap check modes.
1497 # @none: Do not perform any checks
1499 # @constant: Perform only checks which can be done in constant time and
1500 # without reading anything from disk
1502 # @cached: Perform only checks which can be done without reading anything
1505 # @all: Perform all available overlap checks
1509 { 'enum': 'Qcow2OverlapCheckMode',
1510 'data': [ 'none', 'constant', 'cached', 'all' ] }
1513 # @Qcow2OverlapCheckFlags
1515 # Structure of flags for each metadata structure. Setting a field to 'true'
1516 # makes qemu guard that structure against unintended overwriting. The default
1517 # value is chosen according to the template given.
1519 # @template: Specifies a template mode which can be adjusted using the other
1520 # flags, defaults to 'cached'
1524 { 'struct': 'Qcow2OverlapCheckFlags',
1525 'data': { '*template': 'Qcow2OverlapCheckMode',
1526 '*main-header': 'bool',
1527 '*active-l1': 'bool',
1528 '*active-l2': 'bool',
1529 '*refcount-table': 'bool',
1530 '*refcount-block': 'bool',
1531 '*snapshot-table': 'bool',
1532 '*inactive-l1': 'bool',
1533 '*inactive-l2': 'bool' } }
1536 # @Qcow2OverlapChecks
1538 # Specifies which metadata structures should be guarded against unintended
1541 # @flags: set of flags for separate specification of each metadata structure
1544 # @mode: named mode which chooses a specific set of flags
1548 { 'alternate': 'Qcow2OverlapChecks',
1549 'data': { 'flags': 'Qcow2OverlapCheckFlags',
1550 'mode': 'Qcow2OverlapCheckMode' } }
1553 # @BlockdevOptionsQcow2
1555 # Driver specific block device options for qcow2.
1557 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1558 # feature (default is taken from the image file)
1560 # @pass-discard-request: #optional whether discard requests to the qcow2
1561 # device should be forwarded to the data source
1563 # @pass-discard-snapshot: #optional whether discard requests for the data source
1564 # should be issued when a snapshot operation (e.g.
1565 # deleting a snapshot) frees clusters in the qcow2 file
1567 # @pass-discard-other: #optional whether discard requests for the data source
1568 # should be issued on other occasions where a cluster
1571 # @overlap-check: #optional which overlap checks to perform for writes
1572 # to the image, defaults to 'cached' (since 2.2)
1574 # @cache-size: #optional the maximum total size of the L2 table and
1575 # refcount block caches in bytes (since 2.2)
1577 # @l2-cache-size: #optional the maximum size of the L2 table cache in
1580 # @refcount-cache-size: #optional the maximum size of the refcount block cache
1581 # in bytes (since 2.2)
1585 { 'struct': 'BlockdevOptionsQcow2',
1586 'base': 'BlockdevOptionsGenericCOWFormat',
1587 'data': { '*lazy-refcounts': 'bool',
1588 '*pass-discard-request': 'bool',
1589 '*pass-discard-snapshot': 'bool',
1590 '*pass-discard-other': 'bool',
1591 '*overlap-check': 'Qcow2OverlapChecks',
1592 '*cache-size': 'int',
1593 '*l2-cache-size': 'int',
1594 '*refcount-cache-size': 'int' } }
1598 # @BlockdevOptionsArchipelago
1600 # Driver specific block device options for Archipelago.
1602 # @volume: Name of the Archipelago volume image
1604 # @mport: #optional The port number on which mapperd is
1605 # listening. This is optional
1606 # and if not specified, QEMU will make Archipelago
1607 # use the default port (1001).
1609 # @vport: #optional The port number on which vlmcd is
1610 # listening. This is optional
1611 # and if not specified, QEMU will make Archipelago
1612 # use the default port (501).
1614 # @segment: #optional The name of the shared memory segment
1615 # Archipelago stack is using. This is optional
1616 # and if not specified, QEMU will make Archipelago
1617 # use the default value, 'archipelago'.
1620 { 'struct': 'BlockdevOptionsArchipelago',
1621 'data': { 'volume': 'str',
1624 '*segment': 'str' } }
1630 # Trigger events supported by blkdebug.
1632 { 'enum': 'BlkdebugEvent',
1633 'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table',
1634 'l1_grow.activate_table', 'l2_load', 'l2_update',
1635 'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write',
1636 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1637 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1638 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1639 'refblock_load', 'refblock_update', 'refblock_update_part',
1640 'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write',
1641 'refblock_alloc.write_blocks', 'refblock_alloc.write_table',
1642 'refblock_alloc.switch_table', 'cluster_alloc',
1643 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
1644 'flush_to_disk', 'pwritev_rmw.head', 'pwritev_rmw.after_head',
1645 'pwritev_rmw.tail', 'pwritev_rmw.after_tail', 'pwritev',
1646 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
1649 # @BlkdebugInjectErrorOptions
1651 # Describes a single error injection for blkdebug.
1653 # @event: trigger event
1655 # @state: #optional the state identifier blkdebug needs to be in to
1656 # actually trigger the event; defaults to "any"
1658 # @errno: #optional error identifier (errno) to be returned; defaults to
1661 # @sector: #optional specifies the sector index which has to be affected
1662 # in order to actually trigger the event; defaults to "any
1665 # @once: #optional disables further events after this one has been
1666 # triggered; defaults to false
1668 # @immediately: #optional fail immediately; defaults to false
1672 { 'struct': 'BlkdebugInjectErrorOptions',
1673 'data': { 'event': 'BlkdebugEvent',
1678 '*immediately': 'bool' } }
1681 # @BlkdebugSetStateOptions
1683 # Describes a single state-change event for blkdebug.
1685 # @event: trigger event
1687 # @state: #optional the current state identifier blkdebug needs to be in;
1690 # @new_state: the state identifier blkdebug is supposed to assume if
1691 # this event is triggered
1695 { 'struct': 'BlkdebugSetStateOptions',
1696 'data': { 'event': 'BlkdebugEvent',
1698 'new_state': 'int' } }
1701 # @BlockdevOptionsBlkdebug
1703 # Driver specific block device options for blkdebug.
1705 # @image: underlying raw block device (or image file)
1707 # @config: #optional filename of the configuration file
1709 # @align: #optional required alignment for requests in bytes
1711 # @inject-error: #optional array of error injection descriptions
1713 # @set-state: #optional array of state-change descriptions
1717 { 'struct': 'BlockdevOptionsBlkdebug',
1718 'data': { 'image': 'BlockdevRef',
1721 '*inject-error': ['BlkdebugInjectErrorOptions'],
1722 '*set-state': ['BlkdebugSetStateOptions'] } }
1725 # @BlockdevOptionsBlkverify
1727 # Driver specific block device options for blkverify.
1729 # @test: block device to be tested
1731 # @raw: raw image used for verification
1735 { 'struct': 'BlockdevOptionsBlkverify',
1736 'data': { 'test': 'BlockdevRef',
1737 'raw': 'BlockdevRef' } }
1740 # @QuorumReadPattern
1742 # An enumeration of quorum read patterns.
1744 # @quorum: read all the children and do a quorum vote on reads
1746 # @fifo: read only from the first child that has not failed
1750 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
1753 # @BlockdevOptionsQuorum
1755 # Driver specific block device options for Quorum
1757 # @blkverify: #optional true if the driver must print content mismatch
1758 # set to false by default
1760 # @children: the children block devices to use
1762 # @vote-threshold: the vote limit under which a read will fail
1764 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
1767 # @read-pattern: #optional choose read pattern and set to quorum by default
1772 { 'struct': 'BlockdevOptionsQuorum',
1773 'data': { '*blkverify': 'bool',
1774 'children': [ 'BlockdevRef' ],
1775 'vote-threshold': 'int',
1776 '*rewrite-corrupted': 'bool',
1777 '*read-pattern': 'QuorumReadPattern' } }
1782 # Options for creating a block device.
1786 { 'union': 'BlockdevOptions',
1787 'base': 'BlockdevOptionsBase',
1788 'discriminator': 'driver',
1790 'archipelago':'BlockdevOptionsArchipelago',
1791 'blkdebug': 'BlockdevOptionsBlkdebug',
1792 'blkverify': 'BlockdevOptionsBlkverify',
1793 'bochs': 'BlockdevOptionsGenericFormat',
1794 'cloop': 'BlockdevOptionsGenericFormat',
1795 'dmg': 'BlockdevOptionsGenericFormat',
1796 'file': 'BlockdevOptionsFile',
1797 'ftp': 'BlockdevOptionsFile',
1798 'ftps': 'BlockdevOptionsFile',
1799 # TODO gluster: Wait for structured options
1800 'host_cdrom': 'BlockdevOptionsFile',
1801 'host_device':'BlockdevOptionsFile',
1802 'host_floppy':'BlockdevOptionsFile',
1803 'http': 'BlockdevOptionsFile',
1804 'https': 'BlockdevOptionsFile',
1805 # TODO iscsi: Wait for structured options
1806 # TODO nbd: Should take InetSocketAddress for 'host'?
1807 # TODO nfs: Wait for structured options
1808 'null-aio': 'BlockdevOptionsNull',
1809 'null-co': 'BlockdevOptionsNull',
1810 'parallels': 'BlockdevOptionsGenericFormat',
1811 'qcow2': 'BlockdevOptionsQcow2',
1812 'qcow': 'BlockdevOptionsGenericCOWFormat',
1813 'qed': 'BlockdevOptionsGenericCOWFormat',
1814 'quorum': 'BlockdevOptionsQuorum',
1815 'raw': 'BlockdevOptionsGenericFormat',
1816 # TODO rbd: Wait for structured options
1817 # TODO sheepdog: Wait for structured options
1818 # TODO ssh: Should take InetSocketAddress for 'host'?
1819 'tftp': 'BlockdevOptionsFile',
1820 'vdi': 'BlockdevOptionsGenericFormat',
1821 'vhdx': 'BlockdevOptionsGenericFormat',
1822 'vmdk': 'BlockdevOptionsGenericCOWFormat',
1823 'vpc': 'BlockdevOptionsGenericFormat',
1824 'vvfat': 'BlockdevOptionsVVFAT'
1830 # Reference to a block device.
1832 # @definition: defines a new block device inline
1833 # @reference: references the ID of an existing block device. An
1834 # empty string means that no block device should be
1839 { 'alternate': 'BlockdevRef',
1840 'data': { 'definition': 'BlockdevOptions',
1841 'reference': 'str' } }
1846 # Creates a new block device.
1848 # This command is still a work in progress. It doesn't support all
1849 # block drivers, it lacks a matching blockdev-del, and more. Stay
1850 # away from it unless you want to help with its development.
1852 # @options: block device options for the new device
1856 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }
1862 # An enumeration of action that has been taken when a DISK I/O occurs
1864 # @ignore: error has been ignored
1866 # @report: error has been reported to the device
1868 # @stop: error caused VM to be stopped
1872 { 'enum': 'BlockErrorAction',
1873 'data': [ 'ignore', 'report', 'stop' ] }
1877 # @BLOCK_IMAGE_CORRUPTED
1879 # Emitted when a corruption has been detected in a disk image
1881 # @device: device name. This is always present for compatibility
1882 # reasons, but it can be empty ("") if the image does not
1883 # have a device name associated.
1885 # @node-name: #optional node name (Since: 2.4)
1887 # @msg: informative message for human consumption, such as the kind of
1888 # corruption being detected. It should not be parsed by machine as it is
1889 # not guaranteed to be stable
1891 # @offset: #optional, if the corruption resulted from an image access, this is
1892 # the host's access offset into the image
1894 # @size: #optional, if the corruption resulted from an image access, this is
1897 # fatal: if set, the image is marked corrupt and therefore unusable after this
1898 # event and must be repaired (Since 2.2; before, every
1899 # BLOCK_IMAGE_CORRUPTED event was fatal)
1903 { 'event': 'BLOCK_IMAGE_CORRUPTED',
1904 'data': { 'device' : 'str',
1905 '*node-name' : 'str',
1909 'fatal' : 'bool' } }
1914 # Emitted when a disk I/O error occurs
1916 # @device: device name
1918 # @operation: I/O operation
1920 # @action: action that has been taken
1922 # @nospace: #optional true if I/O error was caused due to a no-space
1923 # condition. This key is only present if query-block's
1924 # io-status is present, please see query-block documentation
1925 # for more information (since: 2.2)
1927 # @reason: human readable string describing the error cause.
1928 # (This field is a debugging aid for humans, it should not
1929 # be parsed by applications) (since: 2.2)
1931 # Note: If action is "stop", a STOP event will eventually follow the
1932 # BLOCK_IO_ERROR event
1936 { 'event': 'BLOCK_IO_ERROR',
1937 'data': { 'device': 'str', 'operation': 'IoOperationType',
1938 'action': 'BlockErrorAction', '*nospace': 'bool',
1942 # @BLOCK_JOB_COMPLETED
1944 # Emitted when a block job has completed
1948 # @device: device name
1950 # @len: maximum progress value
1952 # @offset: current progress value. On success this is equal to len.
1953 # On failure this is less than len
1955 # @speed: rate limit, bytes per second
1957 # @error: #optional, error message. Only present on failure. This field
1958 # contains a human-readable error message. There are no semantics
1959 # other than that streaming has failed and clients should not try to
1960 # interpret the error string
1964 { 'event': 'BLOCK_JOB_COMPLETED',
1965 'data': { 'type' : 'BlockJobType',
1973 # @BLOCK_JOB_CANCELLED
1975 # Emitted when a block job has been cancelled
1979 # @device: device name
1981 # @len: maximum progress value
1983 # @offset: current progress value. On success this is equal to len.
1984 # On failure this is less than len
1986 # @speed: rate limit, bytes per second
1990 { 'event': 'BLOCK_JOB_CANCELLED',
1991 'data': { 'type' : 'BlockJobType',
2000 # Emitted when a block job encounters an error
2002 # @device: device name
2004 # @operation: I/O operation
2006 # @action: action that has been taken
2010 { 'event': 'BLOCK_JOB_ERROR',
2011 'data': { 'device' : 'str',
2012 'operation': 'IoOperationType',
2013 'action' : 'BlockErrorAction' } }
2018 # Emitted when a block job is ready to complete
2022 # @device: device name
2024 # @len: maximum progress value
2026 # @offset: current progress value. On success this is equal to len.
2027 # On failure this is less than len
2029 # @speed: rate limit, bytes per second
2031 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
2036 { 'event': 'BLOCK_JOB_READY',
2037 'data': { 'type' : 'BlockJobType',
2045 # Preallocation mode of QEMU image file
2047 # @off: no preallocation
2048 # @metadata: preallocate only for metadata
2049 # @falloc: like @full preallocation but allocate disk space by
2050 # posix_fallocate() rather than writing zeros.
2051 # @full: preallocate all data by writing zeros to device to ensure disk
2052 # space is really available. @full preallocation also sets up
2053 # metadata correctly.
2057 { 'enum': 'PreallocMode',
2058 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
2061 # @BLOCK_WRITE_THRESHOLD
2063 # Emitted when writes on block device reaches or exceeds the
2064 # configured write threshold. For thin-provisioned devices, this
2065 # means the device should be extended to avoid pausing for
2067 # The event is one shot. Once triggered, it needs to be
2068 # re-registered with another block-set-threshold command.
2070 # @node-name: graph node name on which the threshold was exceeded.
2072 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
2074 # @write-threshold: last configured threshold, in bytes.
2078 { 'event': 'BLOCK_WRITE_THRESHOLD',
2079 'data': { 'node-name': 'str',
2080 'amount-exceeded': 'uint64',
2081 'write-threshold': 'uint64' } }
2084 # @block-set-write-threshold
2086 # Change the write threshold for a block drive. An event will be delivered
2087 # if a write to this block drive crosses the configured threshold.
2088 # This is useful to transparently resize thin-provisioned drives without
2089 # the guest OS noticing.
2091 # @node-name: graph node name on which the threshold must be set.
2093 # @write-threshold: configured threshold for the block device, bytes.
2094 # Use 0 to disable the threshold.
2098 { 'command': 'block-set-write-threshold',
2099 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }