5 # == Block core (VM unrelated)
8 { 'include': 'common.json' }
9 { 'include': 'crypto.json' }
10 { 'include': 'job.json' }
11 { 'include': 'sockets.json' }
16 # @id: unique snapshot id
18 # @name: user chosen name
20 # @vm-state-size: size of the VM state
22 # @date-sec: UTC date of the snapshot in seconds
24 # @date-nsec: fractional part in nano seconds to be used with date-sec
26 # @vm-clock-sec: VM clock relative to boot in seconds
28 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
33 { 'struct': 'SnapshotInfo',
34 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
35 'date-sec': 'int', 'date-nsec': 'int',
36 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
39 # @ImageInfoSpecificQCow2EncryptionBase:
41 # @format: The encryption format
45 { 'struct': 'ImageInfoSpecificQCow2EncryptionBase',
46 'data': { 'format': 'BlockdevQcow2EncryptionFormat'}}
49 # @ImageInfoSpecificQCow2Encryption:
53 { 'union': 'ImageInfoSpecificQCow2Encryption',
54 'base': 'ImageInfoSpecificQCow2EncryptionBase',
55 'discriminator': 'format',
56 'data': { 'luks': 'QCryptoBlockInfoLUKS' } }
59 # @ImageInfoSpecificQCow2:
61 # @compat: compatibility level
63 # @data-file: the filename of the external data file that is stored in the
64 # image and used as a default for opening the image (since: 4.0)
66 # @data-file-raw: True if the external data file must stay valid as a
67 # standalone (read-only) raw image without looking at qcow2
68 # metadata (since: 4.0)
70 # @extended-l2: true if the image has extended L2 entries; only valid for
71 # compat >= 1.1 (since 5.2)
73 # @lazy-refcounts: on or off; only valid for compat >= 1.1
75 # @corrupt: true if the image has been marked corrupt; only valid for
76 # compat >= 1.1 (since 2.2)
78 # @refcount-bits: width of a refcount entry in bits (since 2.3)
80 # @encrypt: details about encryption parameters; only set if image
81 # is encrypted (since 2.10)
83 # @bitmaps: A list of qcow2 bitmap details (since 4.0)
85 # @compression-type: the image cluster compression method (since 5.1)
89 { 'struct': 'ImageInfoSpecificQCow2',
93 '*data-file-raw': 'bool',
94 '*extended-l2': 'bool',
95 '*lazy-refcounts': 'bool',
97 'refcount-bits': 'int',
98 '*encrypt': 'ImageInfoSpecificQCow2Encryption',
99 '*bitmaps': ['Qcow2BitmapInfo'],
100 'compression-type': 'Qcow2CompressionType'
104 # @ImageInfoSpecificVmdk:
106 # @create-type: The create type of VMDK image
108 # @cid: Content id of image
110 # @parent-cid: Parent VMDK image's cid
112 # @extents: List of extent files
116 { 'struct': 'ImageInfoSpecificVmdk',
118 'create-type': 'str',
121 'extents': ['ImageInfo']
125 # @ImageInfoSpecific:
127 # A discriminated record of image format specific information structures.
131 { 'union': 'ImageInfoSpecific',
133 'qcow2': 'ImageInfoSpecificQCow2',
134 'vmdk': 'ImageInfoSpecificVmdk',
135 # If we need to add block driver specific parameters for
136 # LUKS in future, then we'll subclass QCryptoBlockInfoLUKS
137 # to define a ImageInfoSpecificLUKS
138 'luks': 'QCryptoBlockInfoLUKS'
144 # Information about a QEMU image file
146 # @filename: name of the image file
148 # @format: format of the image file
150 # @virtual-size: maximum capacity in bytes of the image
152 # @actual-size: actual size on disk in bytes of the image
154 # @dirty-flag: true if image is not cleanly closed
156 # @cluster-size: size of a cluster in bytes
158 # @encrypted: true if the image is encrypted
160 # @compressed: true if the image is compressed (Since 1.7)
162 # @backing-filename: name of the backing file
164 # @full-backing-filename: full path of the backing file
166 # @backing-filename-format: the format of the backing file
168 # @snapshots: list of VM snapshots
170 # @backing-image: info of the backing image (since 1.6)
172 # @format-specific: structure supplying additional format-specific
173 # information (since 1.7)
178 { 'struct': 'ImageInfo',
179 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
180 '*actual-size': 'int', 'virtual-size': 'int',
181 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
182 '*backing-filename': 'str', '*full-backing-filename': 'str',
183 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
184 '*backing-image': 'ImageInfo',
185 '*format-specific': 'ImageInfoSpecific' } }
190 # Information about a QEMU image file check
192 # @filename: name of the image file checked
194 # @format: format of the image file checked
196 # @check-errors: number of unexpected errors occurred during check
198 # @image-end-offset: offset (in bytes) where the image ends, this
199 # field is present if the driver for the image format
202 # @corruptions: number of corruptions found during the check if any
204 # @leaks: number of leaks found during the check if any
206 # @corruptions-fixed: number of corruptions fixed during the check
209 # @leaks-fixed: number of leaks fixed during the check if any
211 # @total-clusters: total number of clusters, this field is present
212 # if the driver for the image format supports it
214 # @allocated-clusters: total number of allocated clusters, this
215 # field is present if the driver for the image format
218 # @fragmented-clusters: total number of fragmented clusters, this
219 # field is present if the driver for the image format
222 # @compressed-clusters: total number of compressed clusters, this
223 # field is present if the driver for the image format
229 { 'struct': 'ImageCheck',
230 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
231 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
232 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
233 '*total-clusters': 'int', '*allocated-clusters': 'int',
234 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
239 # Mapping information from a virtual block range to a host file range
241 # @start: the start byte of the mapped virtual range
243 # @length: the number of bytes of the mapped virtual range
245 # @data: whether the mapped range has data
247 # @zero: whether the virtual blocks are zeroed
249 # @depth: the depth of the mapping
251 # @offset: the offset in file that the virtual sectors are mapped to
253 # @filename: filename that is referred to by @offset
258 { 'struct': 'MapEntry',
259 'data': {'start': 'int', 'length': 'int', 'data': 'bool',
260 'zero': 'bool', 'depth': 'int', '*offset': 'int',
261 '*filename': 'str' } }
264 # @BlockdevCacheInfo:
266 # Cache mode information for a block device
268 # @writeback: true if writeback mode is enabled
269 # @direct: true if the host page cache is bypassed (O_DIRECT)
270 # @no-flush: true if flush requests are ignored for the device
274 { 'struct': 'BlockdevCacheInfo',
275 'data': { 'writeback': 'bool',
277 'no-flush': 'bool' } }
282 # Information about the backing device for a block device.
284 # @file: the filename of the backing device
286 # @node-name: the name of the block driver node (Since 2.0)
288 # @ro: true if the backing device was open read-only
290 # @drv: the name of the block format used to open the backing device. As of
291 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
292 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
293 # 'http', 'https', 'luks', 'nbd', 'parallels', 'qcow',
294 # 'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat'
295 # 2.2: 'archipelago' added, 'cow' dropped
296 # 2.3: 'host_floppy' deprecated
297 # 2.5: 'host_floppy' dropped
299 # 2.8: 'replication' added, 'tftp' dropped
300 # 2.9: 'archipelago' dropped
302 # @backing_file: the name of the backing file (for copy-on-write)
304 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
306 # @encrypted: true if the backing device is encrypted
308 # @encryption_key_missing: always false
310 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
312 # @bps: total throughput limit in bytes per second is specified
314 # @bps_rd: read throughput limit in bytes per second is specified
316 # @bps_wr: write throughput limit in bytes per second is specified
318 # @iops: total I/O operations per second is specified
320 # @iops_rd: read I/O operations per second is specified
322 # @iops_wr: write I/O operations per second is specified
324 # @image: the info of image used (since: 1.6)
326 # @bps_max: total throughput limit during bursts,
327 # in bytes (Since 1.7)
329 # @bps_rd_max: read throughput limit during bursts,
330 # in bytes (Since 1.7)
332 # @bps_wr_max: write throughput limit during bursts,
333 # in bytes (Since 1.7)
335 # @iops_max: total I/O operations per second during bursts,
336 # in bytes (Since 1.7)
338 # @iops_rd_max: read I/O operations per second during bursts,
339 # in bytes (Since 1.7)
341 # @iops_wr_max: write I/O operations per second during bursts,
342 # in bytes (Since 1.7)
344 # @bps_max_length: maximum length of the @bps_max burst
345 # period, in seconds. (Since 2.6)
347 # @bps_rd_max_length: maximum length of the @bps_rd_max
348 # burst period, in seconds. (Since 2.6)
350 # @bps_wr_max_length: maximum length of the @bps_wr_max
351 # burst period, in seconds. (Since 2.6)
353 # @iops_max_length: maximum length of the @iops burst
354 # period, in seconds. (Since 2.6)
356 # @iops_rd_max_length: maximum length of the @iops_rd_max
357 # burst period, in seconds. (Since 2.6)
359 # @iops_wr_max_length: maximum length of the @iops_wr_max
360 # burst period, in seconds. (Since 2.6)
362 # @iops_size: an I/O size in bytes (Since 1.7)
364 # @group: throttle group name (Since 2.4)
366 # @cache: the cache mode used for the block device (since: 2.3)
368 # @write_threshold: configured write threshold for the device.
369 # 0 if disabled. (Since 2.3)
371 # @dirty-bitmaps: dirty bitmaps information (only present if node
372 # has one or more dirty bitmaps) (Since 4.2)
375 # @deprecated: Member @encryption_key_missing is deprecated. It is
381 { 'struct': 'BlockDeviceInfo',
382 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
383 '*backing_file': 'str', 'backing_file_depth': 'int',
385 'encryption_key_missing': { 'type': 'bool',
386 'features': [ 'deprecated' ] },
387 'detect_zeroes': 'BlockdevDetectZeroesOptions',
388 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
389 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
390 'image': 'ImageInfo',
391 '*bps_max': 'int', '*bps_rd_max': 'int',
392 '*bps_wr_max': 'int', '*iops_max': 'int',
393 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
394 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
395 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
396 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
397 '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
398 'write_threshold': 'int', '*dirty-bitmaps': ['BlockDirtyInfo'] } }
401 # @BlockDeviceIoStatus:
403 # An enumeration of block device I/O status.
405 # @ok: The last I/O operation has succeeded
407 # @failed: The last I/O operation has failed
409 # @nospace: The last I/O operation has failed due to a no-space condition
413 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
416 # @BlockDeviceMapEntry:
418 # Entry in the metadata map of the device (returned by "qemu-img map")
420 # @start: Offset in the image of the first byte described by this entry
423 # @length: Length of the range described by this entry (in bytes)
425 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
426 # before reaching one for which the range is allocated. The value is
427 # in the range 0 to the depth of the image chain - 1.
429 # @zero: the sectors in this range read as zeros
431 # @data: reading the image will actually read data from a file (in particular,
432 # if @offset is present this means that the sectors are not simply
433 # preallocated, but contain actual data in raw format)
435 # @offset: if present, the image file stores the data for this range in
436 # raw format at the given offset.
440 { 'struct': 'BlockDeviceMapEntry',
441 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
442 'data': 'bool', '*offset': 'int' } }
445 # @DirtyBitmapStatus:
447 # An enumeration of possible states that a dirty bitmap can report to the user.
449 # @frozen: The bitmap is currently in-use by some operation and is immutable.
450 # If the bitmap was @active prior to the operation, new writes by the
451 # guest are being recorded in a temporary buffer, and will not be lost.
452 # Generally, bitmaps are cleared on successful use in an operation and
453 # the temporary buffer is committed into the bitmap. On failure, the
454 # temporary buffer is merged back into the bitmap without first
456 # Please refer to the documentation for each bitmap-using operation,
457 # See also @blockdev-backup, @drive-backup.
459 # @disabled: The bitmap is not currently recording new writes by the guest.
460 # This is requested explicitly via @block-dirty-bitmap-disable.
461 # It can still be cleared, deleted, or used for backup operations.
463 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
464 # deleted, or used for backup operations.
466 # @locked: The bitmap is currently in-use by some operation and is immutable.
467 # If the bitmap was @active prior to the operation, it is still
468 # recording new writes. If the bitmap was @disabled, it is not
469 # recording new writes. (Since 2.12)
471 # @inconsistent: This is a persistent dirty bitmap that was marked in-use on
472 # disk, and is unusable by QEMU. It can only be deleted.
473 # Please rely on the inconsistent field in @BlockDirtyInfo
474 # instead, as the status field is deprecated. (Since 4.0)
478 { 'enum': 'DirtyBitmapStatus',
479 'data': ['active', 'disabled', 'frozen', 'locked', 'inconsistent'] }
484 # Block dirty bitmap information.
486 # @name: the name of the dirty bitmap (Since 2.4)
488 # @count: number of dirty bytes according to the dirty bitmap
490 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
492 # @status: current status of the dirty bitmap (since 2.4)
494 # @recording: true if the bitmap is recording new writes from the guest.
495 # Replaces `active` and `disabled` statuses. (since 4.0)
497 # @busy: true if the bitmap is in-use by some operation (NBD or jobs)
498 # and cannot be modified via QMP or used by another operation.
499 # Replaces `locked` and `frozen` statuses. (since 4.0)
501 # @persistent: true if the bitmap was stored on disk, is scheduled to be stored
502 # on disk, or both. (since 4.0)
504 # @inconsistent: true if this is a persistent bitmap that was improperly
505 # stored. Implies @persistent to be true; @recording and
506 # @busy to be false. This bitmap cannot be used. To remove
507 # it, use @block-dirty-bitmap-remove. (Since 4.0)
510 # @deprecated: Member @status is deprecated. Use @recording and
515 { 'struct': 'BlockDirtyInfo',
516 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
517 'recording': 'bool', 'busy': 'bool',
518 'status': { 'type': 'DirtyBitmapStatus',
519 'features': [ 'deprecated' ] },
520 'persistent': 'bool', '*inconsistent': 'bool' } }
523 # @Qcow2BitmapInfoFlags:
525 # An enumeration of flags that a bitmap can report to the user.
527 # @in-use: This flag is set by any process actively modifying the qcow2 file,
528 # and cleared when the updated bitmap is flushed to the qcow2 image.
529 # The presence of this flag in an offline image means that the bitmap
530 # was not saved correctly after its last usage, and may contain
533 # @auto: The bitmap must reflect all changes of the virtual disk by any
534 # application that would write to this qcow2 file.
538 { 'enum': 'Qcow2BitmapInfoFlags',
539 'data': ['in-use', 'auto'] }
544 # Qcow2 bitmap information.
546 # @name: the name of the bitmap
548 # @granularity: granularity of the bitmap in bytes
550 # @flags: flags of the bitmap
554 { 'struct': 'Qcow2BitmapInfo',
555 'data': {'name': 'str', 'granularity': 'uint32',
556 'flags': ['Qcow2BitmapInfoFlags'] } }
559 # @BlockLatencyHistogramInfo:
561 # Block latency histogram.
563 # @boundaries: list of interval boundary values in nanoseconds, all greater
564 # than zero and in ascending order.
565 # For example, the list [10, 50, 100] produces the following
566 # histogram intervals: [0, 10), [10, 50), [50, 100), [100, +inf).
568 # @bins: list of io request counts corresponding to histogram intervals.
569 # len(@bins) = len(@boundaries) + 1
570 # For the example above, @bins may be something like [3, 1, 5, 2],
571 # and corresponding histogram looks like:
578 # | +------------------
583 { 'struct': 'BlockLatencyHistogramInfo',
584 'data': {'boundaries': ['uint64'], 'bins': ['uint64'] } }
589 # Block device information. This structure describes a virtual device and
590 # the backing device associated with it.
592 # @device: The device name associated with the virtual device.
594 # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
595 # device. (since 2.10)
597 # @type: This field is returned only for compatibility reasons, it should
598 # not be used (always returns 'unknown')
600 # @removable: True if the device supports removable media.
602 # @locked: True if the guest has locked this device from having its media
605 # @tray_open: True if the device's tray is open
606 # (only present if it has a tray)
608 # @dirty-bitmaps: dirty bitmaps information (only present if the
609 # driver has one or more dirty bitmaps) (Since 2.0)
611 # @io-status: @BlockDeviceIoStatus. Only present if the device
612 # supports it and the VM is configured to stop on errors
613 # (supported device models: virtio-blk, IDE, SCSI except
616 # @inserted: @BlockDeviceInfo describing the device if media is
620 # @deprecated: Member @dirty-bitmaps is deprecated. Use @inserted
621 # member @dirty-bitmaps instead.
625 { 'struct': 'BlockInfo',
626 'data': {'device': 'str', '*qdev': 'str', 'type': 'str', 'removable': 'bool',
627 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
628 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
629 '*dirty-bitmaps': { 'type': ['BlockDirtyInfo'],
630 'features': [ 'deprecated' ] } } }
635 # Image file size calculation information. This structure describes the size
636 # requirements for creating a new image file.
638 # The size requirements depend on the new image file format. File size always
639 # equals virtual disk size for the 'raw' format, even for sparse POSIX files.
640 # Compact formats such as 'qcow2' represent unallocated and zero regions
641 # efficiently so file size may be smaller than virtual disk size.
643 # The values are upper bounds that are guaranteed to fit the new image file.
644 # Subsequent modification, such as internal snapshot or further bitmap
645 # creation, may require additional space and is not covered here.
647 # @required: Size required for a new image file, in bytes, when copying just
648 # allocated guest-visible contents.
650 # @fully-allocated: Image file size, in bytes, once data has been written
651 # to all sectors, when copying just guest-visible contents.
653 # @bitmaps: Additional size required if all the top-level bitmap metadata
654 # in the source image were to be copied to the destination,
655 # present only when source and destination both support
656 # persistent bitmaps. (since 5.1)
660 { 'struct': 'BlockMeasureInfo',
661 'data': {'required': 'int', 'fully-allocated': 'int', '*bitmaps': 'int'} }
666 # Get a list of BlockInfo for all virtual block devices.
668 # Returns: a list of @BlockInfo describing each virtual block device. Filter
669 # nodes that were created implicitly are skipped over.
675 # -> { "execute": "query-block" }
680 # "device":"ide0-hd0",
687 # "file":"disks/test.qcow2",
688 # "backing_file_depth":1,
695 # "bps_max": 8000000,
702 # "detect_zeroes": "on",
703 # "write_threshold": 0,
705 # "filename":"disks/test.qcow2",
707 # "virtual-size":2048000,
708 # "backing_file":"base.qcow2",
709 # "full-backing-filename":"disks/base.qcow2",
710 # "backing-filename-format":"qcow2",
714 # "name": "snapshot1",
715 # "vm-state-size": 0,
716 # "date-sec": 10000200,
718 # "vm-clock-sec": 206,
719 # "vm-clock-nsec": 30
723 # "filename":"disks/base.qcow2",
725 # "virtual-size":2048000
729 # "qdev": "ide_disk",
734 # "device":"ide1-cd0",
737 # "qdev": "/machine/unattached/device[23]",
738 # "tray_open": false,
742 # "device":"floppy0",
745 # "qdev": "/machine/unattached/device[20]",
758 { 'command': 'query-block', 'returns': ['BlockInfo'] }
762 # @BlockDeviceTimedStats:
764 # Statistics of a block device during a given interval of time.
766 # @interval_length: Interval used for calculating the statistics,
769 # @min_rd_latency_ns: Minimum latency of read operations in the
770 # defined interval, in nanoseconds.
772 # @min_wr_latency_ns: Minimum latency of write operations in the
773 # defined interval, in nanoseconds.
775 # @min_flush_latency_ns: Minimum latency of flush operations in the
776 # defined interval, in nanoseconds.
778 # @max_rd_latency_ns: Maximum latency of read operations in the
779 # defined interval, in nanoseconds.
781 # @max_wr_latency_ns: Maximum latency of write operations in the
782 # defined interval, in nanoseconds.
784 # @max_flush_latency_ns: Maximum latency of flush operations in the
785 # defined interval, in nanoseconds.
787 # @avg_rd_latency_ns: Average latency of read operations in the
788 # defined interval, in nanoseconds.
790 # @avg_wr_latency_ns: Average latency of write operations in the
791 # defined interval, in nanoseconds.
793 # @avg_flush_latency_ns: Average latency of flush operations in the
794 # defined interval, in nanoseconds.
796 # @avg_rd_queue_depth: Average number of pending read operations
797 # in the defined interval.
799 # @avg_wr_queue_depth: Average number of pending write operations
800 # in the defined interval.
804 { 'struct': 'BlockDeviceTimedStats',
805 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
806 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
807 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
808 'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
809 'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
810 'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
815 # Statistics of a virtual block device or a block backing device.
817 # @rd_bytes: The number of bytes read by the device.
819 # @wr_bytes: The number of bytes written by the device.
821 # @unmap_bytes: The number of bytes unmapped by the device (Since 4.2)
823 # @rd_operations: The number of read operations performed by the device.
825 # @wr_operations: The number of write operations performed by the device.
827 # @flush_operations: The number of cache flush operations performed by the
828 # device (since 0.15.0)
830 # @unmap_operations: The number of unmap operations performed by the device
833 # @rd_total_time_ns: Total time spent on reads in nanoseconds (since 0.15.0).
835 # @wr_total_time_ns: Total time spent on writes in nanoseconds (since 0.15.0).
837 # @flush_total_time_ns: Total time spent on cache flushes in nanoseconds
840 # @unmap_total_time_ns: Total time spent on unmap operations in nanoseconds
843 # @wr_highest_offset: The offset after the greatest byte written to the
844 # device. The intended use of this information is for
845 # growable sparse files (like qcow2) that are used on top
846 # of a physical device.
848 # @rd_merged: Number of read requests that have been merged into another
849 # request (Since 2.3).
851 # @wr_merged: Number of write requests that have been merged into another
852 # request (Since 2.3).
854 # @unmap_merged: Number of unmap requests that have been merged into another
855 # request (Since 4.2)
857 # @idle_time_ns: Time since the last I/O operation, in
858 # nanoseconds. If the field is absent it means that
859 # there haven't been any operations yet (Since 2.5).
861 # @failed_rd_operations: The number of failed read operations
862 # performed by the device (Since 2.5)
864 # @failed_wr_operations: The number of failed write operations
865 # performed by the device (Since 2.5)
867 # @failed_flush_operations: The number of failed flush operations
868 # performed by the device (Since 2.5)
870 # @failed_unmap_operations: The number of failed unmap operations performed
871 # by the device (Since 4.2)
873 # @invalid_rd_operations: The number of invalid read operations
874 # performed by the device (Since 2.5)
876 # @invalid_wr_operations: The number of invalid write operations
877 # performed by the device (Since 2.5)
879 # @invalid_flush_operations: The number of invalid flush operations
880 # performed by the device (Since 2.5)
882 # @invalid_unmap_operations: The number of invalid unmap operations performed
883 # by the device (Since 4.2)
885 # @account_invalid: Whether invalid operations are included in the
886 # last access statistics (Since 2.5)
888 # @account_failed: Whether failed operations are included in the
889 # latency and last access statistics (Since 2.5)
891 # @timed_stats: Statistics specific to the set of previously defined
892 # intervals of time (Since 2.5)
894 # @rd_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
896 # @wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
898 # @flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
902 { 'struct': 'BlockDeviceStats',
903 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'unmap_bytes' : 'int',
904 'rd_operations': 'int', 'wr_operations': 'int',
905 'flush_operations': 'int', 'unmap_operations': 'int',
906 'rd_total_time_ns': 'int', 'wr_total_time_ns': 'int',
907 'flush_total_time_ns': 'int', 'unmap_total_time_ns': 'int',
908 'wr_highest_offset': 'int',
909 'rd_merged': 'int', 'wr_merged': 'int', 'unmap_merged': 'int',
910 '*idle_time_ns': 'int',
911 'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
912 'failed_flush_operations': 'int', 'failed_unmap_operations': 'int',
913 'invalid_rd_operations': 'int', 'invalid_wr_operations': 'int',
914 'invalid_flush_operations': 'int', 'invalid_unmap_operations': 'int',
915 'account_invalid': 'bool', 'account_failed': 'bool',
916 'timed_stats': ['BlockDeviceTimedStats'],
917 '*rd_latency_histogram': 'BlockLatencyHistogramInfo',
918 '*wr_latency_histogram': 'BlockLatencyHistogramInfo',
919 '*flush_latency_histogram': 'BlockLatencyHistogramInfo' } }
922 # @BlockStatsSpecificFile:
924 # File driver statistics
926 # @discard-nb-ok: The number of successful discard operations performed by
929 # @discard-nb-failed: The number of failed discard operations performed by
932 # @discard-bytes-ok: The number of bytes discarded by the driver.
936 { 'struct': 'BlockStatsSpecificFile',
938 'discard-nb-ok': 'uint64',
939 'discard-nb-failed': 'uint64',
940 'discard-bytes-ok': 'uint64' } }
943 # @BlockStatsSpecific:
945 # Block driver specific statistics
949 { 'union': 'BlockStatsSpecific',
950 'base': { 'driver': 'BlockdevDriver' },
951 'discriminator': 'driver',
953 'file': 'BlockStatsSpecificFile',
954 'host_device': 'BlockStatsSpecificFile' } }
959 # Statistics of a virtual block device or a block backing device.
961 # @device: If the stats are for a virtual block device, the name
962 # corresponding to the virtual block device.
964 # @node-name: The node name of the device. (Since 2.3)
966 # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
967 # device. (since 3.0)
969 # @stats: A @BlockDeviceStats for the device.
971 # @driver-specific: Optional driver-specific stats. (Since 4.2)
973 # @parent: This describes the file block device if it has one.
974 # Contains recursively the statistics of the underlying
975 # protocol (e.g. the host file for a qcow2 image). If there is
976 # no underlying protocol, this field is omitted
978 # @backing: This describes the backing block device if it has one.
983 { 'struct': 'BlockStats',
984 'data': {'*device': 'str', '*qdev': 'str', '*node-name': 'str',
985 'stats': 'BlockDeviceStats',
986 '*driver-specific': 'BlockStatsSpecific',
987 '*parent': 'BlockStats',
988 '*backing': 'BlockStats'} }
993 # Query the @BlockStats for all virtual block devices.
995 # @query-nodes: If true, the command will query all the block nodes
996 # that have a node name, in a list which will include "parent"
997 # information, but not "backing".
998 # If false or omitted, the behavior is as before - query all the
999 # device backends, recursively including their "parent" and
1000 # "backing". Filter nodes that were created implicitly are
1001 # skipped over in this mode. (Since 2.3)
1003 # Returns: A list of @BlockStats for each virtual block devices.
1009 # -> { "execute": "query-blockstats" }
1013 # "device":"ide0-hd0",
1016 # "wr_highest_offset":3686448128,
1017 # "wr_bytes":9786368,
1018 # "wr_operations":751,
1019 # "rd_bytes":122567168,
1020 # "rd_operations":36772
1021 # "wr_total_times_ns":313253456
1022 # "rd_total_times_ns":3465673657
1023 # "flush_total_times_ns":49653
1024 # "flush_operations":61,
1027 # "idle_time_ns":2953431879,
1028 # "account_invalid":true,
1029 # "account_failed":false
1033 # "wr_highest_offset":2821110784,
1034 # "wr_bytes":9786368,
1035 # "wr_operations":692,
1036 # "rd_bytes":122739200,
1037 # "rd_operations":36604
1038 # "flush_operations":51,
1039 # "wr_total_times_ns":313253456
1040 # "rd_total_times_ns":3465673657
1041 # "flush_total_times_ns":49653,
1044 # "idle_time_ns":2953431879,
1045 # "account_invalid":true,
1046 # "account_failed":false
1048 # "qdev": "/machine/unattached/device[23]"
1051 # "device":"ide1-cd0",
1053 # "wr_highest_offset":0,
1055 # "wr_operations":0,
1058 # "flush_operations":0,
1059 # "wr_total_times_ns":0
1060 # "rd_total_times_ns":0
1061 # "flush_total_times_ns":0,
1064 # "account_invalid":false,
1065 # "account_failed":false
1067 # "qdev": "/machine/unattached/device[24]"
1070 # "device":"floppy0",
1072 # "wr_highest_offset":0,
1074 # "wr_operations":0,
1077 # "flush_operations":0,
1078 # "wr_total_times_ns":0
1079 # "rd_total_times_ns":0
1080 # "flush_total_times_ns":0,
1083 # "account_invalid":false,
1084 # "account_failed":false
1086 # "qdev": "/machine/unattached/device[16]"
1091 # "wr_highest_offset":0,
1093 # "wr_operations":0,
1096 # "flush_operations":0,
1097 # "wr_total_times_ns":0
1098 # "rd_total_times_ns":0
1099 # "flush_total_times_ns":0,
1102 # "account_invalid":false,
1103 # "account_failed":false
1110 { 'command': 'query-blockstats',
1111 'data': { '*query-nodes': 'bool' },
1112 'returns': ['BlockStats'] }
1117 # An enumeration of possible behaviors for errors on I/O operations.
1118 # The exact meaning depends on whether the I/O was initiated by a guest
1121 # @report: for guest operations, report the error to the guest;
1122 # for jobs, cancel the job
1124 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
1125 # or BLOCK_JOB_ERROR). The backup, mirror and commit block jobs retry
1126 # the failing request later and may still complete successfully. The
1127 # stream block job continues to stream and will complete with an
1130 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
1132 # @stop: for guest operations, stop the virtual machine;
1133 # for jobs, pause the job
1135 # @auto: inherit the error handling policy of the backend (since: 2.7)
1139 { 'enum': 'BlockdevOnError',
1140 'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] }
1145 # An enumeration of possible behaviors for the initial synchronization
1146 # phase of storage mirroring.
1148 # @top: copies data in the topmost image to the destination
1150 # @full: copies data from all images to the destination
1152 # @none: only copy data written from now on
1154 # @incremental: only copy data described by the dirty bitmap. (since: 2.4)
1156 # @bitmap: only copy data described by the dirty bitmap. (since: 4.2)
1157 # Behavior on completion is determined by the BitmapSyncMode.
1161 { 'enum': 'MirrorSyncMode',
1162 'data': ['top', 'full', 'none', 'incremental', 'bitmap'] }
1167 # An enumeration of possible behaviors for the synchronization of a bitmap
1168 # when used for data copy operations.
1170 # @on-success: The bitmap is only synced when the operation is successful.
1171 # This is the behavior always used for 'INCREMENTAL' backups.
1173 # @never: The bitmap is never synchronized with the operation, and is
1174 # treated solely as a read-only manifest of blocks to copy.
1176 # @always: The bitmap is always synchronized with the operation,
1177 # regardless of whether or not the operation was successful.
1181 { 'enum': 'BitmapSyncMode',
1182 'data': ['on-success', 'never', 'always'] }
1187 # An enumeration whose values tell the mirror block job when to
1188 # trigger writes to the target.
1190 # @background: copy data in background only.
1192 # @write-blocking: when data is written to the source, write it
1193 # (synchronously) to the target as well. In
1194 # addition, data is copied in background just like in
1199 { 'enum': 'MirrorCopyMode',
1200 'data': ['background', 'write-blocking'] }
1205 # Information about a long-running block device operation.
1207 # @type: the job type ('stream' for image streaming)
1209 # @device: The job identifier. Originally the device name but other
1210 # values are allowed since QEMU 2.7
1212 # @len: Estimated @offset value at the completion of the job. This value can
1213 # arbitrarily change while the job is running, in both directions.
1215 # @offset: Progress made until now. The unit is arbitrary and the value can
1216 # only meaningfully be used for the ratio of @offset to @len. The
1217 # value is monotonically increasing.
1219 # @busy: false if the job is known to be in a quiescent state, with
1220 # no pending I/O. Since 1.3.
1222 # @paused: whether the job is paused or, if @busy is true, will
1223 # pause itself as soon as possible. Since 1.3.
1225 # @speed: the rate limit, bytes per second
1227 # @io-status: the status of the job (since 1.3)
1229 # @ready: true if the job may be completed (since 2.2)
1231 # @status: Current job state/status (since 2.12)
1233 # @auto-finalize: Job will finalize itself when PENDING, moving to
1234 # the CONCLUDED state. (since 2.12)
1236 # @auto-dismiss: Job will dismiss itself when CONCLUDED, moving to the NULL
1237 # state and disappearing from the query list. (since 2.12)
1239 # @error: Error information if the job did not complete successfully.
1240 # Not set if the job completed successfully. (since 2.12.1)
1244 { 'struct': 'BlockJobInfo',
1245 'data': {'type': 'str', 'device': 'str', 'len': 'int',
1246 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
1247 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool',
1248 'status': 'JobStatus',
1249 'auto-finalize': 'bool', 'auto-dismiss': 'bool',
1253 # @query-block-jobs:
1255 # Return information about long-running block device operations.
1257 # Returns: a list of @BlockJobInfo for each active block job
1261 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
1266 # This command sets the password of a block device that has not been open
1267 # with a password and requires one.
1269 # This command is now obsolete and will always return an error since 2.10
1272 { 'command': 'block_passwd',
1273 'data': { '*device': 'str',
1274 '*node-name': 'str',
1275 'password': 'str' } }
1280 # Resize a block image while a guest is running.
1282 # Either @device or @node-name must be set but not both.
1284 # @device: the name of the device to get the image resized
1286 # @node-name: graph node name to get the image resized (Since 2.0)
1288 # @size: new image size in bytes
1290 # Returns: - nothing on success
1291 # - If @device is not a valid block device, DeviceNotFound
1297 # -> { "execute": "block_resize",
1298 # "arguments": { "device": "scratch", "size": 1073741824 } }
1299 # <- { "return": {} }
1302 { 'command': 'block_resize',
1303 'data': { '*device': 'str',
1304 '*node-name': 'str',
1310 # An enumeration that tells QEMU how to set the backing file path in
1313 # @existing: QEMU should look for an existing image file.
1315 # @absolute-paths: QEMU should create a new image with absolute paths
1316 # for the backing file. If there is no backing file available, the new
1317 # image will not be backed either.
1321 { 'enum': 'NewImageMode',
1322 'data': [ 'existing', 'absolute-paths' ] }
1325 # @BlockdevSnapshotSync:
1327 # Either @device or @node-name must be set but not both.
1329 # @device: the name of the device to take a snapshot of.
1331 # @node-name: graph node name to generate the snapshot from (Since 2.0)
1333 # @snapshot-file: the target of the new overlay image. If the file
1334 # exists, or if it is a device, the overlay will be created in the
1335 # existing file/device. Otherwise, a new file will be created.
1337 # @snapshot-node-name: the graph node name of the new image (Since 2.0)
1339 # @format: the format of the overlay image, default is 'qcow2'.
1341 # @mode: whether and how QEMU should create a new image, default is
1344 { 'struct': 'BlockdevSnapshotSync',
1345 'data': { '*device': 'str', '*node-name': 'str',
1346 'snapshot-file': 'str', '*snapshot-node-name': 'str',
1347 '*format': 'str', '*mode': 'NewImageMode' } }
1350 # @BlockdevSnapshot:
1352 # @node: device or node name that will have a snapshot taken.
1354 # @overlay: reference to the existing block device that will become
1355 # the overlay of @node, as part of taking the snapshot.
1356 # It must not have a current backing file (this can be
1357 # achieved by passing "backing": null to blockdev-add).
1361 { 'struct': 'BlockdevSnapshot',
1362 'data': { 'node': 'str', 'overlay': 'str' } }
1367 # @job-id: identifier for the newly-created block job. If
1368 # omitted, the device name will be used. (Since 2.7)
1370 # @device: the device name or node-name of a root node which should be copied.
1372 # @sync: what parts of the disk image should be copied to the destination
1373 # (all the disk, only the sectors allocated in the topmost image, from a
1374 # dirty bitmap, or only new I/O).
1376 # @speed: the maximum speed, in bytes per second. The default is 0,
1379 # @bitmap: The name of a dirty bitmap to use.
1380 # Must be present if sync is "bitmap" or "incremental".
1381 # Can be present if sync is "full" or "top".
1382 # Must not be present otherwise.
1383 # (Since 2.4 (drive-backup), 3.1 (blockdev-backup))
1385 # @bitmap-mode: Specifies the type of data the bitmap should contain after
1386 # the operation concludes.
1387 # Must be present if a bitmap was provided,
1388 # Must NOT be present otherwise. (Since 4.2)
1390 # @compress: true to compress data, if the target format supports it.
1391 # (default: false) (since 2.8)
1393 # @on-source-error: the action to take on an error on the source,
1394 # default 'report'. 'stop' and 'enospc' can only be used
1395 # if the block device supports io-status (see BlockInfo).
1397 # @on-target-error: the action to take on an error on the target,
1398 # default 'report' (no limitations, since this applies to
1399 # a different block device than @device).
1401 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1402 # finished its work, waiting for @block-job-finalize before
1403 # making any block graph changes.
1404 # When true, this job will automatically
1405 # perform its abort or commit actions.
1406 # Defaults to true. (Since 2.12)
1408 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1409 # has completely ceased all work, and awaits @block-job-dismiss.
1410 # When true, this job will automatically disappear from the query
1411 # list without user intervention.
1412 # Defaults to true. (Since 2.12)
1414 # @filter-node-name: the node name that should be assigned to the
1415 # filter driver that the backup job inserts into the graph
1416 # above node specified by @drive. If this option is not given,
1417 # a node name is autogenerated. (Since: 4.2)
1419 # Note: @on-source-error and @on-target-error only affect background
1420 # I/O. If an error occurs during a guest write request, the device's
1421 # rerror/werror actions will be used.
1425 { 'struct': 'BackupCommon',
1426 'data': { '*job-id': 'str', 'device': 'str',
1427 'sync': 'MirrorSyncMode', '*speed': 'int',
1428 '*bitmap': 'str', '*bitmap-mode': 'BitmapSyncMode',
1429 '*compress': 'bool',
1430 '*on-source-error': 'BlockdevOnError',
1431 '*on-target-error': 'BlockdevOnError',
1432 '*auto-finalize': 'bool', '*auto-dismiss': 'bool',
1433 '*filter-node-name': 'str' } }
1438 # @target: the target of the new image. If the file exists, or if it
1439 # is a device, the existing file/device will be used as the new
1440 # destination. If it does not exist, a new file will be created.
1442 # @format: the format of the new destination, default is to
1443 # probe if @mode is 'existing', else the format of the source
1445 # @mode: whether and how QEMU should create a new image, default is
1450 { 'struct': 'DriveBackup',
1451 'base': 'BackupCommon',
1452 'data': { 'target': 'str',
1454 '*mode': 'NewImageMode' } }
1459 # @target: the device name or node-name of the backup target node.
1463 { 'struct': 'BlockdevBackup',
1464 'base': 'BackupCommon',
1465 'data': { 'target': 'str' } }
1468 # @blockdev-snapshot-sync:
1470 # Takes a synchronous snapshot of a block device.
1472 # For the arguments, see the documentation of BlockdevSnapshotSync.
1474 # Returns: - nothing on success
1475 # - If @device is not a valid block device, DeviceNotFound
1481 # -> { "execute": "blockdev-snapshot-sync",
1482 # "arguments": { "device": "ide-hd0",
1484 # "/some/place/my-image",
1485 # "format": "qcow2" } }
1486 # <- { "return": {} }
1489 { 'command': 'blockdev-snapshot-sync',
1490 'data': 'BlockdevSnapshotSync' }
1494 # @blockdev-snapshot:
1496 # Takes a snapshot of a block device.
1498 # Take a snapshot, by installing 'node' as the backing image of
1499 # 'overlay'. Additionally, if 'node' is associated with a block
1500 # device, the block device changes to using 'overlay' as its new active
1503 # For the arguments, see the documentation of BlockdevSnapshot.
1506 # @allow-write-only-overlay: If present, the check whether this operation is safe
1507 # was relaxed so that it can be used to change
1508 # backing file of a destination of a blockdev-mirror.
1515 # -> { "execute": "blockdev-add",
1516 # "arguments": { "driver": "qcow2",
1517 # "node-name": "node1534",
1518 # "file": { "driver": "file",
1519 # "filename": "hd1.qcow2" },
1520 # "backing": null } }
1522 # <- { "return": {} }
1524 # -> { "execute": "blockdev-snapshot",
1525 # "arguments": { "node": "ide-hd0",
1526 # "overlay": "node1534" } }
1527 # <- { "return": {} }
1530 { 'command': 'blockdev-snapshot',
1531 'data': 'BlockdevSnapshot',
1532 'features': [ 'allow-write-only-overlay' ] }
1535 # @change-backing-file:
1537 # Change the backing file in the image file metadata. This does not
1538 # cause QEMU to reopen the image file to reparse the backing filename
1539 # (it may, however, perform a reopen to change permissions from
1540 # r/o -> r/w -> r/o, if needed). The new backing file string is written
1541 # into the image file metadata, and the QEMU internal strings are
1544 # @image-node-name: The name of the block driver state node of the
1545 # image to modify. The "device" argument is used
1546 # to verify "image-node-name" is in the chain
1547 # described by "device".
1549 # @device: The device name or node-name of the root node that owns
1552 # @backing-file: The string to write as the backing file. This
1553 # string is not validated, so care should be taken
1554 # when specifying the string or the image chain may
1555 # not be able to be reopened again.
1557 # Returns: - Nothing on success
1558 # - If "device" does not exist or cannot be determined, DeviceNotFound
1562 { 'command': 'change-backing-file',
1563 'data': { 'device': 'str', 'image-node-name': 'str',
1564 'backing-file': 'str' } }
1569 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1570 # writes data between 'top' and 'base' into 'base'.
1572 # @job-id: identifier for the newly-created block job. If
1573 # omitted, the device name will be used. (Since 2.7)
1575 # @device: the device name or node-name of a root node
1577 # @base-node: The node name of the backing image to write data into.
1578 # If not specified, this is the deepest backing image.
1581 # @base: Same as @base-node, except that it is a file name rather than a node
1582 # name. This must be the exact filename string that was used to open the
1583 # node; other strings, even if addressing the same file, are not
1586 # @top-node: The node name of the backing image within the image chain
1587 # which contains the topmost data to be committed down. If
1588 # not specified, this is the active layer. (since: 3.1)
1590 # @top: Same as @top-node, except that it is a file name rather than a node
1591 # name. This must be the exact filename string that was used to open the
1592 # node; other strings, even if addressing the same file, are not
1595 # @backing-file: The backing file string to write into the overlay
1596 # image of 'top'. If 'top' is the active layer,
1597 # specifying a backing file string is an error. This
1598 # filename is not validated.
1600 # If a pathname string is such that it cannot be
1601 # resolved by QEMU, that means that subsequent QMP or
1602 # HMP commands must use node-names for the image in
1603 # question, as filename lookup methods will fail.
1605 # If not specified, QEMU will automatically determine
1606 # the backing file string to use, or error out if
1607 # there is no obvious choice. Care should be taken
1608 # when specifying the string, to specify a valid
1609 # filename or protocol.
1612 # If top == base, that is an error.
1613 # If top == active, the job will not be completed by itself,
1614 # user needs to complete the job with the block-job-complete
1615 # command after getting the ready event. (Since 2.0)
1617 # If the base image is smaller than top, then the base image
1618 # will be resized to be the same size as top. If top is
1619 # smaller than the base image, the base will not be
1620 # truncated. If you want the base image size to match the
1621 # size of the smaller top, you can safely truncate it
1622 # yourself once the commit operation successfully completes.
1624 # @speed: the maximum speed, in bytes per second
1626 # @on-error: the action to take on an error. 'ignore' means that the request
1627 # should be retried. (default: report; Since: 5.0)
1629 # @filter-node-name: the node name that should be assigned to the
1630 # filter driver that the commit job inserts into the graph
1631 # above @top. If this option is not given, a node name is
1632 # autogenerated. (Since: 2.9)
1634 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1635 # finished its work, waiting for @block-job-finalize before
1636 # making any block graph changes.
1637 # When true, this job will automatically
1638 # perform its abort or commit actions.
1639 # Defaults to true. (Since 3.1)
1641 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1642 # has completely ceased all work, and awaits @block-job-dismiss.
1643 # When true, this job will automatically disappear from the query
1644 # list without user intervention.
1645 # Defaults to true. (Since 3.1)
1648 # @deprecated: Members @base and @top are deprecated. Use @base-node
1649 # and @top-node instead.
1651 # Returns: - Nothing on success
1652 # - If @device does not exist, DeviceNotFound
1653 # - Any other error returns a GenericError.
1659 # -> { "execute": "block-commit",
1660 # "arguments": { "device": "virtio0",
1661 # "top": "/tmp/snap1.qcow2" } }
1662 # <- { "return": {} }
1665 { 'command': 'block-commit',
1666 'data': { '*job-id': 'str', 'device': 'str', '*base-node': 'str',
1667 '*base': { 'type': 'str', 'features': [ 'deprecated' ] },
1669 '*top': { 'type': 'str', 'features': [ 'deprecated' ] },
1670 '*backing-file': 'str', '*speed': 'int',
1671 '*on-error': 'BlockdevOnError',
1672 '*filter-node-name': 'str',
1673 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
1678 # Start a point-in-time copy of a block device to a new destination. The
1679 # status of ongoing drive-backup operations can be checked with
1680 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1681 # The operation can be stopped before it has completed using the
1682 # block-job-cancel command.
1684 # Returns: - nothing on success
1685 # - If @device is not a valid block device, GenericError
1691 # -> { "execute": "drive-backup",
1692 # "arguments": { "device": "drive0",
1694 # "target": "backup.img" } }
1695 # <- { "return": {} }
1698 { 'command': 'drive-backup', 'boxed': true,
1699 'data': 'DriveBackup' }
1704 # Start a point-in-time copy of a block device to a new destination. The
1705 # status of ongoing blockdev-backup operations can be checked with
1706 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1707 # The operation can be stopped before it has completed using the
1708 # block-job-cancel command.
1710 # Returns: - nothing on success
1711 # - If @device is not a valid block device, DeviceNotFound
1716 # -> { "execute": "blockdev-backup",
1717 # "arguments": { "device": "src-id",
1719 # "target": "tgt-id" } }
1720 # <- { "return": {} }
1723 { 'command': 'blockdev-backup', 'boxed': true,
1724 'data': 'BlockdevBackup' }
1728 # @query-named-block-nodes:
1730 # Get the named block driver list
1732 # @flat: Omit the nested data about backing image ("backing-image" key) if true.
1733 # Default is false (Since 5.0)
1735 # Returns: the list of BlockDeviceInfo
1741 # -> { "execute": "query-named-block-nodes" }
1742 # <- { "return": [ { "ro":false,
1744 # "encrypted":false,
1745 # "file":"disks/test.qcow2",
1746 # "node-name": "my-node",
1747 # "backing_file_depth":1,
1754 # "bps_max": 8000000,
1761 # "write_threshold": 0,
1763 # "filename":"disks/test.qcow2",
1765 # "virtual-size":2048000,
1766 # "backing_file":"base.qcow2",
1767 # "full-backing-filename":"disks/base.qcow2",
1768 # "backing-filename-format":"qcow2",
1772 # "name": "snapshot1",
1773 # "vm-state-size": 0,
1774 # "date-sec": 10000200,
1776 # "vm-clock-sec": 206,
1777 # "vm-clock-nsec": 30
1781 # "filename":"disks/base.qcow2",
1783 # "virtual-size":2048000
1788 { 'command': 'query-named-block-nodes',
1789 'returns': [ 'BlockDeviceInfo' ],
1790 'data': { '*flat': 'bool' } }
1793 # @XDbgBlockGraphNodeType:
1795 # @block-backend: corresponds to BlockBackend
1797 # @block-job: corresonds to BlockJob
1799 # @block-driver: corresponds to BlockDriverState
1803 { 'enum': 'XDbgBlockGraphNodeType',
1804 'data': [ 'block-backend', 'block-job', 'block-driver' ] }
1807 # @XDbgBlockGraphNode:
1809 # @id: Block graph node identifier. This @id is generated only for
1810 # x-debug-query-block-graph and does not relate to any other identifiers in
1813 # @type: Type of graph node. Can be one of block-backend, block-job or
1814 # block-driver-state.
1816 # @name: Human readable name of the node. Corresponds to node-name for
1817 # block-driver-state nodes; is not guaranteed to be unique in the whole
1818 # graph (with block-jobs and block-backends).
1822 { 'struct': 'XDbgBlockGraphNode',
1823 'data': { 'id': 'uint64', 'type': 'XDbgBlockGraphNodeType', 'name': 'str' } }
1828 # Enum of base block permissions.
1830 # @consistent-read: A user that has the "permission" of consistent reads is
1831 # guaranteed that their view of the contents of the block
1832 # device is complete and self-consistent, representing the
1833 # contents of a disk at a specific point.
1834 # For most block devices (including their backing files) this
1835 # is true, but the property cannot be maintained in a few
1836 # situations like for intermediate nodes of a commit block
1839 # @write: This permission is required to change the visible disk contents.
1841 # @write-unchanged: This permission (which is weaker than BLK_PERM_WRITE) is
1842 # both enough and required for writes to the block node when
1843 # the caller promises that the visible disk content doesn't
1845 # As the BLK_PERM_WRITE permission is strictly stronger,
1846 # either is sufficient to perform an unchanging write.
1848 # @resize: This permission is required to change the size of a block node.
1850 # @graph-mod: This permission is required to change the node that this
1851 # BdrvChild points to.
1855 { 'enum': 'BlockPermission',
1856 'data': [ 'consistent-read', 'write', 'write-unchanged', 'resize',
1859 # @XDbgBlockGraphEdge:
1861 # Block Graph edge description for x-debug-query-block-graph.
1863 # @parent: parent id
1867 # @name: name of the relation (examples are 'file' and 'backing')
1869 # @perm: granted permissions for the parent operating on the child
1871 # @shared-perm: permissions that can still be granted to other users of the
1872 # child while it is still attached to this parent
1876 { 'struct': 'XDbgBlockGraphEdge',
1877 'data': { 'parent': 'uint64', 'child': 'uint64',
1878 'name': 'str', 'perm': [ 'BlockPermission' ],
1879 'shared-perm': [ 'BlockPermission' ] } }
1884 # Block Graph - list of nodes and list of edges.
1888 { 'struct': 'XDbgBlockGraph',
1889 'data': { 'nodes': ['XDbgBlockGraphNode'], 'edges': ['XDbgBlockGraphEdge'] } }
1892 # @x-debug-query-block-graph:
1894 # Get the block graph.
1898 { 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph' }
1903 # Start mirroring a block device's writes to a new destination. target
1904 # specifies the target of the new image. If the file exists, or if it
1905 # is a device, it will be used as the new destination for writes. If
1906 # it does not exist, a new file will be created. format specifies the
1907 # format of the mirror image, default is to probe if mode='existing',
1908 # else the format of the source.
1910 # Returns: - nothing on success
1911 # - If @device is not a valid block device, GenericError
1917 # -> { "execute": "drive-mirror",
1918 # "arguments": { "device": "ide-hd0",
1919 # "target": "/some/place/my-image",
1921 # "format": "qcow2" } }
1922 # <- { "return": {} }
1925 { 'command': 'drive-mirror', 'boxed': true,
1926 'data': 'DriveMirror' }
1931 # A set of parameters describing drive mirror setup.
1933 # @job-id: identifier for the newly-created block job. If
1934 # omitted, the device name will be used. (Since 2.7)
1936 # @device: the device name or node-name of a root node whose writes should be
1939 # @target: the target of the new image. If the file exists, or if it
1940 # is a device, the existing file/device will be used as the new
1941 # destination. If it does not exist, a new file will be created.
1943 # @format: the format of the new destination, default is to
1944 # probe if @mode is 'existing', else the format of the source
1946 # @node-name: the new block driver state node name in the graph
1949 # @replaces: with sync=full graph node name to be replaced by the new
1950 # image when a whole image copy is done. This can be used to repair
1951 # broken Quorum files. (Since 2.1)
1953 # @mode: whether and how QEMU should create a new image, default is
1956 # @speed: the maximum speed, in bytes per second
1958 # @sync: what parts of the disk image should be copied to the destination
1959 # (all the disk, only the sectors allocated in the topmost image, or
1962 # @granularity: granularity of the dirty bitmap, default is 64K
1963 # if the image format doesn't have clusters, 4K if the clusters
1964 # are smaller than that, else the cluster size. Must be a
1965 # power of 2 between 512 and 64M (since 1.4).
1967 # @buf-size: maximum amount of data in flight from source to
1968 # target (since 1.4).
1970 # @on-source-error: the action to take on an error on the source,
1971 # default 'report'. 'stop' and 'enospc' can only be used
1972 # if the block device supports io-status (see BlockInfo).
1974 # @on-target-error: the action to take on an error on the target,
1975 # default 'report' (no limitations, since this applies to
1976 # a different block device than @device).
1977 # @unmap: Whether to try to unmap target sectors where source has
1978 # only zero. If true, and target unallocated sectors will read as zero,
1979 # target image sectors will be unmapped; otherwise, zeroes will be
1980 # written. Both will result in identical contents.
1981 # Default is true. (Since 2.4)
1983 # @copy-mode: when to copy data to the destination; defaults to 'background'
1986 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1987 # finished its work, waiting for @block-job-finalize before
1988 # making any block graph changes.
1989 # When true, this job will automatically
1990 # perform its abort or commit actions.
1991 # Defaults to true. (Since 3.1)
1993 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1994 # has completely ceased all work, and awaits @block-job-dismiss.
1995 # When true, this job will automatically disappear from the query
1996 # list without user intervention.
1997 # Defaults to true. (Since 3.1)
2000 { 'struct': 'DriveMirror',
2001 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2002 '*format': 'str', '*node-name': 'str', '*replaces': 'str',
2003 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
2004 '*speed': 'int', '*granularity': 'uint32',
2005 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2006 '*on-target-error': 'BlockdevOnError',
2007 '*unmap': 'bool', '*copy-mode': 'MirrorCopyMode',
2008 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2011 # @BlockDirtyBitmap:
2013 # @node: name of device/node which the bitmap is tracking
2015 # @name: name of the dirty bitmap
2019 { 'struct': 'BlockDirtyBitmap',
2020 'data': { 'node': 'str', 'name': 'str' } }
2023 # @BlockDirtyBitmapAdd:
2025 # @node: name of device/node which the bitmap is tracking
2027 # @name: name of the dirty bitmap (must be less than 1024 bytes)
2029 # @granularity: the bitmap granularity, default is 64k for
2030 # block-dirty-bitmap-add
2032 # @persistent: the bitmap is persistent, i.e. it will be saved to the
2033 # corresponding block device image file on its close. For now only
2034 # Qcow2 disks support persistent bitmaps. Default is false for
2035 # block-dirty-bitmap-add. (Since: 2.10)
2037 # @disabled: the bitmap is created in the disabled state, which means that
2038 # it will not track drive changes. The bitmap may be enabled with
2039 # block-dirty-bitmap-enable. Default is false. (Since: 4.0)
2043 { 'struct': 'BlockDirtyBitmapAdd',
2044 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32',
2045 '*persistent': 'bool', '*disabled': 'bool' } }
2048 # @BlockDirtyBitmapMergeSource:
2050 # @local: name of the bitmap, attached to the same node as target bitmap.
2052 # @external: bitmap with specified node
2056 { 'alternate': 'BlockDirtyBitmapMergeSource',
2057 'data': { 'local': 'str',
2058 'external': 'BlockDirtyBitmap' } }
2061 # @BlockDirtyBitmapMerge:
2063 # @node: name of device/node which the @target bitmap is tracking
2065 # @target: name of the destination dirty bitmap
2067 # @bitmaps: name(s) of the source dirty bitmap(s) at @node and/or fully
2068 # specifed BlockDirtyBitmap elements. The latter are supported
2073 { 'struct': 'BlockDirtyBitmapMerge',
2074 'data': { 'node': 'str', 'target': 'str',
2075 'bitmaps': ['BlockDirtyBitmapMergeSource'] } }
2078 # @block-dirty-bitmap-add:
2080 # Create a dirty bitmap with a name on the node, and start tracking the writes.
2082 # Returns: - nothing on success
2083 # - If @node is not a valid block device or node, DeviceNotFound
2084 # - If @name is already taken, GenericError with an explanation
2090 # -> { "execute": "block-dirty-bitmap-add",
2091 # "arguments": { "node": "drive0", "name": "bitmap0" } }
2092 # <- { "return": {} }
2095 { 'command': 'block-dirty-bitmap-add',
2096 'data': 'BlockDirtyBitmapAdd' }
2099 # @block-dirty-bitmap-remove:
2101 # Stop write tracking and remove the dirty bitmap that was created
2102 # with block-dirty-bitmap-add. If the bitmap is persistent, remove it from its
2105 # Returns: - nothing on success
2106 # - If @node is not a valid block device or node, DeviceNotFound
2107 # - If @name is not found, GenericError with an explanation
2108 # - if @name is frozen by an operation, GenericError
2114 # -> { "execute": "block-dirty-bitmap-remove",
2115 # "arguments": { "node": "drive0", "name": "bitmap0" } }
2116 # <- { "return": {} }
2119 { 'command': 'block-dirty-bitmap-remove',
2120 'data': 'BlockDirtyBitmap' }
2123 # @block-dirty-bitmap-clear:
2125 # Clear (reset) a dirty bitmap on the device, so that an incremental
2126 # backup from this point in time forward will only backup clusters
2127 # modified after this clear operation.
2129 # Returns: - nothing on success
2130 # - If @node is not a valid block device, DeviceNotFound
2131 # - If @name is not found, GenericError with an explanation
2137 # -> { "execute": "block-dirty-bitmap-clear",
2138 # "arguments": { "node": "drive0", "name": "bitmap0" } }
2139 # <- { "return": {} }
2142 { 'command': 'block-dirty-bitmap-clear',
2143 'data': 'BlockDirtyBitmap' }
2146 # @block-dirty-bitmap-enable:
2148 # Enables a dirty bitmap so that it will begin tracking disk changes.
2150 # Returns: - nothing on success
2151 # - If @node is not a valid block device, DeviceNotFound
2152 # - If @name is not found, GenericError with an explanation
2158 # -> { "execute": "block-dirty-bitmap-enable",
2159 # "arguments": { "node": "drive0", "name": "bitmap0" } }
2160 # <- { "return": {} }
2163 { 'command': 'block-dirty-bitmap-enable',
2164 'data': 'BlockDirtyBitmap' }
2167 # @block-dirty-bitmap-disable:
2169 # Disables a dirty bitmap so that it will stop tracking disk changes.
2171 # Returns: - nothing on success
2172 # - If @node is not a valid block device, DeviceNotFound
2173 # - If @name is not found, GenericError with an explanation
2179 # -> { "execute": "block-dirty-bitmap-disable",
2180 # "arguments": { "node": "drive0", "name": "bitmap0" } }
2181 # <- { "return": {} }
2184 { 'command': 'block-dirty-bitmap-disable',
2185 'data': 'BlockDirtyBitmap' }
2188 # @block-dirty-bitmap-merge:
2190 # Merge dirty bitmaps listed in @bitmaps to the @target dirty bitmap.
2191 # Dirty bitmaps in @bitmaps will be unchanged, except if it also appears
2192 # as the @target bitmap. Any bits already set in @target will still be
2193 # set after the merge, i.e., this operation does not clear the target.
2194 # On error, @target is unchanged.
2196 # The resulting bitmap will count as dirty any clusters that were dirty in any
2197 # of the source bitmaps. This can be used to achieve backup checkpoints, or in
2198 # simpler usages, to copy bitmaps.
2200 # Returns: - nothing on success
2201 # - If @node is not a valid block device, DeviceNotFound
2202 # - If any bitmap in @bitmaps or @target is not found, GenericError
2203 # - If any of the bitmaps have different sizes or granularities,
2210 # -> { "execute": "block-dirty-bitmap-merge",
2211 # "arguments": { "node": "drive0", "target": "bitmap0",
2212 # "bitmaps": ["bitmap1"] } }
2213 # <- { "return": {} }
2216 { 'command': 'block-dirty-bitmap-merge',
2217 'data': 'BlockDirtyBitmapMerge' }
2220 # @BlockDirtyBitmapSha256:
2222 # SHA256 hash of dirty bitmap data
2224 # @sha256: ASCII representation of SHA256 bitmap hash
2228 { 'struct': 'BlockDirtyBitmapSha256',
2229 'data': {'sha256': 'str'} }
2232 # @x-debug-block-dirty-bitmap-sha256:
2234 # Get bitmap SHA256.
2236 # Returns: - BlockDirtyBitmapSha256 on success
2237 # - If @node is not a valid block device, DeviceNotFound
2238 # - If @name is not found or if hashing has failed, GenericError with an
2243 { 'command': 'x-debug-block-dirty-bitmap-sha256',
2244 'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256' }
2249 # Start mirroring a block device's writes to a new destination.
2251 # @job-id: identifier for the newly-created block job. If
2252 # omitted, the device name will be used. (Since 2.7)
2254 # @device: The device name or node-name of a root node whose writes should be
2257 # @target: the id or node-name of the block device to mirror to. This mustn't be
2258 # attached to guest.
2260 # @replaces: with sync=full graph node name to be replaced by the new
2261 # image when a whole image copy is done. This can be used to repair
2262 # broken Quorum files.
2264 # @speed: the maximum speed, in bytes per second
2266 # @sync: what parts of the disk image should be copied to the destination
2267 # (all the disk, only the sectors allocated in the topmost image, or
2270 # @granularity: granularity of the dirty bitmap, default is 64K
2271 # if the image format doesn't have clusters, 4K if the clusters
2272 # are smaller than that, else the cluster size. Must be a
2273 # power of 2 between 512 and 64M
2275 # @buf-size: maximum amount of data in flight from source to
2278 # @on-source-error: the action to take on an error on the source,
2279 # default 'report'. 'stop' and 'enospc' can only be used
2280 # if the block device supports io-status (see BlockInfo).
2282 # @on-target-error: the action to take on an error on the target,
2283 # default 'report' (no limitations, since this applies to
2284 # a different block device than @device).
2286 # @filter-node-name: the node name that should be assigned to the
2287 # filter driver that the mirror job inserts into the graph
2288 # above @device. If this option is not given, a node name is
2289 # autogenerated. (Since: 2.9)
2291 # @copy-mode: when to copy data to the destination; defaults to 'background'
2294 # @auto-finalize: When false, this job will wait in a PENDING state after it has
2295 # finished its work, waiting for @block-job-finalize before
2296 # making any block graph changes.
2297 # When true, this job will automatically
2298 # perform its abort or commit actions.
2299 # Defaults to true. (Since 3.1)
2301 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
2302 # has completely ceased all work, and awaits @block-job-dismiss.
2303 # When true, this job will automatically disappear from the query
2304 # list without user intervention.
2305 # Defaults to true. (Since 3.1)
2306 # Returns: nothing on success.
2312 # -> { "execute": "blockdev-mirror",
2313 # "arguments": { "device": "ide-hd0",
2314 # "target": "target0",
2315 # "sync": "full" } }
2316 # <- { "return": {} }
2319 { 'command': 'blockdev-mirror',
2320 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2322 'sync': 'MirrorSyncMode',
2323 '*speed': 'int', '*granularity': 'uint32',
2324 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2325 '*on-target-error': 'BlockdevOnError',
2326 '*filter-node-name': 'str',
2327 '*copy-mode': 'MirrorCopyMode',
2328 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2333 # A set of parameters describing block throttling.
2335 # @device: Block device name
2337 # @id: The name or QOM path of the guest device (since: 2.8)
2339 # @bps: total throughput limit in bytes per second
2341 # @bps_rd: read throughput limit in bytes per second
2343 # @bps_wr: write throughput limit in bytes per second
2345 # @iops: total I/O operations per second
2347 # @iops_rd: read I/O operations per second
2349 # @iops_wr: write I/O operations per second
2351 # @bps_max: total throughput limit during bursts,
2352 # in bytes (Since 1.7)
2354 # @bps_rd_max: read throughput limit during bursts,
2355 # in bytes (Since 1.7)
2357 # @bps_wr_max: write throughput limit during bursts,
2358 # in bytes (Since 1.7)
2360 # @iops_max: total I/O operations per second during bursts,
2361 # in bytes (Since 1.7)
2363 # @iops_rd_max: read I/O operations per second during bursts,
2364 # in bytes (Since 1.7)
2366 # @iops_wr_max: write I/O operations per second during bursts,
2367 # in bytes (Since 1.7)
2369 # @bps_max_length: maximum length of the @bps_max burst
2370 # period, in seconds. It must only
2371 # be set if @bps_max is set as well.
2372 # Defaults to 1. (Since 2.6)
2374 # @bps_rd_max_length: maximum length of the @bps_rd_max
2375 # burst period, in seconds. It must only
2376 # be set if @bps_rd_max is set as well.
2377 # Defaults to 1. (Since 2.6)
2379 # @bps_wr_max_length: maximum length of the @bps_wr_max
2380 # burst period, in seconds. It must only
2381 # be set if @bps_wr_max is set as well.
2382 # Defaults to 1. (Since 2.6)
2384 # @iops_max_length: maximum length of the @iops burst
2385 # period, in seconds. It must only
2386 # be set if @iops_max is set as well.
2387 # Defaults to 1. (Since 2.6)
2389 # @iops_rd_max_length: maximum length of the @iops_rd_max
2390 # burst period, in seconds. It must only
2391 # be set if @iops_rd_max is set as well.
2392 # Defaults to 1. (Since 2.6)
2394 # @iops_wr_max_length: maximum length of the @iops_wr_max
2395 # burst period, in seconds. It must only
2396 # be set if @iops_wr_max is set as well.
2397 # Defaults to 1. (Since 2.6)
2399 # @iops_size: an I/O size in bytes (Since 1.7)
2401 # @group: throttle group name (Since 2.4)
2404 # @deprecated: Member @device is deprecated. Use @id instead.
2408 { 'struct': 'BlockIOThrottle',
2409 'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] },
2410 '*id': 'str', 'bps': 'int', 'bps_rd': 'int',
2411 'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
2412 '*bps_max': 'int', '*bps_rd_max': 'int',
2413 '*bps_wr_max': 'int', '*iops_max': 'int',
2414 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
2415 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
2416 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
2417 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
2418 '*iops_size': 'int', '*group': 'str' } }
2423 # Limit parameters for throttling.
2424 # Since some limit combinations are illegal, limits should always be set in one
2425 # transaction. All fields are optional. When setting limits, if a field is
2426 # missing the current value is not changed.
2428 # @iops-total: limit total I/O operations per second
2429 # @iops-total-max: I/O operations burst
2430 # @iops-total-max-length: length of the iops-total-max burst period, in seconds
2431 # It must only be set if @iops-total-max is set as well.
2432 # @iops-read: limit read operations per second
2433 # @iops-read-max: I/O operations read burst
2434 # @iops-read-max-length: length of the iops-read-max burst period, in seconds
2435 # It must only be set if @iops-read-max is set as well.
2436 # @iops-write: limit write operations per second
2437 # @iops-write-max: I/O operations write burst
2438 # @iops-write-max-length: length of the iops-write-max burst period, in seconds
2439 # It must only be set if @iops-write-max is set as well.
2440 # @bps-total: limit total bytes per second
2441 # @bps-total-max: total bytes burst
2442 # @bps-total-max-length: length of the bps-total-max burst period, in seconds.
2443 # It must only be set if @bps-total-max is set as well.
2444 # @bps-read: limit read bytes per second
2445 # @bps-read-max: total bytes read burst
2446 # @bps-read-max-length: length of the bps-read-max burst period, in seconds
2447 # It must only be set if @bps-read-max is set as well.
2448 # @bps-write: limit write bytes per second
2449 # @bps-write-max: total bytes write burst
2450 # @bps-write-max-length: length of the bps-write-max burst period, in seconds
2451 # It must only be set if @bps-write-max is set as well.
2452 # @iops-size: when limiting by iops max size of an I/O in bytes
2456 { 'struct': 'ThrottleLimits',
2457 'data': { '*iops-total' : 'int', '*iops-total-max' : 'int',
2458 '*iops-total-max-length' : 'int', '*iops-read' : 'int',
2459 '*iops-read-max' : 'int', '*iops-read-max-length' : 'int',
2460 '*iops-write' : 'int', '*iops-write-max' : 'int',
2461 '*iops-write-max-length' : 'int', '*bps-total' : 'int',
2462 '*bps-total-max' : 'int', '*bps-total-max-length' : 'int',
2463 '*bps-read' : 'int', '*bps-read-max' : 'int',
2464 '*bps-read-max-length' : 'int', '*bps-write' : 'int',
2465 '*bps-write-max' : 'int', '*bps-write-max-length' : 'int',
2466 '*iops-size' : 'int' } }
2471 # Copy data from a backing file into a block device.
2473 # The block streaming operation is performed in the background until the entire
2474 # backing file has been copied. This command returns immediately once streaming
2475 # has started. The status of ongoing block streaming operations can be checked
2476 # with query-block-jobs. The operation can be stopped before it has completed
2477 # using the block-job-cancel command.
2479 # The node that receives the data is called the top image, can be located in
2480 # any part of the chain (but always above the base image; see below) and can be
2481 # specified using its device or node name. Earlier qemu versions only allowed
2482 # 'device' to name the top level node; presence of the 'base-node' parameter
2483 # during introspection can be used as a witness of the enhanced semantics
2486 # If a base file is specified then sectors are not copied from that base file and
2487 # its backing chain. This can be used to stream a subset of the backing file
2488 # chain instead of flattening the entire image.
2489 # When streaming completes the image file will have the base file as its backing
2490 # file, unless that node was changed while the job was running. In that case,
2491 # base's parent's backing (or filtered, whichever exists) child (i.e., base at
2492 # the beginning of the job) will be the new backing file.
2494 # On successful completion the image file is updated to drop the backing file
2495 # and the BLOCK_JOB_COMPLETED event is emitted.
2497 # In case @device is a filter node, block-stream modifies the first non-filter
2498 # overlay node below it to point to the new backing node instead of modifying
2501 # @job-id: identifier for the newly-created block job. If
2502 # omitted, the device name will be used. (Since 2.7)
2504 # @device: the device or node name of the top image
2506 # @base: the common backing file name.
2507 # It cannot be set if @base-node is also set.
2509 # @base-node: the node name of the backing file.
2510 # It cannot be set if @base is also set. (Since 2.8)
2512 # @backing-file: The backing file string to write into the top
2513 # image. This filename is not validated.
2515 # If a pathname string is such that it cannot be
2516 # resolved by QEMU, that means that subsequent QMP or
2517 # HMP commands must use node-names for the image in
2518 # question, as filename lookup methods will fail.
2520 # If not specified, QEMU will automatically determine
2521 # the backing file string to use, or error out if there
2522 # is no obvious choice. Care should be taken when
2523 # specifying the string, to specify a valid filename or
2527 # @speed: the maximum speed, in bytes per second
2529 # @on-error: the action to take on an error (default report).
2530 # 'stop' and 'enospc' can only be used if the block device
2531 # supports io-status (see BlockInfo). Since 1.3.
2533 # @auto-finalize: When false, this job will wait in a PENDING state after it has
2534 # finished its work, waiting for @block-job-finalize before
2535 # making any block graph changes.
2536 # When true, this job will automatically
2537 # perform its abort or commit actions.
2538 # Defaults to true. (Since 3.1)
2540 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
2541 # has completely ceased all work, and awaits @block-job-dismiss.
2542 # When true, this job will automatically disappear from the query
2543 # list without user intervention.
2544 # Defaults to true. (Since 3.1)
2546 # Returns: - Nothing on success.
2547 # - If @device does not exist, DeviceNotFound.
2553 # -> { "execute": "block-stream",
2554 # "arguments": { "device": "virtio0",
2555 # "base": "/tmp/master.qcow2" } }
2556 # <- { "return": {} }
2559 { 'command': 'block-stream',
2560 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
2561 '*base-node': 'str', '*backing-file': 'str', '*speed': 'int',
2562 '*on-error': 'BlockdevOnError',
2563 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2566 # @block-job-set-speed:
2568 # Set maximum speed for a background block operation.
2570 # This command can only be issued when there is an active block job.
2572 # Throttling can be disabled by setting the speed to 0.
2574 # @device: The job identifier. This used to be a device name (hence
2575 # the name of the parameter), but since QEMU 2.7 it can have
2578 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
2581 # Returns: - Nothing on success
2582 # - If no background operation is active on this device, DeviceNotActive
2586 { 'command': 'block-job-set-speed',
2587 'data': { 'device': 'str', 'speed': 'int' } }
2590 # @block-job-cancel:
2592 # Stop an active background block operation.
2594 # This command returns immediately after marking the active background block
2595 # operation for cancellation. It is an error to call this command if no
2596 # operation is in progress.
2598 # The operation will cancel as soon as possible and then emit the
2599 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
2600 # enumerated using query-block-jobs.
2602 # Note that if you issue 'block-job-cancel' after 'drive-mirror' has indicated
2603 # (via the event BLOCK_JOB_READY) that the source and destination are
2604 # synchronized, then the event triggered by this command changes to
2605 # BLOCK_JOB_COMPLETED, to indicate that the mirroring has ended and the
2606 # destination now has a point-in-time copy tied to the time of the cancellation.
2608 # For streaming, the image file retains its backing file unless the streaming
2609 # operation happens to complete just as it is being cancelled. A new streaming
2610 # operation can be started at a later time to finish copying all data from the
2613 # @device: The job identifier. This used to be a device name (hence
2614 # the name of the parameter), but since QEMU 2.7 it can have
2617 # @force: If true, and the job has already emitted the event BLOCK_JOB_READY,
2618 # abandon the job immediately (even if it is paused) instead of waiting
2619 # for the destination to complete its final synchronization (since 1.3)
2621 # Returns: - Nothing on success
2622 # - If no background operation is active on this device, DeviceNotActive
2626 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
2631 # Pause an active background block operation.
2633 # This command returns immediately after marking the active background block
2634 # operation for pausing. It is an error to call this command if no
2635 # operation is in progress or if the job is already paused.
2637 # The operation will pause as soon as possible. No event is emitted when
2638 # the operation is actually paused. Cancelling a paused job automatically
2641 # @device: The job identifier. This used to be a device name (hence
2642 # the name of the parameter), but since QEMU 2.7 it can have
2645 # Returns: - Nothing on success
2646 # - If no background operation is active on this device, DeviceNotActive
2650 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
2653 # @block-job-resume:
2655 # Resume an active background block operation.
2657 # This command returns immediately after resuming a paused background block
2658 # operation. It is an error to call this command if no operation is in
2659 # progress or if the job is not paused.
2661 # This command also clears the error status of the job.
2663 # @device: The job identifier. This used to be a device name (hence
2664 # the name of the parameter), but since QEMU 2.7 it can have
2667 # Returns: - Nothing on success
2668 # - If no background operation is active on this device, DeviceNotActive
2672 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
2675 # @block-job-complete:
2677 # Manually trigger completion of an active background block operation. This
2678 # is supported for drive mirroring, where it also switches the device to
2679 # write to the target path only. The ability to complete is signaled with
2680 # a BLOCK_JOB_READY event.
2682 # This command completes an active background block operation synchronously.
2683 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
2684 # is not defined. Note that if an I/O error occurs during the processing of
2685 # this command: 1) the command itself will fail; 2) the error will be processed
2686 # according to the rerror/werror arguments that were specified when starting
2689 # A cancelled or paused job cannot be completed.
2691 # @device: The job identifier. This used to be a device name (hence
2692 # the name of the parameter), but since QEMU 2.7 it can have
2695 # Returns: - Nothing on success
2696 # - If no background operation is active on this device, DeviceNotActive
2700 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
2703 # @block-job-dismiss:
2705 # For jobs that have already concluded, remove them from the block-job-query
2706 # list. This command only needs to be run for jobs which were started with
2707 # QEMU 2.12+ job lifetime management semantics.
2709 # This command will refuse to operate on any job that has not yet reached
2710 # its terminal state, JOB_STATUS_CONCLUDED. For jobs that make use of the
2711 # BLOCK_JOB_READY event, block-job-cancel or block-job-complete will still need
2712 # to be used as appropriate.
2714 # @id: The job identifier.
2716 # Returns: Nothing on success
2720 { 'command': 'block-job-dismiss', 'data': { 'id': 'str' } }
2723 # @block-job-finalize:
2725 # Once a job that has manual=true reaches the pending state, it can be
2726 # instructed to finalize any graph changes and do any necessary cleanup
2728 # For jobs in a transaction, instructing one job to finalize will force
2729 # ALL jobs in the transaction to finalize, so it is only necessary to instruct
2730 # a single member job to finalize.
2732 # @id: The job identifier.
2734 # Returns: Nothing on success
2738 { 'command': 'block-job-finalize', 'data': { 'id': 'str' } }
2741 # @BlockdevDiscardOptions:
2743 # Determines how to handle discard requests.
2745 # @ignore: Ignore the request
2746 # @unmap: Forward as an unmap request
2750 { 'enum': 'BlockdevDiscardOptions',
2751 'data': [ 'ignore', 'unmap' ] }
2754 # @BlockdevDetectZeroesOptions:
2756 # Describes the operation mode for the automatic conversion of plain
2757 # zero writes by the OS to driver specific optimized zero write commands.
2759 # @off: Disabled (default)
2761 # @unmap: Enabled and even try to unmap blocks if possible. This requires
2762 # also that @BlockdevDiscardOptions is set to unmap for this device.
2766 { 'enum': 'BlockdevDetectZeroesOptions',
2767 'data': [ 'off', 'on', 'unmap' ] }
2770 # @BlockdevAioOptions:
2772 # Selects the AIO backend to handle I/O requests
2774 # @threads: Use qemu's thread pool
2775 # @native: Use native AIO backend (only Linux and Windows)
2776 # @io_uring: Use linux io_uring (since 5.0)
2780 { 'enum': 'BlockdevAioOptions',
2781 'data': [ 'threads', 'native',
2782 { 'name': 'io_uring', 'if': 'defined(CONFIG_LINUX_IO_URING)' } ] }
2785 # @BlockdevCacheOptions:
2787 # Includes cache-related options for block devices
2789 # @direct: enables use of O_DIRECT (bypass the host page cache;
2791 # @no-flush: ignore any flush requests for the device (default:
2796 { 'struct': 'BlockdevCacheOptions',
2797 'data': { '*direct': 'bool',
2798 '*no-flush': 'bool' } }
2803 # Drivers that are supported in block device operations.
2805 # @throttle: Since 2.11
2807 # @copy-on-read: Since 3.0
2808 # @blklogwrites: Since 3.0
2809 # @blkreplay: Since 4.2
2810 # @compress: Since 5.0
2814 { 'enum': 'BlockdevDriver',
2815 'data': [ 'blkdebug', 'blklogwrites', 'blkreplay', 'blkverify', 'bochs',
2816 'cloop', 'compress', 'copy-on-read', 'dmg', 'file', 'ftp', 'ftps',
2817 'gluster', 'host_cdrom', 'host_device', 'http', 'https', 'iscsi',
2818 'luks', 'nbd', 'nfs', 'null-aio', 'null-co', 'nvme', 'parallels',
2819 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'rbd',
2820 { 'name': 'replication', 'if': 'defined(CONFIG_REPLICATION)' },
2822 'ssh', 'throttle', 'vdi', 'vhdx', 'vmdk', 'vpc', 'vvfat' ] }
2825 # @BlockdevOptionsFile:
2827 # Driver specific block device options for the file backend.
2829 # @filename: path to the image file
2830 # @pr-manager: the id for the object that will handle persistent reservations
2831 # for this device (default: none, forward the commands via SG_IO;
2833 # @aio: AIO backend (default: threads) (since: 2.8)
2834 # @locking: whether to enable file locking. If set to 'auto', only enable
2835 # when Open File Descriptor (OFD) locking API is available
2836 # (default: auto, since 2.10)
2837 # @drop-cache: invalidate page cache during live migration. This prevents
2838 # stale data on the migration destination with cache.direct=off.
2839 # Currently only supported on Linux hosts.
2840 # (default: on, since: 4.0)
2841 # @x-check-cache-dropped: whether to check that page cache was dropped on live
2842 # migration. May cause noticeable delays if the image
2843 # file is large, do not use in production.
2844 # (default: off) (since: 3.0)
2847 # @dynamic-auto-read-only: If present, enabled auto-read-only means that the
2848 # driver will open the image read-only at first,
2849 # dynamically reopen the image file read-write when
2850 # the first writer is attached to the node and reopen
2851 # read-only when the last writer is detached. This
2852 # allows giving QEMU write permissions only on demand
2853 # when an operation actually needs write access.
2857 { 'struct': 'BlockdevOptionsFile',
2858 'data': { 'filename': 'str',
2859 '*pr-manager': 'str',
2860 '*locking': 'OnOffAuto',
2861 '*aio': 'BlockdevAioOptions',
2862 '*drop-cache': {'type': 'bool',
2863 'if': 'defined(CONFIG_LINUX)'},
2864 '*x-check-cache-dropped': 'bool' },
2865 'features': [ { 'name': 'dynamic-auto-read-only',
2866 'if': 'defined(CONFIG_POSIX)' } ] }
2869 # @BlockdevOptionsNull:
2871 # Driver specific block device options for the null backend.
2873 # @size: size of the device in bytes.
2874 # @latency-ns: emulated latency (in nanoseconds) in processing
2875 # requests. Default to zero which completes requests immediately.
2877 # @read-zeroes: if true, reads from the device produce zeroes; if false, the
2878 # buffer is left unchanged. (default: false; since: 4.1)
2882 { 'struct': 'BlockdevOptionsNull',
2883 'data': { '*size': 'int', '*latency-ns': 'uint64', '*read-zeroes': 'bool' } }
2886 # @BlockdevOptionsNVMe:
2888 # Driver specific block device options for the NVMe backend.
2890 # @device: PCI controller address of the NVMe device in
2891 # format hhhh:bb:ss.f (host:bus:slot.function)
2892 # @namespace: namespace number of the device, starting from 1.
2894 # Note that the PCI @device must have been unbound from any host
2895 # kernel driver before instructing QEMU to add the blockdev.
2899 { 'struct': 'BlockdevOptionsNVMe',
2900 'data': { 'device': 'str', 'namespace': 'int' } }
2903 # @BlockdevOptionsVVFAT:
2905 # Driver specific block device options for the vvfat protocol.
2907 # @dir: directory to be exported as FAT image
2908 # @fat-type: FAT type: 12, 16 or 32
2909 # @floppy: whether to export a floppy image (true) or
2910 # partitioned hard disk (false; default)
2911 # @label: set the volume label, limited to 11 bytes. FAT16 and
2912 # FAT32 traditionally have some restrictions on labels, which are
2913 # ignored by most operating systems. Defaults to "QEMU VVFAT".
2915 # @rw: whether to allow write operations (default: false)
2919 { 'struct': 'BlockdevOptionsVVFAT',
2920 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
2921 '*label': 'str', '*rw': 'bool' } }
2924 # @BlockdevOptionsGenericFormat:
2926 # Driver specific block device options for image format that have no option
2927 # besides their data source.
2929 # @file: reference to or definition of the data source block device
2933 { 'struct': 'BlockdevOptionsGenericFormat',
2934 'data': { 'file': 'BlockdevRef' } }
2937 # @BlockdevOptionsLUKS:
2939 # Driver specific block device options for LUKS.
2941 # @key-secret: the ID of a QCryptoSecret object providing
2942 # the decryption key (since 2.6). Mandatory except when
2943 # doing a metadata-only probe of the image.
2947 { 'struct': 'BlockdevOptionsLUKS',
2948 'base': 'BlockdevOptionsGenericFormat',
2949 'data': { '*key-secret': 'str' } }
2953 # @BlockdevOptionsGenericCOWFormat:
2955 # Driver specific block device options for image format that have no option
2956 # besides their data source and an optional backing file.
2958 # @backing: reference to or definition of the backing file block
2959 # device, null disables the backing file entirely.
2960 # Defaults to the backing file stored the image file.
2964 { 'struct': 'BlockdevOptionsGenericCOWFormat',
2965 'base': 'BlockdevOptionsGenericFormat',
2966 'data': { '*backing': 'BlockdevRefOrNull' } }
2969 # @Qcow2OverlapCheckMode:
2971 # General overlap check modes.
2973 # @none: Do not perform any checks
2975 # @constant: Perform only checks which can be done in constant time and
2976 # without reading anything from disk
2978 # @cached: Perform only checks which can be done without reading anything
2981 # @all: Perform all available overlap checks
2985 { 'enum': 'Qcow2OverlapCheckMode',
2986 'data': [ 'none', 'constant', 'cached', 'all' ] }
2989 # @Qcow2OverlapCheckFlags:
2991 # Structure of flags for each metadata structure. Setting a field to 'true'
2992 # makes qemu guard that structure against unintended overwriting. The default
2993 # value is chosen according to the template given.
2995 # @template: Specifies a template mode which can be adjusted using the other
2996 # flags, defaults to 'cached'
2998 # @bitmap-directory: since 3.0
3002 { 'struct': 'Qcow2OverlapCheckFlags',
3003 'data': { '*template': 'Qcow2OverlapCheckMode',
3004 '*main-header': 'bool',
3005 '*active-l1': 'bool',
3006 '*active-l2': 'bool',
3007 '*refcount-table': 'bool',
3008 '*refcount-block': 'bool',
3009 '*snapshot-table': 'bool',
3010 '*inactive-l1': 'bool',
3011 '*inactive-l2': 'bool',
3012 '*bitmap-directory': 'bool' } }
3015 # @Qcow2OverlapChecks:
3017 # Specifies which metadata structures should be guarded against unintended
3020 # @flags: set of flags for separate specification of each metadata structure
3023 # @mode: named mode which chooses a specific set of flags
3027 { 'alternate': 'Qcow2OverlapChecks',
3028 'data': { 'flags': 'Qcow2OverlapCheckFlags',
3029 'mode': 'Qcow2OverlapCheckMode' } }
3032 # @BlockdevQcowEncryptionFormat:
3034 # @aes: AES-CBC with plain64 initialization vectors
3038 { 'enum': 'BlockdevQcowEncryptionFormat',
3042 # @BlockdevQcowEncryption:
3046 { 'union': 'BlockdevQcowEncryption',
3047 'base': { 'format': 'BlockdevQcowEncryptionFormat' },
3048 'discriminator': 'format',
3049 'data': { 'aes': 'QCryptoBlockOptionsQCow' } }
3052 # @BlockdevOptionsQcow:
3054 # Driver specific block device options for qcow.
3056 # @encrypt: Image decryption options. Mandatory for
3057 # encrypted images, except when doing a metadata-only
3058 # probe of the image.
3062 { 'struct': 'BlockdevOptionsQcow',
3063 'base': 'BlockdevOptionsGenericCOWFormat',
3064 'data': { '*encrypt': 'BlockdevQcowEncryption' } }
3069 # @BlockdevQcow2EncryptionFormat:
3070 # @aes: AES-CBC with plain64 initialization vectors
3074 { 'enum': 'BlockdevQcow2EncryptionFormat',
3075 'data': [ 'aes', 'luks' ] }
3078 # @BlockdevQcow2Encryption:
3082 { 'union': 'BlockdevQcow2Encryption',
3083 'base': { 'format': 'BlockdevQcow2EncryptionFormat' },
3084 'discriminator': 'format',
3085 'data': { 'aes': 'QCryptoBlockOptionsQCow',
3086 'luks': 'QCryptoBlockOptionsLUKS'} }
3089 # @BlockdevOptionsQcow2:
3091 # Driver specific block device options for qcow2.
3093 # @lazy-refcounts: whether to enable the lazy refcounts
3094 # feature (default is taken from the image file)
3096 # @pass-discard-request: whether discard requests to the qcow2
3097 # device should be forwarded to the data source
3099 # @pass-discard-snapshot: whether discard requests for the data source
3100 # should be issued when a snapshot operation (e.g.
3101 # deleting a snapshot) frees clusters in the qcow2 file
3103 # @pass-discard-other: whether discard requests for the data source
3104 # should be issued on other occasions where a cluster
3107 # @overlap-check: which overlap checks to perform for writes
3108 # to the image, defaults to 'cached' (since 2.2)
3110 # @cache-size: the maximum total size of the L2 table and
3111 # refcount block caches in bytes (since 2.2)
3113 # @l2-cache-size: the maximum size of the L2 table cache in
3116 # @l2-cache-entry-size: the size of each entry in the L2 cache in
3117 # bytes. It must be a power of two between 512
3118 # and the cluster size. The default value is
3119 # the cluster size (since 2.12)
3121 # @refcount-cache-size: the maximum size of the refcount block cache
3122 # in bytes (since 2.2)
3124 # @cache-clean-interval: clean unused entries in the L2 and refcount
3125 # caches. The interval is in seconds. The default value
3126 # is 600 on supporting platforms, and 0 on other
3127 # platforms. 0 disables this feature. (since 2.5)
3129 # @encrypt: Image decryption options. Mandatory for
3130 # encrypted images, except when doing a metadata-only
3131 # probe of the image. (since 2.10)
3133 # @data-file: reference to or definition of the external data file.
3134 # This may only be specified for images that require an
3135 # external data file. If it is not specified for such
3136 # an image, the data file name is loaded from the image
3141 { 'struct': 'BlockdevOptionsQcow2',
3142 'base': 'BlockdevOptionsGenericCOWFormat',
3143 'data': { '*lazy-refcounts': 'bool',
3144 '*pass-discard-request': 'bool',
3145 '*pass-discard-snapshot': 'bool',
3146 '*pass-discard-other': 'bool',
3147 '*overlap-check': 'Qcow2OverlapChecks',
3148 '*cache-size': 'int',
3149 '*l2-cache-size': 'int',
3150 '*l2-cache-entry-size': 'int',
3151 '*refcount-cache-size': 'int',
3152 '*cache-clean-interval': 'int',
3153 '*encrypt': 'BlockdevQcow2Encryption',
3154 '*data-file': 'BlockdevRef' } }
3157 # @SshHostKeyCheckMode:
3159 # @none: Don't check the host key at all
3160 # @hash: Compare the host key with a given hash
3161 # @known_hosts: Check the host key against the known_hosts file
3165 { 'enum': 'SshHostKeyCheckMode',
3166 'data': [ 'none', 'hash', 'known_hosts' ] }
3169 # @SshHostKeyCheckHashType:
3171 # @md5: The given hash is an md5 hash
3172 # @sha1: The given hash is an sha1 hash
3176 { 'enum': 'SshHostKeyCheckHashType',
3177 'data': [ 'md5', 'sha1' ] }
3182 # @type: The hash algorithm used for the hash
3183 # @hash: The expected hash value
3187 { 'struct': 'SshHostKeyHash',
3188 'data': { 'type': 'SshHostKeyCheckHashType',
3196 { 'union': 'SshHostKeyCheck',
3197 'base': { 'mode': 'SshHostKeyCheckMode' },
3198 'discriminator': 'mode',
3199 'data': { 'hash': 'SshHostKeyHash' } }
3202 # @BlockdevOptionsSsh:
3204 # @server: host address
3206 # @path: path to the image on the host
3208 # @user: user as which to connect, defaults to current
3211 # @host-key-check: Defines how and what to check the host key against
3212 # (default: known_hosts)
3216 { 'struct': 'BlockdevOptionsSsh',
3217 'data': { 'server': 'InetSocketAddress',
3220 '*host-key-check': 'SshHostKeyCheck' } }
3226 # Trigger events supported by blkdebug.
3228 # @l1_shrink_write_table: write zeros to the l1 table to shrink image.
3231 # @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11)
3233 # @cor_write: a write due to copy-on-read (since 2.11)
3235 # @cluster_alloc_space: an allocation of file space for a cluster (since 4.1)
3237 # @none: triggers once at creation of the blkdebug node (since 4.1)
3241 { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
3242 'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
3243 'l1_grow_activate_table', 'l2_load', 'l2_update',
3244 'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
3245 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
3246 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
3247 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
3248 'refblock_load', 'refblock_update', 'refblock_update_part',
3249 'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
3250 'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
3251 'refblock_alloc_switch_table', 'cluster_alloc',
3252 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
3253 'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
3254 'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
3255 'pwritev_zero', 'pwritev_done', 'empty_image_prepare',
3256 'l1_shrink_write_table', 'l1_shrink_free_l2_clusters',
3257 'cor_write', 'cluster_alloc_space', 'none'] }
3262 # Kinds of I/O that blkdebug can inject errors in.
3264 # @read: .bdrv_co_preadv()
3266 # @write: .bdrv_co_pwritev()
3268 # @write-zeroes: .bdrv_co_pwrite_zeroes()
3270 # @discard: .bdrv_co_pdiscard()
3272 # @flush: .bdrv_co_flush_to_disk()
3274 # @block-status: .bdrv_co_block_status()
3278 { 'enum': 'BlkdebugIOType', 'prefix': 'BLKDEBUG_IO_TYPE',
3279 'data': [ 'read', 'write', 'write-zeroes', 'discard', 'flush',
3283 # @BlkdebugInjectErrorOptions:
3285 # Describes a single error injection for blkdebug.
3287 # @event: trigger event
3289 # @state: the state identifier blkdebug needs to be in to
3290 # actually trigger the event; defaults to "any"
3292 # @iotype: the type of I/O operations on which this error should
3293 # be injected; defaults to "all read, write,
3294 # write-zeroes, discard, and flush operations"
3297 # @errno: error identifier (errno) to be returned; defaults to
3300 # @sector: specifies the sector index which has to be affected
3301 # in order to actually trigger the event; defaults to "any
3304 # @once: disables further events after this one has been
3305 # triggered; defaults to false
3307 # @immediately: fail immediately; defaults to false
3311 { 'struct': 'BlkdebugInjectErrorOptions',
3312 'data': { 'event': 'BlkdebugEvent',
3314 '*iotype': 'BlkdebugIOType',
3318 '*immediately': 'bool' } }
3321 # @BlkdebugSetStateOptions:
3323 # Describes a single state-change event for blkdebug.
3325 # @event: trigger event
3327 # @state: the current state identifier blkdebug needs to be in;
3330 # @new_state: the state identifier blkdebug is supposed to assume if
3331 # this event is triggered
3335 { 'struct': 'BlkdebugSetStateOptions',
3336 'data': { 'event': 'BlkdebugEvent',
3338 'new_state': 'int' } }
3341 # @BlockdevOptionsBlkdebug:
3343 # Driver specific block device options for blkdebug.
3345 # @image: underlying raw block device (or image file)
3347 # @config: filename of the configuration file
3349 # @align: required alignment for requests in bytes, must be
3350 # positive power of 2, or 0 for default
3352 # @max-transfer: maximum size for I/O transfers in bytes, must be
3353 # positive multiple of @align and of the underlying
3354 # file's request alignment (but need not be a power of
3355 # 2), or 0 for default (since 2.10)
3357 # @opt-write-zero: preferred alignment for write zero requests in bytes,
3358 # must be positive multiple of @align and of the
3359 # underlying file's request alignment (but need not be a
3360 # power of 2), or 0 for default (since 2.10)
3362 # @max-write-zero: maximum size for write zero requests in bytes, must be
3363 # positive multiple of @align, of @opt-write-zero, and of
3364 # the underlying file's request alignment (but need not
3365 # be a power of 2), or 0 for default (since 2.10)
3367 # @opt-discard: preferred alignment for discard requests in bytes, must
3368 # be positive multiple of @align and of the underlying
3369 # file's request alignment (but need not be a power of
3370 # 2), or 0 for default (since 2.10)
3372 # @max-discard: maximum size for discard requests in bytes, must be
3373 # positive multiple of @align, of @opt-discard, and of
3374 # the underlying file's request alignment (but need not
3375 # be a power of 2), or 0 for default (since 2.10)
3377 # @inject-error: array of error injection descriptions
3379 # @set-state: array of state-change descriptions
3381 # @take-child-perms: Permissions to take on @image in addition to what
3382 # is necessary anyway (which depends on how the
3383 # blkdebug node is used). Defaults to none.
3386 # @unshare-child-perms: Permissions not to share on @image in addition
3387 # to what cannot be shared anyway (which depends
3388 # on how the blkdebug node is used). Defaults
3389 # to none. (since 5.0)
3393 { 'struct': 'BlockdevOptionsBlkdebug',
3394 'data': { 'image': 'BlockdevRef',
3396 '*align': 'int', '*max-transfer': 'int32',
3397 '*opt-write-zero': 'int32', '*max-write-zero': 'int32',
3398 '*opt-discard': 'int32', '*max-discard': 'int32',
3399 '*inject-error': ['BlkdebugInjectErrorOptions'],
3400 '*set-state': ['BlkdebugSetStateOptions'],
3401 '*take-child-perms': ['BlockPermission'],
3402 '*unshare-child-perms': ['BlockPermission'] } }
3405 # @BlockdevOptionsBlklogwrites:
3407 # Driver specific block device options for blklogwrites.
3409 # @file: block device
3411 # @log: block device used to log writes to @file
3413 # @log-sector-size: sector size used in logging writes to @file, determines
3414 # granularity of offsets and sizes of writes (default: 512)
3416 # @log-append: append to an existing log (default: false)
3418 # @log-super-update-interval: interval of write requests after which the log
3419 # super block is updated to disk (default: 4096)
3423 { 'struct': 'BlockdevOptionsBlklogwrites',
3424 'data': { 'file': 'BlockdevRef',
3425 'log': 'BlockdevRef',
3426 '*log-sector-size': 'uint32',
3427 '*log-append': 'bool',
3428 '*log-super-update-interval': 'uint64' } }
3431 # @BlockdevOptionsBlkverify:
3433 # Driver specific block device options for blkverify.
3435 # @test: block device to be tested
3437 # @raw: raw image used for verification
3441 { 'struct': 'BlockdevOptionsBlkverify',
3442 'data': { 'test': 'BlockdevRef',
3443 'raw': 'BlockdevRef' } }
3446 # @BlockdevOptionsBlkreplay:
3448 # Driver specific block device options for blkreplay.
3450 # @image: disk image which should be controlled with blkreplay
3454 { 'struct': 'BlockdevOptionsBlkreplay',
3455 'data': { 'image': 'BlockdevRef' } }
3458 # @QuorumReadPattern:
3460 # An enumeration of quorum read patterns.
3462 # @quorum: read all the children and do a quorum vote on reads
3464 # @fifo: read only from the first child that has not failed
3468 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
3471 # @BlockdevOptionsQuorum:
3473 # Driver specific block device options for Quorum
3475 # @blkverify: true if the driver must print content mismatch
3476 # set to false by default
3478 # @children: the children block devices to use
3480 # @vote-threshold: the vote limit under which a read will fail
3482 # @rewrite-corrupted: rewrite corrupted data when quorum is reached
3485 # @read-pattern: choose read pattern and set to quorum by default
3490 { 'struct': 'BlockdevOptionsQuorum',
3491 'data': { '*blkverify': 'bool',
3492 'children': [ 'BlockdevRef' ],
3493 'vote-threshold': 'int',
3494 '*rewrite-corrupted': 'bool',
3495 '*read-pattern': 'QuorumReadPattern' } }
3498 # @BlockdevOptionsGluster:
3500 # Driver specific block device options for Gluster
3502 # @volume: name of gluster volume where VM image resides
3504 # @path: absolute path to image file in gluster volume
3506 # @server: gluster servers description
3508 # @debug: libgfapi log level (default '4' which is Error)
3511 # @logfile: libgfapi log file (default /dev/stderr) (Since 2.8)
3515 { 'struct': 'BlockdevOptionsGluster',
3516 'data': { 'volume': 'str',
3518 'server': ['SocketAddress'],
3520 '*logfile': 'str' } }
3525 # An enumeration of libiscsi transport types
3529 { 'enum': 'IscsiTransport',
3530 'data': [ 'tcp', 'iser' ] }
3533 # @IscsiHeaderDigest:
3535 # An enumeration of header digests supported by libiscsi
3539 { 'enum': 'IscsiHeaderDigest',
3540 'prefix': 'QAPI_ISCSI_HEADER_DIGEST',
3541 'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] }
3544 # @BlockdevOptionsIscsi:
3546 # @transport: The iscsi transport type
3548 # @portal: The address of the iscsi portal
3550 # @target: The target iqn name
3552 # @lun: LUN to connect to. Defaults to 0.
3554 # @user: User name to log in with. If omitted, no CHAP
3555 # authentication is performed.
3557 # @password-secret: The ID of a QCryptoSecret object providing
3558 # the password for the login. This option is required if
3559 # @user is specified.
3561 # @initiator-name: The iqn name we want to identify to the target
3562 # as. If this option is not specified, an initiator name is
3563 # generated automatically.
3565 # @header-digest: The desired header digest. Defaults to
3568 # @timeout: Timeout in seconds after which a request will
3569 # timeout. 0 means no timeout and is the default.
3571 # Driver specific block device options for iscsi
3575 { 'struct': 'BlockdevOptionsIscsi',
3576 'data': { 'transport': 'IscsiTransport',
3581 '*password-secret': 'str',
3582 '*initiator-name': 'str',
3583 '*header-digest': 'IscsiHeaderDigest',
3584 '*timeout': 'int' } }
3592 { 'enum': 'RbdAuthMode',
3593 'data': [ 'cephx', 'none' ] }
3596 # @BlockdevOptionsRbd:
3598 # @pool: Ceph pool name.
3600 # @namespace: Rados namespace name in the Ceph pool. (Since 5.0)
3602 # @image: Image name in the Ceph pool.
3604 # @conf: path to Ceph configuration file. Values
3605 # in the configuration file will be overridden by
3606 # options specified via QAPI.
3608 # @snapshot: Ceph snapshot name.
3610 # @user: Ceph id name.
3612 # @auth-client-required: Acceptable authentication modes.
3613 # This maps to Ceph configuration option
3614 # "auth_client_required". (Since 3.0)
3616 # @key-secret: ID of a QCryptoSecret object providing a key
3617 # for cephx authentication.
3618 # This maps to Ceph configuration option
3619 # "key". (Since 3.0)
3621 # @server: Monitor host address and port. This maps
3622 # to the "mon_host" Ceph option.
3626 { 'struct': 'BlockdevOptionsRbd',
3627 'data': { 'pool': 'str',
3628 '*namespace': 'str',
3633 '*auth-client-required': ['RbdAuthMode'],
3634 '*key-secret': 'str',
3635 '*server': ['InetSocketAddressBase'] } }
3638 # @BlockdevOptionsSheepdog:
3640 # Driver specific block device options for sheepdog
3642 # @vdi: Virtual disk image name
3643 # @server: The Sheepdog server to connect to
3644 # @snap-id: Snapshot ID
3645 # @tag: Snapshot tag name
3647 # Only one of @snap-id and @tag may be present.
3651 { 'struct': 'BlockdevOptionsSheepdog',
3652 'data': { 'server': 'SocketAddress',
3654 '*snap-id': 'uint32',
3660 # An enumeration of replication modes.
3662 # @primary: Primary mode, the vm's state will be sent to secondary QEMU.
3664 # @secondary: Secondary mode, receive the vm's state from primary QEMU.
3668 { 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ],
3669 'if': 'defined(CONFIG_REPLICATION)' }
3672 # @BlockdevOptionsReplication:
3674 # Driver specific block device options for replication
3676 # @mode: the replication mode
3678 # @top-id: In secondary mode, node name or device ID of the root
3679 # node who owns the replication node chain. Must not be given in
3684 { 'struct': 'BlockdevOptionsReplication',
3685 'base': 'BlockdevOptionsGenericFormat',
3686 'data': { 'mode': 'ReplicationMode',
3688 'if': 'defined(CONFIG_REPLICATION)' }
3693 # An enumeration of NFS transport types
3695 # @inet: TCP transport
3699 { 'enum': 'NFSTransport',
3700 'data': [ 'inet' ] }
3705 # Captures the address of the socket
3707 # @type: transport type used for NFS (only TCP supported)
3709 # @host: host address for NFS server
3713 { 'struct': 'NFSServer',
3714 'data': { 'type': 'NFSTransport',
3718 # @BlockdevOptionsNfs:
3720 # Driver specific block device option for NFS
3722 # @server: host address
3724 # @path: path of the image on the host
3726 # @user: UID value to use when talking to the
3727 # server (defaults to 65534 on Windows and getuid()
3730 # @group: GID value to use when talking to the
3731 # server (defaults to 65534 on Windows and getgid()
3734 # @tcp-syn-count: number of SYNs during the session
3735 # establishment (defaults to libnfs default)
3737 # @readahead-size: set the readahead size in bytes (defaults
3738 # to libnfs default)
3740 # @page-cache-size: set the pagecache size in bytes (defaults
3741 # to libnfs default)
3743 # @debug: set the NFS debug level (max 2) (defaults
3744 # to libnfs default)
3748 { 'struct': 'BlockdevOptionsNfs',
3749 'data': { 'server': 'NFSServer',
3753 '*tcp-syn-count': 'int',
3754 '*readahead-size': 'int',
3755 '*page-cache-size': 'int',
3759 # @BlockdevOptionsCurlBase:
3761 # Driver specific block device options shared by all protocols supported by the
3764 # @url: URL of the image file
3766 # @readahead: Size of the read-ahead cache; must be a multiple of
3767 # 512 (defaults to 256 kB)
3769 # @timeout: Timeout for connections, in seconds (defaults to 5)
3771 # @username: Username for authentication (defaults to none)
3773 # @password-secret: ID of a QCryptoSecret object providing a password
3774 # for authentication (defaults to no password)
3776 # @proxy-username: Username for proxy authentication (defaults to none)
3778 # @proxy-password-secret: ID of a QCryptoSecret object providing a password
3779 # for proxy authentication (defaults to no password)
3783 { 'struct': 'BlockdevOptionsCurlBase',
3784 'data': { 'url': 'str',
3785 '*readahead': 'int',
3788 '*password-secret': 'str',
3789 '*proxy-username': 'str',
3790 '*proxy-password-secret': 'str' } }
3793 # @BlockdevOptionsCurlHttp:
3795 # Driver specific block device options for HTTP connections over the curl
3796 # backend. URLs must start with "http://".
3798 # @cookie: List of cookies to set; format is
3799 # "name1=content1; name2=content2;" as explained by
3800 # CURLOPT_COOKIE(3). Defaults to no cookies.
3802 # @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
3803 # secure way. See @cookie for the format. (since 2.10)
3807 { 'struct': 'BlockdevOptionsCurlHttp',
3808 'base': 'BlockdevOptionsCurlBase',
3809 'data': { '*cookie': 'str',
3810 '*cookie-secret': 'str'} }
3813 # @BlockdevOptionsCurlHttps:
3815 # Driver specific block device options for HTTPS connections over the curl
3816 # backend. URLs must start with "https://".
3818 # @cookie: List of cookies to set; format is
3819 # "name1=content1; name2=content2;" as explained by
3820 # CURLOPT_COOKIE(3). Defaults to no cookies.
3822 # @sslverify: Whether to verify the SSL certificate's validity (defaults to
3825 # @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
3826 # secure way. See @cookie for the format. (since 2.10)
3830 { 'struct': 'BlockdevOptionsCurlHttps',
3831 'base': 'BlockdevOptionsCurlBase',
3832 'data': { '*cookie': 'str',
3833 '*sslverify': 'bool',
3834 '*cookie-secret': 'str'} }
3837 # @BlockdevOptionsCurlFtp:
3839 # Driver specific block device options for FTP connections over the curl
3840 # backend. URLs must start with "ftp://".
3844 { 'struct': 'BlockdevOptionsCurlFtp',
3845 'base': 'BlockdevOptionsCurlBase',
3849 # @BlockdevOptionsCurlFtps:
3851 # Driver specific block device options for FTPS connections over the curl
3852 # backend. URLs must start with "ftps://".
3854 # @sslverify: Whether to verify the SSL certificate's validity (defaults to
3859 { 'struct': 'BlockdevOptionsCurlFtps',
3860 'base': 'BlockdevOptionsCurlBase',
3861 'data': { '*sslverify': 'bool' } }
3864 # @BlockdevOptionsNbd:
3866 # Driver specific block device options for NBD.
3868 # @server: NBD server address
3870 # @export: export name
3872 # @tls-creds: TLS credentials ID
3874 # @x-dirty-bitmap: A "qemu:dirty-bitmap:NAME" string to query in place of
3875 # traditional "base:allocation" block status (see
3876 # NBD_OPT_LIST_META_CONTEXT in the NBD protocol) (since 3.0)
3878 # @reconnect-delay: On an unexpected disconnect, the nbd client tries to
3879 # connect again until succeeding or encountering a serious
3880 # error. During the first @reconnect-delay seconds, all
3881 # requests are paused and will be rerun on a successful
3882 # reconnect. After that time, any delayed requests and all
3883 # future requests before a successful reconnect will
3884 # immediately fail. Default 0 (Since 4.2)
3888 { 'struct': 'BlockdevOptionsNbd',
3889 'data': { 'server': 'SocketAddress',
3891 '*tls-creds': 'str',
3892 '*x-dirty-bitmap': 'str',
3893 '*reconnect-delay': 'uint32' } }
3896 # @BlockdevOptionsRaw:
3898 # Driver specific block device options for the raw driver.
3900 # @offset: position where the block device starts
3901 # @size: the assumed size of the device
3905 { 'struct': 'BlockdevOptionsRaw',
3906 'base': 'BlockdevOptionsGenericFormat',
3907 'data': { '*offset': 'int', '*size': 'int' } }
3910 # @BlockdevOptionsThrottle:
3912 # Driver specific block device options for the throttle driver
3914 # @throttle-group: the name of the throttle-group object to use. It
3915 # must already exist.
3916 # @file: reference to or definition of the data source block device
3919 { 'struct': 'BlockdevOptionsThrottle',
3920 'data': { 'throttle-group': 'str',
3921 'file' : 'BlockdevRef'
3926 # Options for creating a block device. Many options are available for all
3927 # block devices, independent of the block driver:
3929 # @driver: block driver name
3930 # @node-name: the node name of the new node (Since 2.0).
3931 # This option is required on the top level of blockdev-add.
3932 # Valid node names start with an alphabetic character and may
3933 # contain only alphanumeric characters, '-', '.' and '_'. Their
3934 # maximum length is 31 characters.
3935 # @discard: discard-related options (default: ignore)
3936 # @cache: cache-related options
3937 # @read-only: whether the block device should be read-only (default: false).
3938 # Note that some block drivers support only read-only access,
3939 # either generally or in certain configurations. In this case,
3940 # the default value does not work and the option must be
3941 # specified explicitly.
3942 # @auto-read-only: if true and @read-only is false, QEMU may automatically
3943 # decide not to open the image read-write as requested, but
3944 # fall back to read-only instead (and switch between the modes
3945 # later), e.g. depending on whether the image file is writable
3946 # or whether a writing user is attached to the node
3947 # (default: false, since 3.1)
3948 # @detect-zeroes: detect and optimize zero writes (Since 2.1)
3950 # @force-share: force share all permission on added nodes.
3951 # Requires read-only=true. (Since 2.10)
3953 # Remaining options are determined by the block driver.
3957 { 'union': 'BlockdevOptions',
3958 'base': { 'driver': 'BlockdevDriver',
3959 '*node-name': 'str',
3960 '*discard': 'BlockdevDiscardOptions',
3961 '*cache': 'BlockdevCacheOptions',
3962 '*read-only': 'bool',
3963 '*auto-read-only': 'bool',
3964 '*force-share': 'bool',
3965 '*detect-zeroes': 'BlockdevDetectZeroesOptions' },
3966 'discriminator': 'driver',
3968 'blkdebug': 'BlockdevOptionsBlkdebug',
3969 'blklogwrites':'BlockdevOptionsBlklogwrites',
3970 'blkverify': 'BlockdevOptionsBlkverify',
3971 'blkreplay': 'BlockdevOptionsBlkreplay',
3972 'bochs': 'BlockdevOptionsGenericFormat',
3973 'cloop': 'BlockdevOptionsGenericFormat',
3974 'compress': 'BlockdevOptionsGenericFormat',
3975 'copy-on-read':'BlockdevOptionsGenericFormat',
3976 'dmg': 'BlockdevOptionsGenericFormat',
3977 'file': 'BlockdevOptionsFile',
3978 'ftp': 'BlockdevOptionsCurlFtp',
3979 'ftps': 'BlockdevOptionsCurlFtps',
3980 'gluster': 'BlockdevOptionsGluster',
3981 'host_cdrom': 'BlockdevOptionsFile',
3982 'host_device':'BlockdevOptionsFile',
3983 'http': 'BlockdevOptionsCurlHttp',
3984 'https': 'BlockdevOptionsCurlHttps',
3985 'iscsi': 'BlockdevOptionsIscsi',
3986 'luks': 'BlockdevOptionsLUKS',
3987 'nbd': 'BlockdevOptionsNbd',
3988 'nfs': 'BlockdevOptionsNfs',
3989 'null-aio': 'BlockdevOptionsNull',
3990 'null-co': 'BlockdevOptionsNull',
3991 'nvme': 'BlockdevOptionsNVMe',
3992 'parallels': 'BlockdevOptionsGenericFormat',
3993 'qcow2': 'BlockdevOptionsQcow2',
3994 'qcow': 'BlockdevOptionsQcow',
3995 'qed': 'BlockdevOptionsGenericCOWFormat',
3996 'quorum': 'BlockdevOptionsQuorum',
3997 'raw': 'BlockdevOptionsRaw',
3998 'rbd': 'BlockdevOptionsRbd',
3999 'replication': { 'type': 'BlockdevOptionsReplication',
4000 'if': 'defined(CONFIG_REPLICATION)' },
4001 'sheepdog': 'BlockdevOptionsSheepdog',
4002 'ssh': 'BlockdevOptionsSsh',
4003 'throttle': 'BlockdevOptionsThrottle',
4004 'vdi': 'BlockdevOptionsGenericFormat',
4005 'vhdx': 'BlockdevOptionsGenericFormat',
4006 'vmdk': 'BlockdevOptionsGenericCOWFormat',
4007 'vpc': 'BlockdevOptionsGenericFormat',
4008 'vvfat': 'BlockdevOptionsVVFAT'
4014 # Reference to a block device.
4016 # @definition: defines a new block device inline
4017 # @reference: references the ID of an existing block device
4021 { 'alternate': 'BlockdevRef',
4022 'data': { 'definition': 'BlockdevOptions',
4023 'reference': 'str' } }
4026 # @BlockdevRefOrNull:
4028 # Reference to a block device.
4030 # @definition: defines a new block device inline
4031 # @reference: references the ID of an existing block device.
4032 # An empty string means that no block device should
4033 # be referenced. Deprecated; use null instead.
4034 # @null: No block device should be referenced (since 2.10)
4038 { 'alternate': 'BlockdevRefOrNull',
4039 'data': { 'definition': 'BlockdevOptions',
4046 # Creates a new block device.
4053 # -> { "execute": "blockdev-add",
4055 # "driver": "qcow2",
4056 # "node-name": "test1",
4059 # "filename": "test.qcow2"
4063 # <- { "return": {} }
4066 # -> { "execute": "blockdev-add",
4068 # "driver": "qcow2",
4069 # "node-name": "node0",
4070 # "discard": "unmap",
4076 # "filename": "/tmp/test.qcow2"
4082 # "filename": "/dev/fdset/4"
4088 # <- { "return": {} }
4091 { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true }
4094 # @x-blockdev-reopen:
4096 # Reopens a block device using the given set of options. Any option
4097 # not specified will be reset to its default value regardless of its
4098 # previous status. If an option cannot be changed or a particular
4099 # driver does not support reopening then the command will return an
4102 # The top-level @node-name option (from BlockdevOptions) must be
4103 # specified and is used to select the block device to be reopened.
4104 # Other @node-name options must be either omitted or set to the
4105 # current name of the appropriate node. This command won't change any
4106 # node name and any attempt to do it will result in an error.
4108 # In the case of options that refer to child nodes, the behavior of
4109 # this command depends on the value:
4111 # 1) A set of options (BlockdevOptions): the child is reopened with
4112 # the specified set of options.
4114 # 2) A reference to the current child: the child is reopened using
4115 # its existing set of options.
4117 # 3) A reference to a different node: the current child is replaced
4118 # with the specified one.
4120 # 4) NULL: the current child (if any) is detached.
4122 # Options (1) and (2) are supported in all cases, but at the moment
4123 # only @backing allows replacing or detaching an existing child.
4125 # Unlike with blockdev-add, the @backing option must always be present
4126 # unless the node being reopened does not have a backing file and its
4127 # image does not have a default backing file name as part of its
4132 { 'command': 'x-blockdev-reopen',
4133 'data': 'BlockdevOptions', 'boxed': true }
4138 # Deletes a block device that has been added using blockdev-add.
4139 # The command will fail if the node is attached to a device or is
4140 # otherwise being used.
4142 # @node-name: Name of the graph node to delete.
4148 # -> { "execute": "blockdev-add",
4150 # "driver": "qcow2",
4151 # "node-name": "node0",
4154 # "filename": "test.qcow2"
4158 # <- { "return": {} }
4160 # -> { "execute": "blockdev-del",
4161 # "arguments": { "node-name": "node0" }
4163 # <- { "return": {} }
4166 { 'command': 'blockdev-del', 'data': { 'node-name': 'str' } }
4169 # @BlockdevCreateOptionsFile:
4171 # Driver specific image creation options for file.
4173 # @filename: Filename for the new image file
4174 # @size: Size of the virtual disk in bytes
4175 # @preallocation: Preallocation mode for the new image (default: off;
4176 # allowed values: off,
4177 # falloc (if defined CONFIG_POSIX_FALLOCATE),
4178 # full (if defined CONFIG_POSIX))
4179 # @nocow: Turn off copy-on-write (valid only on btrfs; default: off)
4180 # @extent-size-hint: Extent size hint to add to the image file; 0 for not
4181 # adding an extent size hint (default: 1 MB, since 5.1)
4185 { 'struct': 'BlockdevCreateOptionsFile',
4186 'data': { 'filename': 'str',
4188 '*preallocation': 'PreallocMode',
4190 '*extent-size-hint': 'size'} }
4193 # @BlockdevCreateOptionsGluster:
4195 # Driver specific image creation options for gluster.
4197 # @location: Where to store the new image file
4198 # @size: Size of the virtual disk in bytes
4199 # @preallocation: Preallocation mode for the new image (default: off;
4200 # allowed values: off,
4201 # falloc (if defined CONFIG_GLUSTERFS_FALLOCATE),
4202 # full (if defined CONFIG_GLUSTERFS_ZEROFILL))
4206 { 'struct': 'BlockdevCreateOptionsGluster',
4207 'data': { 'location': 'BlockdevOptionsGluster',
4209 '*preallocation': 'PreallocMode' } }
4212 # @BlockdevCreateOptionsLUKS:
4214 # Driver specific image creation options for LUKS.
4216 # @file: Node to create the image format on
4217 # @size: Size of the virtual disk in bytes
4218 # @preallocation: Preallocation mode for the new image
4220 # (default: off; allowed values: off, metadata, falloc, full)
4224 { 'struct': 'BlockdevCreateOptionsLUKS',
4225 'base': 'QCryptoBlockCreateOptionsLUKS',
4226 'data': { 'file': 'BlockdevRef',
4228 '*preallocation': 'PreallocMode' } }
4231 # @BlockdevCreateOptionsNfs:
4233 # Driver specific image creation options for NFS.
4235 # @location: Where to store the new image file
4236 # @size: Size of the virtual disk in bytes
4240 { 'struct': 'BlockdevCreateOptionsNfs',
4241 'data': { 'location': 'BlockdevOptionsNfs',
4245 # @BlockdevCreateOptionsParallels:
4247 # Driver specific image creation options for parallels.
4249 # @file: Node to create the image format on
4250 # @size: Size of the virtual disk in bytes
4251 # @cluster-size: Cluster size in bytes (default: 1 MB)
4255 { 'struct': 'BlockdevCreateOptionsParallels',
4256 'data': { 'file': 'BlockdevRef',
4258 '*cluster-size': 'size' } }
4261 # @BlockdevCreateOptionsQcow:
4263 # Driver specific image creation options for qcow.
4265 # @file: Node to create the image format on
4266 # @size: Size of the virtual disk in bytes
4267 # @backing-file: File name of the backing file if a backing file
4269 # @encrypt: Encryption options if the image should be encrypted
4273 { 'struct': 'BlockdevCreateOptionsQcow',
4274 'data': { 'file': 'BlockdevRef',
4276 '*backing-file': 'str',
4277 '*encrypt': 'QCryptoBlockCreateOptions' } }
4280 # @BlockdevQcow2Version:
4282 # @v2: The original QCOW2 format as introduced in qemu 0.10 (version 2)
4283 # @v3: The extended QCOW2 format as introduced in qemu 1.1 (version 3)
4287 { 'enum': 'BlockdevQcow2Version',
4288 'data': [ 'v2', 'v3' ] }
4292 # @Qcow2CompressionType:
4294 # Compression type used in qcow2 image file
4296 # @zlib: zlib compression, see <http://zlib.net/>
4297 # @zstd: zstd compression, see <http://github.com/facebook/zstd>
4301 { 'enum': 'Qcow2CompressionType',
4302 'data': [ 'zlib', { 'name': 'zstd', 'if': 'defined(CONFIG_ZSTD)' } ] }
4305 # @BlockdevCreateOptionsQcow2:
4307 # Driver specific image creation options for qcow2.
4309 # @file: Node to create the image format on
4310 # @data-file: Node to use as an external data file in which all guest
4311 # data is stored so that only metadata remains in the qcow2
4313 # @data-file-raw: True if the external data file must stay valid as a
4314 # standalone (read-only) raw image without looking at qcow2
4315 # metadata (default: false; since: 4.0)
4316 # @extended-l2 True to make the image have extended L2 entries
4317 # (default: false; since 5.2)
4318 # @size: Size of the virtual disk in bytes
4319 # @version: Compatibility level (default: v3)
4320 # @backing-file: File name of the backing file if a backing file
4322 # @backing-fmt: Name of the block driver to use for the backing file
4323 # @encrypt: Encryption options if the image should be encrypted
4324 # @cluster-size: qcow2 cluster size in bytes (default: 65536)
4325 # @preallocation: Preallocation mode for the new image (default: off;
4326 # allowed values: off, falloc, full, metadata)
4327 # @lazy-refcounts: True if refcounts may be updated lazily (default: off)
4328 # @refcount-bits: Width of reference counts in bits (default: 16)
4329 # @compression-type: The image cluster compression method
4330 # (default: zlib, since 5.1)
4334 { 'struct': 'BlockdevCreateOptionsQcow2',
4335 'data': { 'file': 'BlockdevRef',
4336 '*data-file': 'BlockdevRef',
4337 '*data-file-raw': 'bool',
4338 '*extended-l2': 'bool',
4340 '*version': 'BlockdevQcow2Version',
4341 '*backing-file': 'str',
4342 '*backing-fmt': 'BlockdevDriver',
4343 '*encrypt': 'QCryptoBlockCreateOptions',
4344 '*cluster-size': 'size',
4345 '*preallocation': 'PreallocMode',
4346 '*lazy-refcounts': 'bool',
4347 '*refcount-bits': 'int',
4348 '*compression-type':'Qcow2CompressionType' } }
4351 # @BlockdevCreateOptionsQed:
4353 # Driver specific image creation options for qed.
4355 # @file: Node to create the image format on
4356 # @size: Size of the virtual disk in bytes
4357 # @backing-file: File name of the backing file if a backing file
4359 # @backing-fmt: Name of the block driver to use for the backing file
4360 # @cluster-size: Cluster size in bytes (default: 65536)
4361 # @table-size: L1/L2 table size (in clusters)
4365 { 'struct': 'BlockdevCreateOptionsQed',
4366 'data': { 'file': 'BlockdevRef',
4368 '*backing-file': 'str',
4369 '*backing-fmt': 'BlockdevDriver',
4370 '*cluster-size': 'size',
4371 '*table-size': 'int' } }
4374 # @BlockdevCreateOptionsRbd:
4376 # Driver specific image creation options for rbd/Ceph.
4378 # @location: Where to store the new image file. This location cannot
4379 # point to a snapshot.
4380 # @size: Size of the virtual disk in bytes
4381 # @cluster-size: RBD object size
4385 { 'struct': 'BlockdevCreateOptionsRbd',
4386 'data': { 'location': 'BlockdevOptionsRbd',
4388 '*cluster-size' : 'size' } }
4391 # @BlockdevVmdkSubformat:
4393 # Subformat options for VMDK images
4395 # @monolithicSparse: Single file image with sparse cluster allocation
4397 # @monolithicFlat: Single flat data image and a descriptor file
4399 # @twoGbMaxExtentSparse: Data is split into 2GB (per virtual LBA) sparse extent
4400 # files, in addition to a descriptor file
4402 # @twoGbMaxExtentFlat: Data is split into 2GB (per virtual LBA) flat extent
4403 # files, in addition to a descriptor file
4405 # @streamOptimized: Single file image sparse cluster allocation, optimized
4406 # for streaming over network.
4410 { 'enum': 'BlockdevVmdkSubformat',
4411 'data': [ 'monolithicSparse', 'monolithicFlat', 'twoGbMaxExtentSparse',
4412 'twoGbMaxExtentFlat', 'streamOptimized'] }
4415 # @BlockdevVmdkAdapterType:
4417 # Adapter type info for VMDK images
4421 { 'enum': 'BlockdevVmdkAdapterType',
4422 'data': [ 'ide', 'buslogic', 'lsilogic', 'legacyESX'] }
4425 # @BlockdevCreateOptionsVmdk:
4427 # Driver specific image creation options for VMDK.
4429 # @file: Where to store the new image file. This refers to the image
4430 # file for monolithcSparse and streamOptimized format, or the
4431 # descriptor file for other formats.
4432 # @size: Size of the virtual disk in bytes
4433 # @extents: Where to store the data extents. Required for monolithcFlat,
4434 # twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For
4435 # monolithicFlat, only one entry is required; for
4436 # twoGbMaxExtent* formats, the number of entries required is
4437 # calculated as extent_number = virtual_size / 2GB. Providing
4438 # more extents than will be used is an error.
4439 # @subformat: The subformat of the VMDK image. Default: "monolithicSparse".
4440 # @backing-file: The path of backing file. Default: no backing file is used.
4441 # @adapter-type: The adapter type used to fill in the descriptor. Default: ide.
4442 # @hwversion: Hardware version. The meaningful options are "4" or "6".
4444 # @zeroed-grain: Whether to enable zeroed-grain feature for sparse subformats.
4449 { 'struct': 'BlockdevCreateOptionsVmdk',
4450 'data': { 'file': 'BlockdevRef',
4452 '*extents': ['BlockdevRef'],
4453 '*subformat': 'BlockdevVmdkSubformat',
4454 '*backing-file': 'str',
4455 '*adapter-type': 'BlockdevVmdkAdapterType',
4456 '*hwversion': 'str',
4457 '*zeroed-grain': 'bool' } }
4461 # @SheepdogRedundancyType:
4463 # @full: Create a fully replicated vdi with x copies
4464 # @erasure-coded: Create an erasure coded vdi with x data strips and
4469 { 'enum': 'SheepdogRedundancyType',
4470 'data': [ 'full', 'erasure-coded' ] }
4473 # @SheepdogRedundancyFull:
4475 # @copies: Number of copies to use (between 1 and 31)
4479 { 'struct': 'SheepdogRedundancyFull',
4480 'data': { 'copies': 'int' }}
4483 # @SheepdogRedundancyErasureCoded:
4485 # @data-strips: Number of data strips to use (one of {2,4,8,16})
4486 # @parity-strips: Number of parity strips to use (between 1 and 15)
4490 { 'struct': 'SheepdogRedundancyErasureCoded',
4491 'data': { 'data-strips': 'int',
4492 'parity-strips': 'int' }}
4495 # @SheepdogRedundancy:
4499 { 'union': 'SheepdogRedundancy',
4500 'base': { 'type': 'SheepdogRedundancyType' },
4501 'discriminator': 'type',
4502 'data': { 'full': 'SheepdogRedundancyFull',
4503 'erasure-coded': 'SheepdogRedundancyErasureCoded' } }
4506 # @BlockdevCreateOptionsSheepdog:
4508 # Driver specific image creation options for Sheepdog.
4510 # @location: Where to store the new image file
4511 # @size: Size of the virtual disk in bytes
4512 # @backing-file: File name of a base image
4513 # @preallocation: Preallocation mode for the new image (default: off;
4514 # allowed values: off, full)
4515 # @redundancy: Redundancy of the image
4516 # @object-size: Object size of the image
4520 { 'struct': 'BlockdevCreateOptionsSheepdog',
4521 'data': { 'location': 'BlockdevOptionsSheepdog',
4523 '*backing-file': 'str',
4524 '*preallocation': 'PreallocMode',
4525 '*redundancy': 'SheepdogRedundancy',
4526 '*object-size': 'size' } }
4529 # @BlockdevCreateOptionsSsh:
4531 # Driver specific image creation options for SSH.
4533 # @location: Where to store the new image file
4534 # @size: Size of the virtual disk in bytes
4538 { 'struct': 'BlockdevCreateOptionsSsh',
4539 'data': { 'location': 'BlockdevOptionsSsh',
4543 # @BlockdevCreateOptionsVdi:
4545 # Driver specific image creation options for VDI.
4547 # @file: Node to create the image format on
4548 # @size: Size of the virtual disk in bytes
4549 # @preallocation: Preallocation mode for the new image (default: off;
4550 # allowed values: off, metadata)
4554 { 'struct': 'BlockdevCreateOptionsVdi',
4555 'data': { 'file': 'BlockdevRef',
4557 '*preallocation': 'PreallocMode' } }
4560 # @BlockdevVhdxSubformat:
4562 # @dynamic: Growing image file
4563 # @fixed: Preallocated fixed-size image file
4567 { 'enum': 'BlockdevVhdxSubformat',
4568 'data': [ 'dynamic', 'fixed' ] }
4571 # @BlockdevCreateOptionsVhdx:
4573 # Driver specific image creation options for vhdx.
4575 # @file: Node to create the image format on
4576 # @size: Size of the virtual disk in bytes
4577 # @log-size: Log size in bytes, must be a multiple of 1 MB
4579 # @block-size: Block size in bytes, must be a multiple of 1 MB and not
4580 # larger than 256 MB (default: automatically choose a block
4581 # size depending on the image size)
4582 # @subformat: vhdx subformat (default: dynamic)
4583 # @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-standard,
4584 # but default. Do not set to 'off' when using 'qemu-img
4585 # convert' with subformat=dynamic.
4589 { 'struct': 'BlockdevCreateOptionsVhdx',
4590 'data': { 'file': 'BlockdevRef',
4592 '*log-size': 'size',
4593 '*block-size': 'size',
4594 '*subformat': 'BlockdevVhdxSubformat',
4595 '*block-state-zero': 'bool' } }
4598 # @BlockdevVpcSubformat:
4600 # @dynamic: Growing image file
4601 # @fixed: Preallocated fixed-size image file
4605 { 'enum': 'BlockdevVpcSubformat',
4606 'data': [ 'dynamic', 'fixed' ] }
4609 # @BlockdevCreateOptionsVpc:
4611 # Driver specific image creation options for vpc (VHD).
4613 # @file: Node to create the image format on
4614 # @size: Size of the virtual disk in bytes
4615 # @subformat: vhdx subformat (default: dynamic)
4616 # @force-size: Force use of the exact byte size instead of rounding to the
4617 # next size that can be represented in CHS geometry
4622 { 'struct': 'BlockdevCreateOptionsVpc',
4623 'data': { 'file': 'BlockdevRef',
4625 '*subformat': 'BlockdevVpcSubformat',
4626 '*force-size': 'bool' } }
4629 # @BlockdevCreateOptions:
4631 # Options for creating an image format on a given node.
4633 # @driver: block driver to create the image format
4637 { 'union': 'BlockdevCreateOptions',
4639 'driver': 'BlockdevDriver' },
4640 'discriminator': 'driver',
4642 'file': 'BlockdevCreateOptionsFile',
4643 'gluster': 'BlockdevCreateOptionsGluster',
4644 'luks': 'BlockdevCreateOptionsLUKS',
4645 'nfs': 'BlockdevCreateOptionsNfs',
4646 'parallels': 'BlockdevCreateOptionsParallels',
4647 'qcow': 'BlockdevCreateOptionsQcow',
4648 'qcow2': 'BlockdevCreateOptionsQcow2',
4649 'qed': 'BlockdevCreateOptionsQed',
4650 'rbd': 'BlockdevCreateOptionsRbd',
4651 'sheepdog': 'BlockdevCreateOptionsSheepdog',
4652 'ssh': 'BlockdevCreateOptionsSsh',
4653 'vdi': 'BlockdevCreateOptionsVdi',
4654 'vhdx': 'BlockdevCreateOptionsVhdx',
4655 'vmdk': 'BlockdevCreateOptionsVmdk',
4656 'vpc': 'BlockdevCreateOptionsVpc'
4662 # Starts a job to create an image format on a given node. The job is
4663 # automatically finalized, but a manual job-dismiss is required.
4665 # @job-id: Identifier for the newly created job.
4667 # @options: Options for the image creation.
4671 { 'command': 'blockdev-create',
4672 'data': { 'job-id': 'str',
4673 'options': 'BlockdevCreateOptions' } }
4676 # @BlockdevAmendOptionsLUKS:
4678 # Driver specific image amend options for LUKS.
4682 { 'struct': 'BlockdevAmendOptionsLUKS',
4683 'base': 'QCryptoBlockAmendOptionsLUKS',
4688 # @BlockdevAmendOptionsQcow2:
4690 # Driver specific image amend options for qcow2.
4691 # For now, only encryption options can be amended
4693 # @encrypt Encryption options to be amended
4697 { 'struct': 'BlockdevAmendOptionsQcow2',
4698 'data': { '*encrypt': 'QCryptoBlockAmendOptions' } }
4701 # @BlockdevAmendOptions:
4703 # Options for amending an image format
4705 # @driver: Block driver of the node to amend.
4709 { 'union': 'BlockdevAmendOptions',
4711 'driver': 'BlockdevDriver' },
4712 'discriminator': 'driver',
4714 'luks': 'BlockdevAmendOptionsLUKS',
4715 'qcow2': 'BlockdevAmendOptionsQcow2' } }
4718 # @x-blockdev-amend:
4720 # Starts a job to amend format specific options of an existing open block device
4721 # The job is automatically finalized, but a manual job-dismiss is required.
4723 # @job-id: Identifier for the newly created job.
4725 # @node-name: Name of the block node to work on
4727 # @options: Options (driver specific)
4729 # @force: Allow unsafe operations, format specific
4730 # For luks that allows erase of the last active keyslot
4731 # (permanent loss of data),
4732 # and replacement of an active keyslot
4733 # (possible loss of data if IO error happens)
4737 { 'command': 'x-blockdev-amend',
4738 'data': { 'job-id': 'str',
4740 'options': 'BlockdevAmendOptions',
4741 '*force': 'bool' } }
4744 # @BlockErrorAction:
4746 # An enumeration of action that has been taken when a DISK I/O occurs
4748 # @ignore: error has been ignored
4750 # @report: error has been reported to the device
4752 # @stop: error caused VM to be stopped
4756 { 'enum': 'BlockErrorAction',
4757 'data': [ 'ignore', 'report', 'stop' ] }
4761 # @BLOCK_IMAGE_CORRUPTED:
4763 # Emitted when a disk image is being marked corrupt. The image can be
4764 # identified by its device or node name. The 'device' field is always
4765 # present for compatibility reasons, but it can be empty ("") if the
4766 # image does not have a device name associated.
4768 # @device: device name. This is always present for compatibility
4769 # reasons, but it can be empty ("") if the image does not
4770 # have a device name associated.
4772 # @node-name: node name (Since: 2.4)
4774 # @msg: informative message for human consumption, such as the kind of
4775 # corruption being detected. It should not be parsed by machine as it is
4776 # not guaranteed to be stable
4778 # @offset: if the corruption resulted from an image access, this is
4779 # the host's access offset into the image
4781 # @size: if the corruption resulted from an image access, this is
4784 # @fatal: if set, the image is marked corrupt and therefore unusable after this
4785 # event and must be repaired (Since 2.2; before, every
4786 # BLOCK_IMAGE_CORRUPTED event was fatal)
4788 # Note: If action is "stop", a STOP event will eventually follow the
4789 # BLOCK_IO_ERROR event.
4793 # <- { "event": "BLOCK_IMAGE_CORRUPTED",
4794 # "data": { "device": "ide0-hd0", "node-name": "node0",
4795 # "msg": "Prevented active L1 table overwrite", "offset": 196608,
4797 # "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
4801 { 'event': 'BLOCK_IMAGE_CORRUPTED',
4802 'data': { 'device' : 'str',
4803 '*node-name' : 'str',
4807 'fatal' : 'bool' } }
4812 # Emitted when a disk I/O error occurs
4814 # @device: device name. This is always present for compatibility
4815 # reasons, but it can be empty ("") if the image does not
4816 # have a device name associated.
4818 # @node-name: node name. Note that errors may be reported for the root node
4819 # that is directly attached to a guest device rather than for the
4820 # node where the error occurred. The node name is not present if
4821 # the drive is empty. (Since: 2.8)
4823 # @operation: I/O operation
4825 # @action: action that has been taken
4827 # @nospace: true if I/O error was caused due to a no-space
4828 # condition. This key is only present if query-block's
4829 # io-status is present, please see query-block documentation
4830 # for more information (since: 2.2)
4832 # @reason: human readable string describing the error cause.
4833 # (This field is a debugging aid for humans, it should not
4834 # be parsed by applications) (since: 2.2)
4836 # Note: If action is "stop", a STOP event will eventually follow the
4837 # BLOCK_IO_ERROR event
4843 # <- { "event": "BLOCK_IO_ERROR",
4844 # "data": { "device": "ide0-hd1",
4845 # "node-name": "#block212",
4846 # "operation": "write",
4847 # "action": "stop" },
4848 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
4851 { 'event': 'BLOCK_IO_ERROR',
4852 'data': { 'device': 'str', '*node-name': 'str',
4853 'operation': 'IoOperationType',
4854 'action': 'BlockErrorAction', '*nospace': 'bool',
4858 # @BLOCK_JOB_COMPLETED:
4860 # Emitted when a block job has completed
4864 # @device: The job identifier. Originally the device name but other
4865 # values are allowed since QEMU 2.7
4867 # @len: maximum progress value
4869 # @offset: current progress value. On success this is equal to len.
4870 # On failure this is less than len
4872 # @speed: rate limit, bytes per second
4874 # @error: error message. Only present on failure. This field
4875 # contains a human-readable error message. There are no semantics
4876 # other than that streaming has failed and clients should not try to
4877 # interpret the error string
4883 # <- { "event": "BLOCK_JOB_COMPLETED",
4884 # "data": { "type": "stream", "device": "virtio-disk0",
4885 # "len": 10737418240, "offset": 10737418240,
4887 # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
4890 { 'event': 'BLOCK_JOB_COMPLETED',
4891 'data': { 'type' : 'JobType',
4899 # @BLOCK_JOB_CANCELLED:
4901 # Emitted when a block job has been cancelled
4905 # @device: The job identifier. Originally the device name but other
4906 # values are allowed since QEMU 2.7
4908 # @len: maximum progress value
4910 # @offset: current progress value. On success this is equal to len.
4911 # On failure this is less than len
4913 # @speed: rate limit, bytes per second
4919 # <- { "event": "BLOCK_JOB_CANCELLED",
4920 # "data": { "type": "stream", "device": "virtio-disk0",
4921 # "len": 10737418240, "offset": 134217728,
4923 # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
4926 { 'event': 'BLOCK_JOB_CANCELLED',
4927 'data': { 'type' : 'JobType',
4936 # Emitted when a block job encounters an error
4938 # @device: The job identifier. Originally the device name but other
4939 # values are allowed since QEMU 2.7
4941 # @operation: I/O operation
4943 # @action: action that has been taken
4949 # <- { "event": "BLOCK_JOB_ERROR",
4950 # "data": { "device": "ide0-hd1",
4951 # "operation": "write",
4952 # "action": "stop" },
4953 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
4956 { 'event': 'BLOCK_JOB_ERROR',
4957 'data': { 'device' : 'str',
4958 'operation': 'IoOperationType',
4959 'action' : 'BlockErrorAction' } }
4964 # Emitted when a block job is ready to complete
4968 # @device: The job identifier. Originally the device name but other
4969 # values are allowed since QEMU 2.7
4971 # @len: maximum progress value
4973 # @offset: current progress value. On success this is equal to len.
4974 # On failure this is less than len
4976 # @speed: rate limit, bytes per second
4978 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
4985 # <- { "event": "BLOCK_JOB_READY",
4986 # "data": { "device": "drive0", "type": "mirror", "speed": 0,
4987 # "len": 2097152, "offset": 2097152 }
4988 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
4991 { 'event': 'BLOCK_JOB_READY',
4992 'data': { 'type' : 'JobType',
4999 # @BLOCK_JOB_PENDING:
5001 # Emitted when a block job is awaiting explicit authorization to finalize graph
5002 # changes via @block-job-finalize. If this job is part of a transaction, it will
5003 # not emit this event until the transaction has converged first.
5007 # @id: The job identifier.
5013 # <- { "event": "BLOCK_JOB_WAITING",
5014 # "data": { "device": "drive0", "type": "mirror" },
5015 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
5018 { 'event': 'BLOCK_JOB_PENDING',
5019 'data': { 'type' : 'JobType',
5025 # Preallocation mode of QEMU image file
5027 # @off: no preallocation
5028 # @metadata: preallocate only for metadata
5029 # @falloc: like @full preallocation but allocate disk space by
5030 # posix_fallocate() rather than writing data.
5031 # @full: preallocate all data by writing it to the device to ensure
5032 # disk space is really available. This data may or may not be
5033 # zero, depending on the image format and storage.
5034 # @full preallocation also sets up metadata correctly.
5038 { 'enum': 'PreallocMode',
5039 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
5042 # @BLOCK_WRITE_THRESHOLD:
5044 # Emitted when writes on block device reaches or exceeds the
5045 # configured write threshold. For thin-provisioned devices, this
5046 # means the device should be extended to avoid pausing for
5048 # The event is one shot. Once triggered, it needs to be
5049 # re-registered with another block-set-write-threshold command.
5051 # @node-name: graph node name on which the threshold was exceeded.
5053 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
5055 # @write-threshold: last configured threshold, in bytes.
5059 { 'event': 'BLOCK_WRITE_THRESHOLD',
5060 'data': { 'node-name': 'str',
5061 'amount-exceeded': 'uint64',
5062 'write-threshold': 'uint64' } }
5065 # @block-set-write-threshold:
5067 # Change the write threshold for a block drive. An event will be
5068 # delivered if a write to this block drive crosses the configured
5069 # threshold. The threshold is an offset, thus must be
5070 # non-negative. Default is no write threshold. Setting the threshold
5071 # to zero disables it.
5073 # This is useful to transparently resize thin-provisioned drives without
5074 # the guest OS noticing.
5076 # @node-name: graph node name on which the threshold must be set.
5078 # @write-threshold: configured threshold for the block device, bytes.
5079 # Use 0 to disable the threshold.
5085 # -> { "execute": "block-set-write-threshold",
5086 # "arguments": { "node-name": "mydev",
5087 # "write-threshold": 17179869184 } }
5088 # <- { "return": {} }
5091 { 'command': 'block-set-write-threshold',
5092 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }
5095 # @x-blockdev-change:
5097 # Dynamically reconfigure the block driver state graph. It can be used
5098 # to add, remove, insert or replace a graph node. Currently only the
5099 # Quorum driver implements this feature to add or remove its child. This
5100 # is useful to fix a broken quorum child.
5102 # If @node is specified, it will be inserted under @parent. @child
5103 # may not be specified in this case. If both @parent and @child are
5104 # specified but @node is not, @child will be detached from @parent.
5106 # @parent: the id or name of the parent node.
5108 # @child: the name of a child under the given parent node.
5110 # @node: the name of the node that will be added.
5112 # Note: this command is experimental, and its API is not stable. It
5113 # does not support all kinds of operations, all kinds of children, nor
5114 # all block drivers.
5116 # FIXME Removing children from a quorum node means introducing gaps in the
5117 # child indices. This cannot be represented in the 'children' list of
5118 # BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename().
5120 # Warning: The data in a new quorum child MUST be consistent with that of
5121 # the rest of the array.
5127 # 1. Add a new node to a quorum
5128 # -> { "execute": "blockdev-add",
5131 # "node-name": "new_node",
5132 # "file": { "driver": "file",
5133 # "filename": "test.raw" } } }
5134 # <- { "return": {} }
5135 # -> { "execute": "x-blockdev-change",
5136 # "arguments": { "parent": "disk1",
5137 # "node": "new_node" } }
5138 # <- { "return": {} }
5140 # 2. Delete a quorum's node
5141 # -> { "execute": "x-blockdev-change",
5142 # "arguments": { "parent": "disk1",
5143 # "child": "children.1" } }
5144 # <- { "return": {} }
5147 { 'command': 'x-blockdev-change',
5148 'data' : { 'parent': 'str',
5153 # @x-blockdev-set-iothread:
5155 # Move @node and its children into the @iothread. If @iothread is null then
5156 # move @node and its children into the main loop.
5158 # The node must not be attached to a BlockBackend.
5160 # @node-name: the name of the block driver node
5162 # @iothread: the name of the IOThread object or null for the main loop
5164 # @force: true if the node and its children should be moved when a BlockBackend
5165 # is already attached
5167 # Note: this command is experimental and intended for test cases that need
5168 # control over IOThreads only.
5174 # 1. Move a node into an IOThread
5175 # -> { "execute": "x-blockdev-set-iothread",
5176 # "arguments": { "node-name": "disk1",
5177 # "iothread": "iothread0" } }
5178 # <- { "return": {} }
5180 # 2. Move a node into the main loop
5181 # -> { "execute": "x-blockdev-set-iothread",
5182 # "arguments": { "node-name": "disk1",
5183 # "iothread": null } }
5184 # <- { "return": {} }
5187 { 'command': 'x-blockdev-set-iothread',
5188 'data' : { 'node-name': 'str',
5189 'iothread': 'StrOrNull',
5190 '*force': 'bool' } }
5193 # @NbdServerOptions:
5195 # @addr: Address on which to listen.
5196 # @tls-creds: ID of the TLS credentials object (since 2.6).
5197 # @tls-authz: ID of the QAuthZ authorization object used to validate
5198 # the client's x509 distinguished name. This object is
5199 # is only resolved at time of use, so can be deleted and
5200 # recreated on the fly while the NBD server is active.
5201 # If missing, it will default to denying access (since 4.0).
5203 # Keep this type consistent with the nbd-server-start arguments. The only
5204 # intended difference is using SocketAddress instead of SocketAddressLegacy.
5208 { 'struct': 'NbdServerOptions',
5209 'data': { 'addr': 'SocketAddress',
5210 '*tls-creds': 'str',
5211 '*tls-authz': 'str'} }
5214 # @nbd-server-start:
5216 # Start an NBD server listening on the given host and port. Block
5217 # devices can then be exported using @nbd-server-add. The NBD
5218 # server will present them as named exports; for example, another
5219 # QEMU instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
5221 # @addr: Address on which to listen.
5222 # @tls-creds: ID of the TLS credentials object (since 2.6).
5223 # @tls-authz: ID of the QAuthZ authorization object used to validate
5224 # the client's x509 distinguished name. This object is
5225 # is only resolved at time of use, so can be deleted and
5226 # recreated on the fly while the NBD server is active.
5227 # If missing, it will default to denying access (since 4.0).
5229 # Returns: error if the server is already running.
5231 # Keep this type consistent with the NbdServerOptions type. The only intended
5232 # difference is using SocketAddressLegacy instead of SocketAddress.
5236 { 'command': 'nbd-server-start',
5237 'data': { 'addr': 'SocketAddressLegacy',
5238 '*tls-creds': 'str',
5239 '*tls-authz': 'str'} }
5244 # An NBD block export.
5246 # @device: The device name or node name of the node to be exported
5248 # @name: Export name. If unspecified, the @device parameter is used as the
5249 # export name. (Since 2.12)
5251 # @description: Free-form description of the export, up to 4096 bytes.
5254 # @writable: Whether clients should be able to write to the device via the
5255 # NBD connection (default false).
5257 # @bitmap: Also export the dirty bitmap reachable from @device, so the
5258 # NBD client can use NBD_OPT_SET_META_CONTEXT with
5259 # "qemu:dirty-bitmap:NAME" to inspect the bitmap. (since 4.0)
5263 { 'struct': 'BlockExportNbd',
5264 'data': {'device': 'str', '*name': 'str', '*description': 'str',
5265 '*writable': 'bool', '*bitmap': 'str' } }
5270 # Export a block node to QEMU's embedded NBD server.
5272 # Returns: error if the server is not running, or export with the same name
5277 { 'command': 'nbd-server-add',
5278 'data': 'BlockExportNbd', 'boxed': true }
5281 # @NbdServerRemoveMode:
5283 # Mode for removing an NBD export.
5285 # @safe: Remove export if there are no existing connections, fail otherwise.
5287 # @hard: Drop all connections immediately and remove export.
5289 # Potential additional modes to be added in the future:
5291 # hide: Just hide export from new clients, leave existing connections as is.
5292 # Remove export after all clients are disconnected.
5294 # soft: Hide export from new clients, answer with ESHUTDOWN for all further
5295 # requests from existing clients.
5299 {'enum': 'NbdServerRemoveMode', 'data': ['safe', 'hard']}
5302 # @nbd-server-remove:
5304 # Remove NBD export by name.
5306 # @name: Export name.
5308 # @mode: Mode of command operation. See @NbdServerRemoveMode description.
5309 # Default is 'safe'.
5312 # - the server is not running
5313 # - export is not found
5314 # - mode is 'safe' and there are existing connections
5318 { 'command': 'nbd-server-remove',
5319 'data': {'name': 'str', '*mode': 'NbdServerRemoveMode'} }
5324 # Stop QEMU's embedded NBD server, and unregister all devices previously
5325 # added via @nbd-server-add.
5329 { 'command': 'nbd-server-stop' }
5334 # An enumeration of block export types
5340 { 'enum': 'BlockExportType',
5346 # Describes a block export, i.e. how single node should be exported on an
5347 # external interface.
5351 { 'union': 'BlockExport',
5352 'base': { 'type': 'BlockExportType' },
5353 'discriminator': 'type',
5355 'nbd': 'BlockExportNbd'
5361 # An enumeration of the quorum operation types
5363 # @read: read operation
5365 # @write: write operation
5367 # @flush: flush operation
5371 { 'enum': 'QuorumOpType',
5372 'data': [ 'read', 'write', 'flush' ] }
5377 # Emitted by the Quorum block driver if it fails to establish a quorum
5379 # @reference: device name if defined else node name
5381 # @sector-num: number of the first sector of the failed read operation
5383 # @sectors-count: failed read operation sector count
5385 # Note: This event is rate-limited.
5391 # <- { "event": "QUORUM_FAILURE",
5392 # "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
5393 # "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
5396 { 'event': 'QUORUM_FAILURE',
5397 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } }
5400 # @QUORUM_REPORT_BAD:
5402 # Emitted to report a corruption of a Quorum file
5404 # @type: quorum operation type (Since 2.6)
5406 # @error: error message. Only present on failure. This field
5407 # contains a human-readable error message. There are no semantics other
5408 # than that the block layer reported an error and clients should not
5409 # try to interpret the error string.
5411 # @node-name: the graph node name of the block driver state
5413 # @sector-num: number of the first sector of the failed read operation
5415 # @sectors-count: failed read operation sector count
5417 # Note: This event is rate-limited.
5425 # { "event": "QUORUM_REPORT_BAD",
5426 # "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5,
5428 # "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
5430 # 2. Flush operation
5432 # { "event": "QUORUM_REPORT_BAD",
5433 # "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120,
5434 # "type": "flush", "error": "Broken pipe" },
5435 # "timestamp": { "seconds": 1456406829, "microseconds": 291763 } }
5438 { 'event': 'QUORUM_REPORT_BAD',
5439 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str',
5440 'sector-num': 'int', 'sectors-count': 'int' } }
5443 # @BlockdevSnapshotInternal:
5445 # @device: the device name or node-name of a root node to generate the snapshot
5448 # @name: the name of the internal snapshot to be created
5450 # Notes: In transaction, if @name is empty, or any snapshot matching @name
5451 # exists, the operation will fail. Only some image formats support it,
5452 # for example, qcow2, rbd, and sheepdog.
5456 { 'struct': 'BlockdevSnapshotInternal',
5457 'data': { 'device': 'str', 'name': 'str' } }
5460 # @blockdev-snapshot-internal-sync:
5462 # Synchronously take an internal snapshot of a block device, when the
5463 # format of the image used supports it. If the name is an empty
5464 # string, or a snapshot with name already exists, the operation will
5467 # For the arguments, see the documentation of BlockdevSnapshotInternal.
5469 # Returns: - nothing on success
5470 # - If @device is not a valid block device, GenericError
5471 # - If any snapshot matching @name exists, or @name is empty,
5473 # - If the format of the image used does not support it,
5474 # BlockFormatFeatureNotSupported
5480 # -> { "execute": "blockdev-snapshot-internal-sync",
5481 # "arguments": { "device": "ide-hd0",
5482 # "name": "snapshot0" }
5484 # <- { "return": {} }
5487 { 'command': 'blockdev-snapshot-internal-sync',
5488 'data': 'BlockdevSnapshotInternal' }
5491 # @blockdev-snapshot-delete-internal-sync:
5493 # Synchronously delete an internal snapshot of a block device, when the format
5494 # of the image used support it. The snapshot is identified by name or id or
5495 # both. One of the name or id is required. Return SnapshotInfo for the
5496 # successfully deleted snapshot.
5498 # @device: the device name or node-name of a root node to delete the snapshot
5501 # @id: optional the snapshot's ID to be deleted
5503 # @name: optional the snapshot's name to be deleted
5505 # Returns: - SnapshotInfo on success
5506 # - If @device is not a valid block device, GenericError
5507 # - If snapshot not found, GenericError
5508 # - If the format of the image used does not support it,
5509 # BlockFormatFeatureNotSupported
5510 # - If @id and @name are both not specified, GenericError
5516 # -> { "execute": "blockdev-snapshot-delete-internal-sync",
5517 # "arguments": { "device": "ide-hd0",
5518 # "name": "snapshot0" }
5522 # "name": "snapshot0",
5523 # "vm-state-size": 0,
5524 # "date-sec": 1000012,
5526 # "vm-clock-sec": 100,
5527 # "vm-clock-nsec": 20
5532 { 'command': 'blockdev-snapshot-delete-internal-sync',
5533 'data': { 'device': 'str', '*id': 'str', '*name': 'str'},
5534 'returns': 'SnapshotInfo' }