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 # Mapping information from a virtual block range to a host file range
193 # @start: the start byte of the mapped virtual range
195 # @length: the number of bytes of the mapped virtual range
197 # @data: whether the mapped range has data
199 # @zero: whether the virtual blocks are zeroed
201 # @depth: the depth of the mapping
203 # @offset: #optional the offset in file that the virtual sectors are mapped to
205 # @filename: #optional filename that is referred to by @offset
210 { 'struct': 'MapEntry',
211 'data': {'start': 'int', 'length': 'int', 'data': 'bool',
212 'zero': 'bool', 'depth': 'int', '*offset': 'int',
213 '*filename': 'str' } }
218 # Cache mode information for a block device
220 # @writeback: true if writeback mode is enabled
221 # @direct: true if the host page cache is bypassed (O_DIRECT)
222 # @no-flush: true if flush requests are ignored for the device
226 { 'struct': 'BlockdevCacheInfo',
227 'data': { 'writeback': 'bool',
229 'no-flush': 'bool' } }
234 # Information about the backing device for a block device.
236 # @file: the filename of the backing device
238 # @node-name: #optional the name of the block driver node (Since 2.0)
240 # @ro: true if the backing device was open read-only
242 # @drv: the name of the block format used to open the backing device. As of
243 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
244 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
245 # 'http', 'https', 'nbd', 'parallels', 'qcow',
246 # 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
247 # 2.2: 'archipelago' added, 'cow' dropped
248 # 2.3: 'host_floppy' deprecated
249 # 2.5: 'host_floppy' dropped
251 # @backing_file: #optional the name of the backing file (for copy-on-write)
253 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
255 # @encrypted: true if the backing device is encrypted
257 # @encryption_key_missing: true if the backing device is encrypted but an
258 # valid encryption key is missing
260 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
262 # @bps: total throughput limit in bytes per second is specified
264 # @bps_rd: read throughput limit in bytes per second is specified
266 # @bps_wr: write throughput limit in bytes per second is specified
268 # @iops: total I/O operations per second is specified
270 # @iops_rd: read I/O operations per second is specified
272 # @iops_wr: write I/O operations per second is specified
274 # @image: the info of image used (since: 1.6)
276 # @bps_max: #optional total max in bytes (Since 1.7)
278 # @bps_rd_max: #optional read max in bytes (Since 1.7)
280 # @bps_wr_max: #optional write max in bytes (Since 1.7)
282 # @iops_max: #optional total I/O operations max (Since 1.7)
284 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
286 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
288 # @iops_size: #optional an I/O size in bytes (Since 1.7)
290 # @group: #optional throttle group name (Since 2.4)
292 # @cache: the cache mode used for the block device (since: 2.3)
294 # @write_threshold: configured write threshold for the device.
295 # 0 if disabled. (Since 2.3)
300 { 'struct': 'BlockDeviceInfo',
301 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
302 '*backing_file': 'str', 'backing_file_depth': 'int',
303 'encrypted': 'bool', 'encryption_key_missing': 'bool',
304 'detect_zeroes': 'BlockdevDetectZeroesOptions',
305 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
306 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
307 'image': 'ImageInfo',
308 '*bps_max': 'int', '*bps_rd_max': 'int',
309 '*bps_wr_max': 'int', '*iops_max': 'int',
310 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
311 '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
312 'write_threshold': 'int' } }
315 # @BlockDeviceIoStatus:
317 # An enumeration of block device I/O status.
319 # @ok: The last I/O operation has succeeded
321 # @failed: The last I/O operation has failed
323 # @nospace: The last I/O operation has failed due to a no-space condition
327 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
330 # @BlockDeviceMapEntry:
332 # Entry in the metadata map of the device (returned by "qemu-img map")
334 # @start: Offset in the image of the first byte described by this entry
337 # @length: Length of the range described by this entry (in bytes)
339 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
340 # before reaching one for which the range is allocated. The value is
341 # in the range 0 to the depth of the image chain - 1.
343 # @zero: the sectors in this range read as zeros
345 # @data: reading the image will actually read data from a file (in particular,
346 # if @offset is present this means that the sectors are not simply
347 # preallocated, but contain actual data in raw format)
349 # @offset: if present, the image file stores the data for this range in
350 # raw format at the given offset.
354 { 'struct': 'BlockDeviceMapEntry',
355 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
356 'data': 'bool', '*offset': 'int' } }
359 # @DirtyBitmapStatus:
361 # An enumeration of possible states that a dirty bitmap can report to the user.
363 # @frozen: The bitmap is currently in-use by a backup operation or block job,
366 # @disabled: The bitmap is currently in-use by an internal operation and is
367 # read-only. It can still be deleted.
369 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
370 # deleted, or used for backup operations.
374 { 'enum': 'DirtyBitmapStatus',
375 'data': ['active', 'disabled', 'frozen'] }
380 # Block dirty bitmap information.
382 # @name: #optional the name of the dirty bitmap (Since 2.4)
384 # @count: number of dirty bytes according to the dirty bitmap
386 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
388 # @status: current status of the dirty bitmap (since 2.4)
392 { 'struct': 'BlockDirtyInfo',
393 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
394 'status': 'DirtyBitmapStatus'} }
399 # Block device information. This structure describes a virtual device and
400 # the backing device associated with it.
402 # @device: The device name associated with the virtual device.
404 # @type: This field is returned only for compatibility reasons, it should
405 # not be used (always returns 'unknown')
407 # @removable: True if the device supports removable media.
409 # @locked: True if the guest has locked this device from having its media
412 # @tray_open: #optional True if the device's tray is open
413 # (only present if it has a tray)
415 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
416 # driver has one or more dirty bitmaps) (Since 2.0)
418 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
419 # supports it and the VM is configured to stop on errors
420 # (supported device models: virtio-blk, ide, scsi-disk)
422 # @inserted: #optional @BlockDeviceInfo describing the device if media is
427 { 'struct': 'BlockInfo',
428 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
429 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
430 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
431 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
436 # Get a list of BlockInfo for all virtual block devices.
438 # Returns: a list of @BlockInfo describing each virtual block device
442 { 'command': 'query-block', 'returns': ['BlockInfo'] }
446 # @BlockDeviceTimedStats:
448 # Statistics of a block device during a given interval of time.
450 # @interval_length: Interval used for calculating the statistics,
453 # @min_rd_latency_ns: Minimum latency of read operations in the
454 # defined interval, in nanoseconds.
456 # @min_wr_latency_ns: Minimum latency of write operations in the
457 # defined interval, in nanoseconds.
459 # @min_flush_latency_ns: Minimum latency of flush operations in the
460 # defined interval, in nanoseconds.
462 # @max_rd_latency_ns: Maximum latency of read operations in the
463 # defined interval, in nanoseconds.
465 # @max_wr_latency_ns: Maximum latency of write operations in the
466 # defined interval, in nanoseconds.
468 # @max_flush_latency_ns: Maximum latency of flush operations in the
469 # defined interval, in nanoseconds.
471 # @avg_rd_latency_ns: Average latency of read operations in the
472 # defined interval, in nanoseconds.
474 # @avg_wr_latency_ns: Average latency of write operations in the
475 # defined interval, in nanoseconds.
477 # @avg_flush_latency_ns: Average latency of flush operations in the
478 # defined interval, in nanoseconds.
480 # @avg_rd_queue_depth: Average number of pending read operations
481 # in the defined interval.
483 # @avg_wr_queue_depth: Average number of pending write operations
484 # in the defined interval.
489 { 'struct': 'BlockDeviceTimedStats',
490 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
491 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
492 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
493 'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
494 'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
495 'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
500 # Statistics of a virtual block device or a block backing device.
502 # @rd_bytes: The number of bytes read by the device.
504 # @wr_bytes: The number of bytes written by the device.
506 # @rd_operations: The number of read operations performed by the device.
508 # @wr_operations: The number of write operations performed by the device.
510 # @flush_operations: The number of cache flush operations performed by the
511 # device (since 0.15.0)
513 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
516 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
518 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
520 # @wr_highest_offset: The offset after the greatest byte written to the
521 # device. The intended use of this information is for
522 # growable sparse files (like qcow2) that are used on top
523 # of a physical device.
525 # @rd_merged: Number of read requests that have been merged into another
526 # request (Since 2.3).
528 # @wr_merged: Number of write requests that have been merged into another
529 # request (Since 2.3).
531 # @idle_time_ns: #optional Time since the last I/O operation, in
532 # nanoseconds. If the field is absent it means that
533 # there haven't been any operations yet (Since 2.5).
535 # @failed_rd_operations: The number of failed read operations
536 # performed by the device (Since 2.5)
538 # @failed_wr_operations: The number of failed write operations
539 # performed by the device (Since 2.5)
541 # @failed_flush_operations: The number of failed flush operations
542 # performed by the device (Since 2.5)
544 # @invalid_rd_operations: The number of invalid read operations
545 # performed by the device (Since 2.5)
547 # @invalid_wr_operations: The number of invalid write operations
548 # performed by the device (Since 2.5)
550 # @invalid_flush_operations: The number of invalid flush operations
551 # performed by the device (Since 2.5)
553 # @account_invalid: Whether invalid operations are included in the
554 # last access statistics (Since 2.5)
556 # @account_failed: Whether failed operations are included in the
557 # latency and last access statistics (Since 2.5)
559 # @timed_stats: Statistics specific to the set of previously defined
560 # intervals of time (Since 2.5)
564 { 'struct': 'BlockDeviceStats',
565 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
566 'wr_operations': 'int', 'flush_operations': 'int',
567 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
568 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
569 'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int',
570 'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
571 'failed_flush_operations': 'int', 'invalid_rd_operations': 'int',
572 'invalid_wr_operations': 'int', 'invalid_flush_operations': 'int',
573 'account_invalid': 'bool', 'account_failed': 'bool',
574 'timed_stats': ['BlockDeviceTimedStats'] } }
579 # Statistics of a virtual block device or a block backing device.
581 # @device: #optional If the stats are for a virtual block device, the name
582 # corresponding to the virtual block device.
584 # @node-name: #optional The node name of the device. (Since 2.3)
586 # @stats: A @BlockDeviceStats for the device.
588 # @parent: #optional This describes the file block device if it has one.
590 # @backing: #optional This describes the backing block device if it has one.
595 { 'struct': 'BlockStats',
596 'data': {'*device': 'str', '*node-name': 'str',
597 'stats': 'BlockDeviceStats',
598 '*parent': 'BlockStats',
599 '*backing': 'BlockStats'} }
604 # Query the @BlockStats for all virtual block devices.
606 # @query-nodes: #optional If true, the command will query all the block nodes
607 # that have a node name, in a list which will include "parent"
608 # information, but not "backing".
609 # If false or omitted, the behavior is as before - query all the
610 # device backends, recursively including their "parent" and
611 # "backing". (Since 2.3)
613 # Returns: A list of @BlockStats for each virtual block devices.
617 { 'command': 'query-blockstats',
618 'data': { '*query-nodes': 'bool' },
619 'returns': ['BlockStats'] }
624 # An enumeration of possible behaviors for errors on I/O operations.
625 # The exact meaning depends on whether the I/O was initiated by a guest
628 # @report: for guest operations, report the error to the guest;
629 # for jobs, cancel the job
631 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
632 # or BLOCK_JOB_ERROR)
634 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
636 # @stop: for guest operations, stop the virtual machine;
637 # for jobs, pause the job
641 { 'enum': 'BlockdevOnError',
642 'data': ['report', 'ignore', 'enospc', 'stop'] }
647 # An enumeration of possible behaviors for the initial synchronization
648 # phase of storage mirroring.
650 # @top: copies data in the topmost image to the destination
652 # @full: copies data from all images to the destination
654 # @none: only copy data written from now on
656 # @incremental: only copy data described by the dirty bitmap. Since: 2.4
660 { 'enum': 'MirrorSyncMode',
661 'data': ['top', 'full', 'none', 'incremental'] }
666 # Type of a block job.
668 # @commit: block commit job type, see "block-commit"
670 # @stream: block stream job type, see "block-stream"
672 # @mirror: drive mirror job type, see "drive-mirror"
674 # @backup: drive backup job type, see "drive-backup"
678 { 'enum': 'BlockJobType',
679 'data': ['commit', 'stream', 'mirror', 'backup'] }
684 # Information about a long-running block device operation.
686 # @type: the job type ('stream' for image streaming)
688 # @device: the block device name
690 # @len: the maximum progress value
692 # @busy: false if the job is known to be in a quiescent state, with
693 # no pending I/O. Since 1.3.
695 # @paused: whether the job is paused or, if @busy is true, will
696 # pause itself as soon as possible. Since 1.3.
698 # @offset: the current progress value
700 # @speed: the rate limit, bytes per second
702 # @io-status: the status of the job (since 1.3)
704 # @ready: true if the job may be completed (since 2.2)
708 { 'struct': 'BlockJobInfo',
709 'data': {'type': 'str', 'device': 'str', 'len': 'int',
710 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
711 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
716 # Return information about long-running block device operations.
718 # Returns: a list of @BlockJobInfo for each active block job
722 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
727 # This command sets the password of a block device that has not been open
728 # with a password and requires one.
730 # The two cases where this can happen are a block device is created through
731 # QEMU's initial command line or a block device is changed through the legacy
734 # In the event that the block device is created through the initial command
735 # line, the VM will start in the stopped state regardless of whether '-S' is
736 # used. The intention is for a management tool to query the block devices to
737 # determine which ones are encrypted, set the passwords with this command, and
738 # then start the guest with the @cont command.
740 # Either @device or @node-name must be set but not both.
742 # @device: #optional the name of the block backend device to set the password on
744 # @node-name: #optional graph node name to set the password on (Since 2.0)
746 # @password: the password to use for the device
748 # Returns: nothing on success
749 # If @device is not a valid block device, DeviceNotFound
750 # If @device is not encrypted, DeviceNotEncrypted
752 # Notes: Not all block formats support encryption and some that do are not
753 # able to validate that a password is correct. Disk corruption may
754 # occur if an invalid password is specified.
758 { 'command': 'block_passwd', 'data': {'*device': 'str',
759 '*node-name': 'str', 'password': 'str'} }
764 # Resize a block image while a guest is running.
766 # Either @device or @node-name must be set but not both.
768 # @device: #optional the name of the device to get the image resized
770 # @node-name: #optional graph node name to get the image resized (Since 2.0)
772 # @size: new image size in bytes
774 # Returns: nothing on success
775 # If @device is not a valid block device, DeviceNotFound
779 { 'command': 'block_resize', 'data': { '*device': 'str',
786 # An enumeration that tells QEMU how to set the backing file path in
789 # @existing: QEMU should look for an existing image file.
791 # @absolute-paths: QEMU should create a new image with absolute paths
792 # for the backing file. If there is no backing file available, the new
793 # image will not be backed either.
797 { 'enum': 'NewImageMode',
798 'data': [ 'existing', 'absolute-paths' ] }
801 # @BlockdevSnapshotSync
803 # Either @device or @node-name must be set but not both.
805 # @device: #optional the name of the device to generate the snapshot from.
807 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
809 # @snapshot-file: the target of the new image. A new file will be created.
811 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
813 # @format: #optional the format of the snapshot image, default is 'qcow2'.
815 # @mode: #optional whether and how QEMU should create a new image, default is
818 { 'struct': 'BlockdevSnapshotSync',
819 'data': { '*device': 'str', '*node-name': 'str',
820 'snapshot-file': 'str', '*snapshot-node-name': 'str',
821 '*format': 'str', '*mode': 'NewImageMode' } }
826 # @node: device or node name that will have a snapshot created.
828 # @overlay: reference to the existing block device that will become
829 # the overlay of @node, as part of creating the snapshot.
830 # It must not have a current backing file (this can be
831 # achieved by passing "backing": "" to blockdev-add).
835 { 'struct': 'BlockdevSnapshot',
836 'data': { 'node': 'str', 'overlay': 'str' } }
841 # @device: the name of the device which should be copied.
843 # @target: the target of the new image. If the file exists, or if it
844 # is a device, the existing file/device will be used as the new
845 # destination. If it does not exist, a new file will be created.
847 # @format: #optional the format of the new destination, default is to
848 # probe if @mode is 'existing', else the format of the source
850 # @sync: what parts of the disk image should be copied to the destination
851 # (all the disk, only the sectors allocated in the topmost image, from a
852 # dirty bitmap, or only new I/O).
854 # @mode: #optional whether and how QEMU should create a new image, default is
857 # @speed: #optional the maximum speed, in bytes per second
859 # @bitmap: #optional the name of dirty bitmap if sync is "incremental".
860 # Must be present if sync is "incremental", must NOT be present
861 # otherwise. (Since 2.4)
863 # @on-source-error: #optional the action to take on an error on the source,
864 # default 'report'. 'stop' and 'enospc' can only be used
865 # if the block device supports io-status (see BlockInfo).
867 # @on-target-error: #optional the action to take on an error on the target,
868 # default 'report' (no limitations, since this applies to
869 # a different block device than @device).
871 # Note that @on-source-error and @on-target-error only affect background I/O.
872 # If an error occurs during a guest write request, the device's rerror/werror
873 # actions will be used.
877 { 'struct': 'DriveBackup',
878 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
879 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
880 '*speed': 'int', '*bitmap': 'str',
881 '*on-source-error': 'BlockdevOnError',
882 '*on-target-error': 'BlockdevOnError' } }
887 # @device: the name of the device which should be copied.
889 # @target: the name of the backup target device.
891 # @sync: what parts of the disk image should be copied to the destination
892 # (all the disk, only the sectors allocated in the topmost image, or
895 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
898 # @on-source-error: #optional the action to take on an error on the source,
899 # default 'report'. 'stop' and 'enospc' can only be used
900 # if the block device supports io-status (see BlockInfo).
902 # @on-target-error: #optional the action to take on an error on the target,
903 # default 'report' (no limitations, since this applies to
904 # a different block device than @device).
906 # Note that @on-source-error and @on-target-error only affect background I/O.
907 # If an error occurs during a guest write request, the device's rerror/werror
908 # actions will be used.
912 { 'struct': 'BlockdevBackup',
913 'data': { 'device': 'str', 'target': 'str',
914 'sync': 'MirrorSyncMode',
916 '*on-source-error': 'BlockdevOnError',
917 '*on-target-error': 'BlockdevOnError' } }
920 # @blockdev-snapshot-sync
922 # Generates a synchronous snapshot of a block device.
924 # For the arguments, see the documentation of BlockdevSnapshotSync.
926 # Returns: nothing on success
927 # If @device is not a valid block device, DeviceNotFound
931 { 'command': 'blockdev-snapshot-sync',
932 'data': 'BlockdevSnapshotSync' }
938 # Generates a snapshot of a block device.
940 # For the arguments, see the documentation of BlockdevSnapshot.
944 { 'command': 'blockdev-snapshot',
945 'data': 'BlockdevSnapshot' }
948 # @change-backing-file
950 # Change the backing file in the image file metadata. This does not
951 # cause QEMU to reopen the image file to reparse the backing filename
952 # (it may, however, perform a reopen to change permissions from
953 # r/o -> r/w -> r/o, if needed). The new backing file string is written
954 # into the image file metadata, and the QEMU internal strings are
957 # @image-node-name: The name of the block driver state node of the
960 # @device: The name of the device that owns image-node-name.
962 # @backing-file: The string to write as the backing file. This
963 # string is not validated, so care should be taken
964 # when specifying the string or the image chain may
965 # not be able to be reopened again.
969 { 'command': 'change-backing-file',
970 'data': { 'device': 'str', 'image-node-name': 'str',
971 'backing-file': 'str' } }
976 # Live commit of data from overlay image nodes into backing nodes - i.e.,
977 # writes data between 'top' and 'base' into 'base'.
979 # @device: the name of the device
981 # @base: #optional The file name of the backing image to write data into.
982 # If not specified, this is the deepest backing image
984 # @top: #optional The file name of the backing image within the image chain,
985 # which contains the topmost data to be committed down. If
986 # not specified, this is the active layer.
988 # @backing-file: #optional The backing file string to write into the overlay
989 # image of 'top'. If 'top' is the active layer,
990 # specifying a backing file string is an error. This
991 # filename is not validated.
993 # If a pathname string is such that it cannot be
994 # resolved by QEMU, that means that subsequent QMP or
995 # HMP commands must use node-names for the image in
996 # question, as filename lookup methods will fail.
998 # If not specified, QEMU will automatically determine
999 # the backing file string to use, or error out if
1000 # there is no obvious choice. Care should be taken
1001 # when specifying the string, to specify a valid
1002 # filename or protocol.
1005 # If top == base, that is an error.
1006 # If top == active, the job will not be completed by itself,
1007 # user needs to complete the job with the block-job-complete
1008 # command after getting the ready event. (Since 2.0)
1010 # If the base image is smaller than top, then the base image
1011 # will be resized to be the same size as top. If top is
1012 # smaller than the base image, the base will not be
1013 # truncated. If you want the base image size to match the
1014 # size of the smaller top, you can safely truncate it
1015 # yourself once the commit operation successfully completes.
1017 # @speed: #optional the maximum speed, in bytes per second
1019 # Returns: Nothing on success
1020 # If commit or stream is already active on this device, DeviceInUse
1021 # If @device does not exist, DeviceNotFound
1022 # If image commit is not supported by this device, NotSupported
1023 # If @base or @top is invalid, a generic error is returned
1024 # If @speed is invalid, InvalidParameter
1029 { 'command': 'block-commit',
1030 'data': { 'device': 'str', '*base': 'str', '*top': 'str',
1031 '*backing-file': 'str', '*speed': 'int' } }
1036 # Start a point-in-time copy of a block device to a new destination. The
1037 # status of ongoing drive-backup operations can be checked with
1038 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1039 # The operation can be stopped before it has completed using the
1040 # block-job-cancel command.
1042 # For the arguments, see the documentation of DriveBackup.
1044 # Returns: nothing on success
1045 # If @device is not a valid block device, DeviceNotFound
1049 { 'command': 'drive-backup', 'data': 'DriveBackup' }
1054 # Start a point-in-time copy of a block device to a new destination. The
1055 # status of ongoing blockdev-backup operations can be checked with
1056 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1057 # The operation can be stopped before it has completed using the
1058 # block-job-cancel command.
1060 # For the arguments, see the documentation of BlockdevBackup.
1064 { 'command': 'blockdev-backup', 'data': 'BlockdevBackup' }
1068 # @query-named-block-nodes
1070 # Get the named block driver list
1072 # Returns: the list of BlockDeviceInfo
1076 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
1081 # Start mirroring a block device's writes to a new destination.
1083 # @device: the name of the device whose writes should be mirrored.
1085 # @target: the target of the new image. If the file exists, or if it
1086 # is a device, the existing file/device will be used as the new
1087 # destination. If it does not exist, a new file will be created.
1089 # @format: #optional the format of the new destination, default is to
1090 # probe if @mode is 'existing', else the format of the source
1092 # @node-name: #optional the new block driver state node name in the graph
1095 # @replaces: #optional with sync=full graph node name to be replaced by the new
1096 # image when a whole image copy is done. This can be used to repair
1097 # broken Quorum files. (Since 2.1)
1099 # @mode: #optional whether and how QEMU should create a new image, default is
1102 # @speed: #optional the maximum speed, in bytes per second
1104 # @sync: what parts of the disk image should be copied to the destination
1105 # (all the disk, only the sectors allocated in the topmost image, or
1108 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1109 # if the image format doesn't have clusters, 4K if the clusters
1110 # are smaller than that, else the cluster size. Must be a
1111 # power of 2 between 512 and 64M (since 1.4).
1113 # @buf-size: #optional maximum amount of data in flight from source to
1114 # target (since 1.4).
1116 # @on-source-error: #optional the action to take on an error on the source,
1117 # default 'report'. 'stop' and 'enospc' can only be used
1118 # if the block device supports io-status (see BlockInfo).
1120 # @on-target-error: #optional the action to take on an error on the target,
1121 # default 'report' (no limitations, since this applies to
1122 # a different block device than @device).
1123 # @unmap: #optional Whether to try to unmap target sectors where source has
1124 # only zero. If true, and target unallocated sectors will read as zero,
1125 # target image sectors will be unmapped; otherwise, zeroes will be
1126 # written. Both will result in identical contents.
1127 # Default is true. (Since 2.4)
1129 # Returns: nothing on success
1130 # If @device is not a valid block device, DeviceNotFound
1134 { 'command': 'drive-mirror',
1135 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
1136 '*node-name': 'str', '*replaces': 'str',
1137 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1138 '*speed': 'int', '*granularity': 'uint32',
1139 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1140 '*on-target-error': 'BlockdevOnError',
1141 '*unmap': 'bool' } }
1146 # @node: name of device/node which the bitmap is tracking
1148 # @name: name of the dirty bitmap
1152 { 'struct': 'BlockDirtyBitmap',
1153 'data': { 'node': 'str', 'name': 'str' } }
1156 # @BlockDirtyBitmapAdd
1158 # @node: name of device/node which the bitmap is tracking
1160 # @name: name of the dirty bitmap
1162 # @granularity: #optional the bitmap granularity, default is 64k for
1163 # block-dirty-bitmap-add
1167 { 'struct': 'BlockDirtyBitmapAdd',
1168 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } }
1171 # @block-dirty-bitmap-add
1173 # Create a dirty bitmap with a name on the node
1175 # Returns: nothing on success
1176 # If @node is not a valid block device or node, DeviceNotFound
1177 # If @name is already taken, GenericError with an explanation
1181 { 'command': 'block-dirty-bitmap-add',
1182 'data': 'BlockDirtyBitmapAdd' }
1185 # @block-dirty-bitmap-remove
1187 # Remove a dirty bitmap on the node
1189 # Returns: nothing on success
1190 # If @node is not a valid block device or node, DeviceNotFound
1191 # If @name is not found, GenericError with an explanation
1192 # if @name is frozen by an operation, GenericError
1196 { 'command': 'block-dirty-bitmap-remove',
1197 'data': 'BlockDirtyBitmap' }
1200 # @block-dirty-bitmap-clear
1202 # Clear (reset) a dirty bitmap on the device
1204 # Returns: nothing on success
1205 # If @node is not a valid block device, DeviceNotFound
1206 # If @name is not found, GenericError with an explanation
1210 { 'command': 'block-dirty-bitmap-clear',
1211 'data': 'BlockDirtyBitmap' }
1216 # Start mirroring a block device's writes to a new destination.
1218 # @device: the name of the device whose writes should be mirrored.
1220 # @target: the id or node-name of the block device to mirror to. This mustn't be
1221 # attached to guest.
1223 # @replaces: #optional with sync=full graph node name to be replaced by the new
1224 # image when a whole image copy is done. This can be used to repair
1225 # broken Quorum files.
1227 # @speed: #optional the maximum speed, in bytes per second
1229 # @sync: what parts of the disk image should be copied to the destination
1230 # (all the disk, only the sectors allocated in the topmost image, or
1233 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1234 # if the image format doesn't have clusters, 4K if the clusters
1235 # are smaller than that, else the cluster size. Must be a
1236 # power of 2 between 512 and 64M
1238 # @buf-size: #optional maximum amount of data in flight from source to
1241 # @on-source-error: #optional the action to take on an error on the source,
1242 # default 'report'. 'stop' and 'enospc' can only be used
1243 # if the block device supports io-status (see BlockInfo).
1245 # @on-target-error: #optional the action to take on an error on the target,
1246 # default 'report' (no limitations, since this applies to
1247 # a different block device than @device).
1249 # Returns: nothing on success.
1253 { 'command': 'blockdev-mirror',
1254 'data': { 'device': 'str', 'target': 'str',
1256 'sync': 'MirrorSyncMode',
1257 '*speed': 'int', '*granularity': 'uint32',
1258 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1259 '*on-target-error': 'BlockdevOnError' } }
1262 # @block_set_io_throttle:
1264 # Change I/O throttle limits for a block drive.
1266 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1269 # If two or more devices are members of the same group, the limits
1270 # will apply to the combined I/O of the whole group in a round-robin
1271 # fashion. Therefore, setting new I/O limits to a device will affect
1274 # The name of the group can be specified using the 'group' parameter.
1275 # If the parameter is unset, it is assumed to be the current group of
1276 # that device. If it's not in any group yet, the name of the device
1277 # will be used as the name for its group.
1279 # The 'group' parameter can also be used to move a device to a
1280 # different group. In this case the limits specified in the parameters
1281 # will be applied to the new group only.
1283 # I/O limits can be disabled by setting all of them to 0. In this case
1284 # the device will be removed from its group and the rest of its
1285 # members will not be affected. The 'group' parameter is ignored.
1287 # @device: The name of the device
1289 # @bps: total throughput limit in bytes per second
1291 # @bps_rd: read throughput limit in bytes per second
1293 # @bps_wr: write throughput limit in bytes per second
1295 # @iops: total I/O operations per second
1297 # @ops_rd: read I/O operations per second
1299 # @iops_wr: write I/O operations per second
1301 # @bps_max: #optional total throughput limit during bursts,
1302 # in bytes (Since 1.7)
1304 # @bps_rd_max: #optional read throughput limit during bursts,
1305 # in bytes (Since 1.7)
1307 # @bps_wr_max: #optional write throughput limit during bursts,
1308 # in bytes (Since 1.7)
1310 # @iops_max: #optional total I/O operations per second during bursts,
1311 # in bytes (Since 1.7)
1313 # @iops_rd_max: #optional read I/O operations per second during bursts,
1314 # in bytes (Since 1.7)
1316 # @iops_wr_max: #optional write I/O operations per second during bursts,
1317 # in bytes (Since 1.7)
1319 # @bps_max_length: #optional maximum length of the @bps_max burst
1320 # period, in seconds. It must only
1321 # be set if @bps_max is set as well.
1322 # Defaults to 1. (Since 2.6)
1324 # @bps_rd_max_length: #optional maximum length of the @bps_rd_max
1325 # burst period, in seconds. It must only
1326 # be set if @bps_rd_max is set as well.
1327 # Defaults to 1. (Since 2.6)
1329 # @bps_wr_max_length: #optional maximum length of the @bps_wr_max
1330 # burst period, in seconds. It must only
1331 # be set if @bps_wr_max is set as well.
1332 # Defaults to 1. (Since 2.6)
1334 # @iops_max_length: #optional maximum length of the @iops burst
1335 # period, in seconds. It must only
1336 # be set if @iops_max is set as well.
1337 # Defaults to 1. (Since 2.6)
1339 # @iops_rd_max_length: #optional maximum length of the @iops_rd_max
1340 # burst period, in seconds. It must only
1341 # be set if @iops_rd_max is set as well.
1342 # Defaults to 1. (Since 2.6)
1344 # @iops_wr_max_length: #optional maximum length of the @iops_wr_max
1345 # burst period, in seconds. It must only
1346 # be set if @iops_wr_max is set as well.
1347 # Defaults to 1. (Since 2.6)
1349 # @iops_size: #optional an I/O size in bytes (Since 1.7)
1351 # @group: #optional throttle group name (Since 2.4)
1353 # Returns: Nothing on success
1354 # If @device is not a valid block device, DeviceNotFound
1358 { 'command': 'block_set_io_throttle',
1359 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1360 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1361 '*bps_max': 'int', '*bps_rd_max': 'int',
1362 '*bps_wr_max': 'int', '*iops_max': 'int',
1363 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1364 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
1365 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
1366 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
1367 '*iops_size': 'int', '*group': 'str' } }
1372 # Copy data from a backing file into a block device.
1374 # The block streaming operation is performed in the background until the entire
1375 # backing file has been copied. This command returns immediately once streaming
1376 # has started. The status of ongoing block streaming operations can be checked
1377 # with query-block-jobs. The operation can be stopped before it has completed
1378 # using the block-job-cancel command.
1380 # If a base file is specified then sectors are not copied from that base file and
1381 # its backing chain. When streaming completes the image file will have the base
1382 # file as its backing file. This can be used to stream a subset of the backing
1383 # file chain instead of flattening the entire image.
1385 # On successful completion the image file is updated to drop the backing file
1386 # and the BLOCK_JOB_COMPLETED event is emitted.
1388 # @device: the device name
1390 # @base: #optional the common backing file name
1392 # @backing-file: #optional The backing file string to write into the active
1393 # layer. This filename is not validated.
1395 # If a pathname string is such that it cannot be
1396 # resolved by QEMU, that means that subsequent QMP or
1397 # HMP commands must use node-names for the image in
1398 # question, as filename lookup methods will fail.
1400 # If not specified, QEMU will automatically determine
1401 # the backing file string to use, or error out if there
1402 # is no obvious choice. Care should be taken when
1403 # specifying the string, to specify a valid filename or
1407 # @speed: #optional the maximum speed, in bytes per second
1409 # @on-error: #optional the action to take on an error (default report).
1410 # 'stop' and 'enospc' can only be used if the block device
1411 # supports io-status (see BlockInfo). Since 1.3.
1413 # Returns: Nothing on success
1414 # If @device does not exist, DeviceNotFound
1418 { 'command': 'block-stream',
1419 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str',
1420 '*speed': 'int', '*on-error': 'BlockdevOnError' } }
1423 # @block-job-set-speed:
1425 # Set maximum speed for a background block operation.
1427 # This command can only be issued when there is an active block job.
1429 # Throttling can be disabled by setting the speed to 0.
1431 # @device: the device name
1433 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1436 # Returns: Nothing on success
1437 # If no background operation is active on this device, DeviceNotActive
1441 { 'command': 'block-job-set-speed',
1442 'data': { 'device': 'str', 'speed': 'int' } }
1445 # @block-job-cancel:
1447 # Stop an active background block operation.
1449 # This command returns immediately after marking the active background block
1450 # operation for cancellation. It is an error to call this command if no
1451 # operation is in progress.
1453 # The operation will cancel as soon as possible and then emit the
1454 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1455 # enumerated using query-block-jobs.
1457 # For streaming, the image file retains its backing file unless the streaming
1458 # operation happens to complete just as it is being cancelled. A new streaming
1459 # operation can be started at a later time to finish copying all data from the
1462 # @device: the device name
1464 # @force: #optional whether to allow cancellation of a paused job (default
1465 # false). Since 1.3.
1467 # Returns: Nothing on success
1468 # If no background operation is active on this device, DeviceNotActive
1472 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1477 # Pause an active background block operation.
1479 # This command returns immediately after marking the active background block
1480 # operation for pausing. It is an error to call this command if no
1481 # operation is in progress. Pausing an already paused job has no cumulative
1482 # effect; a single block-job-resume command will resume the job.
1484 # The operation will pause as soon as possible. No event is emitted when
1485 # the operation is actually paused. Cancelling a paused job automatically
1488 # @device: the device name
1490 # Returns: Nothing on success
1491 # If no background operation is active on this device, DeviceNotActive
1495 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1498 # @block-job-resume:
1500 # Resume an active background block operation.
1502 # This command returns immediately after resuming a paused background block
1503 # operation. It is an error to call this command if no operation is in
1504 # progress. Resuming an already running job is not an error.
1506 # This command also clears the error status of the job.
1508 # @device: the device name
1510 # Returns: Nothing on success
1511 # If no background operation is active on this device, DeviceNotActive
1515 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1518 # @block-job-complete:
1520 # Manually trigger completion of an active background block operation. This
1521 # is supported for drive mirroring, where it also switches the device to
1522 # write to the target path only. The ability to complete is signaled with
1523 # a BLOCK_JOB_READY event.
1525 # This command completes an active background block operation synchronously.
1526 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1527 # is not defined. Note that if an I/O error occurs during the processing of
1528 # this command: 1) the command itself will fail; 2) the error will be processed
1529 # according to the rerror/werror arguments that were specified when starting
1532 # A cancelled or paused job cannot be completed.
1534 # @device: the device name
1536 # Returns: Nothing on success
1537 # If no background operation is active on this device, DeviceNotActive
1541 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1544 # @BlockdevDiscardOptions
1546 # Determines how to handle discard requests.
1548 # @ignore: Ignore the request
1549 # @unmap: Forward as an unmap request
1553 { 'enum': 'BlockdevDiscardOptions',
1554 'data': [ 'ignore', 'unmap' ] }
1557 # @BlockdevDetectZeroesOptions
1559 # Describes the operation mode for the automatic conversion of plain
1560 # zero writes by the OS to driver specific optimized zero write commands.
1562 # @off: Disabled (default)
1564 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1565 # also that @BlockdevDiscardOptions is set to unmap for this device.
1569 { 'enum': 'BlockdevDetectZeroesOptions',
1570 'data': [ 'off', 'on', 'unmap' ] }
1573 # @BlockdevAioOptions
1575 # Selects the AIO backend to handle I/O requests
1577 # @threads: Use qemu's thread pool
1578 # @native: Use native AIO backend (only Linux and Windows)
1582 { 'enum': 'BlockdevAioOptions',
1583 'data': [ 'threads', 'native' ] }
1586 # @BlockdevCacheOptions
1588 # Includes cache-related options for block devices
1590 # @writeback: #optional enables writeback mode for any caches (default: true)
1591 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1593 # @no-flush: #optional ignore any flush requests for the device (default:
1598 { 'struct': 'BlockdevCacheOptions',
1599 'data': { '*writeback': 'bool',
1601 '*no-flush': 'bool' } }
1606 # Drivers that are supported in block device operations.
1608 # @host_device, @host_cdrom: Since 2.1
1612 { 'enum': 'BlockdevDriver',
1613 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1614 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
1615 'http', 'https', 'null-aio', 'null-co', 'parallels',
1616 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx',
1617 'vmdk', 'vpc', 'vvfat' ] }
1620 # @BlockdevOptionsBase
1622 # Options that are available for all block devices, independent of the block
1625 # @driver: block driver name
1626 # @id: #optional id by which the new block device can be referred to.
1627 # This option is only allowed on the top level of blockdev-add.
1628 # A BlockBackend will be created by blockdev-add if and only if
1629 # this option is given.
1630 # @node-name: #optional the name of a block driver state node (Since 2.0).
1631 # This option is required on the top level of blockdev-add if
1632 # the @id option is not given there.
1633 # @discard: #optional discard-related options (default: ignore)
1634 # @cache: #optional cache-related options
1635 # @aio: #optional AIO backend (default: threads)
1636 # @rerror: #optional how to handle read errors on the device
1638 # @werror: #optional how to handle write errors on the device
1640 # @read-only: #optional whether the block device should be read-only
1642 # @stats-account-invalid: #optional whether to include invalid
1643 # operations when computing last access statistics
1644 # (default: true) (Since 2.5)
1645 # @stats-account-failed: #optional whether to include failed
1646 # operations when computing latency and last
1647 # access statistics (default: true) (Since 2.5)
1648 # @stats-intervals: #optional list of intervals for collecting I/O
1649 # statistics, in seconds (default: none) (Since 2.5)
1650 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
1655 { 'struct': 'BlockdevOptionsBase',
1656 'data': { 'driver': 'BlockdevDriver',
1658 '*node-name': 'str',
1659 '*discard': 'BlockdevDiscardOptions',
1660 '*cache': 'BlockdevCacheOptions',
1661 '*aio': 'BlockdevAioOptions',
1662 '*rerror': 'BlockdevOnError',
1663 '*werror': 'BlockdevOnError',
1664 '*read-only': 'bool',
1665 '*stats-account-invalid': 'bool',
1666 '*stats-account-failed': 'bool',
1667 '*stats-intervals': ['int'],
1668 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } }
1671 # @BlockdevOptionsFile
1673 # Driver specific block device options for the file backend and similar
1676 # @filename: path to the image file
1680 { 'struct': 'BlockdevOptionsFile',
1681 'data': { 'filename': 'str' } }
1684 # @BlockdevOptionsNull
1686 # Driver specific block device options for the null backend.
1688 # @size: #optional size of the device in bytes.
1689 # @latency-ns: #optional emulated latency (in nanoseconds) in processing
1690 # requests. Default to zero which completes requests immediately.
1695 { 'struct': 'BlockdevOptionsNull',
1696 'data': { '*size': 'int', '*latency-ns': 'uint64' } }
1699 # @BlockdevOptionsVVFAT
1701 # Driver specific block device options for the vvfat protocol.
1703 # @dir: directory to be exported as FAT image
1704 # @fat-type: #optional FAT type: 12, 16 or 32
1705 # @floppy: #optional whether to export a floppy image (true) or
1706 # partitioned hard disk (false; default)
1707 # @label: #optional set the volume label, limited to 11 bytes. FAT16 and
1708 # FAT32 traditionally have some restrictions on labels, which are
1709 # ignored by most operating systems. Defaults to "QEMU VVFAT".
1711 # @rw: #optional whether to allow write operations (default: false)
1715 { 'struct': 'BlockdevOptionsVVFAT',
1716 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1717 '*label': 'str', '*rw': 'bool' } }
1720 # @BlockdevOptionsGenericFormat
1722 # Driver specific block device options for image format that have no option
1723 # besides their data source.
1725 # @file: reference to or definition of the data source block device
1729 { 'struct': 'BlockdevOptionsGenericFormat',
1730 'data': { 'file': 'BlockdevRef' } }
1733 # @BlockdevOptionsGenericCOWFormat
1735 # Driver specific block device options for image format that have no option
1736 # besides their data source and an optional backing file.
1738 # @backing: #optional reference to or definition of the backing file block
1739 # device (if missing, taken from the image file content). It is
1740 # allowed to pass an empty string here in order to disable the
1741 # default backing file.
1745 { 'struct': 'BlockdevOptionsGenericCOWFormat',
1746 'base': 'BlockdevOptionsGenericFormat',
1747 'data': { '*backing': 'BlockdevRef' } }
1750 # @Qcow2OverlapCheckMode
1752 # General overlap check modes.
1754 # @none: Do not perform any checks
1756 # @constant: Perform only checks which can be done in constant time and
1757 # without reading anything from disk
1759 # @cached: Perform only checks which can be done without reading anything
1762 # @all: Perform all available overlap checks
1766 { 'enum': 'Qcow2OverlapCheckMode',
1767 'data': [ 'none', 'constant', 'cached', 'all' ] }
1770 # @Qcow2OverlapCheckFlags
1772 # Structure of flags for each metadata structure. Setting a field to 'true'
1773 # makes qemu guard that structure against unintended overwriting. The default
1774 # value is chosen according to the template given.
1776 # @template: Specifies a template mode which can be adjusted using the other
1777 # flags, defaults to 'cached'
1781 { 'struct': 'Qcow2OverlapCheckFlags',
1782 'data': { '*template': 'Qcow2OverlapCheckMode',
1783 '*main-header': 'bool',
1784 '*active-l1': 'bool',
1785 '*active-l2': 'bool',
1786 '*refcount-table': 'bool',
1787 '*refcount-block': 'bool',
1788 '*snapshot-table': 'bool',
1789 '*inactive-l1': 'bool',
1790 '*inactive-l2': 'bool' } }
1793 # @Qcow2OverlapChecks
1795 # Specifies which metadata structures should be guarded against unintended
1798 # @flags: set of flags for separate specification of each metadata structure
1801 # @mode: named mode which chooses a specific set of flags
1805 { 'alternate': 'Qcow2OverlapChecks',
1806 'data': { 'flags': 'Qcow2OverlapCheckFlags',
1807 'mode': 'Qcow2OverlapCheckMode' } }
1810 # @BlockdevOptionsQcow2
1812 # Driver specific block device options for qcow2.
1814 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1815 # feature (default is taken from the image file)
1817 # @pass-discard-request: #optional whether discard requests to the qcow2
1818 # device should be forwarded to the data source
1820 # @pass-discard-snapshot: #optional whether discard requests for the data source
1821 # should be issued when a snapshot operation (e.g.
1822 # deleting a snapshot) frees clusters in the qcow2 file
1824 # @pass-discard-other: #optional whether discard requests for the data source
1825 # should be issued on other occasions where a cluster
1828 # @overlap-check: #optional which overlap checks to perform for writes
1829 # to the image, defaults to 'cached' (since 2.2)
1831 # @cache-size: #optional the maximum total size of the L2 table and
1832 # refcount block caches in bytes (since 2.2)
1834 # @l2-cache-size: #optional the maximum size of the L2 table cache in
1837 # @refcount-cache-size: #optional the maximum size of the refcount block cache
1838 # in bytes (since 2.2)
1840 # @cache-clean-interval: #optional clean unused entries in the L2 and refcount
1841 # caches. The interval is in seconds. The default value
1842 # is 0 and it disables this feature (since 2.5)
1846 { 'struct': 'BlockdevOptionsQcow2',
1847 'base': 'BlockdevOptionsGenericCOWFormat',
1848 'data': { '*lazy-refcounts': 'bool',
1849 '*pass-discard-request': 'bool',
1850 '*pass-discard-snapshot': 'bool',
1851 '*pass-discard-other': 'bool',
1852 '*overlap-check': 'Qcow2OverlapChecks',
1853 '*cache-size': 'int',
1854 '*l2-cache-size': 'int',
1855 '*refcount-cache-size': 'int',
1856 '*cache-clean-interval': 'int' } }
1860 # @BlockdevOptionsArchipelago
1862 # Driver specific block device options for Archipelago.
1864 # @volume: Name of the Archipelago volume image
1866 # @mport: #optional The port number on which mapperd is
1867 # listening. This is optional
1868 # and if not specified, QEMU will make Archipelago
1869 # use the default port (1001).
1871 # @vport: #optional The port number on which vlmcd is
1872 # listening. This is optional
1873 # and if not specified, QEMU will make Archipelago
1874 # use the default port (501).
1876 # @segment: #optional The name of the shared memory segment
1877 # Archipelago stack is using. This is optional
1878 # and if not specified, QEMU will make Archipelago
1879 # use the default value, 'archipelago'.
1882 { 'struct': 'BlockdevOptionsArchipelago',
1883 'data': { 'volume': 'str',
1886 '*segment': 'str' } }
1892 # Trigger events supported by blkdebug.
1896 { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
1897 'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
1898 'l1_grow_activate_table', 'l2_load', 'l2_update',
1899 'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
1900 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1901 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1902 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1903 'refblock_load', 'refblock_update', 'refblock_update_part',
1904 'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
1905 'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
1906 'refblock_alloc_switch_table', 'cluster_alloc',
1907 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
1908 'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
1909 'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
1910 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
1913 # @BlkdebugInjectErrorOptions
1915 # Describes a single error injection for blkdebug.
1917 # @event: trigger event
1919 # @state: #optional the state identifier blkdebug needs to be in to
1920 # actually trigger the event; defaults to "any"
1922 # @errno: #optional error identifier (errno) to be returned; defaults to
1925 # @sector: #optional specifies the sector index which has to be affected
1926 # in order to actually trigger the event; defaults to "any
1929 # @once: #optional disables further events after this one has been
1930 # triggered; defaults to false
1932 # @immediately: #optional fail immediately; defaults to false
1936 { 'struct': 'BlkdebugInjectErrorOptions',
1937 'data': { 'event': 'BlkdebugEvent',
1942 '*immediately': 'bool' } }
1945 # @BlkdebugSetStateOptions
1947 # Describes a single state-change event for blkdebug.
1949 # @event: trigger event
1951 # @state: #optional the current state identifier blkdebug needs to be in;
1954 # @new_state: the state identifier blkdebug is supposed to assume if
1955 # this event is triggered
1959 { 'struct': 'BlkdebugSetStateOptions',
1960 'data': { 'event': 'BlkdebugEvent',
1962 'new_state': 'int' } }
1965 # @BlockdevOptionsBlkdebug
1967 # Driver specific block device options for blkdebug.
1969 # @image: underlying raw block device (or image file)
1971 # @config: #optional filename of the configuration file
1973 # @align: #optional required alignment for requests in bytes
1975 # @inject-error: #optional array of error injection descriptions
1977 # @set-state: #optional array of state-change descriptions
1981 { 'struct': 'BlockdevOptionsBlkdebug',
1982 'data': { 'image': 'BlockdevRef',
1985 '*inject-error': ['BlkdebugInjectErrorOptions'],
1986 '*set-state': ['BlkdebugSetStateOptions'] } }
1989 # @BlockdevOptionsBlkverify
1991 # Driver specific block device options for blkverify.
1993 # @test: block device to be tested
1995 # @raw: raw image used for verification
1999 { 'struct': 'BlockdevOptionsBlkverify',
2000 'data': { 'test': 'BlockdevRef',
2001 'raw': 'BlockdevRef' } }
2004 # @QuorumReadPattern
2006 # An enumeration of quorum read patterns.
2008 # @quorum: read all the children and do a quorum vote on reads
2010 # @fifo: read only from the first child that has not failed
2014 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
2017 # @BlockdevOptionsQuorum
2019 # Driver specific block device options for Quorum
2021 # @blkverify: #optional true if the driver must print content mismatch
2022 # set to false by default
2024 # @children: the children block devices to use
2026 # @vote-threshold: the vote limit under which a read will fail
2028 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
2031 # @read-pattern: #optional choose read pattern and set to quorum by default
2036 { 'struct': 'BlockdevOptionsQuorum',
2037 'data': { '*blkverify': 'bool',
2038 'children': [ 'BlockdevRef' ],
2039 'vote-threshold': 'int',
2040 '*rewrite-corrupted': 'bool',
2041 '*read-pattern': 'QuorumReadPattern' } }
2046 # Options for creating a block device.
2050 { 'union': 'BlockdevOptions',
2051 'base': 'BlockdevOptionsBase',
2052 'discriminator': 'driver',
2054 'archipelago':'BlockdevOptionsArchipelago',
2055 'blkdebug': 'BlockdevOptionsBlkdebug',
2056 'blkverify': 'BlockdevOptionsBlkverify',
2057 'bochs': 'BlockdevOptionsGenericFormat',
2058 'cloop': 'BlockdevOptionsGenericFormat',
2059 'dmg': 'BlockdevOptionsGenericFormat',
2060 'file': 'BlockdevOptionsFile',
2061 'ftp': 'BlockdevOptionsFile',
2062 'ftps': 'BlockdevOptionsFile',
2063 # TODO gluster: Wait for structured options
2064 'host_cdrom': 'BlockdevOptionsFile',
2065 'host_device':'BlockdevOptionsFile',
2066 'http': 'BlockdevOptionsFile',
2067 'https': 'BlockdevOptionsFile',
2068 # TODO iscsi: Wait for structured options
2069 # TODO nbd: Should take InetSocketAddress for 'host'?
2070 # TODO nfs: Wait for structured options
2071 'null-aio': 'BlockdevOptionsNull',
2072 'null-co': 'BlockdevOptionsNull',
2073 'parallels': 'BlockdevOptionsGenericFormat',
2074 'qcow2': 'BlockdevOptionsQcow2',
2075 'qcow': 'BlockdevOptionsGenericCOWFormat',
2076 'qed': 'BlockdevOptionsGenericCOWFormat',
2077 'quorum': 'BlockdevOptionsQuorum',
2078 'raw': 'BlockdevOptionsGenericFormat',
2079 # TODO rbd: Wait for structured options
2080 # TODO sheepdog: Wait for structured options
2081 # TODO ssh: Should take InetSocketAddress for 'host'?
2082 'tftp': 'BlockdevOptionsFile',
2083 'vdi': 'BlockdevOptionsGenericFormat',
2084 'vhdx': 'BlockdevOptionsGenericFormat',
2085 'vmdk': 'BlockdevOptionsGenericCOWFormat',
2086 'vpc': 'BlockdevOptionsGenericFormat',
2087 'vvfat': 'BlockdevOptionsVVFAT'
2093 # Reference to a block device.
2095 # @definition: defines a new block device inline
2096 # @reference: references the ID of an existing block device. An
2097 # empty string means that no block device should be
2102 { 'alternate': 'BlockdevRef',
2103 'data': { 'definition': 'BlockdevOptions',
2104 'reference': 'str' } }
2109 # Creates a new block device. If the @id option is given at the top level, a
2110 # BlockBackend will be created; otherwise, @node-name is mandatory at the top
2111 # level and no BlockBackend will be created.
2113 # This command is still a work in progress. It doesn't support all
2114 # block drivers among other things. Stay away from it unless you want
2115 # to help with its development.
2117 # @options: block device options for the new device
2121 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }
2126 # Deletes a block device that has been added using blockdev-add.
2127 # The selected device can be either a block backend or a graph node.
2129 # In the former case the backend will be destroyed, along with its
2130 # inserted medium if there's any. The command will fail if the backend
2131 # or its medium are in use.
2133 # In the latter case the node will be destroyed. The command will fail
2134 # if the node is attached to a block backend or is otherwise being
2137 # One of @id or @node-name must be specified, but not both.
2139 # This command is still a work in progress and is considered
2140 # experimental. Stay away from it unless you want to help with its
2143 # @id: #optional Name of the block backend device to delete.
2145 # @node-name: #optional Name of the graph node to delete.
2149 { 'command': 'x-blockdev-del', 'data': { '*id': 'str', '*node-name': 'str' } }
2152 # @blockdev-open-tray:
2154 # Opens a block device's tray. If there is a block driver state tree inserted as
2155 # a medium, it will become inaccessible to the guest (but it will remain
2156 # associated to the block device, so closing the tray will make it accessible
2159 # If the tray was already open before, this will be a no-op.
2161 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
2162 # which no such event will be generated, these include:
2163 # - if the guest has locked the tray, @force is false and the guest does not
2164 # respond to the eject request
2165 # - if the BlockBackend denoted by @device does not have a guest device attached
2167 # - if the guest device does not have an actual tray
2169 # @device: block device name
2171 # @force: #optional if false (the default), an eject request will be sent to
2172 # the guest if it has locked the tray (and the tray will not be opened
2173 # immediately); if true, the tray will be opened regardless of whether
2178 { 'command': 'blockdev-open-tray',
2179 'data': { 'device': 'str',
2180 '*force': 'bool' } }
2183 # @blockdev-close-tray:
2185 # Closes a block device's tray. If there is a block driver state tree associated
2186 # with the block device (which is currently ejected), that tree will be loaded
2189 # If the tray was already closed before, this will be a no-op.
2191 # @device: block device name
2195 { 'command': 'blockdev-close-tray',
2196 'data': { 'device': 'str' } }
2199 # @x-blockdev-remove-medium:
2201 # Removes a medium (a block driver state tree) from a block device. That block
2202 # device's tray must currently be open (unless there is no attached guest
2205 # If the tray is open and there is no medium inserted, this will be a no-op.
2207 # This command is still a work in progress and is considered experimental.
2208 # Stay away from it unless you want to help with its development.
2210 # @device: block device name
2214 { 'command': 'x-blockdev-remove-medium',
2215 'data': { 'device': 'str' } }
2218 # @x-blockdev-insert-medium:
2220 # Inserts a medium (a block driver state tree) into a block device. That block
2221 # device's tray must currently be open (unless there is no attached guest
2222 # device) and there must be no medium inserted already.
2224 # This command is still a work in progress and is considered experimental.
2225 # Stay away from it unless you want to help with its development.
2227 # @device: block device name
2229 # @node-name: name of a node in the block driver state graph
2233 { 'command': 'x-blockdev-insert-medium',
2234 'data': { 'device': 'str',
2235 'node-name': 'str'} }
2239 # @BlockdevChangeReadOnlyMode:
2241 # Specifies the new read-only mode of a block device subject to the
2242 # @blockdev-change-medium command.
2244 # @retain: Retains the current read-only mode
2246 # @read-only: Makes the device read-only
2248 # @read-write: Makes the device writable
2252 { 'enum': 'BlockdevChangeReadOnlyMode',
2253 'data': ['retain', 'read-only', 'read-write'] }
2257 # @blockdev-change-medium:
2259 # Changes the medium inserted into a block device by ejecting the current medium
2260 # and loading a new image file which is inserted as the new medium (this command
2261 # combines blockdev-open-tray, x-blockdev-remove-medium,
2262 # x-blockdev-insert-medium and blockdev-close-tray).
2264 # @device: block device name
2266 # @filename: filename of the new image to be loaded
2268 # @format: #optional, format to open the new image with (defaults to
2269 # the probed format)
2271 # @read-only-mode: #optional, change the read-only mode of the device; defaults
2276 { 'command': 'blockdev-change-medium',
2277 'data': { 'device': 'str',
2280 '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
2286 # An enumeration of action that has been taken when a DISK I/O occurs
2288 # @ignore: error has been ignored
2290 # @report: error has been reported to the device
2292 # @stop: error caused VM to be stopped
2296 { 'enum': 'BlockErrorAction',
2297 'data': [ 'ignore', 'report', 'stop' ] }
2301 # @BLOCK_IMAGE_CORRUPTED
2303 # Emitted when a corruption has been detected in a disk image
2305 # @device: device name. This is always present for compatibility
2306 # reasons, but it can be empty ("") if the image does not
2307 # have a device name associated.
2309 # @node-name: #optional node name (Since: 2.4)
2311 # @msg: informative message for human consumption, such as the kind of
2312 # corruption being detected. It should not be parsed by machine as it is
2313 # not guaranteed to be stable
2315 # @offset: #optional, if the corruption resulted from an image access, this is
2316 # the host's access offset into the image
2318 # @size: #optional, if the corruption resulted from an image access, this is
2321 # fatal: if set, the image is marked corrupt and therefore unusable after this
2322 # event and must be repaired (Since 2.2; before, every
2323 # BLOCK_IMAGE_CORRUPTED event was fatal)
2327 { 'event': 'BLOCK_IMAGE_CORRUPTED',
2328 'data': { 'device' : 'str',
2329 '*node-name' : 'str',
2333 'fatal' : 'bool' } }
2338 # Emitted when a disk I/O error occurs
2340 # @device: device name
2342 # @operation: I/O operation
2344 # @action: action that has been taken
2346 # @nospace: #optional true if I/O error was caused due to a no-space
2347 # condition. This key is only present if query-block's
2348 # io-status is present, please see query-block documentation
2349 # for more information (since: 2.2)
2351 # @reason: human readable string describing the error cause.
2352 # (This field is a debugging aid for humans, it should not
2353 # be parsed by applications) (since: 2.2)
2355 # Note: If action is "stop", a STOP event will eventually follow the
2356 # BLOCK_IO_ERROR event
2360 { 'event': 'BLOCK_IO_ERROR',
2361 'data': { 'device': 'str', 'operation': 'IoOperationType',
2362 'action': 'BlockErrorAction', '*nospace': 'bool',
2366 # @BLOCK_JOB_COMPLETED
2368 # Emitted when a block job has completed
2372 # @device: device name
2374 # @len: maximum progress value
2376 # @offset: current progress value. On success this is equal to len.
2377 # On failure this is less than len
2379 # @speed: rate limit, bytes per second
2381 # @error: #optional, error message. Only present on failure. This field
2382 # contains a human-readable error message. There are no semantics
2383 # other than that streaming has failed and clients should not try to
2384 # interpret the error string
2388 { 'event': 'BLOCK_JOB_COMPLETED',
2389 'data': { 'type' : 'BlockJobType',
2397 # @BLOCK_JOB_CANCELLED
2399 # Emitted when a block job has been cancelled
2403 # @device: device name
2405 # @len: maximum progress value
2407 # @offset: current progress value. On success this is equal to len.
2408 # On failure this is less than len
2410 # @speed: rate limit, bytes per second
2414 { 'event': 'BLOCK_JOB_CANCELLED',
2415 'data': { 'type' : 'BlockJobType',
2424 # Emitted when a block job encounters an error
2426 # @device: device name
2428 # @operation: I/O operation
2430 # @action: action that has been taken
2434 { 'event': 'BLOCK_JOB_ERROR',
2435 'data': { 'device' : 'str',
2436 'operation': 'IoOperationType',
2437 'action' : 'BlockErrorAction' } }
2442 # Emitted when a block job is ready to complete
2446 # @device: device name
2448 # @len: maximum progress value
2450 # @offset: current progress value. On success this is equal to len.
2451 # On failure this is less than len
2453 # @speed: rate limit, bytes per second
2455 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
2460 { 'event': 'BLOCK_JOB_READY',
2461 'data': { 'type' : 'BlockJobType',
2469 # Preallocation mode of QEMU image file
2471 # @off: no preallocation
2472 # @metadata: preallocate only for metadata
2473 # @falloc: like @full preallocation but allocate disk space by
2474 # posix_fallocate() rather than writing zeros.
2475 # @full: preallocate all data by writing zeros to device to ensure disk
2476 # space is really available. @full preallocation also sets up
2477 # metadata correctly.
2481 { 'enum': 'PreallocMode',
2482 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
2485 # @BLOCK_WRITE_THRESHOLD
2487 # Emitted when writes on block device reaches or exceeds the
2488 # configured write threshold. For thin-provisioned devices, this
2489 # means the device should be extended to avoid pausing for
2491 # The event is one shot. Once triggered, it needs to be
2492 # re-registered with another block-set-threshold command.
2494 # @node-name: graph node name on which the threshold was exceeded.
2496 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
2498 # @write-threshold: last configured threshold, in bytes.
2502 { 'event': 'BLOCK_WRITE_THRESHOLD',
2503 'data': { 'node-name': 'str',
2504 'amount-exceeded': 'uint64',
2505 'write-threshold': 'uint64' } }
2508 # @block-set-write-threshold
2510 # Change the write threshold for a block drive. An event will be delivered
2511 # if a write to this block drive crosses the configured threshold.
2512 # This is useful to transparently resize thin-provisioned drives without
2513 # the guest OS noticing.
2515 # @node-name: graph node name on which the threshold must be set.
2517 # @write-threshold: configured threshold for the block device, bytes.
2518 # Use 0 to disable the threshold.
2522 { 'command': 'block-set-write-threshold',
2523 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }