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
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 { 'type': '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 { 'type': '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 { 'type': '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 { 'type': '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 { 'type': '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 { 'type': '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 { 'type': 'BlockDeviceMapEntry',
325 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
326 'data': 'bool', '*offset': 'int' } }
331 # Block dirty bitmap information.
333 # @count: number of dirty bytes according to the dirty bitmap
335 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
339 { 'type': 'BlockDirtyInfo',
340 'data': {'count': 'int', 'granularity': 'int'} }
345 # Block device information. This structure describes a virtual device and
346 # the backing device associated with it.
348 # @device: The device name associated with the virtual device.
350 # @type: This field is returned only for compatibility reasons, it should
351 # not be used (always returns 'unknown')
353 # @removable: True if the device supports removable media.
355 # @locked: True if the guest has locked this device from having its media
358 # @tray_open: #optional True if the device has a tray and it is open
359 # (only present if removable is true)
361 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
362 # driver has one or more dirty bitmaps) (Since 2.0)
364 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
365 # supports it and the VM is configured to stop on errors
366 # (supported device models: virtio-blk, ide, scsi-disk)
368 # @inserted: #optional @BlockDeviceInfo describing the device if media is
373 { 'type': 'BlockInfo',
374 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
375 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
376 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
377 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
382 # Get a list of BlockInfo for all virtual block devices.
384 # Returns: a list of @BlockInfo describing each virtual block device
388 { 'command': 'query-block', 'returns': ['BlockInfo'] }
393 # Statistics of a virtual block device or a block backing device.
395 # @rd_bytes: The number of bytes read by the device.
397 # @wr_bytes: The number of bytes written by the device.
399 # @rd_operations: The number of read operations performed by the device.
401 # @wr_operations: The number of write operations performed by the device.
403 # @flush_operations: The number of cache flush operations performed by the
404 # device (since 0.15.0)
406 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
409 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
411 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
413 # @wr_highest_offset: The offset after the greatest byte written to the
414 # device. The intended use of this information is for
415 # growable sparse files (like qcow2) that are used on top
416 # of a physical device.
418 # @rd_merged: Number of read requests that have been merged into another
419 # request (Since 2.3).
421 # @wr_merged: Number of write requests that have been merged into another
422 # request (Since 2.3).
426 { 'type': 'BlockDeviceStats',
427 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
428 'wr_operations': 'int', 'flush_operations': 'int',
429 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
430 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
431 'rd_merged': 'int', 'wr_merged': 'int' } }
436 # Statistics of a virtual block device or a block backing device.
438 # @device: #optional If the stats are for a virtual block device, the name
439 # corresponding to the virtual block device.
441 # @node-name: #optional The node name of the device. (Since 2.3)
443 # @stats: A @BlockDeviceStats for the device.
445 # @parent: #optional This describes the file block device if it has one.
447 # @backing: #optional This describes the backing block device if it has one.
452 { 'type': 'BlockStats',
453 'data': {'*device': 'str', '*node-name': 'str',
454 'stats': 'BlockDeviceStats',
455 '*parent': 'BlockStats',
456 '*backing': 'BlockStats'} }
461 # Query the @BlockStats for all virtual block devices.
463 # @query-nodes: #optional If true, the command will query all the block nodes
464 # that have a node name, in a list which will include "parent"
465 # information, but not "backing".
466 # If false or omitted, the behavior is as before - query all the
467 # device backends, recursively including their "parent" and
468 # "backing". (Since 2.3)
470 # Returns: A list of @BlockStats for each virtual block devices.
474 { 'command': 'query-blockstats',
475 'data': { '*query-nodes': 'bool' },
476 'returns': ['BlockStats'] }
481 # An enumeration of possible behaviors for errors on I/O operations.
482 # The exact meaning depends on whether the I/O was initiated by a guest
485 # @report: for guest operations, report the error to the guest;
486 # for jobs, cancel the job
488 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
489 # or BLOCK_JOB_ERROR)
491 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
493 # @stop: for guest operations, stop the virtual machine;
494 # for jobs, pause the job
498 { 'enum': 'BlockdevOnError',
499 'data': ['report', 'ignore', 'enospc', 'stop'] }
504 # An enumeration of possible behaviors for the initial synchronization
505 # phase of storage mirroring.
507 # @top: copies data in the topmost image to the destination
509 # @full: copies data from all images to the destination
511 # @none: only copy data written from now on
515 { 'enum': 'MirrorSyncMode',
516 'data': ['top', 'full', 'none'] }
521 # Type of a block job.
523 # @commit: block commit job type, see "block-commit"
525 # @stream: block stream job type, see "block-stream"
527 # @mirror: drive mirror job type, see "drive-mirror"
529 # @backup: drive backup job type, see "drive-backup"
533 { 'enum': 'BlockJobType',
534 'data': ['commit', 'stream', 'mirror', 'backup'] }
539 # Information about a long-running block device operation.
541 # @type: the job type ('stream' for image streaming)
543 # @device: the block device name
545 # @len: the maximum progress value
547 # @busy: false if the job is known to be in a quiescent state, with
548 # no pending I/O. Since 1.3.
550 # @paused: whether the job is paused or, if @busy is true, will
551 # pause itself as soon as possible. Since 1.3.
553 # @offset: the current progress value
555 # @speed: the rate limit, bytes per second
557 # @io-status: the status of the job (since 1.3)
559 # @ready: true if the job may be completed (since 2.2)
563 { 'type': 'BlockJobInfo',
564 'data': {'type': 'str', 'device': 'str', 'len': 'int',
565 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
566 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
571 # Return information about long-running block device operations.
573 # Returns: a list of @BlockJobInfo for each active block job
577 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
582 # This command sets the password of a block device that has not been open
583 # with a password and requires one.
585 # The two cases where this can happen are a block device is created through
586 # QEMU's initial command line or a block device is changed through the legacy
589 # In the event that the block device is created through the initial command
590 # line, the VM will start in the stopped state regardless of whether '-S' is
591 # used. The intention is for a management tool to query the block devices to
592 # determine which ones are encrypted, set the passwords with this command, and
593 # then start the guest with the @cont command.
595 # Either @device or @node-name must be set but not both.
597 # @device: #optional the name of the block backend device to set the password on
599 # @node-name: #optional graph node name to set the password on (Since 2.0)
601 # @password: the password to use for the device
603 # Returns: nothing on success
604 # If @device is not a valid block device, DeviceNotFound
605 # If @device is not encrypted, DeviceNotEncrypted
607 # Notes: Not all block formats support encryption and some that do are not
608 # able to validate that a password is correct. Disk corruption may
609 # occur if an invalid password is specified.
613 { 'command': 'block_passwd', 'data': {'*device': 'str',
614 '*node-name': 'str', 'password': 'str'} }
619 # Resize a block image while a guest is running.
621 # Either @device or @node-name must be set but not both.
623 # @device: #optional the name of the device to get the image resized
625 # @node-name: #optional graph node name to get the image resized (Since 2.0)
627 # @size: new image size in bytes
629 # Returns: nothing on success
630 # If @device is not a valid block device, DeviceNotFound
634 { 'command': 'block_resize', 'data': { '*device': 'str',
641 # An enumeration that tells QEMU how to set the backing file path in
644 # @existing: QEMU should look for an existing image file.
646 # @absolute-paths: QEMU should create a new image with absolute paths
647 # for the backing file. If there is no backing file available, the new
648 # image will not be backed either.
652 { 'enum': 'NewImageMode',
653 'data': [ 'existing', 'absolute-paths' ] }
658 # Either @device or @node-name must be set but not both.
660 # @device: #optional the name of the device to generate the snapshot from.
662 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
664 # @snapshot-file: the target of the new image. A new file will be created.
666 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
668 # @format: #optional the format of the snapshot image, default is 'qcow2'.
670 # @mode: #optional whether and how QEMU should create a new image, default is
673 { 'type': 'BlockdevSnapshot',
674 'data': { '*device': 'str', '*node-name': 'str',
675 'snapshot-file': 'str', '*snapshot-node-name': 'str',
676 '*format': 'str', '*mode': 'NewImageMode' } }
681 # @device: the name of the device which should be copied.
683 # @target: the target of the new image. If the file exists, or if it
684 # is a device, the existing file/device will be used as the new
685 # destination. If it does not exist, a new file will be created.
687 # @format: #optional the format of the new destination, default is to
688 # probe if @mode is 'existing', else the format of the source
690 # @sync: what parts of the disk image should be copied to the destination
691 # (all the disk, only the sectors allocated in the topmost image, or
694 # @mode: #optional whether and how QEMU should create a new image, default is
697 # @speed: #optional the maximum speed, in bytes per second
699 # @on-source-error: #optional the action to take on an error on the source,
700 # default 'report'. 'stop' and 'enospc' can only be used
701 # if the block device supports io-status (see BlockInfo).
703 # @on-target-error: #optional the action to take on an error on the target,
704 # default 'report' (no limitations, since this applies to
705 # a different block device than @device).
707 # Note that @on-source-error and @on-target-error only affect background I/O.
708 # If an error occurs during a guest write request, the device's rerror/werror
709 # actions will be used.
713 { 'type': 'DriveBackup',
714 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
715 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
717 '*on-source-error': 'BlockdevOnError',
718 '*on-target-error': 'BlockdevOnError' } }
723 # @device: the name of the device which should be copied.
725 # @target: the name of the backup target device.
727 # @sync: what parts of the disk image should be copied to the destination
728 # (all the disk, only the sectors allocated in the topmost image, or
731 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
734 # @on-source-error: #optional the action to take on an error on the source,
735 # default 'report'. 'stop' and 'enospc' can only be used
736 # if the block device supports io-status (see BlockInfo).
738 # @on-target-error: #optional the action to take on an error on the target,
739 # default 'report' (no limitations, since this applies to
740 # a different block device than @device).
742 # Note that @on-source-error and @on-target-error only affect background I/O.
743 # If an error occurs during a guest write request, the device's rerror/werror
744 # actions will be used.
748 { 'type': 'BlockdevBackup',
749 'data': { 'device': 'str', 'target': 'str',
750 'sync': 'MirrorSyncMode',
752 '*on-source-error': 'BlockdevOnError',
753 '*on-target-error': 'BlockdevOnError' } }
756 # @blockdev-snapshot-sync
758 # Generates a synchronous snapshot of a block device.
760 # For the arguments, see the documentation of BlockdevSnapshot.
762 # Returns: nothing on success
763 # If @device is not a valid block device, DeviceNotFound
767 { 'command': 'blockdev-snapshot-sync',
768 'data': 'BlockdevSnapshot' }
771 # @change-backing-file
773 # Change the backing file in the image file metadata. This does not
774 # cause QEMU to reopen the image file to reparse the backing filename
775 # (it may, however, perform a reopen to change permissions from
776 # r/o -> r/w -> r/o, if needed). The new backing file string is written
777 # into the image file metadata, and the QEMU internal strings are
780 # @image-node-name: The name of the block driver state node of the
783 # @device: The name of the device that owns image-node-name.
785 # @backing-file: The string to write as the backing file. This
786 # string is not validated, so care should be taken
787 # when specifying the string or the image chain may
788 # not be able to be reopened again.
792 { 'command': 'change-backing-file',
793 'data': { 'device': 'str', 'image-node-name': 'str',
794 'backing-file': 'str' } }
799 # Live commit of data from overlay image nodes into backing nodes - i.e.,
800 # writes data between 'top' and 'base' into 'base'.
802 # @device: the name of the device
804 # @base: #optional The file name of the backing image to write data into.
805 # If not specified, this is the deepest backing image
807 # @top: #optional The file name of the backing image within the image chain,
808 # which contains the topmost data to be committed down. If
809 # not specified, this is the active layer.
811 # @backing-file: #optional The backing file string to write into the overlay
812 # image of 'top'. If 'top' is the active layer,
813 # specifying a backing file string is an error. This
814 # filename is not validated.
816 # If a pathname string is such that it cannot be
817 # resolved by QEMU, that means that subsequent QMP or
818 # HMP commands must use node-names for the image in
819 # question, as filename lookup methods will fail.
821 # If not specified, QEMU will automatically determine
822 # the backing file string to use, or error out if
823 # there is no obvious choice. Care should be taken
824 # when specifying the string, to specify a valid
825 # filename or protocol.
828 # If top == base, that is an error.
829 # If top == active, the job will not be completed by itself,
830 # user needs to complete the job with the block-job-complete
831 # command after getting the ready event. (Since 2.0)
833 # If the base image is smaller than top, then the base image
834 # will be resized to be the same size as top. If top is
835 # smaller than the base image, the base will not be
836 # truncated. If you want the base image size to match the
837 # size of the smaller top, you can safely truncate it
838 # yourself once the commit operation successfully completes.
840 # @speed: #optional the maximum speed, in bytes per second
842 # Returns: Nothing on success
843 # If commit or stream is already active on this device, DeviceInUse
844 # If @device does not exist, DeviceNotFound
845 # If image commit is not supported by this device, NotSupported
846 # If @base or @top is invalid, a generic error is returned
847 # If @speed is invalid, InvalidParameter
852 { 'command': 'block-commit',
853 'data': { 'device': 'str', '*base': 'str', '*top': 'str',
854 '*backing-file': 'str', '*speed': 'int' } }
859 # Start a point-in-time copy of a block device to a new destination. The
860 # status of ongoing drive-backup operations can be checked with
861 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
862 # The operation can be stopped before it has completed using the
863 # block-job-cancel command.
865 # For the arguments, see the documentation of DriveBackup.
867 # Returns: nothing on success
868 # If @device is not a valid block device, DeviceNotFound
872 { 'command': 'drive-backup', 'data': 'DriveBackup' }
877 # Start a point-in-time copy of a block device to a new destination. The
878 # status of ongoing blockdev-backup operations can be checked with
879 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
880 # The operation can be stopped before it has completed using the
881 # block-job-cancel command.
883 # For the arguments, see the documentation of BlockdevBackup.
885 # Returns: Nothing on success.
886 # If @device or @target is not a valid block device, DeviceNotFound.
890 { 'command': 'blockdev-backup', 'data': 'BlockdevBackup' }
894 # @query-named-block-nodes
896 # Get the named block driver list
898 # Returns: the list of BlockDeviceInfo
902 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
907 # Start mirroring a block device's writes to a new destination.
909 # @device: the name of the device whose writes should be mirrored.
911 # @target: the target of the new image. If the file exists, or if it
912 # is a device, the existing file/device will be used as the new
913 # destination. If it does not exist, a new file will be created.
915 # @format: #optional the format of the new destination, default is to
916 # probe if @mode is 'existing', else the format of the source
918 # @node-name: #optional the new block driver state node name in the graph
921 # @replaces: #optional with sync=full graph node name to be replaced by the new
922 # image when a whole image copy is done. This can be used to repair
923 # broken Quorum files. (Since 2.1)
925 # @mode: #optional whether and how QEMU should create a new image, default is
928 # @speed: #optional the maximum speed, in bytes per second
930 # @sync: what parts of the disk image should be copied to the destination
931 # (all the disk, only the sectors allocated in the topmost image, or
934 # @granularity: #optional granularity of the dirty bitmap, default is 64K
935 # if the image format doesn't have clusters, 4K if the clusters
936 # are smaller than that, else the cluster size. Must be a
937 # power of 2 between 512 and 64M (since 1.4).
939 # @buf-size: #optional maximum amount of data in flight from source to
940 # target (since 1.4).
942 # @on-source-error: #optional the action to take on an error on the source,
943 # default 'report'. 'stop' and 'enospc' can only be used
944 # if the block device supports io-status (see BlockInfo).
946 # @on-target-error: #optional the action to take on an error on the target,
947 # default 'report' (no limitations, since this applies to
948 # a different block device than @device).
950 # Returns: nothing on success
951 # If @device is not a valid block device, DeviceNotFound
955 { 'command': 'drive-mirror',
956 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
957 '*node-name': 'str', '*replaces': 'str',
958 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
959 '*speed': 'int', '*granularity': 'uint32',
960 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
961 '*on-target-error': 'BlockdevOnError' } }
964 # @block_set_io_throttle:
966 # Change I/O throttle limits for a block drive.
968 # @device: The name of the device
970 # @bps: total throughput limit in bytes per second
972 # @bps_rd: read throughput limit in bytes per second
974 # @bps_wr: write throughput limit in bytes per second
976 # @iops: total I/O operations per second
978 # @ops_rd: read I/O operations per second
980 # @iops_wr: write I/O operations per second
982 # @bps_max: #optional total max in bytes (Since 1.7)
984 # @bps_rd_max: #optional read max in bytes (Since 1.7)
986 # @bps_wr_max: #optional write max in bytes (Since 1.7)
988 # @iops_max: #optional total I/O operations max (Since 1.7)
990 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
992 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
994 # @iops_size: #optional an I/O size in bytes (Since 1.7)
996 # Returns: Nothing on success
997 # If @device is not a valid block device, DeviceNotFound
1001 { 'command': 'block_set_io_throttle',
1002 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1003 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1004 '*bps_max': 'int', '*bps_rd_max': 'int',
1005 '*bps_wr_max': 'int', '*iops_max': 'int',
1006 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1007 '*iops_size': 'int' } }
1012 # Copy data from a backing file into a block device.
1014 # The block streaming operation is performed in the background until the entire
1015 # backing file has been copied. This command returns immediately once streaming
1016 # has started. The status of ongoing block streaming operations can be checked
1017 # with query-block-jobs. The operation can be stopped before it has completed
1018 # using the block-job-cancel command.
1020 # If a base file is specified then sectors are not copied from that base file and
1021 # its backing chain. When streaming completes the image file will have the base
1022 # file as its backing file. This can be used to stream a subset of the backing
1023 # file chain instead of flattening the entire image.
1025 # On successful completion the image file is updated to drop the backing file
1026 # and the BLOCK_JOB_COMPLETED event is emitted.
1028 # @device: the device name
1030 # @base: #optional the common backing file name
1032 # @backing-file: #optional The backing file string to write into the active
1033 # layer. This filename is not validated.
1035 # If a pathname string is such that it cannot be
1036 # resolved by QEMU, that means that subsequent QMP or
1037 # HMP commands must use node-names for the image in
1038 # question, as filename lookup methods will fail.
1040 # If not specified, QEMU will automatically determine
1041 # the backing file string to use, or error out if there
1042 # is no obvious choice. Care should be taken when
1043 # specifying the string, to specify a valid filename or
1047 # @speed: #optional the maximum speed, in bytes per second
1049 # @on-error: #optional the action to take on an error (default report).
1050 # 'stop' and 'enospc' can only be used if the block device
1051 # supports io-status (see BlockInfo). Since 1.3.
1053 # Returns: Nothing on success
1054 # If @device does not exist, DeviceNotFound
1058 { 'command': 'block-stream',
1059 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str',
1060 '*speed': 'int', '*on-error': 'BlockdevOnError' } }
1063 # @block-job-set-speed:
1065 # Set maximum speed for a background block operation.
1067 # This command can only be issued when there is an active block job.
1069 # Throttling can be disabled by setting the speed to 0.
1071 # @device: the device name
1073 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1076 # Returns: Nothing on success
1077 # If no background operation is active on this device, DeviceNotActive
1081 { 'command': 'block-job-set-speed',
1082 'data': { 'device': 'str', 'speed': 'int' } }
1085 # @block-job-cancel:
1087 # Stop an active background block operation.
1089 # This command returns immediately after marking the active background block
1090 # operation for cancellation. It is an error to call this command if no
1091 # operation is in progress.
1093 # The operation will cancel as soon as possible and then emit the
1094 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1095 # enumerated using query-block-jobs.
1097 # For streaming, the image file retains its backing file unless the streaming
1098 # operation happens to complete just as it is being cancelled. A new streaming
1099 # operation can be started at a later time to finish copying all data from the
1102 # @device: the device name
1104 # @force: #optional whether to allow cancellation of a paused job (default
1105 # false). Since 1.3.
1107 # Returns: Nothing on success
1108 # If no background operation is active on this device, DeviceNotActive
1112 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1117 # Pause an active background block operation.
1119 # This command returns immediately after marking the active background block
1120 # operation for pausing. It is an error to call this command if no
1121 # operation is in progress. Pausing an already paused job has no cumulative
1122 # effect; a single block-job-resume command will resume the job.
1124 # The operation will pause as soon as possible. No event is emitted when
1125 # the operation is actually paused. Cancelling a paused job automatically
1128 # @device: the device name
1130 # Returns: Nothing on success
1131 # If no background operation is active on this device, DeviceNotActive
1135 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1138 # @block-job-resume:
1140 # Resume an active background block operation.
1142 # This command returns immediately after resuming a paused background block
1143 # operation. It is an error to call this command if no operation is in
1144 # progress. Resuming an already running job is not an error.
1146 # This command also clears the error status of the job.
1148 # @device: the device name
1150 # Returns: Nothing on success
1151 # If no background operation is active on this device, DeviceNotActive
1155 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1158 # @block-job-complete:
1160 # Manually trigger completion of an active background block operation. This
1161 # is supported for drive mirroring, where it also switches the device to
1162 # write to the target path only. The ability to complete is signaled with
1163 # a BLOCK_JOB_READY event.
1165 # This command completes an active background block operation synchronously.
1166 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1167 # is not defined. Note that if an I/O error occurs during the processing of
1168 # this command: 1) the command itself will fail; 2) the error will be processed
1169 # according to the rerror/werror arguments that were specified when starting
1172 # A cancelled or paused job cannot be completed.
1174 # @device: the device name
1176 # Returns: Nothing on success
1177 # If no background operation is active on this device, DeviceNotActive
1181 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1184 # @BlockdevDiscardOptions
1186 # Determines how to handle discard requests.
1188 # @ignore: Ignore the request
1189 # @unmap: Forward as an unmap request
1193 { 'enum': 'BlockdevDiscardOptions',
1194 'data': [ 'ignore', 'unmap' ] }
1197 # @BlockdevDetectZeroesOptions
1199 # Describes the operation mode for the automatic conversion of plain
1200 # zero writes by the OS to driver specific optimized zero write commands.
1202 # @off: Disabled (default)
1204 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1205 # also that @BlockdevDiscardOptions is set to unmap for this device.
1209 { 'enum': 'BlockdevDetectZeroesOptions',
1210 'data': [ 'off', 'on', 'unmap' ] }
1213 # @BlockdevAioOptions
1215 # Selects the AIO backend to handle I/O requests
1217 # @threads: Use qemu's thread pool
1218 # @native: Use native AIO backend (only Linux and Windows)
1222 { 'enum': 'BlockdevAioOptions',
1223 'data': [ 'threads', 'native' ] }
1226 # @BlockdevCacheOptions
1228 # Includes cache-related options for block devices
1230 # @writeback: #optional enables writeback mode for any caches (default: true)
1231 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1233 # @no-flush: #optional ignore any flush requests for the device (default:
1238 { 'type': 'BlockdevCacheOptions',
1239 'data': { '*writeback': 'bool',
1241 '*no-flush': 'bool' } }
1246 # Drivers that are supported in block device operations.
1248 # @host_device, @host_cdrom, @host_floppy: Since 2.1
1249 # @host_floppy: deprecated since 2.3
1253 { 'enum': 'BlockdevDriver',
1254 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1255 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
1256 'host_floppy', 'http', 'https', 'null-aio', 'null-co', 'parallels',
1257 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx',
1258 'vmdk', 'vpc', 'vvfat' ] }
1261 # @BlockdevOptionsBase
1263 # Options that are available for all block devices, independent of the block
1266 # @driver: block driver name
1267 # @id: #optional id by which the new block device can be referred to.
1268 # This is a required option on the top level of blockdev-add, and
1269 # currently not allowed on any other level.
1270 # @node-name: #optional the name of a block driver state node (Since 2.0)
1271 # @discard: #optional discard-related options (default: ignore)
1272 # @cache: #optional cache-related options
1273 # @aio: #optional AIO backend (default: threads)
1274 # @rerror: #optional how to handle read errors on the device
1276 # @werror: #optional how to handle write errors on the device
1278 # @read-only: #optional whether the block device should be read-only
1280 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
1285 { 'type': 'BlockdevOptionsBase',
1286 'data': { 'driver': 'BlockdevDriver',
1288 '*node-name': 'str',
1289 '*discard': 'BlockdevDiscardOptions',
1290 '*cache': 'BlockdevCacheOptions',
1291 '*aio': 'BlockdevAioOptions',
1292 '*rerror': 'BlockdevOnError',
1293 '*werror': 'BlockdevOnError',
1294 '*read-only': 'bool',
1295 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } }
1298 # @BlockdevOptionsFile
1300 # Driver specific block device options for the file backend and similar
1303 # @filename: path to the image file
1307 { 'type': 'BlockdevOptionsFile',
1308 'data': { 'filename': 'str' } }
1311 # @BlockdevOptionsNull
1313 # Driver specific block device options for the null backend.
1315 # @size: #optional size of the device in bytes.
1319 { 'type': 'BlockdevOptionsNull',
1320 'data': { '*size': 'int' } }
1323 # @BlockdevOptionsVVFAT
1325 # Driver specific block device options for the vvfat protocol.
1327 # @dir: directory to be exported as FAT image
1328 # @fat-type: #optional FAT type: 12, 16 or 32
1329 # @floppy: #optional whether to export a floppy image (true) or
1330 # partitioned hard disk (false; default)
1331 # @rw: #optional whether to allow write operations (default: false)
1335 { 'type': 'BlockdevOptionsVVFAT',
1336 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1340 # @BlockdevOptionsGenericFormat
1342 # Driver specific block device options for image format that have no option
1343 # besides their data source.
1345 # @file: reference to or definition of the data source block device
1349 { 'type': 'BlockdevOptionsGenericFormat',
1350 'data': { 'file': 'BlockdevRef' } }
1353 # @BlockdevOptionsGenericCOWFormat
1355 # Driver specific block device options for image format that have no option
1356 # besides their data source and an optional backing file.
1358 # @backing: #optional reference to or definition of the backing file block
1359 # device (if missing, taken from the image file content). It is
1360 # allowed to pass an empty string here in order to disable the
1361 # default backing file.
1365 { 'type': 'BlockdevOptionsGenericCOWFormat',
1366 'base': 'BlockdevOptionsGenericFormat',
1367 'data': { '*backing': 'BlockdevRef' } }
1370 # @Qcow2OverlapCheckMode
1372 # General overlap check modes.
1374 # @none: Do not perform any checks
1376 # @constant: Perform only checks which can be done in constant time and
1377 # without reading anything from disk
1379 # @cached: Perform only checks which can be done without reading anything
1382 # @all: Perform all available overlap checks
1386 { 'enum': 'Qcow2OverlapCheckMode',
1387 'data': [ 'none', 'constant', 'cached', 'all' ] }
1390 # @Qcow2OverlapCheckFlags
1392 # Structure of flags for each metadata structure. Setting a field to 'true'
1393 # makes qemu guard that structure against unintended overwriting. The default
1394 # value is chosen according to the template given.
1396 # @template: Specifies a template mode which can be adjusted using the other
1397 # flags, defaults to 'cached'
1401 { 'type': 'Qcow2OverlapCheckFlags',
1402 'data': { '*template': 'Qcow2OverlapCheckMode',
1403 '*main-header': 'bool',
1404 '*active-l1': 'bool',
1405 '*active-l2': 'bool',
1406 '*refcount-table': 'bool',
1407 '*refcount-block': 'bool',
1408 '*snapshot-table': 'bool',
1409 '*inactive-l1': 'bool',
1410 '*inactive-l2': 'bool' } }
1413 # @Qcow2OverlapChecks
1415 # Specifies which metadata structures should be guarded against unintended
1418 # @flags: set of flags for separate specification of each metadata structure
1421 # @mode: named mode which chooses a specific set of flags
1425 { 'union': 'Qcow2OverlapChecks',
1426 'discriminator': {},
1427 'data': { 'flags': 'Qcow2OverlapCheckFlags',
1428 'mode': 'Qcow2OverlapCheckMode' } }
1431 # @BlockdevOptionsQcow2
1433 # Driver specific block device options for qcow2.
1435 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1436 # feature (default is taken from the image file)
1438 # @pass-discard-request: #optional whether discard requests to the qcow2
1439 # device should be forwarded to the data source
1441 # @pass-discard-snapshot: #optional whether discard requests for the data source
1442 # should be issued when a snapshot operation (e.g.
1443 # deleting a snapshot) frees clusters in the qcow2 file
1445 # @pass-discard-other: #optional whether discard requests for the data source
1446 # should be issued on other occasions where a cluster
1449 # @overlap-check: #optional which overlap checks to perform for writes
1450 # to the image, defaults to 'cached' (since 2.2)
1452 # @cache-size: #optional the maximum total size of the L2 table and
1453 # refcount block caches in bytes (since 2.2)
1455 # @l2-cache-size: #optional the maximum size of the L2 table cache in
1458 # @refcount-cache-size: #optional the maximum size of the refcount block cache
1459 # in bytes (since 2.2)
1463 { 'type': 'BlockdevOptionsQcow2',
1464 'base': 'BlockdevOptionsGenericCOWFormat',
1465 'data': { '*lazy-refcounts': 'bool',
1466 '*pass-discard-request': 'bool',
1467 '*pass-discard-snapshot': 'bool',
1468 '*pass-discard-other': 'bool',
1469 '*overlap-check': 'Qcow2OverlapChecks',
1470 '*cache-size': 'int',
1471 '*l2-cache-size': 'int',
1472 '*refcount-cache-size': 'int' } }
1476 # @BlockdevOptionsArchipelago
1478 # Driver specific block device options for Archipelago.
1480 # @volume: Name of the Archipelago volume image
1482 # @mport: #optional The port number on which mapperd is
1483 # listening. This is optional
1484 # and if not specified, QEMU will make Archipelago
1485 # use the default port (1001).
1487 # @vport: #optional The port number on which vlmcd is
1488 # listening. This is optional
1489 # and if not specified, QEMU will make Archipelago
1490 # use the default port (501).
1492 # @segment: #optional The name of the shared memory segment
1493 # Archipelago stack is using. This is optional
1494 # and if not specified, QEMU will make Archipelago
1495 # use the default value, 'archipelago'.
1498 { 'type': 'BlockdevOptionsArchipelago',
1499 'data': { 'volume': 'str',
1502 '*segment': 'str' } }
1508 # Trigger events supported by blkdebug.
1510 { 'enum': 'BlkdebugEvent',
1511 'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table',
1512 'l1_grow.activate_table', 'l2_load', 'l2_update',
1513 'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write',
1514 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1515 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1516 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1517 'refblock_load', 'refblock_update', 'refblock_update_part',
1518 'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write',
1519 'refblock_alloc.write_blocks', 'refblock_alloc.write_table',
1520 'refblock_alloc.switch_table', 'cluster_alloc',
1521 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
1522 'flush_to_disk', 'pwritev_rmw.head', 'pwritev_rmw.after_head',
1523 'pwritev_rmw.tail', 'pwritev_rmw.after_tail', 'pwritev',
1524 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
1527 # @BlkdebugInjectErrorOptions
1529 # Describes a single error injection for blkdebug.
1531 # @event: trigger event
1533 # @state: #optional the state identifier blkdebug needs to be in to
1534 # actually trigger the event; defaults to "any"
1536 # @errno: #optional error identifier (errno) to be returned; defaults to
1539 # @sector: #optional specifies the sector index which has to be affected
1540 # in order to actually trigger the event; defaults to "any
1543 # @once: #optional disables further events after this one has been
1544 # triggered; defaults to false
1546 # @immediately: #optional fail immediately; defaults to false
1550 { 'type': 'BlkdebugInjectErrorOptions',
1551 'data': { 'event': 'BlkdebugEvent',
1556 '*immediately': 'bool' } }
1559 # @BlkdebugSetStateOptions
1561 # Describes a single state-change event for blkdebug.
1563 # @event: trigger event
1565 # @state: #optional the current state identifier blkdebug needs to be in;
1568 # @new_state: the state identifier blkdebug is supposed to assume if
1569 # this event is triggered
1573 { 'type': 'BlkdebugSetStateOptions',
1574 'data': { 'event': 'BlkdebugEvent',
1576 'new_state': 'int' } }
1579 # @BlockdevOptionsBlkdebug
1581 # Driver specific block device options for blkdebug.
1583 # @image: underlying raw block device (or image file)
1585 # @config: #optional filename of the configuration file
1587 # @align: #optional required alignment for requests in bytes
1589 # @inject-error: #optional array of error injection descriptions
1591 # @set-state: #optional array of state-change descriptions
1595 { 'type': 'BlockdevOptionsBlkdebug',
1596 'data': { 'image': 'BlockdevRef',
1599 '*inject-error': ['BlkdebugInjectErrorOptions'],
1600 '*set-state': ['BlkdebugSetStateOptions'] } }
1603 # @BlockdevOptionsBlkverify
1605 # Driver specific block device options for blkverify.
1607 # @test: block device to be tested
1609 # @raw: raw image used for verification
1613 { 'type': 'BlockdevOptionsBlkverify',
1614 'data': { 'test': 'BlockdevRef',
1615 'raw': 'BlockdevRef' } }
1618 # @QuorumReadPattern
1620 # An enumeration of quorum read patterns.
1622 # @quorum: read all the children and do a quorum vote on reads
1624 # @fifo: read only from the first child that has not failed
1628 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
1631 # @BlockdevOptionsQuorum
1633 # Driver specific block device options for Quorum
1635 # @blkverify: #optional true if the driver must print content mismatch
1636 # set to false by default
1638 # @children: the children block devices to use
1640 # @vote-threshold: the vote limit under which a read will fail
1642 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
1645 # @read-pattern: #optional choose read pattern and set to quorum by default
1650 { 'type': 'BlockdevOptionsQuorum',
1651 'data': { '*blkverify': 'bool',
1652 'children': [ 'BlockdevRef' ],
1653 'vote-threshold': 'int',
1654 '*rewrite-corrupted': 'bool',
1655 '*read-pattern': 'QuorumReadPattern' } }
1660 # Options for creating a block device.
1664 { 'union': 'BlockdevOptions',
1665 'base': 'BlockdevOptionsBase',
1666 'discriminator': 'driver',
1668 'archipelago':'BlockdevOptionsArchipelago',
1669 'blkdebug': 'BlockdevOptionsBlkdebug',
1670 'blkverify': 'BlockdevOptionsBlkverify',
1671 'bochs': 'BlockdevOptionsGenericFormat',
1672 'cloop': 'BlockdevOptionsGenericFormat',
1673 'dmg': 'BlockdevOptionsGenericFormat',
1674 'file': 'BlockdevOptionsFile',
1675 'ftp': 'BlockdevOptionsFile',
1676 'ftps': 'BlockdevOptionsFile',
1677 # TODO gluster: Wait for structured options
1678 'host_cdrom': 'BlockdevOptionsFile',
1679 'host_device':'BlockdevOptionsFile',
1680 'host_floppy':'BlockdevOptionsFile',
1681 'http': 'BlockdevOptionsFile',
1682 'https': 'BlockdevOptionsFile',
1683 # TODO iscsi: Wait for structured options
1684 # TODO nbd: Should take InetSocketAddress for 'host'?
1685 # TODO nfs: Wait for structured options
1686 'null-aio': 'BlockdevOptionsNull',
1687 'null-co': 'BlockdevOptionsNull',
1688 'parallels': 'BlockdevOptionsGenericFormat',
1689 'qcow2': 'BlockdevOptionsQcow2',
1690 'qcow': 'BlockdevOptionsGenericCOWFormat',
1691 'qed': 'BlockdevOptionsGenericCOWFormat',
1692 'quorum': 'BlockdevOptionsQuorum',
1693 'raw': 'BlockdevOptionsGenericFormat',
1694 # TODO rbd: Wait for structured options
1695 # TODO sheepdog: Wait for structured options
1696 # TODO ssh: Should take InetSocketAddress for 'host'?
1697 'tftp': 'BlockdevOptionsFile',
1698 'vdi': 'BlockdevOptionsGenericFormat',
1699 'vhdx': 'BlockdevOptionsGenericFormat',
1700 'vmdk': 'BlockdevOptionsGenericCOWFormat',
1701 'vpc': 'BlockdevOptionsGenericFormat',
1702 'vvfat': 'BlockdevOptionsVVFAT'
1708 # Reference to a block device.
1710 # @definition: defines a new block device inline
1711 # @reference: references the ID of an existing block device. An
1712 # empty string means that no block device should be
1717 { 'union': 'BlockdevRef',
1718 'discriminator': {},
1719 'data': { 'definition': 'BlockdevOptions',
1720 'reference': 'str' } }
1725 # Creates a new block device.
1727 # @options: block device options for the new device
1731 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }
1737 # An enumeration of action that has been taken when a DISK I/O occurs
1739 # @ignore: error has been ignored
1741 # @report: error has been reported to the device
1743 # @stop: error caused VM to be stopped
1747 { 'enum': 'BlockErrorAction',
1748 'data': [ 'ignore', 'report', 'stop' ] }
1752 # @BLOCK_IMAGE_CORRUPTED
1754 # Emitted when a corruption has been detected in a disk image
1756 # @device: device name
1758 # @msg: informative message for human consumption, such as the kind of
1759 # corruption being detected. It should not be parsed by machine as it is
1760 # not guaranteed to be stable
1762 # @offset: #optional, if the corruption resulted from an image access, this is
1763 # the access offset into the image
1765 # @size: #optional, if the corruption resulted from an image access, this is
1768 # fatal: if set, the image is marked corrupt and therefore unusable after this
1769 # event and must be repaired (Since 2.2; before, every
1770 # BLOCK_IMAGE_CORRUPTED event was fatal)
1774 { 'event': 'BLOCK_IMAGE_CORRUPTED',
1775 'data': { 'device' : 'str',
1779 'fatal' : 'bool' } }
1784 # Emitted when a disk I/O error occurs
1786 # @device: device name
1788 # @operation: I/O operation
1790 # @action: action that has been taken
1792 # @nospace: #optional true if I/O error was caused due to a no-space
1793 # condition. This key is only present if query-block's
1794 # io-status is present, please see query-block documentation
1795 # for more information (since: 2.2)
1797 # @reason: human readable string describing the error cause.
1798 # (This field is a debugging aid for humans, it should not
1799 # be parsed by applications) (since: 2.2)
1801 # Note: If action is "stop", a STOP event will eventually follow the
1802 # BLOCK_IO_ERROR event
1806 { 'event': 'BLOCK_IO_ERROR',
1807 'data': { 'device': 'str', 'operation': 'IoOperationType',
1808 'action': 'BlockErrorAction', '*nospace': 'bool',
1812 # @BLOCK_JOB_COMPLETED
1814 # Emitted when a block job has completed
1818 # @device: device name
1820 # @len: maximum progress value
1822 # @offset: current progress value. On success this is equal to len.
1823 # On failure this is less than len
1825 # @speed: rate limit, bytes per second
1827 # @error: #optional, error message. Only present on failure. This field
1828 # contains a human-readable error message. There are no semantics
1829 # other than that streaming has failed and clients should not try to
1830 # interpret the error string
1834 { 'event': 'BLOCK_JOB_COMPLETED',
1835 'data': { 'type' : 'BlockJobType',
1843 # @BLOCK_JOB_CANCELLED
1845 # Emitted when a block job has been cancelled
1849 # @device: device name
1851 # @len: maximum progress value
1853 # @offset: current progress value. On success this is equal to len.
1854 # On failure this is less than len
1856 # @speed: rate limit, bytes per second
1860 { 'event': 'BLOCK_JOB_CANCELLED',
1861 'data': { 'type' : 'BlockJobType',
1870 # Emitted when a block job encounters an error
1872 # @device: device name
1874 # @operation: I/O operation
1876 # @action: action that has been taken
1880 { 'event': 'BLOCK_JOB_ERROR',
1881 'data': { 'device' : 'str',
1882 'operation': 'IoOperationType',
1883 'action' : 'BlockErrorAction' } }
1888 # Emitted when a block job is ready to complete
1892 # @device: device name
1894 # @len: maximum progress value
1896 # @offset: current progress value. On success this is equal to len.
1897 # On failure this is less than len
1899 # @speed: rate limit, bytes per second
1901 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
1906 { 'event': 'BLOCK_JOB_READY',
1907 'data': { 'type' : 'BlockJobType',
1915 # Preallocation mode of QEMU image file
1917 # @off: no preallocation
1918 # @metadata: preallocate only for metadata
1919 # @falloc: like @full preallocation but allocate disk space by
1920 # posix_fallocate() rather than writing zeros.
1921 # @full: preallocate all data by writing zeros to device to ensure disk
1922 # space is really available. @full preallocation also sets up
1923 # metadata correctly.
1927 { 'enum': 'PreallocMode',
1928 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
1931 # @BLOCK_WRITE_THRESHOLD
1933 # Emitted when writes on block device reaches or exceeds the
1934 # configured write threshold. For thin-provisioned devices, this
1935 # means the device should be extended to avoid pausing for
1937 # The event is one shot. Once triggered, it needs to be
1938 # re-registered with another block-set-threshold command.
1940 # @node-name: graph node name on which the threshold was exceeded.
1942 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
1944 # @write-threshold: last configured threshold, in bytes.
1948 { 'event': 'BLOCK_WRITE_THRESHOLD',
1949 'data': { 'node-name': 'str',
1950 'amount-exceeded': 'uint64',
1951 'write-threshold': 'uint64' } }
1954 # @block-set-write-threshold
1956 # Change the write threshold for a block drive. An event will be delivered
1957 # if a write to this block drive crosses the configured threshold.
1958 # This is useful to transparently resize thin-provisioned drives without
1959 # the guest OS noticing.
1961 # @node-name: graph node name on which the threshold must be set.
1963 # @write-threshold: configured threshold for the block device, bytes.
1964 # Use 0 to disable the threshold.
1968 { 'command': 'block-set-write-threshold',
1969 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }