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 # '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
222 # 2.5: 'host_floppy' dropped
224 # @backing_file: #optional the name of the backing file (for copy-on-write)
226 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
228 # @encrypted: true if the backing device is encrypted
230 # @encryption_key_missing: true if the backing device is encrypted but an
231 # valid encryption key is missing
233 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
235 # @bps: total throughput limit in bytes per second is specified
237 # @bps_rd: read throughput limit in bytes per second is specified
239 # @bps_wr: write throughput limit in bytes per second is specified
241 # @iops: total I/O operations per second is specified
243 # @iops_rd: read I/O operations per second is specified
245 # @iops_wr: write I/O operations per second is specified
247 # @image: the info of image used (since: 1.6)
249 # @bps_max: #optional total max in bytes (Since 1.7)
251 # @bps_rd_max: #optional read max in bytes (Since 1.7)
253 # @bps_wr_max: #optional write max in bytes (Since 1.7)
255 # @iops_max: #optional total I/O operations max (Since 1.7)
257 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
259 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
261 # @iops_size: #optional an I/O size in bytes (Since 1.7)
263 # @group: #optional throttle group name (Since 2.4)
265 # @cache: the cache mode used for the block device (since: 2.3)
267 # @write_threshold: configured write threshold for the device.
268 # 0 if disabled. (Since 2.3)
273 { 'struct': 'BlockDeviceInfo',
274 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
275 '*backing_file': 'str', 'backing_file_depth': 'int',
276 'encrypted': 'bool', 'encryption_key_missing': 'bool',
277 'detect_zeroes': 'BlockdevDetectZeroesOptions',
278 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
279 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
280 'image': 'ImageInfo',
281 '*bps_max': 'int', '*bps_rd_max': 'int',
282 '*bps_wr_max': 'int', '*iops_max': 'int',
283 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
284 '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
285 'write_threshold': 'int' } }
288 # @BlockDeviceIoStatus:
290 # An enumeration of block device I/O status.
292 # @ok: The last I/O operation has succeeded
294 # @failed: The last I/O operation has failed
296 # @nospace: The last I/O operation has failed due to a no-space condition
300 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
303 # @BlockDeviceMapEntry:
305 # Entry in the metadata map of the device (returned by "qemu-img map")
307 # @start: Offset in the image of the first byte described by this entry
310 # @length: Length of the range described by this entry (in bytes)
312 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
313 # before reaching one for which the range is allocated. The value is
314 # in the range 0 to the depth of the image chain - 1.
316 # @zero: the sectors in this range read as zeros
318 # @data: reading the image will actually read data from a file (in particular,
319 # if @offset is present this means that the sectors are not simply
320 # preallocated, but contain actual data in raw format)
322 # @offset: if present, the image file stores the data for this range in
323 # raw format at the given offset.
327 { 'struct': 'BlockDeviceMapEntry',
328 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
329 'data': 'bool', '*offset': 'int' } }
332 # @DirtyBitmapStatus:
334 # An enumeration of possible states that a dirty bitmap can report to the user.
336 # @frozen: The bitmap is currently in-use by a backup operation or block job,
339 # @disabled: The bitmap is currently in-use by an internal operation and is
340 # read-only. It can still be deleted.
342 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
343 # deleted, or used for backup operations.
347 { 'enum': 'DirtyBitmapStatus',
348 'data': ['active', 'disabled', 'frozen'] }
353 # Block dirty bitmap information.
355 # @name: #optional the name of the dirty bitmap (Since 2.4)
357 # @count: number of dirty bytes according to the dirty bitmap
359 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
361 # @status: current status of the dirty bitmap (since 2.4)
365 { 'struct': 'BlockDirtyInfo',
366 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
367 'status': 'DirtyBitmapStatus'} }
372 # Block device information. This structure describes a virtual device and
373 # the backing device associated with it.
375 # @device: The device name associated with the virtual device.
377 # @type: This field is returned only for compatibility reasons, it should
378 # not be used (always returns 'unknown')
380 # @removable: True if the device supports removable media.
382 # @locked: True if the guest has locked this device from having its media
385 # @tray_open: #optional True if the device has a tray and it is open
386 # (only present if removable is true)
388 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
389 # driver has one or more dirty bitmaps) (Since 2.0)
391 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
392 # supports it and the VM is configured to stop on errors
393 # (supported device models: virtio-blk, ide, scsi-disk)
395 # @inserted: #optional @BlockDeviceInfo describing the device if media is
400 { 'struct': 'BlockInfo',
401 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
402 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
403 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
404 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
409 # Get a list of BlockInfo for all virtual block devices.
411 # Returns: a list of @BlockInfo describing each virtual block device
415 { 'command': 'query-block', 'returns': ['BlockInfo'] }
420 # Statistics of a virtual block device or a block backing device.
422 # @rd_bytes: The number of bytes read by the device.
424 # @wr_bytes: The number of bytes written by the device.
426 # @rd_operations: The number of read operations performed by the device.
428 # @wr_operations: The number of write operations performed by the device.
430 # @flush_operations: The number of cache flush operations performed by the
431 # device (since 0.15.0)
433 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
436 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
438 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
440 # @wr_highest_offset: The offset after the greatest byte written to the
441 # device. The intended use of this information is for
442 # growable sparse files (like qcow2) that are used on top
443 # of a physical device.
445 # @rd_merged: Number of read requests that have been merged into another
446 # request (Since 2.3).
448 # @wr_merged: Number of write requests that have been merged into another
449 # request (Since 2.3).
451 # @idle_time_ns: #optional Time since the last I/O operation, in
452 # nanoseconds. If the field is absent it means that
453 # there haven't been any operations yet (Since 2.5).
455 # @failed_rd_operations: The number of failed read operations
456 # performed by the device (Since 2.5)
458 # @failed_wr_operations: The number of failed write operations
459 # performed by the device (Since 2.5)
461 # @failed_flush_operations: The number of failed flush operations
462 # performed by the device (Since 2.5)
464 # @invalid_rd_operations: The number of invalid read operations
465 # performed by the device (Since 2.5)
467 # @invalid_wr_operations: The number of invalid write operations
468 # performed by the device (Since 2.5)
470 # @invalid_flush_operations: The number of invalid flush operations
471 # performed by the device (Since 2.5)
475 { 'struct': 'BlockDeviceStats',
476 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
477 'wr_operations': 'int', 'flush_operations': 'int',
478 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
479 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
480 'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int',
481 'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
482 'failed_flush_operations': 'int', 'invalid_rd_operations': 'int',
483 'invalid_wr_operations': 'int', 'invalid_flush_operations': 'int' } }
488 # Statistics of a virtual block device or a block backing device.
490 # @device: #optional If the stats are for a virtual block device, the name
491 # corresponding to the virtual block device.
493 # @node-name: #optional The node name of the device. (Since 2.3)
495 # @stats: A @BlockDeviceStats for the device.
497 # @parent: #optional This describes the file block device if it has one.
499 # @backing: #optional This describes the backing block device if it has one.
504 { 'struct': 'BlockStats',
505 'data': {'*device': 'str', '*node-name': 'str',
506 'stats': 'BlockDeviceStats',
507 '*parent': 'BlockStats',
508 '*backing': 'BlockStats'} }
513 # Query the @BlockStats for all virtual block devices.
515 # @query-nodes: #optional If true, the command will query all the block nodes
516 # that have a node name, in a list which will include "parent"
517 # information, but not "backing".
518 # If false or omitted, the behavior is as before - query all the
519 # device backends, recursively including their "parent" and
520 # "backing". (Since 2.3)
522 # Returns: A list of @BlockStats for each virtual block devices.
526 { 'command': 'query-blockstats',
527 'data': { '*query-nodes': 'bool' },
528 'returns': ['BlockStats'] }
533 # An enumeration of possible behaviors for errors on I/O operations.
534 # The exact meaning depends on whether the I/O was initiated by a guest
537 # @report: for guest operations, report the error to the guest;
538 # for jobs, cancel the job
540 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
541 # or BLOCK_JOB_ERROR)
543 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
545 # @stop: for guest operations, stop the virtual machine;
546 # for jobs, pause the job
550 { 'enum': 'BlockdevOnError',
551 'data': ['report', 'ignore', 'enospc', 'stop'] }
556 # An enumeration of possible behaviors for the initial synchronization
557 # phase of storage mirroring.
559 # @top: copies data in the topmost image to the destination
561 # @full: copies data from all images to the destination
563 # @none: only copy data written from now on
565 # @incremental: only copy data described by the dirty bitmap. Since: 2.4
569 { 'enum': 'MirrorSyncMode',
570 'data': ['top', 'full', 'none', 'incremental'] }
575 # Type of a block job.
577 # @commit: block commit job type, see "block-commit"
579 # @stream: block stream job type, see "block-stream"
581 # @mirror: drive mirror job type, see "drive-mirror"
583 # @backup: drive backup job type, see "drive-backup"
587 { 'enum': 'BlockJobType',
588 'data': ['commit', 'stream', 'mirror', 'backup'] }
593 # Information about a long-running block device operation.
595 # @type: the job type ('stream' for image streaming)
597 # @device: the block device name
599 # @len: the maximum progress value
601 # @busy: false if the job is known to be in a quiescent state, with
602 # no pending I/O. Since 1.3.
604 # @paused: whether the job is paused or, if @busy is true, will
605 # pause itself as soon as possible. Since 1.3.
607 # @offset: the current progress value
609 # @speed: the rate limit, bytes per second
611 # @io-status: the status of the job (since 1.3)
613 # @ready: true if the job may be completed (since 2.2)
617 { 'struct': 'BlockJobInfo',
618 'data': {'type': 'str', 'device': 'str', 'len': 'int',
619 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
620 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
625 # Return information about long-running block device operations.
627 # Returns: a list of @BlockJobInfo for each active block job
631 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
636 # This command sets the password of a block device that has not been open
637 # with a password and requires one.
639 # The two cases where this can happen are a block device is created through
640 # QEMU's initial command line or a block device is changed through the legacy
643 # In the event that the block device is created through the initial command
644 # line, the VM will start in the stopped state regardless of whether '-S' is
645 # used. The intention is for a management tool to query the block devices to
646 # determine which ones are encrypted, set the passwords with this command, and
647 # then start the guest with the @cont command.
649 # Either @device or @node-name must be set but not both.
651 # @device: #optional the name of the block backend device to set the password on
653 # @node-name: #optional graph node name to set the password on (Since 2.0)
655 # @password: the password to use for the device
657 # Returns: nothing on success
658 # If @device is not a valid block device, DeviceNotFound
659 # If @device is not encrypted, DeviceNotEncrypted
661 # Notes: Not all block formats support encryption and some that do are not
662 # able to validate that a password is correct. Disk corruption may
663 # occur if an invalid password is specified.
667 { 'command': 'block_passwd', 'data': {'*device': 'str',
668 '*node-name': 'str', 'password': 'str'} }
673 # Resize a block image while a guest is running.
675 # Either @device or @node-name must be set but not both.
677 # @device: #optional the name of the device to get the image resized
679 # @node-name: #optional graph node name to get the image resized (Since 2.0)
681 # @size: new image size in bytes
683 # Returns: nothing on success
684 # If @device is not a valid block device, DeviceNotFound
688 { 'command': 'block_resize', 'data': { '*device': 'str',
695 # An enumeration that tells QEMU how to set the backing file path in
698 # @existing: QEMU should look for an existing image file.
700 # @absolute-paths: QEMU should create a new image with absolute paths
701 # for the backing file. If there is no backing file available, the new
702 # image will not be backed either.
706 { 'enum': 'NewImageMode',
707 'data': [ 'existing', 'absolute-paths' ] }
710 # @BlockdevSnapshotSync
712 # Either @device or @node-name must be set but not both.
714 # @device: #optional the name of the device to generate the snapshot from.
716 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
718 # @snapshot-file: the target of the new image. A new file will be created.
720 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
722 # @format: #optional the format of the snapshot image, default is 'qcow2'.
724 # @mode: #optional whether and how QEMU should create a new image, default is
727 { 'struct': 'BlockdevSnapshotSync',
728 'data': { '*device': 'str', '*node-name': 'str',
729 'snapshot-file': 'str', '*snapshot-node-name': 'str',
730 '*format': 'str', '*mode': 'NewImageMode' } }
735 # @node: device or node name that will have a snapshot created.
737 # @overlay: reference to the existing block device that will become
738 # the overlay of @node, as part of creating the snapshot.
739 # It must not have a current backing file (this can be
740 # achieved by passing "backing": "" to blockdev-add).
744 { 'struct': 'BlockdevSnapshot',
745 'data': { 'node': 'str', 'overlay': 'str' } }
750 # @device: the name of the device which should be copied.
752 # @target: the target of the new image. If the file exists, or if it
753 # is a device, the existing file/device will be used as the new
754 # destination. If it does not exist, a new file will be created.
756 # @format: #optional the format of the new destination, default is to
757 # probe if @mode is 'existing', else the format of the source
759 # @sync: what parts of the disk image should be copied to the destination
760 # (all the disk, only the sectors allocated in the topmost image, from a
761 # dirty bitmap, or only new I/O).
763 # @mode: #optional whether and how QEMU should create a new image, default is
766 # @speed: #optional the maximum speed, in bytes per second
768 # @bitmap: #optional the name of dirty bitmap if sync is "incremental".
769 # Must be present if sync is "incremental", must NOT be present
770 # otherwise. (Since 2.4)
772 # @on-source-error: #optional the action to take on an error on the source,
773 # default 'report'. 'stop' and 'enospc' can only be used
774 # if the block device supports io-status (see BlockInfo).
776 # @on-target-error: #optional the action to take on an error on the target,
777 # default 'report' (no limitations, since this applies to
778 # a different block device than @device).
780 # Note that @on-source-error and @on-target-error only affect background I/O.
781 # If an error occurs during a guest write request, the device's rerror/werror
782 # actions will be used.
786 { 'struct': 'DriveBackup',
787 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
788 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
789 '*speed': 'int', '*bitmap': 'str',
790 '*on-source-error': 'BlockdevOnError',
791 '*on-target-error': 'BlockdevOnError' } }
796 # @device: the name of the device which should be copied.
798 # @target: the name of the backup target device.
800 # @sync: what parts of the disk image should be copied to the destination
801 # (all the disk, only the sectors allocated in the topmost image, or
804 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
807 # @on-source-error: #optional the action to take on an error on the source,
808 # default 'report'. 'stop' and 'enospc' can only be used
809 # if the block device supports io-status (see BlockInfo).
811 # @on-target-error: #optional the action to take on an error on the target,
812 # default 'report' (no limitations, since this applies to
813 # a different block device than @device).
815 # Note that @on-source-error and @on-target-error only affect background I/O.
816 # If an error occurs during a guest write request, the device's rerror/werror
817 # actions will be used.
821 { 'struct': 'BlockdevBackup',
822 'data': { 'device': 'str', 'target': 'str',
823 'sync': 'MirrorSyncMode',
825 '*on-source-error': 'BlockdevOnError',
826 '*on-target-error': 'BlockdevOnError' } }
829 # @blockdev-snapshot-sync
831 # Generates a synchronous snapshot of a block device.
833 # For the arguments, see the documentation of BlockdevSnapshotSync.
835 # Returns: nothing on success
836 # If @device is not a valid block device, DeviceNotFound
840 { 'command': 'blockdev-snapshot-sync',
841 'data': 'BlockdevSnapshotSync' }
847 # Generates a snapshot of a block device.
849 # For the arguments, see the documentation of BlockdevSnapshot.
853 { 'command': 'blockdev-snapshot',
854 'data': 'BlockdevSnapshot' }
857 # @change-backing-file
859 # Change the backing file in the image file metadata. This does not
860 # cause QEMU to reopen the image file to reparse the backing filename
861 # (it may, however, perform a reopen to change permissions from
862 # r/o -> r/w -> r/o, if needed). The new backing file string is written
863 # into the image file metadata, and the QEMU internal strings are
866 # @image-node-name: The name of the block driver state node of the
869 # @device: The name of the device that owns image-node-name.
871 # @backing-file: The string to write as the backing file. This
872 # string is not validated, so care should be taken
873 # when specifying the string or the image chain may
874 # not be able to be reopened again.
878 { 'command': 'change-backing-file',
879 'data': { 'device': 'str', 'image-node-name': 'str',
880 'backing-file': 'str' } }
885 # Live commit of data from overlay image nodes into backing nodes - i.e.,
886 # writes data between 'top' and 'base' into 'base'.
888 # @device: the name of the device
890 # @base: #optional The file name of the backing image to write data into.
891 # If not specified, this is the deepest backing image
893 # @top: #optional The file name of the backing image within the image chain,
894 # which contains the topmost data to be committed down. If
895 # not specified, this is the active layer.
897 # @backing-file: #optional The backing file string to write into the overlay
898 # image of 'top'. If 'top' is the active layer,
899 # specifying a backing file string is an error. This
900 # filename is not validated.
902 # If a pathname string is such that it cannot be
903 # resolved by QEMU, that means that subsequent QMP or
904 # HMP commands must use node-names for the image in
905 # question, as filename lookup methods will fail.
907 # If not specified, QEMU will automatically determine
908 # the backing file string to use, or error out if
909 # there is no obvious choice. Care should be taken
910 # when specifying the string, to specify a valid
911 # filename or protocol.
914 # If top == base, that is an error.
915 # If top == active, the job will not be completed by itself,
916 # user needs to complete the job with the block-job-complete
917 # command after getting the ready event. (Since 2.0)
919 # If the base image is smaller than top, then the base image
920 # will be resized to be the same size as top. If top is
921 # smaller than the base image, the base will not be
922 # truncated. If you want the base image size to match the
923 # size of the smaller top, you can safely truncate it
924 # yourself once the commit operation successfully completes.
926 # @speed: #optional the maximum speed, in bytes per second
928 # Returns: Nothing on success
929 # If commit or stream is already active on this device, DeviceInUse
930 # If @device does not exist, DeviceNotFound
931 # If image commit is not supported by this device, NotSupported
932 # If @base or @top is invalid, a generic error is returned
933 # If @speed is invalid, InvalidParameter
938 { 'command': 'block-commit',
939 'data': { 'device': 'str', '*base': 'str', '*top': 'str',
940 '*backing-file': 'str', '*speed': 'int' } }
945 # Start a point-in-time copy of a block device to a new destination. The
946 # status of ongoing drive-backup operations can be checked with
947 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
948 # The operation can be stopped before it has completed using the
949 # block-job-cancel command.
951 # For the arguments, see the documentation of DriveBackup.
953 # Returns: nothing on success
954 # If @device is not a valid block device, DeviceNotFound
958 { 'command': 'drive-backup', 'data': 'DriveBackup' }
963 # Start a point-in-time copy of a block device to a new destination. The
964 # status of ongoing blockdev-backup operations can be checked with
965 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
966 # The operation can be stopped before it has completed using the
967 # block-job-cancel command.
969 # For the arguments, see the documentation of BlockdevBackup.
973 { 'command': 'blockdev-backup', 'data': 'BlockdevBackup' }
977 # @query-named-block-nodes
979 # Get the named block driver list
981 # Returns: the list of BlockDeviceInfo
985 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
990 # Start mirroring a block device's writes to a new destination.
992 # @device: the name of the device whose writes should be mirrored.
994 # @target: the target of the new image. If the file exists, or if it
995 # is a device, the existing file/device will be used as the new
996 # destination. If it does not exist, a new file will be created.
998 # @format: #optional the format of the new destination, default is to
999 # probe if @mode is 'existing', else the format of the source
1001 # @node-name: #optional the new block driver state node name in the graph
1004 # @replaces: #optional with sync=full graph node name to be replaced by the new
1005 # image when a whole image copy is done. This can be used to repair
1006 # broken Quorum files. (Since 2.1)
1008 # @mode: #optional whether and how QEMU should create a new image, default is
1011 # @speed: #optional the maximum speed, in bytes per second
1013 # @sync: what parts of the disk image should be copied to the destination
1014 # (all the disk, only the sectors allocated in the topmost image, or
1017 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1018 # if the image format doesn't have clusters, 4K if the clusters
1019 # are smaller than that, else the cluster size. Must be a
1020 # power of 2 between 512 and 64M (since 1.4).
1022 # @buf-size: #optional maximum amount of data in flight from source to
1023 # target (since 1.4).
1025 # @on-source-error: #optional the action to take on an error on the source,
1026 # default 'report'. 'stop' and 'enospc' can only be used
1027 # if the block device supports io-status (see BlockInfo).
1029 # @on-target-error: #optional the action to take on an error on the target,
1030 # default 'report' (no limitations, since this applies to
1031 # a different block device than @device).
1032 # @unmap: #optional Whether to try to unmap target sectors where source has
1033 # only zero. If true, and target unallocated sectors will read as zero,
1034 # target image sectors will be unmapped; otherwise, zeroes will be
1035 # written. Both will result in identical contents.
1036 # Default is true. (Since 2.4)
1038 # Returns: nothing on success
1039 # If @device is not a valid block device, DeviceNotFound
1043 { 'command': 'drive-mirror',
1044 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
1045 '*node-name': 'str', '*replaces': 'str',
1046 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1047 '*speed': 'int', '*granularity': 'uint32',
1048 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1049 '*on-target-error': 'BlockdevOnError',
1050 '*unmap': 'bool' } }
1055 # @node: name of device/node which the bitmap is tracking
1057 # @name: name of the dirty bitmap
1061 { 'struct': 'BlockDirtyBitmap',
1062 'data': { 'node': 'str', 'name': 'str' } }
1065 # @BlockDirtyBitmapAdd
1067 # @node: name of device/node which the bitmap is tracking
1069 # @name: name of the dirty bitmap
1071 # @granularity: #optional the bitmap granularity, default is 64k for
1072 # block-dirty-bitmap-add
1076 { 'struct': 'BlockDirtyBitmapAdd',
1077 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } }
1080 # @block-dirty-bitmap-add
1082 # Create a dirty bitmap with a name on the node
1084 # Returns: nothing on success
1085 # If @node is not a valid block device or node, DeviceNotFound
1086 # If @name is already taken, GenericError with an explanation
1090 { 'command': 'block-dirty-bitmap-add',
1091 'data': 'BlockDirtyBitmapAdd' }
1094 # @block-dirty-bitmap-remove
1096 # Remove a dirty bitmap on the node
1098 # Returns: nothing on success
1099 # If @node is not a valid block device or node, DeviceNotFound
1100 # If @name is not found, GenericError with an explanation
1101 # if @name is frozen by an operation, GenericError
1105 { 'command': 'block-dirty-bitmap-remove',
1106 'data': 'BlockDirtyBitmap' }
1109 # @block-dirty-bitmap-clear
1111 # Clear (reset) a dirty bitmap on the device
1113 # Returns: nothing on success
1114 # If @node is not a valid block device, DeviceNotFound
1115 # If @name is not found, GenericError with an explanation
1119 { 'command': 'block-dirty-bitmap-clear',
1120 'data': 'BlockDirtyBitmap' }
1123 # @block_set_io_throttle:
1125 # Change I/O throttle limits for a block drive.
1127 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1130 # If two or more devices are members of the same group, the limits
1131 # will apply to the combined I/O of the whole group in a round-robin
1132 # fashion. Therefore, setting new I/O limits to a device will affect
1135 # The name of the group can be specified using the 'group' parameter.
1136 # If the parameter is unset, it is assumed to be the current group of
1137 # that device. If it's not in any group yet, the name of the device
1138 # will be used as the name for its group.
1140 # The 'group' parameter can also be used to move a device to a
1141 # different group. In this case the limits specified in the parameters
1142 # will be applied to the new group only.
1144 # I/O limits can be disabled by setting all of them to 0. In this case
1145 # the device will be removed from its group and the rest of its
1146 # members will not be affected. The 'group' parameter is ignored.
1148 # @device: The name of the device
1150 # @bps: total throughput limit in bytes per second
1152 # @bps_rd: read throughput limit in bytes per second
1154 # @bps_wr: write throughput limit in bytes per second
1156 # @iops: total I/O operations per second
1158 # @ops_rd: read I/O operations per second
1160 # @iops_wr: write I/O operations per second
1162 # @bps_max: #optional total max in bytes (Since 1.7)
1164 # @bps_rd_max: #optional read max in bytes (Since 1.7)
1166 # @bps_wr_max: #optional write max in bytes (Since 1.7)
1168 # @iops_max: #optional total I/O operations max (Since 1.7)
1170 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
1172 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
1174 # @iops_size: #optional an I/O size in bytes (Since 1.7)
1176 # @group: #optional throttle group name (Since 2.4)
1178 # Returns: Nothing on success
1179 # If @device is not a valid block device, DeviceNotFound
1183 { 'command': 'block_set_io_throttle',
1184 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1185 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1186 '*bps_max': 'int', '*bps_rd_max': 'int',
1187 '*bps_wr_max': 'int', '*iops_max': 'int',
1188 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1189 '*iops_size': 'int', '*group': 'str' } }
1194 # Copy data from a backing file into a block device.
1196 # The block streaming operation is performed in the background until the entire
1197 # backing file has been copied. This command returns immediately once streaming
1198 # has started. The status of ongoing block streaming operations can be checked
1199 # with query-block-jobs. The operation can be stopped before it has completed
1200 # using the block-job-cancel command.
1202 # If a base file is specified then sectors are not copied from that base file and
1203 # its backing chain. When streaming completes the image file will have the base
1204 # file as its backing file. This can be used to stream a subset of the backing
1205 # file chain instead of flattening the entire image.
1207 # On successful completion the image file is updated to drop the backing file
1208 # and the BLOCK_JOB_COMPLETED event is emitted.
1210 # @device: the device name
1212 # @base: #optional the common backing file name
1214 # @backing-file: #optional The backing file string to write into the active
1215 # layer. This filename is not validated.
1217 # If a pathname string is such that it cannot be
1218 # resolved by QEMU, that means that subsequent QMP or
1219 # HMP commands must use node-names for the image in
1220 # question, as filename lookup methods will fail.
1222 # If not specified, QEMU will automatically determine
1223 # the backing file string to use, or error out if there
1224 # is no obvious choice. Care should be taken when
1225 # specifying the string, to specify a valid filename or
1229 # @speed: #optional the maximum speed, in bytes per second
1231 # @on-error: #optional the action to take on an error (default report).
1232 # 'stop' and 'enospc' can only be used if the block device
1233 # supports io-status (see BlockInfo). Since 1.3.
1235 # Returns: Nothing on success
1236 # If @device does not exist, DeviceNotFound
1240 { 'command': 'block-stream',
1241 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str',
1242 '*speed': 'int', '*on-error': 'BlockdevOnError' } }
1245 # @block-job-set-speed:
1247 # Set maximum speed for a background block operation.
1249 # This command can only be issued when there is an active block job.
1251 # Throttling can be disabled by setting the speed to 0.
1253 # @device: the device name
1255 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1258 # Returns: Nothing on success
1259 # If no background operation is active on this device, DeviceNotActive
1263 { 'command': 'block-job-set-speed',
1264 'data': { 'device': 'str', 'speed': 'int' } }
1267 # @block-job-cancel:
1269 # Stop an active background block operation.
1271 # This command returns immediately after marking the active background block
1272 # operation for cancellation. It is an error to call this command if no
1273 # operation is in progress.
1275 # The operation will cancel as soon as possible and then emit the
1276 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1277 # enumerated using query-block-jobs.
1279 # For streaming, the image file retains its backing file unless the streaming
1280 # operation happens to complete just as it is being cancelled. A new streaming
1281 # operation can be started at a later time to finish copying all data from the
1284 # @device: the device name
1286 # @force: #optional whether to allow cancellation of a paused job (default
1287 # false). Since 1.3.
1289 # Returns: Nothing on success
1290 # If no background operation is active on this device, DeviceNotActive
1294 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1299 # Pause an active background block operation.
1301 # This command returns immediately after marking the active background block
1302 # operation for pausing. It is an error to call this command if no
1303 # operation is in progress. Pausing an already paused job has no cumulative
1304 # effect; a single block-job-resume command will resume the job.
1306 # The operation will pause as soon as possible. No event is emitted when
1307 # the operation is actually paused. Cancelling a paused job automatically
1310 # @device: the device name
1312 # Returns: Nothing on success
1313 # If no background operation is active on this device, DeviceNotActive
1317 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1320 # @block-job-resume:
1322 # Resume an active background block operation.
1324 # This command returns immediately after resuming a paused background block
1325 # operation. It is an error to call this command if no operation is in
1326 # progress. Resuming an already running job is not an error.
1328 # This command also clears the error status of the job.
1330 # @device: the device name
1332 # Returns: Nothing on success
1333 # If no background operation is active on this device, DeviceNotActive
1337 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1340 # @block-job-complete:
1342 # Manually trigger completion of an active background block operation. This
1343 # is supported for drive mirroring, where it also switches the device to
1344 # write to the target path only. The ability to complete is signaled with
1345 # a BLOCK_JOB_READY event.
1347 # This command completes an active background block operation synchronously.
1348 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1349 # is not defined. Note that if an I/O error occurs during the processing of
1350 # this command: 1) the command itself will fail; 2) the error will be processed
1351 # according to the rerror/werror arguments that were specified when starting
1354 # A cancelled or paused job cannot be completed.
1356 # @device: the device name
1358 # Returns: Nothing on success
1359 # If no background operation is active on this device, DeviceNotActive
1363 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1366 # @BlockdevDiscardOptions
1368 # Determines how to handle discard requests.
1370 # @ignore: Ignore the request
1371 # @unmap: Forward as an unmap request
1375 { 'enum': 'BlockdevDiscardOptions',
1376 'data': [ 'ignore', 'unmap' ] }
1379 # @BlockdevDetectZeroesOptions
1381 # Describes the operation mode for the automatic conversion of plain
1382 # zero writes by the OS to driver specific optimized zero write commands.
1384 # @off: Disabled (default)
1386 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1387 # also that @BlockdevDiscardOptions is set to unmap for this device.
1391 { 'enum': 'BlockdevDetectZeroesOptions',
1392 'data': [ 'off', 'on', 'unmap' ] }
1395 # @BlockdevAioOptions
1397 # Selects the AIO backend to handle I/O requests
1399 # @threads: Use qemu's thread pool
1400 # @native: Use native AIO backend (only Linux and Windows)
1404 { 'enum': 'BlockdevAioOptions',
1405 'data': [ 'threads', 'native' ] }
1408 # @BlockdevCacheOptions
1410 # Includes cache-related options for block devices
1412 # @writeback: #optional enables writeback mode for any caches (default: true)
1413 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1415 # @no-flush: #optional ignore any flush requests for the device (default:
1420 { 'struct': 'BlockdevCacheOptions',
1421 'data': { '*writeback': 'bool',
1423 '*no-flush': 'bool' } }
1428 # Drivers that are supported in block device operations.
1430 # @host_device, @host_cdrom: Since 2.1
1434 { 'enum': 'BlockdevDriver',
1435 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1436 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
1437 'http', 'https', 'null-aio', 'null-co', 'parallels',
1438 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx',
1439 'vmdk', 'vpc', 'vvfat' ] }
1442 # @BlockdevOptionsBase
1444 # Options that are available for all block devices, independent of the block
1447 # @driver: block driver name
1448 # @id: #optional id by which the new block device can be referred to.
1449 # This option is only allowed on the top level of blockdev-add.
1450 # A BlockBackend will be created by blockdev-add if and only if
1451 # this option is given.
1452 # @node-name: #optional the name of a block driver state node (Since 2.0).
1453 # This option is required on the top level of blockdev-add if
1454 # the @id option is not given there.
1455 # @discard: #optional discard-related options (default: ignore)
1456 # @cache: #optional cache-related options
1457 # @aio: #optional AIO backend (default: threads)
1458 # @rerror: #optional how to handle read errors on the device
1460 # @werror: #optional how to handle write errors on the device
1462 # @read-only: #optional whether the block device should be read-only
1464 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
1469 { 'struct': 'BlockdevOptionsBase',
1470 'data': { 'driver': 'BlockdevDriver',
1472 '*node-name': 'str',
1473 '*discard': 'BlockdevDiscardOptions',
1474 '*cache': 'BlockdevCacheOptions',
1475 '*aio': 'BlockdevAioOptions',
1476 '*rerror': 'BlockdevOnError',
1477 '*werror': 'BlockdevOnError',
1478 '*read-only': 'bool',
1479 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } }
1482 # @BlockdevOptionsFile
1484 # Driver specific block device options for the file backend and similar
1487 # @filename: path to the image file
1491 { 'struct': 'BlockdevOptionsFile',
1492 'data': { 'filename': 'str' } }
1495 # @BlockdevOptionsNull
1497 # Driver specific block device options for the null backend.
1499 # @size: #optional size of the device in bytes.
1500 # @latency-ns: #optional emulated latency (in nanoseconds) in processing
1501 # requests. Default to zero which completes requests immediately.
1506 { 'struct': 'BlockdevOptionsNull',
1507 'data': { '*size': 'int', '*latency-ns': 'uint64' } }
1510 # @BlockdevOptionsVVFAT
1512 # Driver specific block device options for the vvfat protocol.
1514 # @dir: directory to be exported as FAT image
1515 # @fat-type: #optional FAT type: 12, 16 or 32
1516 # @floppy: #optional whether to export a floppy image (true) or
1517 # partitioned hard disk (false; default)
1518 # @label: #optional set the volume label, limited to 11 bytes. FAT16 and
1519 # FAT32 traditionally have some restrictions on labels, which are
1520 # ignored by most operating systems. Defaults to "QEMU VVFAT".
1522 # @rw: #optional whether to allow write operations (default: false)
1526 { 'struct': 'BlockdevOptionsVVFAT',
1527 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1528 '*label': 'str', '*rw': 'bool' } }
1531 # @BlockdevOptionsGenericFormat
1533 # Driver specific block device options for image format that have no option
1534 # besides their data source.
1536 # @file: reference to or definition of the data source block device
1540 { 'struct': 'BlockdevOptionsGenericFormat',
1541 'data': { 'file': 'BlockdevRef' } }
1544 # @BlockdevOptionsGenericCOWFormat
1546 # Driver specific block device options for image format that have no option
1547 # besides their data source and an optional backing file.
1549 # @backing: #optional reference to or definition of the backing file block
1550 # device (if missing, taken from the image file content). It is
1551 # allowed to pass an empty string here in order to disable the
1552 # default backing file.
1556 { 'struct': 'BlockdevOptionsGenericCOWFormat',
1557 'base': 'BlockdevOptionsGenericFormat',
1558 'data': { '*backing': 'BlockdevRef' } }
1561 # @Qcow2OverlapCheckMode
1563 # General overlap check modes.
1565 # @none: Do not perform any checks
1567 # @constant: Perform only checks which can be done in constant time and
1568 # without reading anything from disk
1570 # @cached: Perform only checks which can be done without reading anything
1573 # @all: Perform all available overlap checks
1577 { 'enum': 'Qcow2OverlapCheckMode',
1578 'data': [ 'none', 'constant', 'cached', 'all' ] }
1581 # @Qcow2OverlapCheckFlags
1583 # Structure of flags for each metadata structure. Setting a field to 'true'
1584 # makes qemu guard that structure against unintended overwriting. The default
1585 # value is chosen according to the template given.
1587 # @template: Specifies a template mode which can be adjusted using the other
1588 # flags, defaults to 'cached'
1592 { 'struct': 'Qcow2OverlapCheckFlags',
1593 'data': { '*template': 'Qcow2OverlapCheckMode',
1594 '*main-header': 'bool',
1595 '*active-l1': 'bool',
1596 '*active-l2': 'bool',
1597 '*refcount-table': 'bool',
1598 '*refcount-block': 'bool',
1599 '*snapshot-table': 'bool',
1600 '*inactive-l1': 'bool',
1601 '*inactive-l2': 'bool' } }
1604 # @Qcow2OverlapChecks
1606 # Specifies which metadata structures should be guarded against unintended
1609 # @flags: set of flags for separate specification of each metadata structure
1612 # @mode: named mode which chooses a specific set of flags
1616 { 'alternate': 'Qcow2OverlapChecks',
1617 'data': { 'flags': 'Qcow2OverlapCheckFlags',
1618 'mode': 'Qcow2OverlapCheckMode' } }
1621 # @BlockdevOptionsQcow2
1623 # Driver specific block device options for qcow2.
1625 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1626 # feature (default is taken from the image file)
1628 # @pass-discard-request: #optional whether discard requests to the qcow2
1629 # device should be forwarded to the data source
1631 # @pass-discard-snapshot: #optional whether discard requests for the data source
1632 # should be issued when a snapshot operation (e.g.
1633 # deleting a snapshot) frees clusters in the qcow2 file
1635 # @pass-discard-other: #optional whether discard requests for the data source
1636 # should be issued on other occasions where a cluster
1639 # @overlap-check: #optional which overlap checks to perform for writes
1640 # to the image, defaults to 'cached' (since 2.2)
1642 # @cache-size: #optional the maximum total size of the L2 table and
1643 # refcount block caches in bytes (since 2.2)
1645 # @l2-cache-size: #optional the maximum size of the L2 table cache in
1648 # @refcount-cache-size: #optional the maximum size of the refcount block cache
1649 # in bytes (since 2.2)
1651 # @cache-clean-interval: #optional clean unused entries in the L2 and refcount
1652 # caches. The interval is in seconds. The default value
1653 # is 0 and it disables this feature (since 2.5)
1657 { 'struct': 'BlockdevOptionsQcow2',
1658 'base': 'BlockdevOptionsGenericCOWFormat',
1659 'data': { '*lazy-refcounts': 'bool',
1660 '*pass-discard-request': 'bool',
1661 '*pass-discard-snapshot': 'bool',
1662 '*pass-discard-other': 'bool',
1663 '*overlap-check': 'Qcow2OverlapChecks',
1664 '*cache-size': 'int',
1665 '*l2-cache-size': 'int',
1666 '*refcount-cache-size': 'int',
1667 '*cache-clean-interval': 'int' } }
1671 # @BlockdevOptionsArchipelago
1673 # Driver specific block device options for Archipelago.
1675 # @volume: Name of the Archipelago volume image
1677 # @mport: #optional The port number on which mapperd is
1678 # listening. This is optional
1679 # and if not specified, QEMU will make Archipelago
1680 # use the default port (1001).
1682 # @vport: #optional The port number on which vlmcd is
1683 # listening. This is optional
1684 # and if not specified, QEMU will make Archipelago
1685 # use the default port (501).
1687 # @segment: #optional The name of the shared memory segment
1688 # Archipelago stack is using. This is optional
1689 # and if not specified, QEMU will make Archipelago
1690 # use the default value, 'archipelago'.
1693 { 'struct': 'BlockdevOptionsArchipelago',
1694 'data': { 'volume': 'str',
1697 '*segment': 'str' } }
1703 # Trigger events supported by blkdebug.
1705 { 'enum': 'BlkdebugEvent',
1706 'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table',
1707 'l1_grow.activate_table', 'l2_load', 'l2_update',
1708 'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write',
1709 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1710 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1711 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1712 'refblock_load', 'refblock_update', 'refblock_update_part',
1713 'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write',
1714 'refblock_alloc.write_blocks', 'refblock_alloc.write_table',
1715 'refblock_alloc.switch_table', 'cluster_alloc',
1716 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
1717 'flush_to_disk', 'pwritev_rmw.head', 'pwritev_rmw.after_head',
1718 'pwritev_rmw.tail', 'pwritev_rmw.after_tail', 'pwritev',
1719 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
1722 # @BlkdebugInjectErrorOptions
1724 # Describes a single error injection for blkdebug.
1726 # @event: trigger event
1728 # @state: #optional the state identifier blkdebug needs to be in to
1729 # actually trigger the event; defaults to "any"
1731 # @errno: #optional error identifier (errno) to be returned; defaults to
1734 # @sector: #optional specifies the sector index which has to be affected
1735 # in order to actually trigger the event; defaults to "any
1738 # @once: #optional disables further events after this one has been
1739 # triggered; defaults to false
1741 # @immediately: #optional fail immediately; defaults to false
1745 { 'struct': 'BlkdebugInjectErrorOptions',
1746 'data': { 'event': 'BlkdebugEvent',
1751 '*immediately': 'bool' } }
1754 # @BlkdebugSetStateOptions
1756 # Describes a single state-change event for blkdebug.
1758 # @event: trigger event
1760 # @state: #optional the current state identifier blkdebug needs to be in;
1763 # @new_state: the state identifier blkdebug is supposed to assume if
1764 # this event is triggered
1768 { 'struct': 'BlkdebugSetStateOptions',
1769 'data': { 'event': 'BlkdebugEvent',
1771 'new_state': 'int' } }
1774 # @BlockdevOptionsBlkdebug
1776 # Driver specific block device options for blkdebug.
1778 # @image: underlying raw block device (or image file)
1780 # @config: #optional filename of the configuration file
1782 # @align: #optional required alignment for requests in bytes
1784 # @inject-error: #optional array of error injection descriptions
1786 # @set-state: #optional array of state-change descriptions
1790 { 'struct': 'BlockdevOptionsBlkdebug',
1791 'data': { 'image': 'BlockdevRef',
1794 '*inject-error': ['BlkdebugInjectErrorOptions'],
1795 '*set-state': ['BlkdebugSetStateOptions'] } }
1798 # @BlockdevOptionsBlkverify
1800 # Driver specific block device options for blkverify.
1802 # @test: block device to be tested
1804 # @raw: raw image used for verification
1808 { 'struct': 'BlockdevOptionsBlkverify',
1809 'data': { 'test': 'BlockdevRef',
1810 'raw': 'BlockdevRef' } }
1813 # @QuorumReadPattern
1815 # An enumeration of quorum read patterns.
1817 # @quorum: read all the children and do a quorum vote on reads
1819 # @fifo: read only from the first child that has not failed
1823 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
1826 # @BlockdevOptionsQuorum
1828 # Driver specific block device options for Quorum
1830 # @blkverify: #optional true if the driver must print content mismatch
1831 # set to false by default
1833 # @children: the children block devices to use
1835 # @vote-threshold: the vote limit under which a read will fail
1837 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
1840 # @read-pattern: #optional choose read pattern and set to quorum by default
1845 { 'struct': 'BlockdevOptionsQuorum',
1846 'data': { '*blkverify': 'bool',
1847 'children': [ 'BlockdevRef' ],
1848 'vote-threshold': 'int',
1849 '*rewrite-corrupted': 'bool',
1850 '*read-pattern': 'QuorumReadPattern' } }
1855 # Options for creating a block device.
1859 { 'union': 'BlockdevOptions',
1860 'base': 'BlockdevOptionsBase',
1861 'discriminator': 'driver',
1863 'archipelago':'BlockdevOptionsArchipelago',
1864 'blkdebug': 'BlockdevOptionsBlkdebug',
1865 'blkverify': 'BlockdevOptionsBlkverify',
1866 'bochs': 'BlockdevOptionsGenericFormat',
1867 'cloop': 'BlockdevOptionsGenericFormat',
1868 'dmg': 'BlockdevOptionsGenericFormat',
1869 'file': 'BlockdevOptionsFile',
1870 'ftp': 'BlockdevOptionsFile',
1871 'ftps': 'BlockdevOptionsFile',
1872 # TODO gluster: Wait for structured options
1873 'host_cdrom': 'BlockdevOptionsFile',
1874 'host_device':'BlockdevOptionsFile',
1875 'http': 'BlockdevOptionsFile',
1876 'https': 'BlockdevOptionsFile',
1877 # TODO iscsi: Wait for structured options
1878 # TODO nbd: Should take InetSocketAddress for 'host'?
1879 # TODO nfs: Wait for structured options
1880 'null-aio': 'BlockdevOptionsNull',
1881 'null-co': 'BlockdevOptionsNull',
1882 'parallels': 'BlockdevOptionsGenericFormat',
1883 'qcow2': 'BlockdevOptionsQcow2',
1884 'qcow': 'BlockdevOptionsGenericCOWFormat',
1885 'qed': 'BlockdevOptionsGenericCOWFormat',
1886 'quorum': 'BlockdevOptionsQuorum',
1887 'raw': 'BlockdevOptionsGenericFormat',
1888 # TODO rbd: Wait for structured options
1889 # TODO sheepdog: Wait for structured options
1890 # TODO ssh: Should take InetSocketAddress for 'host'?
1891 'tftp': 'BlockdevOptionsFile',
1892 'vdi': 'BlockdevOptionsGenericFormat',
1893 'vhdx': 'BlockdevOptionsGenericFormat',
1894 'vmdk': 'BlockdevOptionsGenericCOWFormat',
1895 'vpc': 'BlockdevOptionsGenericFormat',
1896 'vvfat': 'BlockdevOptionsVVFAT'
1902 # Reference to a block device.
1904 # @definition: defines a new block device inline
1905 # @reference: references the ID of an existing block device. An
1906 # empty string means that no block device should be
1911 { 'alternate': 'BlockdevRef',
1912 'data': { 'definition': 'BlockdevOptions',
1913 'reference': 'str' } }
1918 # Creates a new block device. If the @id option is given at the top level, a
1919 # BlockBackend will be created; otherwise, @node-name is mandatory at the top
1920 # level and no BlockBackend will be created.
1922 # This command is still a work in progress. It doesn't support all
1923 # block drivers among other things. Stay away from it unless you want
1924 # to help with its development.
1926 # @options: block device options for the new device
1930 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }
1935 # Deletes a block device that has been added using blockdev-add.
1936 # The selected device can be either a block backend or a graph node.
1938 # In the former case the backend will be destroyed, along with its
1939 # inserted medium if there's any. The command will fail if the backend
1940 # or its medium are in use.
1942 # In the latter case the node will be destroyed. The command will fail
1943 # if the node is attached to a block backend or is otherwise being
1946 # One of @id or @node-name must be specified, but not both.
1948 # This command is still a work in progress and is considered
1949 # experimental. Stay away from it unless you want to help with its
1952 # @id: #optional Name of the block backend device to delete.
1954 # @node-name: #optional Name of the graph node to delete.
1958 { 'command': 'x-blockdev-del', 'data': { '*id': 'str', '*node-name': 'str' } }
1961 # @blockdev-open-tray:
1963 # Opens a block device's tray. If there is a block driver state tree inserted as
1964 # a medium, it will become inaccessible to the guest (but it will remain
1965 # associated to the block device, so closing the tray will make it accessible
1968 # If the tray was already open before, this will be a no-op.
1970 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
1971 # which no such event will be generated, these include:
1972 # - if the guest has locked the tray, @force is false and the guest does not
1973 # respond to the eject request
1974 # - if the BlockBackend denoted by @device does not have a guest device attached
1976 # - if the guest device does not have an actual tray and is empty, for instance
1977 # for floppy disk drives
1979 # @device: block device name
1981 # @force: #optional if false (the default), an eject request will be sent to
1982 # the guest if it has locked the tray (and the tray will not be opened
1983 # immediately); if true, the tray will be opened regardless of whether
1988 { 'command': 'blockdev-open-tray',
1989 'data': { 'device': 'str',
1990 '*force': 'bool' } }
1993 # @blockdev-close-tray:
1995 # Closes a block device's tray. If there is a block driver state tree associated
1996 # with the block device (which is currently ejected), that tree will be loaded
1999 # If the tray was already closed before, this will be a no-op.
2001 # @device: block device name
2005 { 'command': 'blockdev-close-tray',
2006 'data': { 'device': 'str' } }
2009 # @blockdev-remove-medium:
2011 # Removes a medium (a block driver state tree) from a block device. That block
2012 # device's tray must currently be open (unless there is no attached guest
2015 # If the tray is open and there is no medium inserted, this will be a no-op.
2017 # @device: block device name
2021 { 'command': 'blockdev-remove-medium',
2022 'data': { 'device': 'str' } }
2025 # @blockdev-insert-medium:
2027 # Inserts a medium (a block driver state tree) into a block device. That block
2028 # device's tray must currently be open (unless there is no attached guest
2029 # device) and there must be no medium inserted already.
2031 # @device: block device name
2033 # @node-name: name of a node in the block driver state graph
2037 { 'command': 'blockdev-insert-medium',
2038 'data': { 'device': 'str',
2039 'node-name': 'str'} }
2043 # @BlockdevChangeReadOnlyMode:
2045 # Specifies the new read-only mode of a block device subject to the
2046 # @blockdev-change-medium command.
2048 # @retain: Retains the current read-only mode
2050 # @read-only: Makes the device read-only
2052 # @read-write: Makes the device writable
2056 { 'enum': 'BlockdevChangeReadOnlyMode',
2057 'data': ['retain', 'read-only', 'read-write'] }
2061 # @blockdev-change-medium:
2063 # Changes the medium inserted into a block device by ejecting the current medium
2064 # and loading a new image file which is inserted as the new medium (this command
2065 # combines blockdev-open-tray, blockdev-remove-medium, blockdev-insert-medium
2066 # and blockdev-close-tray).
2068 # @device: block device name
2070 # @filename: filename of the new image to be loaded
2072 # @format: #optional, format to open the new image with (defaults to
2073 # the probed format)
2075 # @read-only-mode: #optional, change the read-only mode of the device; defaults
2080 { 'command': 'blockdev-change-medium',
2081 'data': { 'device': 'str',
2084 '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
2090 # An enumeration of action that has been taken when a DISK I/O occurs
2092 # @ignore: error has been ignored
2094 # @report: error has been reported to the device
2096 # @stop: error caused VM to be stopped
2100 { 'enum': 'BlockErrorAction',
2101 'data': [ 'ignore', 'report', 'stop' ] }
2105 # @BLOCK_IMAGE_CORRUPTED
2107 # Emitted when a corruption has been detected in a disk image
2109 # @device: device name. This is always present for compatibility
2110 # reasons, but it can be empty ("") if the image does not
2111 # have a device name associated.
2113 # @node-name: #optional node name (Since: 2.4)
2115 # @msg: informative message for human consumption, such as the kind of
2116 # corruption being detected. It should not be parsed by machine as it is
2117 # not guaranteed to be stable
2119 # @offset: #optional, if the corruption resulted from an image access, this is
2120 # the host's access offset into the image
2122 # @size: #optional, if the corruption resulted from an image access, this is
2125 # fatal: if set, the image is marked corrupt and therefore unusable after this
2126 # event and must be repaired (Since 2.2; before, every
2127 # BLOCK_IMAGE_CORRUPTED event was fatal)
2131 { 'event': 'BLOCK_IMAGE_CORRUPTED',
2132 'data': { 'device' : 'str',
2133 '*node-name' : 'str',
2137 'fatal' : 'bool' } }
2142 # Emitted when a disk I/O error occurs
2144 # @device: device name
2146 # @operation: I/O operation
2148 # @action: action that has been taken
2150 # @nospace: #optional true if I/O error was caused due to a no-space
2151 # condition. This key is only present if query-block's
2152 # io-status is present, please see query-block documentation
2153 # for more information (since: 2.2)
2155 # @reason: human readable string describing the error cause.
2156 # (This field is a debugging aid for humans, it should not
2157 # be parsed by applications) (since: 2.2)
2159 # Note: If action is "stop", a STOP event will eventually follow the
2160 # BLOCK_IO_ERROR event
2164 { 'event': 'BLOCK_IO_ERROR',
2165 'data': { 'device': 'str', 'operation': 'IoOperationType',
2166 'action': 'BlockErrorAction', '*nospace': 'bool',
2170 # @BLOCK_JOB_COMPLETED
2172 # Emitted when a block job has completed
2176 # @device: device name
2178 # @len: maximum progress value
2180 # @offset: current progress value. On success this is equal to len.
2181 # On failure this is less than len
2183 # @speed: rate limit, bytes per second
2185 # @error: #optional, error message. Only present on failure. This field
2186 # contains a human-readable error message. There are no semantics
2187 # other than that streaming has failed and clients should not try to
2188 # interpret the error string
2192 { 'event': 'BLOCK_JOB_COMPLETED',
2193 'data': { 'type' : 'BlockJobType',
2201 # @BLOCK_JOB_CANCELLED
2203 # Emitted when a block job has been cancelled
2207 # @device: device name
2209 # @len: maximum progress value
2211 # @offset: current progress value. On success this is equal to len.
2212 # On failure this is less than len
2214 # @speed: rate limit, bytes per second
2218 { 'event': 'BLOCK_JOB_CANCELLED',
2219 'data': { 'type' : 'BlockJobType',
2228 # Emitted when a block job encounters an error
2230 # @device: device name
2232 # @operation: I/O operation
2234 # @action: action that has been taken
2238 { 'event': 'BLOCK_JOB_ERROR',
2239 'data': { 'device' : 'str',
2240 'operation': 'IoOperationType',
2241 'action' : 'BlockErrorAction' } }
2246 # Emitted when a block job is ready to complete
2250 # @device: device name
2252 # @len: maximum progress value
2254 # @offset: current progress value. On success this is equal to len.
2255 # On failure this is less than len
2257 # @speed: rate limit, bytes per second
2259 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
2264 { 'event': 'BLOCK_JOB_READY',
2265 'data': { 'type' : 'BlockJobType',
2273 # Preallocation mode of QEMU image file
2275 # @off: no preallocation
2276 # @metadata: preallocate only for metadata
2277 # @falloc: like @full preallocation but allocate disk space by
2278 # posix_fallocate() rather than writing zeros.
2279 # @full: preallocate all data by writing zeros to device to ensure disk
2280 # space is really available. @full preallocation also sets up
2281 # metadata correctly.
2285 { 'enum': 'PreallocMode',
2286 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
2289 # @BLOCK_WRITE_THRESHOLD
2291 # Emitted when writes on block device reaches or exceeds the
2292 # configured write threshold. For thin-provisioned devices, this
2293 # means the device should be extended to avoid pausing for
2295 # The event is one shot. Once triggered, it needs to be
2296 # re-registered with another block-set-threshold command.
2298 # @node-name: graph node name on which the threshold was exceeded.
2300 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
2302 # @write-threshold: last configured threshold, in bytes.
2306 { 'event': 'BLOCK_WRITE_THRESHOLD',
2307 'data': { 'node-name': 'str',
2308 'amount-exceeded': 'uint64',
2309 'write-threshold': 'uint64' } }
2312 # @block-set-write-threshold
2314 # Change the write threshold for a block drive. An event will be delivered
2315 # if a write to this block drive crosses the configured threshold.
2316 # This is useful to transparently resize thin-provisioned drives without
2317 # the guest OS noticing.
2319 # @node-name: graph node name on which the threshold must be set.
2321 # @write-threshold: configured threshold for the block device, bytes.
2322 # Use 0 to disable the threshold.
2326 { 'command': 'block-set-write-threshold',
2327 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }