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).
457 { 'struct': 'BlockDeviceStats',
458 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
459 'wr_operations': 'int', 'flush_operations': 'int',
460 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
461 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
462 'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int' } }
467 # Statistics of a virtual block device or a block backing device.
469 # @device: #optional If the stats are for a virtual block device, the name
470 # corresponding to the virtual block device.
472 # @node-name: #optional The node name of the device. (Since 2.3)
474 # @stats: A @BlockDeviceStats for the device.
476 # @parent: #optional This describes the file block device if it has one.
478 # @backing: #optional This describes the backing block device if it has one.
483 { 'struct': 'BlockStats',
484 'data': {'*device': 'str', '*node-name': 'str',
485 'stats': 'BlockDeviceStats',
486 '*parent': 'BlockStats',
487 '*backing': 'BlockStats'} }
492 # Query the @BlockStats for all virtual block devices.
494 # @query-nodes: #optional If true, the command will query all the block nodes
495 # that have a node name, in a list which will include "parent"
496 # information, but not "backing".
497 # If false or omitted, the behavior is as before - query all the
498 # device backends, recursively including their "parent" and
499 # "backing". (Since 2.3)
501 # Returns: A list of @BlockStats for each virtual block devices.
505 { 'command': 'query-blockstats',
506 'data': { '*query-nodes': 'bool' },
507 'returns': ['BlockStats'] }
512 # An enumeration of possible behaviors for errors on I/O operations.
513 # The exact meaning depends on whether the I/O was initiated by a guest
516 # @report: for guest operations, report the error to the guest;
517 # for jobs, cancel the job
519 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
520 # or BLOCK_JOB_ERROR)
522 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
524 # @stop: for guest operations, stop the virtual machine;
525 # for jobs, pause the job
529 { 'enum': 'BlockdevOnError',
530 'data': ['report', 'ignore', 'enospc', 'stop'] }
535 # An enumeration of possible behaviors for the initial synchronization
536 # phase of storage mirroring.
538 # @top: copies data in the topmost image to the destination
540 # @full: copies data from all images to the destination
542 # @none: only copy data written from now on
544 # @incremental: only copy data described by the dirty bitmap. Since: 2.4
548 { 'enum': 'MirrorSyncMode',
549 'data': ['top', 'full', 'none', 'incremental'] }
554 # Type of a block job.
556 # @commit: block commit job type, see "block-commit"
558 # @stream: block stream job type, see "block-stream"
560 # @mirror: drive mirror job type, see "drive-mirror"
562 # @backup: drive backup job type, see "drive-backup"
566 { 'enum': 'BlockJobType',
567 'data': ['commit', 'stream', 'mirror', 'backup'] }
572 # Information about a long-running block device operation.
574 # @type: the job type ('stream' for image streaming)
576 # @device: the block device name
578 # @len: the maximum progress value
580 # @busy: false if the job is known to be in a quiescent state, with
581 # no pending I/O. Since 1.3.
583 # @paused: whether the job is paused or, if @busy is true, will
584 # pause itself as soon as possible. Since 1.3.
586 # @offset: the current progress value
588 # @speed: the rate limit, bytes per second
590 # @io-status: the status of the job (since 1.3)
592 # @ready: true if the job may be completed (since 2.2)
596 { 'struct': 'BlockJobInfo',
597 'data': {'type': 'str', 'device': 'str', 'len': 'int',
598 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
599 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
604 # Return information about long-running block device operations.
606 # Returns: a list of @BlockJobInfo for each active block job
610 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
615 # This command sets the password of a block device that has not been open
616 # with a password and requires one.
618 # The two cases where this can happen are a block device is created through
619 # QEMU's initial command line or a block device is changed through the legacy
622 # In the event that the block device is created through the initial command
623 # line, the VM will start in the stopped state regardless of whether '-S' is
624 # used. The intention is for a management tool to query the block devices to
625 # determine which ones are encrypted, set the passwords with this command, and
626 # then start the guest with the @cont command.
628 # Either @device or @node-name must be set but not both.
630 # @device: #optional the name of the block backend device to set the password on
632 # @node-name: #optional graph node name to set the password on (Since 2.0)
634 # @password: the password to use for the device
636 # Returns: nothing on success
637 # If @device is not a valid block device, DeviceNotFound
638 # If @device is not encrypted, DeviceNotEncrypted
640 # Notes: Not all block formats support encryption and some that do are not
641 # able to validate that a password is correct. Disk corruption may
642 # occur if an invalid password is specified.
646 { 'command': 'block_passwd', 'data': {'*device': 'str',
647 '*node-name': 'str', 'password': 'str'} }
652 # Resize a block image while a guest is running.
654 # Either @device or @node-name must be set but not both.
656 # @device: #optional the name of the device to get the image resized
658 # @node-name: #optional graph node name to get the image resized (Since 2.0)
660 # @size: new image size in bytes
662 # Returns: nothing on success
663 # If @device is not a valid block device, DeviceNotFound
667 { 'command': 'block_resize', 'data': { '*device': 'str',
674 # An enumeration that tells QEMU how to set the backing file path in
677 # @existing: QEMU should look for an existing image file.
679 # @absolute-paths: QEMU should create a new image with absolute paths
680 # for the backing file. If there is no backing file available, the new
681 # image will not be backed either.
685 { 'enum': 'NewImageMode',
686 'data': [ 'existing', 'absolute-paths' ] }
689 # @BlockdevSnapshotSync
691 # Either @device or @node-name must be set but not both.
693 # @device: #optional the name of the device to generate the snapshot from.
695 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
697 # @snapshot-file: the target of the new image. A new file will be created.
699 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
701 # @format: #optional the format of the snapshot image, default is 'qcow2'.
703 # @mode: #optional whether and how QEMU should create a new image, default is
706 { 'struct': 'BlockdevSnapshotSync',
707 'data': { '*device': 'str', '*node-name': 'str',
708 'snapshot-file': 'str', '*snapshot-node-name': 'str',
709 '*format': 'str', '*mode': 'NewImageMode' } }
714 # @node: device or node name that will have a snapshot created.
716 # @overlay: reference to the existing block device that will become
717 # the overlay of @node, as part of creating the snapshot.
718 # It must not have a current backing file (this can be
719 # achieved by passing "backing": "" to blockdev-add).
723 { 'struct': 'BlockdevSnapshot',
724 'data': { 'node': 'str', 'overlay': 'str' } }
729 # @device: the name of the device which should be copied.
731 # @target: the target of the new image. If the file exists, or if it
732 # is a device, the existing file/device will be used as the new
733 # destination. If it does not exist, a new file will be created.
735 # @format: #optional the format of the new destination, default is to
736 # probe if @mode is 'existing', else the format of the source
738 # @sync: what parts of the disk image should be copied to the destination
739 # (all the disk, only the sectors allocated in the topmost image, from a
740 # dirty bitmap, or only new I/O).
742 # @mode: #optional whether and how QEMU should create a new image, default is
745 # @speed: #optional the maximum speed, in bytes per second
747 # @bitmap: #optional the name of dirty bitmap if sync is "incremental".
748 # Must be present if sync is "incremental", must NOT be present
749 # otherwise. (Since 2.4)
751 # @on-source-error: #optional the action to take on an error on the source,
752 # default 'report'. 'stop' and 'enospc' can only be used
753 # if the block device supports io-status (see BlockInfo).
755 # @on-target-error: #optional the action to take on an error on the target,
756 # default 'report' (no limitations, since this applies to
757 # a different block device than @device).
759 # Note that @on-source-error and @on-target-error only affect background I/O.
760 # If an error occurs during a guest write request, the device's rerror/werror
761 # actions will be used.
765 { 'struct': 'DriveBackup',
766 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
767 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
768 '*speed': 'int', '*bitmap': 'str',
769 '*on-source-error': 'BlockdevOnError',
770 '*on-target-error': 'BlockdevOnError' } }
775 # @device: the name of the device which should be copied.
777 # @target: the name of the backup target device.
779 # @sync: what parts of the disk image should be copied to the destination
780 # (all the disk, only the sectors allocated in the topmost image, or
783 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
786 # @on-source-error: #optional the action to take on an error on the source,
787 # default 'report'. 'stop' and 'enospc' can only be used
788 # if the block device supports io-status (see BlockInfo).
790 # @on-target-error: #optional the action to take on an error on the target,
791 # default 'report' (no limitations, since this applies to
792 # a different block device than @device).
794 # Note that @on-source-error and @on-target-error only affect background I/O.
795 # If an error occurs during a guest write request, the device's rerror/werror
796 # actions will be used.
800 { 'struct': 'BlockdevBackup',
801 'data': { 'device': 'str', 'target': 'str',
802 'sync': 'MirrorSyncMode',
804 '*on-source-error': 'BlockdevOnError',
805 '*on-target-error': 'BlockdevOnError' } }
808 # @blockdev-snapshot-sync
810 # Generates a synchronous snapshot of a block device.
812 # For the arguments, see the documentation of BlockdevSnapshotSync.
814 # Returns: nothing on success
815 # If @device is not a valid block device, DeviceNotFound
819 { 'command': 'blockdev-snapshot-sync',
820 'data': 'BlockdevSnapshotSync' }
826 # Generates a snapshot of a block device.
828 # For the arguments, see the documentation of BlockdevSnapshot.
832 { 'command': 'blockdev-snapshot',
833 'data': 'BlockdevSnapshot' }
836 # @change-backing-file
838 # Change the backing file in the image file metadata. This does not
839 # cause QEMU to reopen the image file to reparse the backing filename
840 # (it may, however, perform a reopen to change permissions from
841 # r/o -> r/w -> r/o, if needed). The new backing file string is written
842 # into the image file metadata, and the QEMU internal strings are
845 # @image-node-name: The name of the block driver state node of the
848 # @device: The name of the device that owns image-node-name.
850 # @backing-file: The string to write as the backing file. This
851 # string is not validated, so care should be taken
852 # when specifying the string or the image chain may
853 # not be able to be reopened again.
857 { 'command': 'change-backing-file',
858 'data': { 'device': 'str', 'image-node-name': 'str',
859 'backing-file': 'str' } }
864 # Live commit of data from overlay image nodes into backing nodes - i.e.,
865 # writes data between 'top' and 'base' into 'base'.
867 # @device: the name of the device
869 # @base: #optional The file name of the backing image to write data into.
870 # If not specified, this is the deepest backing image
872 # @top: #optional The file name of the backing image within the image chain,
873 # which contains the topmost data to be committed down. If
874 # not specified, this is the active layer.
876 # @backing-file: #optional The backing file string to write into the overlay
877 # image of 'top'. If 'top' is the active layer,
878 # specifying a backing file string is an error. This
879 # filename is not validated.
881 # If a pathname string is such that it cannot be
882 # resolved by QEMU, that means that subsequent QMP or
883 # HMP commands must use node-names for the image in
884 # question, as filename lookup methods will fail.
886 # If not specified, QEMU will automatically determine
887 # the backing file string to use, or error out if
888 # there is no obvious choice. Care should be taken
889 # when specifying the string, to specify a valid
890 # filename or protocol.
893 # If top == base, that is an error.
894 # If top == active, the job will not be completed by itself,
895 # user needs to complete the job with the block-job-complete
896 # command after getting the ready event. (Since 2.0)
898 # If the base image is smaller than top, then the base image
899 # will be resized to be the same size as top. If top is
900 # smaller than the base image, the base will not be
901 # truncated. If you want the base image size to match the
902 # size of the smaller top, you can safely truncate it
903 # yourself once the commit operation successfully completes.
905 # @speed: #optional the maximum speed, in bytes per second
907 # Returns: Nothing on success
908 # If commit or stream is already active on this device, DeviceInUse
909 # If @device does not exist, DeviceNotFound
910 # If image commit is not supported by this device, NotSupported
911 # If @base or @top is invalid, a generic error is returned
912 # If @speed is invalid, InvalidParameter
917 { 'command': 'block-commit',
918 'data': { 'device': 'str', '*base': 'str', '*top': 'str',
919 '*backing-file': 'str', '*speed': 'int' } }
924 # Start a point-in-time copy of a block device to a new destination. The
925 # status of ongoing drive-backup operations can be checked with
926 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
927 # The operation can be stopped before it has completed using the
928 # block-job-cancel command.
930 # For the arguments, see the documentation of DriveBackup.
932 # Returns: nothing on success
933 # If @device is not a valid block device, DeviceNotFound
937 { 'command': 'drive-backup', 'data': 'DriveBackup' }
942 # Start a point-in-time copy of a block device to a new destination. The
943 # status of ongoing blockdev-backup operations can be checked with
944 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
945 # The operation can be stopped before it has completed using the
946 # block-job-cancel command.
948 # For the arguments, see the documentation of BlockdevBackup.
952 { 'command': 'blockdev-backup', 'data': 'BlockdevBackup' }
956 # @query-named-block-nodes
958 # Get the named block driver list
960 # Returns: the list of BlockDeviceInfo
964 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
969 # Start mirroring a block device's writes to a new destination.
971 # @device: the name of the device whose writes should be mirrored.
973 # @target: the target of the new image. If the file exists, or if it
974 # is a device, the existing file/device will be used as the new
975 # destination. If it does not exist, a new file will be created.
977 # @format: #optional the format of the new destination, default is to
978 # probe if @mode is 'existing', else the format of the source
980 # @node-name: #optional the new block driver state node name in the graph
983 # @replaces: #optional with sync=full graph node name to be replaced by the new
984 # image when a whole image copy is done. This can be used to repair
985 # broken Quorum files. (Since 2.1)
987 # @mode: #optional whether and how QEMU should create a new image, default is
990 # @speed: #optional the maximum speed, in bytes per second
992 # @sync: what parts of the disk image should be copied to the destination
993 # (all the disk, only the sectors allocated in the topmost image, or
996 # @granularity: #optional granularity of the dirty bitmap, default is 64K
997 # if the image format doesn't have clusters, 4K if the clusters
998 # are smaller than that, else the cluster size. Must be a
999 # power of 2 between 512 and 64M (since 1.4).
1001 # @buf-size: #optional maximum amount of data in flight from source to
1002 # target (since 1.4).
1004 # @on-source-error: #optional the action to take on an error on the source,
1005 # default 'report'. 'stop' and 'enospc' can only be used
1006 # if the block device supports io-status (see BlockInfo).
1008 # @on-target-error: #optional the action to take on an error on the target,
1009 # default 'report' (no limitations, since this applies to
1010 # a different block device than @device).
1011 # @unmap: #optional Whether to try to unmap target sectors where source has
1012 # only zero. If true, and target unallocated sectors will read as zero,
1013 # target image sectors will be unmapped; otherwise, zeroes will be
1014 # written. Both will result in identical contents.
1015 # Default is true. (Since 2.4)
1017 # Returns: nothing on success
1018 # If @device is not a valid block device, DeviceNotFound
1022 { 'command': 'drive-mirror',
1023 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
1024 '*node-name': 'str', '*replaces': 'str',
1025 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1026 '*speed': 'int', '*granularity': 'uint32',
1027 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1028 '*on-target-error': 'BlockdevOnError',
1029 '*unmap': 'bool' } }
1034 # @node: name of device/node which the bitmap is tracking
1036 # @name: name of the dirty bitmap
1040 { 'struct': 'BlockDirtyBitmap',
1041 'data': { 'node': 'str', 'name': 'str' } }
1044 # @BlockDirtyBitmapAdd
1046 # @node: name of device/node which the bitmap is tracking
1048 # @name: name of the dirty bitmap
1050 # @granularity: #optional the bitmap granularity, default is 64k for
1051 # block-dirty-bitmap-add
1055 { 'struct': 'BlockDirtyBitmapAdd',
1056 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } }
1059 # @block-dirty-bitmap-add
1061 # Create a dirty bitmap with a name on the node
1063 # Returns: nothing on success
1064 # If @node is not a valid block device or node, DeviceNotFound
1065 # If @name is already taken, GenericError with an explanation
1069 { 'command': 'block-dirty-bitmap-add',
1070 'data': 'BlockDirtyBitmapAdd' }
1073 # @block-dirty-bitmap-remove
1075 # Remove a dirty bitmap on the node
1077 # Returns: nothing on success
1078 # If @node is not a valid block device or node, DeviceNotFound
1079 # If @name is not found, GenericError with an explanation
1080 # if @name is frozen by an operation, GenericError
1084 { 'command': 'block-dirty-bitmap-remove',
1085 'data': 'BlockDirtyBitmap' }
1088 # @block-dirty-bitmap-clear
1090 # Clear (reset) a dirty bitmap on the device
1092 # Returns: nothing on success
1093 # If @node is not a valid block device, DeviceNotFound
1094 # If @name is not found, GenericError with an explanation
1098 { 'command': 'block-dirty-bitmap-clear',
1099 'data': 'BlockDirtyBitmap' }
1102 # @block_set_io_throttle:
1104 # Change I/O throttle limits for a block drive.
1106 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1109 # If two or more devices are members of the same group, the limits
1110 # will apply to the combined I/O of the whole group in a round-robin
1111 # fashion. Therefore, setting new I/O limits to a device will affect
1114 # The name of the group can be specified using the 'group' parameter.
1115 # If the parameter is unset, it is assumed to be the current group of
1116 # that device. If it's not in any group yet, the name of the device
1117 # will be used as the name for its group.
1119 # The 'group' parameter can also be used to move a device to a
1120 # different group. In this case the limits specified in the parameters
1121 # will be applied to the new group only.
1123 # I/O limits can be disabled by setting all of them to 0. In this case
1124 # the device will be removed from its group and the rest of its
1125 # members will not be affected. The 'group' parameter is ignored.
1127 # @device: The name of the device
1129 # @bps: total throughput limit in bytes per second
1131 # @bps_rd: read throughput limit in bytes per second
1133 # @bps_wr: write throughput limit in bytes per second
1135 # @iops: total I/O operations per second
1137 # @ops_rd: read I/O operations per second
1139 # @iops_wr: write I/O operations per second
1141 # @bps_max: #optional total max in bytes (Since 1.7)
1143 # @bps_rd_max: #optional read max in bytes (Since 1.7)
1145 # @bps_wr_max: #optional write max in bytes (Since 1.7)
1147 # @iops_max: #optional total I/O operations max (Since 1.7)
1149 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
1151 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
1153 # @iops_size: #optional an I/O size in bytes (Since 1.7)
1155 # @group: #optional throttle group name (Since 2.4)
1157 # Returns: Nothing on success
1158 # If @device is not a valid block device, DeviceNotFound
1162 { 'command': 'block_set_io_throttle',
1163 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1164 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1165 '*bps_max': 'int', '*bps_rd_max': 'int',
1166 '*bps_wr_max': 'int', '*iops_max': 'int',
1167 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1168 '*iops_size': 'int', '*group': 'str' } }
1173 # Copy data from a backing file into a block device.
1175 # The block streaming operation is performed in the background until the entire
1176 # backing file has been copied. This command returns immediately once streaming
1177 # has started. The status of ongoing block streaming operations can be checked
1178 # with query-block-jobs. The operation can be stopped before it has completed
1179 # using the block-job-cancel command.
1181 # If a base file is specified then sectors are not copied from that base file and
1182 # its backing chain. When streaming completes the image file will have the base
1183 # file as its backing file. This can be used to stream a subset of the backing
1184 # file chain instead of flattening the entire image.
1186 # On successful completion the image file is updated to drop the backing file
1187 # and the BLOCK_JOB_COMPLETED event is emitted.
1189 # @device: the device name
1191 # @base: #optional the common backing file name
1193 # @backing-file: #optional The backing file string to write into the active
1194 # layer. This filename is not validated.
1196 # If a pathname string is such that it cannot be
1197 # resolved by QEMU, that means that subsequent QMP or
1198 # HMP commands must use node-names for the image in
1199 # question, as filename lookup methods will fail.
1201 # If not specified, QEMU will automatically determine
1202 # the backing file string to use, or error out if there
1203 # is no obvious choice. Care should be taken when
1204 # specifying the string, to specify a valid filename or
1208 # @speed: #optional the maximum speed, in bytes per second
1210 # @on-error: #optional the action to take on an error (default report).
1211 # 'stop' and 'enospc' can only be used if the block device
1212 # supports io-status (see BlockInfo). Since 1.3.
1214 # Returns: Nothing on success
1215 # If @device does not exist, DeviceNotFound
1219 { 'command': 'block-stream',
1220 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str',
1221 '*speed': 'int', '*on-error': 'BlockdevOnError' } }
1224 # @block-job-set-speed:
1226 # Set maximum speed for a background block operation.
1228 # This command can only be issued when there is an active block job.
1230 # Throttling can be disabled by setting the speed to 0.
1232 # @device: the device name
1234 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1237 # Returns: Nothing on success
1238 # If no background operation is active on this device, DeviceNotActive
1242 { 'command': 'block-job-set-speed',
1243 'data': { 'device': 'str', 'speed': 'int' } }
1246 # @block-job-cancel:
1248 # Stop an active background block operation.
1250 # This command returns immediately after marking the active background block
1251 # operation for cancellation. It is an error to call this command if no
1252 # operation is in progress.
1254 # The operation will cancel as soon as possible and then emit the
1255 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1256 # enumerated using query-block-jobs.
1258 # For streaming, the image file retains its backing file unless the streaming
1259 # operation happens to complete just as it is being cancelled. A new streaming
1260 # operation can be started at a later time to finish copying all data from the
1263 # @device: the device name
1265 # @force: #optional whether to allow cancellation of a paused job (default
1266 # false). Since 1.3.
1268 # Returns: Nothing on success
1269 # If no background operation is active on this device, DeviceNotActive
1273 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1278 # Pause an active background block operation.
1280 # This command returns immediately after marking the active background block
1281 # operation for pausing. It is an error to call this command if no
1282 # operation is in progress. Pausing an already paused job has no cumulative
1283 # effect; a single block-job-resume command will resume the job.
1285 # The operation will pause as soon as possible. No event is emitted when
1286 # the operation is actually paused. Cancelling a paused job automatically
1289 # @device: the device name
1291 # Returns: Nothing on success
1292 # If no background operation is active on this device, DeviceNotActive
1296 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1299 # @block-job-resume:
1301 # Resume an active background block operation.
1303 # This command returns immediately after resuming a paused background block
1304 # operation. It is an error to call this command if no operation is in
1305 # progress. Resuming an already running job is not an error.
1307 # This command also clears the error status of the job.
1309 # @device: the device name
1311 # Returns: Nothing on success
1312 # If no background operation is active on this device, DeviceNotActive
1316 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1319 # @block-job-complete:
1321 # Manually trigger completion of an active background block operation. This
1322 # is supported for drive mirroring, where it also switches the device to
1323 # write to the target path only. The ability to complete is signaled with
1324 # a BLOCK_JOB_READY event.
1326 # This command completes an active background block operation synchronously.
1327 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1328 # is not defined. Note that if an I/O error occurs during the processing of
1329 # this command: 1) the command itself will fail; 2) the error will be processed
1330 # according to the rerror/werror arguments that were specified when starting
1333 # A cancelled or paused job cannot be completed.
1335 # @device: the device name
1337 # Returns: Nothing on success
1338 # If no background operation is active on this device, DeviceNotActive
1342 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1345 # @BlockdevDiscardOptions
1347 # Determines how to handle discard requests.
1349 # @ignore: Ignore the request
1350 # @unmap: Forward as an unmap request
1354 { 'enum': 'BlockdevDiscardOptions',
1355 'data': [ 'ignore', 'unmap' ] }
1358 # @BlockdevDetectZeroesOptions
1360 # Describes the operation mode for the automatic conversion of plain
1361 # zero writes by the OS to driver specific optimized zero write commands.
1363 # @off: Disabled (default)
1365 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1366 # also that @BlockdevDiscardOptions is set to unmap for this device.
1370 { 'enum': 'BlockdevDetectZeroesOptions',
1371 'data': [ 'off', 'on', 'unmap' ] }
1374 # @BlockdevAioOptions
1376 # Selects the AIO backend to handle I/O requests
1378 # @threads: Use qemu's thread pool
1379 # @native: Use native AIO backend (only Linux and Windows)
1383 { 'enum': 'BlockdevAioOptions',
1384 'data': [ 'threads', 'native' ] }
1387 # @BlockdevCacheOptions
1389 # Includes cache-related options for block devices
1391 # @writeback: #optional enables writeback mode for any caches (default: true)
1392 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1394 # @no-flush: #optional ignore any flush requests for the device (default:
1399 { 'struct': 'BlockdevCacheOptions',
1400 'data': { '*writeback': 'bool',
1402 '*no-flush': 'bool' } }
1407 # Drivers that are supported in block device operations.
1409 # @host_device, @host_cdrom: Since 2.1
1413 { 'enum': 'BlockdevDriver',
1414 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1415 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
1416 'http', 'https', 'null-aio', 'null-co', 'parallels',
1417 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx',
1418 'vmdk', 'vpc', 'vvfat' ] }
1421 # @BlockdevOptionsBase
1423 # Options that are available for all block devices, independent of the block
1426 # @driver: block driver name
1427 # @id: #optional id by which the new block device can be referred to.
1428 # This option is only allowed on the top level of blockdev-add.
1429 # A BlockBackend will be created by blockdev-add if and only if
1430 # this option is given.
1431 # @node-name: #optional the name of a block driver state node (Since 2.0).
1432 # This option is required on the top level of blockdev-add if
1433 # the @id option is not given there.
1434 # @discard: #optional discard-related options (default: ignore)
1435 # @cache: #optional cache-related options
1436 # @aio: #optional AIO backend (default: threads)
1437 # @rerror: #optional how to handle read errors on the device
1439 # @werror: #optional how to handle write errors on the device
1441 # @read-only: #optional whether the block device should be read-only
1443 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
1448 { 'struct': 'BlockdevOptionsBase',
1449 'data': { 'driver': 'BlockdevDriver',
1451 '*node-name': 'str',
1452 '*discard': 'BlockdevDiscardOptions',
1453 '*cache': 'BlockdevCacheOptions',
1454 '*aio': 'BlockdevAioOptions',
1455 '*rerror': 'BlockdevOnError',
1456 '*werror': 'BlockdevOnError',
1457 '*read-only': 'bool',
1458 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } }
1461 # @BlockdevOptionsFile
1463 # Driver specific block device options for the file backend and similar
1466 # @filename: path to the image file
1470 { 'struct': 'BlockdevOptionsFile',
1471 'data': { 'filename': 'str' } }
1474 # @BlockdevOptionsNull
1476 # Driver specific block device options for the null backend.
1478 # @size: #optional size of the device in bytes.
1479 # @latency-ns: #optional emulated latency (in nanoseconds) in processing
1480 # requests. Default to zero which completes requests immediately.
1485 { 'struct': 'BlockdevOptionsNull',
1486 'data': { '*size': 'int', '*latency-ns': 'uint64' } }
1489 # @BlockdevOptionsVVFAT
1491 # Driver specific block device options for the vvfat protocol.
1493 # @dir: directory to be exported as FAT image
1494 # @fat-type: #optional FAT type: 12, 16 or 32
1495 # @floppy: #optional whether to export a floppy image (true) or
1496 # partitioned hard disk (false; default)
1497 # @label: #optional set the volume label, limited to 11 bytes. FAT16 and
1498 # FAT32 traditionally have some restrictions on labels, which are
1499 # ignored by most operating systems. Defaults to "QEMU VVFAT".
1501 # @rw: #optional whether to allow write operations (default: false)
1505 { 'struct': 'BlockdevOptionsVVFAT',
1506 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1507 '*label': 'str', '*rw': 'bool' } }
1510 # @BlockdevOptionsGenericFormat
1512 # Driver specific block device options for image format that have no option
1513 # besides their data source.
1515 # @file: reference to or definition of the data source block device
1519 { 'struct': 'BlockdevOptionsGenericFormat',
1520 'data': { 'file': 'BlockdevRef' } }
1523 # @BlockdevOptionsGenericCOWFormat
1525 # Driver specific block device options for image format that have no option
1526 # besides their data source and an optional backing file.
1528 # @backing: #optional reference to or definition of the backing file block
1529 # device (if missing, taken from the image file content). It is
1530 # allowed to pass an empty string here in order to disable the
1531 # default backing file.
1535 { 'struct': 'BlockdevOptionsGenericCOWFormat',
1536 'base': 'BlockdevOptionsGenericFormat',
1537 'data': { '*backing': 'BlockdevRef' } }
1540 # @Qcow2OverlapCheckMode
1542 # General overlap check modes.
1544 # @none: Do not perform any checks
1546 # @constant: Perform only checks which can be done in constant time and
1547 # without reading anything from disk
1549 # @cached: Perform only checks which can be done without reading anything
1552 # @all: Perform all available overlap checks
1556 { 'enum': 'Qcow2OverlapCheckMode',
1557 'data': [ 'none', 'constant', 'cached', 'all' ] }
1560 # @Qcow2OverlapCheckFlags
1562 # Structure of flags for each metadata structure. Setting a field to 'true'
1563 # makes qemu guard that structure against unintended overwriting. The default
1564 # value is chosen according to the template given.
1566 # @template: Specifies a template mode which can be adjusted using the other
1567 # flags, defaults to 'cached'
1571 { 'struct': 'Qcow2OverlapCheckFlags',
1572 'data': { '*template': 'Qcow2OverlapCheckMode',
1573 '*main-header': 'bool',
1574 '*active-l1': 'bool',
1575 '*active-l2': 'bool',
1576 '*refcount-table': 'bool',
1577 '*refcount-block': 'bool',
1578 '*snapshot-table': 'bool',
1579 '*inactive-l1': 'bool',
1580 '*inactive-l2': 'bool' } }
1583 # @Qcow2OverlapChecks
1585 # Specifies which metadata structures should be guarded against unintended
1588 # @flags: set of flags for separate specification of each metadata structure
1591 # @mode: named mode which chooses a specific set of flags
1595 { 'alternate': 'Qcow2OverlapChecks',
1596 'data': { 'flags': 'Qcow2OverlapCheckFlags',
1597 'mode': 'Qcow2OverlapCheckMode' } }
1600 # @BlockdevOptionsQcow2
1602 # Driver specific block device options for qcow2.
1604 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1605 # feature (default is taken from the image file)
1607 # @pass-discard-request: #optional whether discard requests to the qcow2
1608 # device should be forwarded to the data source
1610 # @pass-discard-snapshot: #optional whether discard requests for the data source
1611 # should be issued when a snapshot operation (e.g.
1612 # deleting a snapshot) frees clusters in the qcow2 file
1614 # @pass-discard-other: #optional whether discard requests for the data source
1615 # should be issued on other occasions where a cluster
1618 # @overlap-check: #optional which overlap checks to perform for writes
1619 # to the image, defaults to 'cached' (since 2.2)
1621 # @cache-size: #optional the maximum total size of the L2 table and
1622 # refcount block caches in bytes (since 2.2)
1624 # @l2-cache-size: #optional the maximum size of the L2 table cache in
1627 # @refcount-cache-size: #optional the maximum size of the refcount block cache
1628 # in bytes (since 2.2)
1630 # @cache-clean-interval: #optional clean unused entries in the L2 and refcount
1631 # caches. The interval is in seconds. The default value
1632 # is 0 and it disables this feature (since 2.5)
1636 { 'struct': 'BlockdevOptionsQcow2',
1637 'base': 'BlockdevOptionsGenericCOWFormat',
1638 'data': { '*lazy-refcounts': 'bool',
1639 '*pass-discard-request': 'bool',
1640 '*pass-discard-snapshot': 'bool',
1641 '*pass-discard-other': 'bool',
1642 '*overlap-check': 'Qcow2OverlapChecks',
1643 '*cache-size': 'int',
1644 '*l2-cache-size': 'int',
1645 '*refcount-cache-size': 'int',
1646 '*cache-clean-interval': 'int' } }
1650 # @BlockdevOptionsArchipelago
1652 # Driver specific block device options for Archipelago.
1654 # @volume: Name of the Archipelago volume image
1656 # @mport: #optional The port number on which mapperd is
1657 # listening. This is optional
1658 # and if not specified, QEMU will make Archipelago
1659 # use the default port (1001).
1661 # @vport: #optional The port number on which vlmcd is
1662 # listening. This is optional
1663 # and if not specified, QEMU will make Archipelago
1664 # use the default port (501).
1666 # @segment: #optional The name of the shared memory segment
1667 # Archipelago stack is using. This is optional
1668 # and if not specified, QEMU will make Archipelago
1669 # use the default value, 'archipelago'.
1672 { 'struct': 'BlockdevOptionsArchipelago',
1673 'data': { 'volume': 'str',
1676 '*segment': 'str' } }
1682 # Trigger events supported by blkdebug.
1684 { 'enum': 'BlkdebugEvent',
1685 'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table',
1686 'l1_grow.activate_table', 'l2_load', 'l2_update',
1687 'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write',
1688 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1689 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1690 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1691 'refblock_load', 'refblock_update', 'refblock_update_part',
1692 'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write',
1693 'refblock_alloc.write_blocks', 'refblock_alloc.write_table',
1694 'refblock_alloc.switch_table', 'cluster_alloc',
1695 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
1696 'flush_to_disk', 'pwritev_rmw.head', 'pwritev_rmw.after_head',
1697 'pwritev_rmw.tail', 'pwritev_rmw.after_tail', 'pwritev',
1698 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
1701 # @BlkdebugInjectErrorOptions
1703 # Describes a single error injection for blkdebug.
1705 # @event: trigger event
1707 # @state: #optional the state identifier blkdebug needs to be in to
1708 # actually trigger the event; defaults to "any"
1710 # @errno: #optional error identifier (errno) to be returned; defaults to
1713 # @sector: #optional specifies the sector index which has to be affected
1714 # in order to actually trigger the event; defaults to "any
1717 # @once: #optional disables further events after this one has been
1718 # triggered; defaults to false
1720 # @immediately: #optional fail immediately; defaults to false
1724 { 'struct': 'BlkdebugInjectErrorOptions',
1725 'data': { 'event': 'BlkdebugEvent',
1730 '*immediately': 'bool' } }
1733 # @BlkdebugSetStateOptions
1735 # Describes a single state-change event for blkdebug.
1737 # @event: trigger event
1739 # @state: #optional the current state identifier blkdebug needs to be in;
1742 # @new_state: the state identifier blkdebug is supposed to assume if
1743 # this event is triggered
1747 { 'struct': 'BlkdebugSetStateOptions',
1748 'data': { 'event': 'BlkdebugEvent',
1750 'new_state': 'int' } }
1753 # @BlockdevOptionsBlkdebug
1755 # Driver specific block device options for blkdebug.
1757 # @image: underlying raw block device (or image file)
1759 # @config: #optional filename of the configuration file
1761 # @align: #optional required alignment for requests in bytes
1763 # @inject-error: #optional array of error injection descriptions
1765 # @set-state: #optional array of state-change descriptions
1769 { 'struct': 'BlockdevOptionsBlkdebug',
1770 'data': { 'image': 'BlockdevRef',
1773 '*inject-error': ['BlkdebugInjectErrorOptions'],
1774 '*set-state': ['BlkdebugSetStateOptions'] } }
1777 # @BlockdevOptionsBlkverify
1779 # Driver specific block device options for blkverify.
1781 # @test: block device to be tested
1783 # @raw: raw image used for verification
1787 { 'struct': 'BlockdevOptionsBlkverify',
1788 'data': { 'test': 'BlockdevRef',
1789 'raw': 'BlockdevRef' } }
1792 # @QuorumReadPattern
1794 # An enumeration of quorum read patterns.
1796 # @quorum: read all the children and do a quorum vote on reads
1798 # @fifo: read only from the first child that has not failed
1802 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
1805 # @BlockdevOptionsQuorum
1807 # Driver specific block device options for Quorum
1809 # @blkverify: #optional true if the driver must print content mismatch
1810 # set to false by default
1812 # @children: the children block devices to use
1814 # @vote-threshold: the vote limit under which a read will fail
1816 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
1819 # @read-pattern: #optional choose read pattern and set to quorum by default
1824 { 'struct': 'BlockdevOptionsQuorum',
1825 'data': { '*blkverify': 'bool',
1826 'children': [ 'BlockdevRef' ],
1827 'vote-threshold': 'int',
1828 '*rewrite-corrupted': 'bool',
1829 '*read-pattern': 'QuorumReadPattern' } }
1834 # Options for creating a block device.
1838 { 'union': 'BlockdevOptions',
1839 'base': 'BlockdevOptionsBase',
1840 'discriminator': 'driver',
1842 'archipelago':'BlockdevOptionsArchipelago',
1843 'blkdebug': 'BlockdevOptionsBlkdebug',
1844 'blkverify': 'BlockdevOptionsBlkverify',
1845 'bochs': 'BlockdevOptionsGenericFormat',
1846 'cloop': 'BlockdevOptionsGenericFormat',
1847 'dmg': 'BlockdevOptionsGenericFormat',
1848 'file': 'BlockdevOptionsFile',
1849 'ftp': 'BlockdevOptionsFile',
1850 'ftps': 'BlockdevOptionsFile',
1851 # TODO gluster: Wait for structured options
1852 'host_cdrom': 'BlockdevOptionsFile',
1853 'host_device':'BlockdevOptionsFile',
1854 'http': 'BlockdevOptionsFile',
1855 'https': 'BlockdevOptionsFile',
1856 # TODO iscsi: Wait for structured options
1857 # TODO nbd: Should take InetSocketAddress for 'host'?
1858 # TODO nfs: Wait for structured options
1859 'null-aio': 'BlockdevOptionsNull',
1860 'null-co': 'BlockdevOptionsNull',
1861 'parallels': 'BlockdevOptionsGenericFormat',
1862 'qcow2': 'BlockdevOptionsQcow2',
1863 'qcow': 'BlockdevOptionsGenericCOWFormat',
1864 'qed': 'BlockdevOptionsGenericCOWFormat',
1865 'quorum': 'BlockdevOptionsQuorum',
1866 'raw': 'BlockdevOptionsGenericFormat',
1867 # TODO rbd: Wait for structured options
1868 # TODO sheepdog: Wait for structured options
1869 # TODO ssh: Should take InetSocketAddress for 'host'?
1870 'tftp': 'BlockdevOptionsFile',
1871 'vdi': 'BlockdevOptionsGenericFormat',
1872 'vhdx': 'BlockdevOptionsGenericFormat',
1873 'vmdk': 'BlockdevOptionsGenericCOWFormat',
1874 'vpc': 'BlockdevOptionsGenericFormat',
1875 'vvfat': 'BlockdevOptionsVVFAT'
1881 # Reference to a block device.
1883 # @definition: defines a new block device inline
1884 # @reference: references the ID of an existing block device. An
1885 # empty string means that no block device should be
1890 { 'alternate': 'BlockdevRef',
1891 'data': { 'definition': 'BlockdevOptions',
1892 'reference': 'str' } }
1897 # Creates a new block device. If the @id option is given at the top level, a
1898 # BlockBackend will be created; otherwise, @node-name is mandatory at the top
1899 # level and no BlockBackend will be created.
1901 # This command is still a work in progress. It doesn't support all
1902 # block drivers among other things. Stay away from it unless you want
1903 # to help with its development.
1905 # @options: block device options for the new device
1909 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }
1914 # Deletes a block device that has been added using blockdev-add.
1915 # The selected device can be either a block backend or a graph node.
1917 # In the former case the backend will be destroyed, along with its
1918 # inserted medium if there's any. The command will fail if the backend
1919 # or its medium are in use.
1921 # In the latter case the node will be destroyed. The command will fail
1922 # if the node is attached to a block backend or is otherwise being
1925 # One of @id or @node-name must be specified, but not both.
1927 # This command is still a work in progress and is considered
1928 # experimental. Stay away from it unless you want to help with its
1931 # @id: #optional Name of the block backend device to delete.
1933 # @node-name: #optional Name of the graph node to delete.
1937 { 'command': 'x-blockdev-del', 'data': { '*id': 'str', '*node-name': 'str' } }
1940 # @blockdev-open-tray:
1942 # Opens a block device's tray. If there is a block driver state tree inserted as
1943 # a medium, it will become inaccessible to the guest (but it will remain
1944 # associated to the block device, so closing the tray will make it accessible
1947 # If the tray was already open before, this will be a no-op.
1949 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
1950 # which no such event will be generated, these include:
1951 # - if the guest has locked the tray, @force is false and the guest does not
1952 # respond to the eject request
1953 # - if the BlockBackend denoted by @device does not have a guest device attached
1955 # - if the guest device does not have an actual tray and is empty, for instance
1956 # for floppy disk drives
1958 # @device: block device name
1960 # @force: #optional if false (the default), an eject request will be sent to
1961 # the guest if it has locked the tray (and the tray will not be opened
1962 # immediately); if true, the tray will be opened regardless of whether
1967 { 'command': 'blockdev-open-tray',
1968 'data': { 'device': 'str',
1969 '*force': 'bool' } }
1972 # @blockdev-close-tray:
1974 # Closes a block device's tray. If there is a block driver state tree associated
1975 # with the block device (which is currently ejected), that tree will be loaded
1978 # If the tray was already closed before, this will be a no-op.
1980 # @device: block device name
1984 { 'command': 'blockdev-close-tray',
1985 'data': { 'device': 'str' } }
1988 # @blockdev-remove-medium:
1990 # Removes a medium (a block driver state tree) from a block device. That block
1991 # device's tray must currently be open (unless there is no attached guest
1994 # If the tray is open and there is no medium inserted, this will be a no-op.
1996 # @device: block device name
2000 { 'command': 'blockdev-remove-medium',
2001 'data': { 'device': 'str' } }
2004 # @blockdev-insert-medium:
2006 # Inserts a medium (a block driver state tree) into a block device. That block
2007 # device's tray must currently be open (unless there is no attached guest
2008 # device) and there must be no medium inserted already.
2010 # @device: block device name
2012 # @node-name: name of a node in the block driver state graph
2016 { 'command': 'blockdev-insert-medium',
2017 'data': { 'device': 'str',
2018 'node-name': 'str'} }
2022 # @BlockdevChangeReadOnlyMode:
2024 # Specifies the new read-only mode of a block device subject to the
2025 # @blockdev-change-medium command.
2027 # @retain: Retains the current read-only mode
2029 # @read-only: Makes the device read-only
2031 # @read-write: Makes the device writable
2035 { 'enum': 'BlockdevChangeReadOnlyMode',
2036 'data': ['retain', 'read-only', 'read-write'] }
2040 # @blockdev-change-medium:
2042 # Changes the medium inserted into a block device by ejecting the current medium
2043 # and loading a new image file which is inserted as the new medium (this command
2044 # combines blockdev-open-tray, blockdev-remove-medium, blockdev-insert-medium
2045 # and blockdev-close-tray).
2047 # @device: block device name
2049 # @filename: filename of the new image to be loaded
2051 # @format: #optional, format to open the new image with (defaults to
2052 # the probed format)
2054 # @read-only-mode: #optional, change the read-only mode of the device; defaults
2059 { 'command': 'blockdev-change-medium',
2060 'data': { 'device': 'str',
2063 '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
2069 # An enumeration of action that has been taken when a DISK I/O occurs
2071 # @ignore: error has been ignored
2073 # @report: error has been reported to the device
2075 # @stop: error caused VM to be stopped
2079 { 'enum': 'BlockErrorAction',
2080 'data': [ 'ignore', 'report', 'stop' ] }
2084 # @BLOCK_IMAGE_CORRUPTED
2086 # Emitted when a corruption has been detected in a disk image
2088 # @device: device name. This is always present for compatibility
2089 # reasons, but it can be empty ("") if the image does not
2090 # have a device name associated.
2092 # @node-name: #optional node name (Since: 2.4)
2094 # @msg: informative message for human consumption, such as the kind of
2095 # corruption being detected. It should not be parsed by machine as it is
2096 # not guaranteed to be stable
2098 # @offset: #optional, if the corruption resulted from an image access, this is
2099 # the host's access offset into the image
2101 # @size: #optional, if the corruption resulted from an image access, this is
2104 # fatal: if set, the image is marked corrupt and therefore unusable after this
2105 # event and must be repaired (Since 2.2; before, every
2106 # BLOCK_IMAGE_CORRUPTED event was fatal)
2110 { 'event': 'BLOCK_IMAGE_CORRUPTED',
2111 'data': { 'device' : 'str',
2112 '*node-name' : 'str',
2116 'fatal' : 'bool' } }
2121 # Emitted when a disk I/O error occurs
2123 # @device: device name
2125 # @operation: I/O operation
2127 # @action: action that has been taken
2129 # @nospace: #optional true if I/O error was caused due to a no-space
2130 # condition. This key is only present if query-block's
2131 # io-status is present, please see query-block documentation
2132 # for more information (since: 2.2)
2134 # @reason: human readable string describing the error cause.
2135 # (This field is a debugging aid for humans, it should not
2136 # be parsed by applications) (since: 2.2)
2138 # Note: If action is "stop", a STOP event will eventually follow the
2139 # BLOCK_IO_ERROR event
2143 { 'event': 'BLOCK_IO_ERROR',
2144 'data': { 'device': 'str', 'operation': 'IoOperationType',
2145 'action': 'BlockErrorAction', '*nospace': 'bool',
2149 # @BLOCK_JOB_COMPLETED
2151 # Emitted when a block job has completed
2155 # @device: device name
2157 # @len: maximum progress value
2159 # @offset: current progress value. On success this is equal to len.
2160 # On failure this is less than len
2162 # @speed: rate limit, bytes per second
2164 # @error: #optional, error message. Only present on failure. This field
2165 # contains a human-readable error message. There are no semantics
2166 # other than that streaming has failed and clients should not try to
2167 # interpret the error string
2171 { 'event': 'BLOCK_JOB_COMPLETED',
2172 'data': { 'type' : 'BlockJobType',
2180 # @BLOCK_JOB_CANCELLED
2182 # Emitted when a block job has been cancelled
2186 # @device: device name
2188 # @len: maximum progress value
2190 # @offset: current progress value. On success this is equal to len.
2191 # On failure this is less than len
2193 # @speed: rate limit, bytes per second
2197 { 'event': 'BLOCK_JOB_CANCELLED',
2198 'data': { 'type' : 'BlockJobType',
2207 # Emitted when a block job encounters an error
2209 # @device: device name
2211 # @operation: I/O operation
2213 # @action: action that has been taken
2217 { 'event': 'BLOCK_JOB_ERROR',
2218 'data': { 'device' : 'str',
2219 'operation': 'IoOperationType',
2220 'action' : 'BlockErrorAction' } }
2225 # Emitted when a block job is ready to complete
2229 # @device: device name
2231 # @len: maximum progress value
2233 # @offset: current progress value. On success this is equal to len.
2234 # On failure this is less than len
2236 # @speed: rate limit, bytes per second
2238 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
2243 { 'event': 'BLOCK_JOB_READY',
2244 'data': { 'type' : 'BlockJobType',
2252 # Preallocation mode of QEMU image file
2254 # @off: no preallocation
2255 # @metadata: preallocate only for metadata
2256 # @falloc: like @full preallocation but allocate disk space by
2257 # posix_fallocate() rather than writing zeros.
2258 # @full: preallocate all data by writing zeros to device to ensure disk
2259 # space is really available. @full preallocation also sets up
2260 # metadata correctly.
2264 { 'enum': 'PreallocMode',
2265 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
2268 # @BLOCK_WRITE_THRESHOLD
2270 # Emitted when writes on block device reaches or exceeds the
2271 # configured write threshold. For thin-provisioned devices, this
2272 # means the device should be extended to avoid pausing for
2274 # The event is one shot. Once triggered, it needs to be
2275 # re-registered with another block-set-threshold command.
2277 # @node-name: graph node name on which the threshold was exceeded.
2279 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
2281 # @write-threshold: last configured threshold, in bytes.
2285 { 'event': 'BLOCK_WRITE_THRESHOLD',
2286 'data': { 'node-name': 'str',
2287 'amount-exceeded': 'uint64',
2288 'write-threshold': 'uint64' } }
2291 # @block-set-write-threshold
2293 # Change the write threshold for a block drive. An event will be delivered
2294 # if a write to this block drive crosses the configured threshold.
2295 # This is useful to transparently resize thin-provisioned drives without
2296 # the guest OS noticing.
2298 # @node-name: graph node name on which the threshold must be set.
2300 # @write-threshold: configured threshold for the block device, bytes.
2301 # Use 0 to disable the threshold.
2305 { 'command': 'block-set-write-threshold',
2306 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }