| blob | 42c885047f451976d0dd1ced0db52e8f3b3ea1ad |
1 # -*- Mode: Python -*-
2 #
3 # QAPI block core definitions (vm unrelated)
5 # QAPI common definitions
6 { 'include': 'common.json' }
8 ##
9 # @SnapshotInfo
10 #
11 # @id: unique snapshot id
12 #
13 # @name: user chosen name
14 #
15 # @vm-state-size: size of the VM state
16 #
17 # @date-sec: UTC date of the snapshot in seconds
18 #
19 # @date-nsec: fractional part in nano seconds to be used with date-sec
20 #
21 # @vm-clock-sec: VM clock relative to boot in seconds
22 #
23 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
24 #
25 # Since: 1.3
26 #
27 ##
29 { 'type': 'SnapshotInfo',
30 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
31 'date-sec': 'int', 'date-nsec': 'int',
32 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
34 ##
35 # @ImageInfoSpecificQCow2:
36 #
37 # @compat: compatibility level
38 #
39 # @lazy-refcounts: #optional on or off; only valid for compat >= 1.1
40 #
41 # @corrupt: #optional true if the image has been marked corrupt; only valid for
42 # compat >= 1.1 (since 2.2)
43 #
44 # @refcount-bits: width of a refcount entry in bits (since 2.3)
45 #
46 # Since: 1.7
47 ##
48 { 'type': 'ImageInfoSpecificQCow2',
49 'data': {
50 'compat': 'str',
51 '*lazy-refcounts': 'bool',
52 '*corrupt': 'bool',
53 'refcount-bits': 'int'
54 } }
56 ##
57 # @ImageInfoSpecificVmdk:
58 #
59 # @create-type: The create type of VMDK image
60 #
61 # @cid: Content id of image
62 #
63 # @parent-cid: Parent VMDK image's cid
64 #
65 # @extents: List of extent files
66 #
67 # Since: 1.7
68 ##
69 { 'type': 'ImageInfoSpecificVmdk',
70 'data': {
71 'create-type': 'str',
72 'cid': 'int',
73 'parent-cid': 'int',
74 'extents': ['ImageInfo']
75 } }
77 ##
78 # @ImageInfoSpecific:
79 #
80 # A discriminated record of image format specific information structures.
81 #
82 # Since: 1.7
83 ##
85 { 'union': 'ImageInfoSpecific',
86 'data': {
87 'qcow2': 'ImageInfoSpecificQCow2',
88 'vmdk': 'ImageInfoSpecificVmdk'
89 } }
91 ##
92 # @ImageInfo:
93 #
94 # Information about a QEMU image file
95 #
96 # @filename: name of the image file
97 #
98 # @format: format of the image file
99 #
100 # @virtual-size: maximum capacity in bytes of the image
101 #
102 # @actual-size: #optional actual size on disk in bytes of the image
103 #
104 # @dirty-flag: #optional true if image is not cleanly closed
105 #
106 # @cluster-size: #optional size of a cluster in bytes
107 #
108 # @encrypted: #optional true if the image is encrypted
109 #
110 # @compressed: #optional true if the image is compressed (Since 1.7)
111 #
112 # @backing-filename: #optional name of the backing file
113 #
114 # @full-backing-filename: #optional full path of the backing file
115 #
116 # @backing-filename-format: #optional the format of the backing file
117 #
118 # @snapshots: #optional list of VM snapshots
119 #
120 # @backing-image: #optional info of the backing image (since 1.6)
121 #
122 # @format-specific: #optional structure supplying additional format-specific
123 # information (since 1.7)
124 #
125 # Since: 1.3
126 #
127 ##
129 { 'type': 'ImageInfo',
130 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
131 '*actual-size': 'int', 'virtual-size': 'int',
132 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
133 '*backing-filename': 'str', '*full-backing-filename': 'str',
134 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
135 '*backing-image': 'ImageInfo',
136 '*format-specific': 'ImageInfoSpecific' } }
138 ##
139 # @ImageCheck:
140 #
141 # Information about a QEMU image file check
142 #
143 # @filename: name of the image file checked
144 #
145 # @format: format of the image file checked
146 #
147 # @check-errors: number of unexpected errors occurred during check
148 #
149 # @image-end-offset: #optional offset (in bytes) where the image ends, this
150 # field is present if the driver for the image format
151 # supports it
152 #
153 # @corruptions: #optional number of corruptions found during the check if any
154 #
155 # @leaks: #optional number of leaks found during the check if any
156 #
157 # @corruptions-fixed: #optional number of corruptions fixed during the check
158 # if any
159 #
160 # @leaks-fixed: #optional number of leaks fixed during the check if any
161 #
162 # @total-clusters: #optional total number of clusters, this field is present
163 # if the driver for the image format supports it
164 #
165 # @allocated-clusters: #optional total number of allocated clusters, this
166 # field is present if the driver for the image format
167 # supports it
168 #
169 # @fragmented-clusters: #optional total number of fragmented clusters, this
170 # field is present if the driver for the image format
171 # supports it
172 #
173 # @compressed-clusters: #optional total number of compressed clusters, this
174 # field is present if the driver for the image format
175 # supports it
176 #
177 # Since: 1.4
178 #
179 ##
181 { 'type': 'ImageCheck',
182 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
183 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
184 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
185 '*total-clusters': 'int', '*allocated-clusters': 'int',
186 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
188 ##
189 # @BlockdevCacheInfo
190 #
191 # Cache mode information for a block device
192 #
193 # @writeback: true if writeback mode is enabled
194 # @direct: true if the host page cache is bypassed (O_DIRECT)
195 # @no-flush: true if flush requests are ignored for the device
196 #
197 # Since: 2.3
198 ##
199 { 'type': 'BlockdevCacheInfo',
200 'data': { 'writeback': 'bool',
201 'direct': 'bool',
202 'no-flush': 'bool' } }
204 ##
205 # @BlockDeviceInfo:
206 #
207 # Information about the backing device for a block device.
208 #
209 # @file: the filename of the backing device
210 #
211 # @node-name: #optional the name of the block driver node (Since 2.0)
212 #
213 # @ro: true if the backing device was open read-only
214 #
215 # @drv: the name of the block format used to open the backing device. As of
216 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
217 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
218 # 'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
219 # 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
220 # 2.2: 'archipelago' added, 'cow' dropped
221 #
222 # @backing_file: #optional the name of the backing file (for copy-on-write)
223 #
224 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
225 #
226 # @encrypted: true if the backing device is encrypted
227 #
228 # @encryption_key_missing: true if the backing device is encrypted but an
229 # valid encryption key is missing
230 #
231 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
232 #
233 # @bps: total throughput limit in bytes per second is specified
234 #
235 # @bps_rd: read throughput limit in bytes per second is specified
236 #
237 # @bps_wr: write throughput limit in bytes per second is specified
238 #
239 # @iops: total I/O operations per second is specified
240 #
241 # @iops_rd: read I/O operations per second is specified
242 #
243 # @iops_wr: write I/O operations per second is specified
244 #
245 # @image: the info of image used (since: 1.6)
246 #
247 # @bps_max: #optional total max in bytes (Since 1.7)
248 #
249 # @bps_rd_max: #optional read max in bytes (Since 1.7)
250 #
251 # @bps_wr_max: #optional write max in bytes (Since 1.7)
252 #
253 # @iops_max: #optional total I/O operations max (Since 1.7)
254 #
255 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
256 #
257 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
258 #
259 # @iops_size: #optional an I/O size in bytes (Since 1.7)
260 #
261 # @cache: the cache mode used for the block device (since: 2.3)
262 #
263 # @write_threshold: configured write threshold for the device.
264 # 0 if disabled. (Since 2.3)
265 #
266 # Since: 0.14.0
267 #
268 ##
269 { 'type': 'BlockDeviceInfo',
270 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
271 '*backing_file': 'str', 'backing_file_depth': 'int',
272 'encrypted': 'bool', 'encryption_key_missing': 'bool',
273 'detect_zeroes': 'BlockdevDetectZeroesOptions',
274 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
275 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
276 'image': 'ImageInfo',
277 '*bps_max': 'int', '*bps_rd_max': 'int',
278 '*bps_wr_max': 'int', '*iops_max': 'int',
279 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
280 '*iops_size': 'int', 'cache': 'BlockdevCacheInfo',
281 'write_threshold': 'int' } }
283 ##
284 # @BlockDeviceIoStatus:
285 #
286 # An enumeration of block device I/O status.
287 #
288 # @ok: The last I/O operation has succeeded
289 #
290 # @failed: The last I/O operation has failed
291 #
292 # @nospace: The last I/O operation has failed due to a no-space condition
293 #
294 # Since: 1.0
295 ##
296 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
298 ##
299 # @BlockDeviceMapEntry:
300 #
301 # Entry in the metadata map of the device (returned by "qemu-img map")
302 #
303 # @start: Offset in the image of the first byte described by this entry
304 # (in bytes)
305 #
306 # @length: Length of the range described by this entry (in bytes)
307 #
308 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
309 # before reaching one for which the range is allocated. The value is
310 # in the range 0 to the depth of the image chain - 1.
311 #
312 # @zero: the sectors in this range read as zeros
313 #
314 # @data: reading the image will actually read data from a file (in particular,
315 # if @offset is present this means that the sectors are not simply
316 # preallocated, but contain actual data in raw format)
317 #
318 # @offset: if present, the image file stores the data for this range in
319 # raw format at the given offset.
320 #
321 # Since 1.7
322 ##
323 { 'type': 'BlockDeviceMapEntry',
324 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
325 'data': 'bool', '*offset': 'int' } }
327 ##
328 # @BlockDirtyInfo:
329 #
330 # Block dirty bitmap information.
331 #
332 # @count: number of dirty bytes according to the dirty bitmap
333 #
334 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
335 #
336 # Since: 1.3
337 ##
338 { 'type': 'BlockDirtyInfo',
339 'data': {'count': 'int', 'granularity': 'int'} }
341 ##
342 # @BlockInfo:
343 #
344 # Block device information. This structure describes a virtual device and
345 # the backing device associated with it.
346 #
347 # @device: The device name associated with the virtual device.
348 #
349 # @type: This field is returned only for compatibility reasons, it should
350 # not be used (always returns 'unknown')
351 #
352 # @removable: True if the device supports removable media.
353 #
354 # @locked: True if the guest has locked this device from having its media
355 # removed
356 #
357 # @tray_open: #optional True if the device has a tray and it is open
358 # (only present if removable is true)
359 #
360 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
361 # driver has one or more dirty bitmaps) (Since 2.0)
362 #
363 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
364 # supports it and the VM is configured to stop on errors
365 # (supported device models: virtio-blk, ide, scsi-disk)
366 #
367 # @inserted: #optional @BlockDeviceInfo describing the device if media is
368 # present
369 #
370 # Since: 0.14.0
371 ##
372 { 'type': 'BlockInfo',
373 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
374 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
375 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
376 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
378 ##
379 # @query-block:
380 #
381 # Get a list of BlockInfo for all virtual block devices.
382 #
383 # Returns: a list of @BlockInfo describing each virtual block device
384 #
385 # Since: 0.14.0
386 ##
387 { 'command': 'query-block', 'returns': ['BlockInfo'] }
389 ##
390 # @BlockDeviceStats:
391 #
392 # Statistics of a virtual block device or a block backing device.
393 #
394 # @rd_bytes: The number of bytes read by the device.
395 #
396 # @wr_bytes: The number of bytes written by the device.
397 #
398 # @rd_operations: The number of read operations performed by the device.
399 #
400 # @wr_operations: The number of write operations performed by the device.
401 #
402 # @flush_operations: The number of cache flush operations performed by the
403 # device (since 0.15.0)
404 #
405 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
406 # (since 0.15.0).
407 #
408 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
409 #
410 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
411 #
412 # @wr_highest_offset: The offset after the greatest byte written to the
413 # device. The intended use of this information is for
414 # growable sparse files (like qcow2) that are used on top
415 # of a physical device.
416 #
417 # @rd_merged: Number of read requests that have been merged into another
418 # request (Since 2.3).
419 #
420 # @wr_merged: Number of write requests that have been merged into another
421 # request (Since 2.3).
422 #
423 # Since: 0.14.0
424 ##
425 { 'type': 'BlockDeviceStats',
426 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
427 'wr_operations': 'int', 'flush_operations': 'int',
428 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
429 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
430 'rd_merged': 'int', 'wr_merged': 'int' } }
432 ##
433 # @BlockStats:
434 #
435 # Statistics of a virtual block device or a block backing device.
436 #
437 # @device: #optional If the stats are for a virtual block device, the name
438 # corresponding to the virtual block device.
439 #
440 # @node-name: #optional The node name of the device. (Since 2.3)
441 #
442 # @stats: A @BlockDeviceStats for the device.
443 #
444 # @parent: #optional This describes the file block device if it has one.
445 #
446 # @backing: #optional This describes the backing block device if it has one.
447 # (Since 2.0)
448 #
449 # Since: 0.14.0
450 ##
451 { 'type': 'BlockStats',
452 'data': {'*device': 'str', '*node-name': 'str',
453 'stats': 'BlockDeviceStats',
454 '*parent': 'BlockStats',
455 '*backing': 'BlockStats'} }
457 ##
458 # @query-blockstats:
459 #
460 # Query the @BlockStats for all virtual block devices.
461 #
462 # @query-nodes: #optional If true, the command will query all the block nodes
463 # that have a node name, in a list which will include "parent"
464 # information, but not "backing".
465 # If false or omitted, the behavior is as before - query all the
466 # device backends, recursively including their "parent" and
467 # "backing". (Since 2.3)
468 #
469 # Returns: A list of @BlockStats for each virtual block devices.
470 #
471 # Since: 0.14.0
472 ##
473 { 'command': 'query-blockstats',
474 'data': { '*query-nodes': 'bool' },
475 'returns': ['BlockStats'] }
477 ##
478 # @BlockdevOnError:
479 #
480 # An enumeration of possible behaviors for errors on I/O operations.
481 # The exact meaning depends on whether the I/O was initiated by a guest
482 # or by a block job
483 #
484 # @report: for guest operations, report the error to the guest;
485 # for jobs, cancel the job
486 #
487 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
488 # or BLOCK_JOB_ERROR)
489 #
490 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
491 #
492 # @stop: for guest operations, stop the virtual machine;
493 # for jobs, pause the job
494 #
495 # Since: 1.3
496 ##
497 { 'enum': 'BlockdevOnError',
498 'data': ['report', 'ignore', 'enospc', 'stop'] }
500 ##
501 # @MirrorSyncMode:
502 #
503 # An enumeration of possible behaviors for the initial synchronization
504 # phase of storage mirroring.
505 #
506 # @top: copies data in the topmost image to the destination
507 #
508 # @full: copies data from all images to the destination
509 #
510 # @none: only copy data written from now on
511 #
512 # Since: 1.3
513 ##
514 { 'enum': 'MirrorSyncMode',
515 'data': ['top', 'full', 'none'] }
517 ##
518 # @BlockJobType:
519 #
520 # Type of a block job.
521 #
522 # @commit: block commit job type, see "block-commit"
523 #
524 # @stream: block stream job type, see "block-stream"
525 #
526 # @mirror: drive mirror job type, see "drive-mirror"
527 #
528 # @backup: drive backup job type, see "drive-backup"
529 #
530 # Since: 1.7
531 ##
532 { 'enum': 'BlockJobType',
533 'data': ['commit', 'stream', 'mirror', 'backup'] }
535 ##
536 # @BlockJobInfo:
537 #
538 # Information about a long-running block device operation.
539 #
540 # @type: the job type ('stream' for image streaming)
541 #
542 # @device: the block device name
543 #
544 # @len: the maximum progress value
545 #
546 # @busy: false if the job is known to be in a quiescent state, with
547 # no pending I/O. Since 1.3.
548 #
549 # @paused: whether the job is paused or, if @busy is true, will
550 # pause itself as soon as possible. Since 1.3.
551 #
552 # @offset: the current progress value
553 #
554 # @speed: the rate limit, bytes per second
555 #
556 # @io-status: the status of the job (since 1.3)
557 #
558 # @ready: true if the job may be completed (since 2.2)
559 #
560 # Since: 1.1
561 ##
562 { 'type': 'BlockJobInfo',
563 'data': {'type': 'str', 'device': 'str', 'len': 'int',
564 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
565 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
567 ##
568 # @query-block-jobs:
569 #
570 # Return information about long-running block device operations.
571 #
572 # Returns: a list of @BlockJobInfo for each active block job
573 #
574 # Since: 1.1
575 ##
576 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
578 ##
579 # @block_passwd:
580 #
581 # This command sets the password of a block device that has not been open
582 # with a password and requires one.
583 #
584 # The two cases where this can happen are a block device is created through
585 # QEMU's initial command line or a block device is changed through the legacy
586 # @change interface.
587 #
588 # In the event that the block device is created through the initial command
589 # line, the VM will start in the stopped state regardless of whether '-S' is
590 # used. The intention is for a management tool to query the block devices to
591 # determine which ones are encrypted, set the passwords with this command, and
592 # then start the guest with the @cont command.
593 #
594 # Either @device or @node-name must be set but not both.
595 #
596 # @device: #optional the name of the block backend device to set the password on
597 #
598 # @node-name: #optional graph node name to set the password on (Since 2.0)
599 #
600 # @password: the password to use for the device
601 #
602 # Returns: nothing on success
603 # If @device is not a valid block device, DeviceNotFound
604 # If @device is not encrypted, DeviceNotEncrypted
605 #
606 # Notes: Not all block formats support encryption and some that do are not
607 # able to validate that a password is correct. Disk corruption may
608 # occur if an invalid password is specified.
609 #
610 # Since: 0.14.0
611 ##
612 { 'command': 'block_passwd', 'data': {'*device': 'str',
613 '*node-name': 'str', 'password': 'str'} }
615 ##
616 # @block_resize
617 #
618 # Resize a block image while a guest is running.
619 #
620 # Either @device or @node-name must be set but not both.
621 #
622 # @device: #optional the name of the device to get the image resized
623 #
624 # @node-name: #optional graph node name to get the image resized (Since 2.0)
625 #
626 # @size: new image size in bytes
627 #
628 # Returns: nothing on success
629 # If @device is not a valid block device, DeviceNotFound
630 #
631 # Since: 0.14.0
632 ##
633 { 'command': 'block_resize', 'data': { '*device': 'str',
634 '*node-name': 'str',
635 'size': 'int' }}
637 ##
638 # @NewImageMode
639 #
640 # An enumeration that tells QEMU how to set the backing file path in
641 # a new image file.
642 #
643 # @existing: QEMU should look for an existing image file.
644 #
645 # @absolute-paths: QEMU should create a new image with absolute paths
646 # for the backing file. If there is no backing file available, the new
647 # image will not be backed either.
648 #
649 # Since: 1.1
650 ##
651 { 'enum': 'NewImageMode',
652 'data': [ 'existing', 'absolute-paths' ] }
654 ##
655 # @BlockdevSnapshot
656 #
657 # Either @device or @node-name must be set but not both.
658 #
659 # @device: #optional the name of the device to generate the snapshot from.
660 #
661 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
662 #
663 # @snapshot-file: the target of the new image. A new file will be created.
664 #
665 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
666 #
667 # @format: #optional the format of the snapshot image, default is 'qcow2'.
668 #
669 # @mode: #optional whether and how QEMU should create a new image, default is
670 # 'absolute-paths'.
671 ##
672 { 'type': 'BlockdevSnapshot',
673 'data': { '*device': 'str', '*node-name': 'str',
674 'snapshot-file': 'str', '*snapshot-node-name': 'str',
675 '*format': 'str', '*mode': 'NewImageMode' } }
677 ##
678 # @DriveBackup
679 #
680 # @device: the name of the device which should be copied.
681 #
682 # @target: the target of the new image. If the file exists, or if it
683 # is a device, the existing file/device will be used as the new
684 # destination. If it does not exist, a new file will be created.
685 #
686 # @format: #optional the format of the new destination, default is to
687 # probe if @mode is 'existing', else the format of the source
688 #
689 # @sync: what parts of the disk image should be copied to the destination
690 # (all the disk, only the sectors allocated in the topmost image, or
691 # only new I/O).
692 #
693 # @mode: #optional whether and how QEMU should create a new image, default is
694 # 'absolute-paths'.
695 #
696 # @speed: #optional the maximum speed, in bytes per second
697 #
698 # @on-source-error: #optional the action to take on an error on the source,
699 # default 'report'. 'stop' and 'enospc' can only be used
700 # if the block device supports io-status (see BlockInfo).
701 #
702 # @on-target-error: #optional the action to take on an error on the target,
703 # default 'report' (no limitations, since this applies to
704 # a different block device than @device).
705 #
706 # Note that @on-source-error and @on-target-error only affect background I/O.
707 # If an error occurs during a guest write request, the device's rerror/werror
708 # actions will be used.
709 #
710 # Since: 1.6
711 ##
712 { 'type': 'DriveBackup',
713 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
714 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
715 '*speed': 'int',
716 '*on-source-error': 'BlockdevOnError',
717 '*on-target-error': 'BlockdevOnError' } }
719 ##
720 # @BlockdevBackup
721 #
722 # @device: the name of the device which should be copied.
723 #
724 # @target: the name of the backup target device.
725 #
726 # @sync: what parts of the disk image should be copied to the destination
727 # (all the disk, only the sectors allocated in the topmost image, or
728 # only new I/O).
729 #
730 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
731 # for unlimited.
732 #
733 # @on-source-error: #optional the action to take on an error on the source,
734 # default 'report'. 'stop' and 'enospc' can only be used
735 # if the block device supports io-status (see BlockInfo).
736 #
737 # @on-target-error: #optional the action to take on an error on the target,
738 # default 'report' (no limitations, since this applies to
739 # a different block device than @device).
740 #
741 # Note that @on-source-error and @on-target-error only affect background I/O.
742 # If an error occurs during a guest write request, the device's rerror/werror
743 # actions will be used.
744 #
745 # Since: 2.3
746 ##
747 { 'type': 'BlockdevBackup',
748 'data': { 'device': 'str', 'target': 'str',
749 'sync': 'MirrorSyncMode',
750 '*speed': 'int',
751 '*on-source-error': 'BlockdevOnError',
752 '*on-target-error': 'BlockdevOnError' } }
754 ##
755 # @blockdev-snapshot-sync
756 #
757 # Generates a synchronous snapshot of a block device.
758 #
759 # For the arguments, see the documentation of BlockdevSnapshot.
760 #
761 # Returns: nothing on success
762 # If @device is not a valid block device, DeviceNotFound
763 #
764 # Since 0.14.0
765 ##
766 { 'command': 'blockdev-snapshot-sync',
767 'data': 'BlockdevSnapshot' }
769 ##
770 # @change-backing-file
771 #
772 # Change the backing file in the image file metadata. This does not
773 # cause QEMU to reopen the image file to reparse the backing filename
774 # (it may, however, perform a reopen to change permissions from
775 # r/o -> r/w -> r/o, if needed). The new backing file string is written
776 # into the image file metadata, and the QEMU internal strings are
777 # updated.
778 #
779 # @image-node-name: The name of the block driver state node of the
780 # image to modify.
781 #
782 # @device: The name of the device that owns image-node-name.
783 #
784 # @backing-file: The string to write as the backing file. This
785 # string is not validated, so care should be taken
786 # when specifying the string or the image chain may
787 # not be able to be reopened again.
788 #
789 # Since: 2.1
790 ##
791 { 'command': 'change-backing-file',
792 'data': { 'device': 'str', 'image-node-name': 'str',
793 'backing-file': 'str' } }
795 ##
796 # @block-commit
797 #
798 # Live commit of data from overlay image nodes into backing nodes - i.e.,
799 # writes data between 'top' and 'base' into 'base'.
800 #
801 # @device: the name of the device
802 #
803 # @base: #optional The file name of the backing image to write data into.
804 # If not specified, this is the deepest backing image
805 #
806 # @top: #optional The file name of the backing image within the image chain,
807 # which contains the topmost data to be committed down. If
808 # not specified, this is the active layer.
809 #
810 # @backing-file: #optional The backing file string to write into the overlay
811 # image of 'top'. If 'top' is the active layer,
812 # specifying a backing file string is an error. This
813 # filename is not validated.
814 #
815 # If a pathname string is such that it cannot be
816 # resolved by QEMU, that means that subsequent QMP or
817 # HMP commands must use node-names for the image in
818 # question, as filename lookup methods will fail.
819 #
820 # If not specified, QEMU will automatically determine
821 # the backing file string to use, or error out if
822 # there is no obvious choice. Care should be taken
823 # when specifying the string, to specify a valid
824 # filename or protocol.
825 # (Since 2.1)
826 #
827 # If top == base, that is an error.
828 # If top == active, the job will not be completed by itself,
829 # user needs to complete the job with the block-job-complete
830 # command after getting the ready event. (Since 2.0)
831 #
832 # If the base image is smaller than top, then the base image
833 # will be resized to be the same size as top. If top is
834 # smaller than the base image, the base will not be
835 # truncated. If you want the base image size to match the
836 # size of the smaller top, you can safely truncate it
837 # yourself once the commit operation successfully completes.
838 #
839 # @speed: #optional the maximum speed, in bytes per second
840 #
841 # Returns: Nothing on success
842 # If commit or stream is already active on this device, DeviceInUse
843 # If @device does not exist, DeviceNotFound
844 # If image commit is not supported by this device, NotSupported
845 # If @base or @top is invalid, a generic error is returned
846 # If @speed is invalid, InvalidParameter
847 #
848 # Since: 1.3
849 #
850 ##
851 { 'command': 'block-commit',
852 'data': { 'device': 'str', '*base': 'str', '*top': 'str',
853 '*backing-file': 'str', '*speed': 'int' } }
855 ##
856 # @drive-backup
857 #
858 # Start a point-in-time copy of a block device to a new destination. The
859 # status of ongoing drive-backup operations can be checked with
860 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
861 # The operation can be stopped before it has completed using the
862 # block-job-cancel command.
863 #
864 # For the arguments, see the documentation of DriveBackup.
865 #
866 # Returns: nothing on success
867 # If @device is not a valid block device, DeviceNotFound
868 #
869 # Since 1.6
870 ##
871 { 'command': 'drive-backup', 'data': 'DriveBackup' }
873 ##
874 # @blockdev-backup
875 #
876 # Start a point-in-time copy of a block device to a new destination. The
877 # status of ongoing blockdev-backup operations can be checked with
878 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
879 # The operation can be stopped before it has completed using the
880 # block-job-cancel command.
881 #
882 # For the arguments, see the documentation of BlockdevBackup.
883 #
884 # Returns: Nothing on success.
885 # If @device or @target is not a valid block device, DeviceNotFound.
886 #
887 # Since 2.3
888 ##
889 { 'command': 'blockdev-backup', 'data': 'BlockdevBackup' }
892 ##
893 # @query-named-block-nodes
894 #
895 # Get the named block driver list
896 #
897 # Returns: the list of BlockDeviceInfo
898 #
899 # Since 2.0
900 ##
901 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
903 ##
904 # @drive-mirror
905 #
906 # Start mirroring a block device's writes to a new destination.
907 #
908 # @device: the name of the device whose writes should be mirrored.
909 #
910 # @target: the target of the new image. If the file exists, or if it
911 # is a device, the existing file/device will be used as the new
912 # destination. If it does not exist, a new file will be created.
913 #
914 # @format: #optional the format of the new destination, default is to
915 # probe if @mode is 'existing', else the format of the source
916 #
917 # @node-name: #optional the new block driver state node name in the graph
918 # (Since 2.1)
919 #
920 # @replaces: #optional with sync=full graph node name to be replaced by the new
921 # image when a whole image copy is done. This can be used to repair
922 # broken Quorum files. (Since 2.1)
923 #
924 # @mode: #optional whether and how QEMU should create a new image, default is
925 # 'absolute-paths'.
926 #
927 # @speed: #optional the maximum speed, in bytes per second
928 #
929 # @sync: what parts of the disk image should be copied to the destination
930 # (all the disk, only the sectors allocated in the topmost image, or
931 # only new I/O).
932 #
933 # @granularity: #optional granularity of the dirty bitmap, default is 64K
934 # if the image format doesn't have clusters, 4K if the clusters
935 # are smaller than that, else the cluster size. Must be a
936 # power of 2 between 512 and 64M (since 1.4).
937 #
938 # @buf-size: #optional maximum amount of data in flight from source to
939 # target (since 1.4).
940 #
941 # @on-source-error: #optional the action to take on an error on the source,
942 # default 'report'. 'stop' and 'enospc' can only be used
943 # if the block device supports io-status (see BlockInfo).
944 #
945 # @on-target-error: #optional the action to take on an error on the target,
946 # default 'report' (no limitations, since this applies to
947 # a different block device than @device).
948 #
949 # Returns: nothing on success
950 # If @device is not a valid block device, DeviceNotFound
951 #
952 # Since 1.3
953 ##
954 { 'command': 'drive-mirror',
955 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
956 '*node-name': 'str', '*replaces': 'str',
957 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
958 '*speed': 'int', '*granularity': 'uint32',
959 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
960 '*on-target-error': 'BlockdevOnError' } }
962 ##
963 # @block_set_io_throttle:
964 #
965 # Change I/O throttle limits for a block drive.
966 #
967 # @device: The name of the device
968 #
969 # @bps: total throughput limit in bytes per second
970 #
971 # @bps_rd: read throughput limit in bytes per second
972 #
973 # @bps_wr: write throughput limit in bytes per second
974 #
975 # @iops: total I/O operations per second
976 #
977 # @ops_rd: read I/O operations per second
978 #
979 # @iops_wr: write I/O operations per second
980 #
981 # @bps_max: #optional total max in bytes (Since 1.7)
982 #
983 # @bps_rd_max: #optional read max in bytes (Since 1.7)
984 #
985 # @bps_wr_max: #optional write max in bytes (Since 1.7)
986 #
987 # @iops_max: #optional total I/O operations max (Since 1.7)
988 #
989 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
990 #
991 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
992 #
993 # @iops_size: #optional an I/O size in bytes (Since 1.7)
994 #
995 # Returns: Nothing on success
996 # If @device is not a valid block device, DeviceNotFound
997 #
998 # Since: 1.1
999 ##
1000 { 'command': 'block_set_io_throttle',
1001 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1002 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1003 '*bps_max': 'int', '*bps_rd_max': 'int',
1004 '*bps_wr_max': 'int', '*iops_max': 'int',
1005 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1006 '*iops_size': 'int' } }
1008 ##
1009 # @block-stream:
1010 #
1011 # Copy data from a backing file into a block device.
1012 #
1013 # The block streaming operation is performed in the background until the entire
1014 # backing file has been copied. This command returns immediately once streaming
1015 # has started. The status of ongoing block streaming operations can be checked
1016 # with query-block-jobs. The operation can be stopped before it has completed
1017 # using the block-job-cancel command.
1018 #
1019 # If a base file is specified then sectors are not copied from that base file and
1020 # its backing chain. When streaming completes the image file will have the base
1021 # file as its backing file. This can be used to stream a subset of the backing
1022 # file chain instead of flattening the entire image.
1023 #
1024 # On successful completion the image file is updated to drop the backing file
1025 # and the BLOCK_JOB_COMPLETED event is emitted.
1026 #
1027 # @device: the device name
1028 #
1029 # @base: #optional the common backing file name
1030 #
1031 # @backing-file: #optional The backing file string to write into the active
1032 # layer. This filename is not validated.
1033 #
1034 # If a pathname string is such that it cannot be
1035 # resolved by QEMU, that means that subsequent QMP or
1036 # HMP commands must use node-names for the image in
1037 # question, as filename lookup methods will fail.
1038 #
1039 # If not specified, QEMU will automatically determine
1040 # the backing file string to use, or error out if there
1041 # is no obvious choice. Care should be taken when
1042 # specifying the string, to specify a valid filename or
1043 # protocol.
1044 # (Since 2.1)
1045 #
1046 # @speed: #optional the maximum speed, in bytes per second
1047 #
1048 # @on-error: #optional the action to take on an error (default report).
1049 # 'stop' and 'enospc' can only be used if the block device
1050 # supports io-status (see BlockInfo). Since 1.3.
1051 #
1052 # Returns: Nothing on success
1053 # If @device does not exist, DeviceNotFound
1054 #
1055 # Since: 1.1
1056 ##
1057 { 'command': 'block-stream',
1058 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str',
1059 '*speed': 'int', '*on-error': 'BlockdevOnError' } }
1061 ##
1062 # @block-job-set-speed:
1063 #
1064 # Set maximum speed for a background block operation.
1065 #
1066 # This command can only be issued when there is an active block job.
1067 #
1068 # Throttling can be disabled by setting the speed to 0.
1069 #
1070 # @device: the device name
1071 #
1072 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1073 # Defaults to 0.
1074 #
1075 # Returns: Nothing on success
1076 # If no background operation is active on this device, DeviceNotActive
1077 #
1078 # Since: 1.1
1079 ##
1080 { 'command': 'block-job-set-speed',
1081 'data': { 'device': 'str', 'speed': 'int' } }
1083 ##
1084 # @block-job-cancel:
1085 #
1086 # Stop an active background block operation.
1087 #
1088 # This command returns immediately after marking the active background block
1089 # operation for cancellation. It is an error to call this command if no
1090 # operation is in progress.
1091 #
1092 # The operation will cancel as soon as possible and then emit the
1093 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1094 # enumerated using query-block-jobs.
1095 #
1096 # For streaming, the image file retains its backing file unless the streaming
1097 # operation happens to complete just as it is being cancelled. A new streaming
1098 # operation can be started at a later time to finish copying all data from the
1099 # backing file.
1100 #
1101 # @device: the device name
1102 #
1103 # @force: #optional whether to allow cancellation of a paused job (default
1104 # false). Since 1.3.
1105 #
1106 # Returns: Nothing on success
1107 # If no background operation is active on this device, DeviceNotActive
1108 #
1109 # Since: 1.1
1110 ##
1111 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1113 ##
1114 # @block-job-pause:
1115 #
1116 # Pause an active background block operation.
1117 #
1118 # This command returns immediately after marking the active background block
1119 # operation for pausing. It is an error to call this command if no
1120 # operation is in progress. Pausing an already paused job has no cumulative
1121 # effect; a single block-job-resume command will resume the job.
1122 #
1123 # The operation will pause as soon as possible. No event is emitted when
1124 # the operation is actually paused. Cancelling a paused job automatically
1125 # resumes it.
1126 #
1127 # @device: the device name
1128 #
1129 # Returns: Nothing on success
1130 # If no background operation is active on this device, DeviceNotActive
1131 #
1132 # Since: 1.3
1133 ##
1134 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1136 ##
1137 # @block-job-resume:
1138 #
1139 # Resume an active background block operation.
1140 #
1141 # This command returns immediately after resuming a paused background block
1142 # operation. It is an error to call this command if no operation is in
1143 # progress. Resuming an already running job is not an error.
1144 #
1145 # This command also clears the error status of the job.
1146 #
1147 # @device: the device name
1148 #
1149 # Returns: Nothing on success
1150 # If no background operation is active on this device, DeviceNotActive
1151 #
1152 # Since: 1.3
1153 ##
1154 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1156 ##
1157 # @block-job-complete:
1158 #
1159 # Manually trigger completion of an active background block operation. This
1160 # is supported for drive mirroring, where it also switches the device to
1161 # write to the target path only. The ability to complete is signaled with
1162 # a BLOCK_JOB_READY event.
1163 #
1164 # This command completes an active background block operation synchronously.
1165 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1166 # is not defined. Note that if an I/O error occurs during the processing of
1167 # this command: 1) the command itself will fail; 2) the error will be processed
1168 # according to the rerror/werror arguments that were specified when starting
1169 # the operation.
1170 #
1171 # A cancelled or paused job cannot be completed.
1172 #
1173 # @device: the device name
1174 #
1175 # Returns: Nothing on success
1176 # If no background operation is active on this device, DeviceNotActive
1177 #
1178 # Since: 1.3
1179 ##
1180 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1182 ##
1183 # @BlockdevDiscardOptions
1184 #
1185 # Determines how to handle discard requests.
1186 #
1187 # @ignore: Ignore the request
1188 # @unmap: Forward as an unmap request
1189 #
1190 # Since: 1.7
1191 ##
1192 { 'enum': 'BlockdevDiscardOptions',
1193 'data': [ 'ignore', 'unmap' ] }
1195 ##
1196 # @BlockdevDetectZeroesOptions
1197 #
1198 # Describes the operation mode for the automatic conversion of plain
1199 # zero writes by the OS to driver specific optimized zero write commands.
1200 #
1201 # @off: Disabled (default)
1202 # @on: Enabled
1203 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1204 # also that @BlockdevDiscardOptions is set to unmap for this device.
1205 #
1206 # Since: 2.1
1207 ##
1208 { 'enum': 'BlockdevDetectZeroesOptions',
1209 'data': [ 'off', 'on', 'unmap' ] }
1211 ##
1212 # @BlockdevAioOptions
1213 #
1214 # Selects the AIO backend to handle I/O requests
1215 #
1216 # @threads: Use qemu's thread pool
1217 # @native: Use native AIO backend (only Linux and Windows)
1218 #
1219 # Since: 1.7
1220 ##
1221 { 'enum': 'BlockdevAioOptions',
1222 'data': [ 'threads', 'native' ] }
1224 ##
1225 # @BlockdevCacheOptions
1226 #
1227 # Includes cache-related options for block devices
1228 #
1229 # @writeback: #optional enables writeback mode for any caches (default: true)
1230 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1231 # default: false)
1232 # @no-flush: #optional ignore any flush requests for the device (default:
1233 # false)
1234 #
1235 # Since: 1.7
1236 ##
1237 { 'type': 'BlockdevCacheOptions',
1238 'data': { '*writeback': 'bool',
1239 '*direct': 'bool',
1240 '*no-flush': 'bool' } }
1242 ##
1243 # @BlockdevDriver
1244 #
1245 # Drivers that are supported in block device operations.
1246 #
1247 # @host_device, @host_cdrom, @host_floppy: Since 2.1
1248 #
1249 # Since: 2.0
1250 ##
1251 { 'enum': 'BlockdevDriver',
1252 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1253 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
1254 'host_floppy', 'http', 'https', 'null-aio', 'null-co', 'parallels',
1255 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx',
1256 'vmdk', 'vpc', 'vvfat' ] }
1258 ##
1259 # @BlockdevOptionsBase
1260 #
1261 # Options that are available for all block devices, independent of the block
1262 # driver.
1263 #
1264 # @driver: block driver name
1265 # @id: #optional id by which the new block device can be referred to.
1266 # This is a required option on the top level of blockdev-add, and
1267 # currently not allowed on any other level.
1268 # @node-name: #optional the name of a block driver state node (Since 2.0)
1269 # @discard: #optional discard-related options (default: ignore)
1270 # @cache: #optional cache-related options
1271 # @aio: #optional AIO backend (default: threads)
1272 # @rerror: #optional how to handle read errors on the device
1273 # (default: report)
1274 # @werror: #optional how to handle write errors on the device
1275 # (default: enospc)
1276 # @read-only: #optional whether the block device should be read-only
1277 # (default: false)
1278 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
1279 # (default: off)
1280 #
1281 # Since: 1.7
1282 ##
1283 { 'type': 'BlockdevOptionsBase',
1284 'data': { 'driver': 'BlockdevDriver',
1285 '*id': 'str',
1286 '*node-name': 'str',
1287 '*discard': 'BlockdevDiscardOptions',
1288 '*cache': 'BlockdevCacheOptions',
1289 '*aio': 'BlockdevAioOptions',
1290 '*rerror': 'BlockdevOnError',
1291 '*werror': 'BlockdevOnError',
1292 '*read-only': 'bool',
1293 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } }
1295 ##
1296 # @BlockdevOptionsFile
1297 #
1298 # Driver specific block device options for the file backend and similar
1299 # protocols.
1300 #
1301 # @filename: path to the image file
1302 #
1303 # Since: 1.7
1304 ##
1305 { 'type': 'BlockdevOptionsFile',
1306 'data': { 'filename': 'str' } }
1308 ##
1309 # @BlockdevOptionsNull
1310 #
1311 # Driver specific block device options for the null backend.
1312 #
1313 # @size: #optional size of the device in bytes.
1314 #
1315 # Since: 2.2
1316 ##
1317 { 'type': 'BlockdevOptionsNull',
1318 'data': { '*size': 'int' } }
1320 ##
1321 # @BlockdevOptionsVVFAT
1322 #
1323 # Driver specific block device options for the vvfat protocol.
1324 #
1325 # @dir: directory to be exported as FAT image
1326 # @fat-type: #optional FAT type: 12, 16 or 32
1327 # @floppy: #optional whether to export a floppy image (true) or
1328 # partitioned hard disk (false; default)
1329 # @rw: #optional whether to allow write operations (default: false)
1330 #
1331 # Since: 1.7
1332 ##
1333 { 'type': 'BlockdevOptionsVVFAT',
1334 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1335 '*rw': 'bool' } }
1337 ##
1338 # @BlockdevOptionsGenericFormat
1339 #
1340 # Driver specific block device options for image format that have no option
1341 # besides their data source.
1342 #
1343 # @file: reference to or definition of the data source block device
1344 #
1345 # Since: 1.7
1346 ##
1347 { 'type': 'BlockdevOptionsGenericFormat',
1348 'data': { 'file': 'BlockdevRef' } }
1350 ##
1351 # @BlockdevOptionsGenericCOWFormat
1352 #
1353 # Driver specific block device options for image format that have no option
1354 # besides their data source and an optional backing file.
1355 #
1356 # @backing: #optional reference to or definition of the backing file block
1357 # device (if missing, taken from the image file content). It is
1358 # allowed to pass an empty string here in order to disable the
1359 # default backing file.
1360 #
1361 # Since: 1.7
1362 ##
1363 { 'type': 'BlockdevOptionsGenericCOWFormat',
1364 'base': 'BlockdevOptionsGenericFormat',
1365 'data': { '*backing': 'BlockdevRef' } }
1367 ##
1368 # @Qcow2OverlapCheckMode
1369 #
1370 # General overlap check modes.
1371 #
1372 # @none: Do not perform any checks
1373 #
1374 # @constant: Perform only checks which can be done in constant time and
1375 # without reading anything from disk
1376 #
1377 # @cached: Perform only checks which can be done without reading anything
1378 # from disk
1379 #
1380 # @all: Perform all available overlap checks
1381 #
1382 # Since: 2.2
1383 ##
1384 { 'enum': 'Qcow2OverlapCheckMode',
1385 'data': [ 'none', 'constant', 'cached', 'all' ] }
1387 ##
1388 # @Qcow2OverlapCheckFlags
1389 #
1390 # Structure of flags for each metadata structure. Setting a field to 'true'
1391 # makes qemu guard that structure against unintended overwriting. The default
1392 # value is chosen according to the template given.
1393 #
1394 # @template: Specifies a template mode which can be adjusted using the other
1395 # flags, defaults to 'cached'
1396 #
1397 # Since: 2.2
1398 ##
1399 { 'type': 'Qcow2OverlapCheckFlags',
1400 'data': { '*template': 'Qcow2OverlapCheckMode',
1401 '*main-header': 'bool',
1402 '*active-l1': 'bool',
1403 '*active-l2': 'bool',
1404 '*refcount-table': 'bool',
1405 '*refcount-block': 'bool',
1406 '*snapshot-table': 'bool',
1407 '*inactive-l1': 'bool',
1408 '*inactive-l2': 'bool' } }
1410 ##
1411 # @Qcow2OverlapChecks
1412 #
1413 # Specifies which metadata structures should be guarded against unintended
1414 # overwriting.
1415 #
1416 # @flags: set of flags for separate specification of each metadata structure
1417 # type
1418 #
1419 # @mode: named mode which chooses a specific set of flags
1420 #
1421 # Since: 2.2
1422 ##
1423 { 'union': 'Qcow2OverlapChecks',
1424 'discriminator': {},
1425 'data': { 'flags': 'Qcow2OverlapCheckFlags',
1426 'mode': 'Qcow2OverlapCheckMode' } }
1428 ##
1429 # @BlockdevOptionsQcow2
1430 #
1431 # Driver specific block device options for qcow2.
1432 #
1433 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1434 # feature (default is taken from the image file)
1435 #
1436 # @pass-discard-request: #optional whether discard requests to the qcow2
1437 # device should be forwarded to the data source
1438 #
1439 # @pass-discard-snapshot: #optional whether discard requests for the data source
1440 # should be issued when a snapshot operation (e.g.
1441 # deleting a snapshot) frees clusters in the qcow2 file
1442 #
1443 # @pass-discard-other: #optional whether discard requests for the data source
1444 # should be issued on other occasions where a cluster
1445 # gets freed
1446 #
1447 # @overlap-check: #optional which overlap checks to perform for writes
1448 # to the image, defaults to 'cached' (since 2.2)
1449 #
1450 # @cache-size: #optional the maximum total size of the L2 table and
1451 # refcount block caches in bytes (since 2.2)
1452 #
1453 # @l2-cache-size: #optional the maximum size of the L2 table cache in
1454 # bytes (since 2.2)
1455 #
1456 # @refcount-cache-size: #optional the maximum size of the refcount block cache
1457 # in bytes (since 2.2)
1458 #
1459 # Since: 1.7
1460 ##
1461 { 'type': 'BlockdevOptionsQcow2',
1462 'base': 'BlockdevOptionsGenericCOWFormat',
1463 'data': { '*lazy-refcounts': 'bool',
1464 '*pass-discard-request': 'bool',
1465 '*pass-discard-snapshot': 'bool',
1466 '*pass-discard-other': 'bool',
1467 '*overlap-check': 'Qcow2OverlapChecks',
1468 '*cache-size': 'int',
1469 '*l2-cache-size': 'int',
1470 '*refcount-cache-size': 'int' } }
1473 ##
1474 # @BlockdevOptionsArchipelago
1475 #
1476 # Driver specific block device options for Archipelago.
1477 #
1478 # @volume: Name of the Archipelago volume image
1479 #
1480 # @mport: #optional The port number on which mapperd is
1481 # listening. This is optional
1482 # and if not specified, QEMU will make Archipelago
1483 # use the default port (1001).
1484 #
1485 # @vport: #optional The port number on which vlmcd is
1486 # listening. This is optional
1487 # and if not specified, QEMU will make Archipelago
1488 # use the default port (501).
1489 #
1490 # @segment: #optional The name of the shared memory segment
1491 # Archipelago stack is using. This is optional
1492 # and if not specified, QEMU will make Archipelago
1493 # use the default value, 'archipelago'.
1494 # Since: 2.2
1495 ##
1496 { 'type': 'BlockdevOptionsArchipelago',
1497 'data': { 'volume': 'str',
1498 '*mport': 'int',
1499 '*vport': 'int',
1500 '*segment': 'str' } }
1503 ##
1504 # @BlkdebugEvent
1505 #
1506 # Trigger events supported by blkdebug.
1507 ##
1508 { 'enum': 'BlkdebugEvent',
1509 'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table',
1510 'l1_grow.activate_table', 'l2_load', 'l2_update',
1511 'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write',
1512 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1513 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1514 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1515 'refblock_load', 'refblock_update', 'refblock_update_part',
1516 'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write',
1517 'refblock_alloc.write_blocks', 'refblock_alloc.write_table',
1518 'refblock_alloc.switch_table', 'cluster_alloc',
1519 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
1520 'flush_to_disk', 'pwritev_rmw.head', 'pwritev_rmw.after_head',
1521 'pwritev_rmw.tail', 'pwritev_rmw.after_tail', 'pwritev',
1522 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
1524 ##
1525 # @BlkdebugInjectErrorOptions
1526 #
1527 # Describes a single error injection for blkdebug.
1528 #
1529 # @event: trigger event
1530 #
1531 # @state: #optional the state identifier blkdebug needs to be in to
1532 # actually trigger the event; defaults to "any"
1533 #
1534 # @errno: #optional error identifier (errno) to be returned; defaults to
1535 # EIO
1536 #
1537 # @sector: #optional specifies the sector index which has to be affected
1538 # in order to actually trigger the event; defaults to "any
1539 # sector"
1540 #
1541 # @once: #optional disables further events after this one has been
1542 # triggered; defaults to false
1543 #
1544 # @immediately: #optional fail immediately; defaults to false
1545 #
1546 # Since: 2.0
1547 ##
1548 { 'type': 'BlkdebugInjectErrorOptions',
1549 'data': { 'event': 'BlkdebugEvent',
1550 '*state': 'int',
1551 '*errno': 'int',
1552 '*sector': 'int',
1553 '*once': 'bool',
1554 '*immediately': 'bool' } }
1556 ##
1557 # @BlkdebugSetStateOptions
1558 #
1559 # Describes a single state-change event for blkdebug.
1560 #
1561 # @event: trigger event
1562 #
1563 # @state: #optional the current state identifier blkdebug needs to be in;
1564 # defaults to "any"
1565 #
1566 # @new_state: the state identifier blkdebug is supposed to assume if
1567 # this event is triggered
1568 #
1569 # Since: 2.0
1570 ##
1571 { 'type': 'BlkdebugSetStateOptions',
1572 'data': { 'event': 'BlkdebugEvent',
1573 '*state': 'int',
1574 'new_state': 'int' } }
1576 ##
1577 # @BlockdevOptionsBlkdebug
1578 #
1579 # Driver specific block device options for blkdebug.
1580 #
1581 # @image: underlying raw block device (or image file)
1582 #
1583 # @config: #optional filename of the configuration file
1584 #
1585 # @align: #optional required alignment for requests in bytes
1586 #
1587 # @inject-error: #optional array of error injection descriptions
1588 #
1589 # @set-state: #optional array of state-change descriptions
1590 #
1591 # Since: 2.0
1592 ##
1593 { 'type': 'BlockdevOptionsBlkdebug',
1594 'data': { 'image': 'BlockdevRef',
1595 '*config': 'str',
1596 '*align': 'int',
1597 '*inject-error': ['BlkdebugInjectErrorOptions'],
1598 '*set-state': ['BlkdebugSetStateOptions'] } }
1600 ##
1601 # @BlockdevOptionsBlkverify
1602 #
1603 # Driver specific block device options for blkverify.
1604 #
1605 # @test: block device to be tested
1606 #
1607 # @raw: raw image used for verification
1608 #
1609 # Since: 2.0
1610 ##
1611 { 'type': 'BlockdevOptionsBlkverify',
1612 'data': { 'test': 'BlockdevRef',
1613 'raw': 'BlockdevRef' } }
1615 ##
1616 # @QuorumReadPattern
1617 #
1618 # An enumeration of quorum read patterns.
1619 #
1620 # @quorum: read all the children and do a quorum vote on reads
1621 #
1622 # @fifo: read only from the first child that has not failed
1623 #
1624 # Since: 2.2
1625 ##
1626 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
1628 ##
1629 # @BlockdevOptionsQuorum
1630 #
1631 # Driver specific block device options for Quorum
1632 #
1633 # @blkverify: #optional true if the driver must print content mismatch
1634 # set to false by default
1635 #
1636 # @children: the children block devices to use
1637 #
1638 # @vote-threshold: the vote limit under which a read will fail
1639 #
1640 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
1641 # (Since 2.1)
1642 #
1643 # @read-pattern: #optional choose read pattern and set to quorum by default
1644 # (Since 2.2)
1645 #
1646 # Since: 2.0
1647 ##
1648 { 'type': 'BlockdevOptionsQuorum',
1649 'data': { '*blkverify': 'bool',
1650 'children': [ 'BlockdevRef' ],
1651 'vote-threshold': 'int',
1652 '*rewrite-corrupted': 'bool',
1653 '*read-pattern': 'QuorumReadPattern' } }
1655 ##
1656 # @BlockdevOptions
1657 #
1658 # Options for creating a block device.
1659 #
1660 # Since: 1.7
1661 ##
1662 { 'union': 'BlockdevOptions',
1663 'base': 'BlockdevOptionsBase',
1664 'discriminator': 'driver',
1665 'data': {
1666 'archipelago':'BlockdevOptionsArchipelago',
1667 'blkdebug': 'BlockdevOptionsBlkdebug',
1668 'blkverify': 'BlockdevOptionsBlkverify',
1669 'bochs': 'BlockdevOptionsGenericFormat',
1670 'cloop': 'BlockdevOptionsGenericFormat',
1671 'dmg': 'BlockdevOptionsGenericFormat',
1672 'file': 'BlockdevOptionsFile',
1673 'ftp': 'BlockdevOptionsFile',
1674 'ftps': 'BlockdevOptionsFile',
1675 # TODO gluster: Wait for structured options
1676 'host_cdrom': 'BlockdevOptionsFile',
1677 'host_device':'BlockdevOptionsFile',
1678 'host_floppy':'BlockdevOptionsFile',
1679 'http': 'BlockdevOptionsFile',
1680 'https': 'BlockdevOptionsFile',
1681 # TODO iscsi: Wait for structured options
1682 # TODO nbd: Should take InetSocketAddress for 'host'?
1683 # TODO nfs: Wait for structured options
1684 'null-aio': 'BlockdevOptionsNull',
1685 'null-co': 'BlockdevOptionsNull',
1686 'parallels': 'BlockdevOptionsGenericFormat',
1687 'qcow2': 'BlockdevOptionsQcow2',
1688 'qcow': 'BlockdevOptionsGenericCOWFormat',
1689 'qed': 'BlockdevOptionsGenericCOWFormat',
1690 'quorum': 'BlockdevOptionsQuorum',
1691 'raw': 'BlockdevOptionsGenericFormat',
1692 # TODO rbd: Wait for structured options
1693 # TODO sheepdog: Wait for structured options
1694 # TODO ssh: Should take InetSocketAddress for 'host'?
1695 'tftp': 'BlockdevOptionsFile',
1696 'vdi': 'BlockdevOptionsGenericFormat',
1697 'vhdx': 'BlockdevOptionsGenericFormat',
1698 'vmdk': 'BlockdevOptionsGenericCOWFormat',
1699 'vpc': 'BlockdevOptionsGenericFormat',
1700 'vvfat': 'BlockdevOptionsVVFAT'
1701 } }
1703 ##
1704 # @BlockdevRef
1705 #
1706 # Reference to a block device.
1707 #
1708 # @definition: defines a new block device inline
1709 # @reference: references the ID of an existing block device. An
1710 # empty string means that no block device should be
1711 # referenced.
1712 #
1713 # Since: 1.7
1714 ##
1715 { 'union': 'BlockdevRef',
1716 'discriminator': {},
1717 'data': { 'definition': 'BlockdevOptions',
1718 'reference': 'str' } }
1720 ##
1721 # @blockdev-add:
1722 #
1723 # Creates a new block device.
1724 #
1725 # @options: block device options for the new device
1726 #
1727 # Since: 1.7
1728 ##
1729 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }
1732 ##
1733 # @BlockErrorAction
1734 #
1735 # An enumeration of action that has been taken when a DISK I/O occurs
1736 #
1737 # @ignore: error has been ignored
1738 #
1739 # @report: error has been reported to the device
1740 #
1741 # @stop: error caused VM to be stopped
1742 #
1743 # Since: 2.1
1744 ##
1745 { 'enum': 'BlockErrorAction',
1746 'data': [ 'ignore', 'report', 'stop' ] }
1749 ##
1750 # @BLOCK_IMAGE_CORRUPTED
1751 #
1752 # Emitted when a corruption has been detected in a disk image
1753 #
1754 # @device: device name
1755 #
1756 # @msg: informative message for human consumption, such as the kind of
1757 # corruption being detected. It should not be parsed by machine as it is
1758 # not guaranteed to be stable
1759 #
1760 # @offset: #optional, if the corruption resulted from an image access, this is
1761 # the access offset into the image
1762 #
1763 # @size: #optional, if the corruption resulted from an image access, this is
1764 # the access size
1765 #
1766 # fatal: if set, the image is marked corrupt and therefore unusable after this
1767 # event and must be repaired (Since 2.2; before, every
1768 # BLOCK_IMAGE_CORRUPTED event was fatal)
1769 #
1770 # Since: 1.7
1771 ##
1772 { 'event': 'BLOCK_IMAGE_CORRUPTED',
1773 'data': { 'device' : 'str',
1774 'msg' : 'str',
1775 '*offset': 'int',
1776 '*size' : 'int',
1777 'fatal' : 'bool' } }
1779 ##
1780 # @BLOCK_IO_ERROR
1781 #
1782 # Emitted when a disk I/O error occurs
1783 #
1784 # @device: device name
1785 #
1786 # @operation: I/O operation
1787 #
1788 # @action: action that has been taken
1789 #
1790 # @nospace: #optional true if I/O error was caused due to a no-space
1791 # condition. This key is only present if query-block's
1792 # io-status is present, please see query-block documentation
1793 # for more information (since: 2.2)
1794 #
1795 # @reason: human readable string describing the error cause.
1796 # (This field is a debugging aid for humans, it should not
1797 # be parsed by applications) (since: 2.2)
1798 #
1799 # Note: If action is "stop", a STOP event will eventually follow the
1800 # BLOCK_IO_ERROR event
1801 #
1802 # Since: 0.13.0
1803 ##
1804 { 'event': 'BLOCK_IO_ERROR',
1805 'data': { 'device': 'str', 'operation': 'IoOperationType',
1806 'action': 'BlockErrorAction', '*nospace': 'bool',
1807 'reason': 'str' } }
1809 ##
1810 # @BLOCK_JOB_COMPLETED
1811 #
1812 # Emitted when a block job has completed
1813 #
1814 # @type: job type
1815 #
1816 # @device: device name
1817 #
1818 # @len: maximum progress value
1819 #
1820 # @offset: current progress value. On success this is equal to len.
1821 # On failure this is less than len
1822 #
1823 # @speed: rate limit, bytes per second
1824 #
1825 # @error: #optional, error message. Only present on failure. This field
1826 # contains a human-readable error message. There are no semantics
1827 # other than that streaming has failed and clients should not try to
1828 # interpret the error string
1829 #
1830 # Since: 1.1
1831 ##
1832 { 'event': 'BLOCK_JOB_COMPLETED',
1833 'data': { 'type' : 'BlockJobType',
1834 'device': 'str',
1835 'len' : 'int',
1836 'offset': 'int',
1837 'speed' : 'int',
1838 '*error': 'str' } }
1840 ##
1841 # @BLOCK_JOB_CANCELLED
1842 #
1843 # Emitted when a block job has been cancelled
1844 #
1845 # @type: job type
1846 #
1847 # @device: device name
1848 #
1849 # @len: maximum progress value
1850 #
1851 # @offset: current progress value. On success this is equal to len.
1852 # On failure this is less than len
1853 #
1854 # @speed: rate limit, bytes per second
1855 #
1856 # Since: 1.1
1857 ##
1858 { 'event': 'BLOCK_JOB_CANCELLED',
1859 'data': { 'type' : 'BlockJobType',
1860 'device': 'str',
1861 'len' : 'int',
1862 'offset': 'int',
1863 'speed' : 'int' } }
1865 ##
1866 # @BLOCK_JOB_ERROR
1867 #
1868 # Emitted when a block job encounters an error
1869 #
1870 # @device: device name
1871 #
1872 # @operation: I/O operation
1873 #
1874 # @action: action that has been taken
1875 #
1876 # Since: 1.3
1877 ##
1878 { 'event': 'BLOCK_JOB_ERROR',
1879 'data': { 'device' : 'str',
1880 'operation': 'IoOperationType',
1881 'action' : 'BlockErrorAction' } }
1883 ##
1884 # @BLOCK_JOB_READY
1885 #
1886 # Emitted when a block job is ready to complete
1887 #
1888 # @type: job type
1889 #
1890 # @device: device name
1891 #
1892 # @len: maximum progress value
1893 #
1894 # @offset: current progress value. On success this is equal to len.
1895 # On failure this is less than len
1896 #
1897 # @speed: rate limit, bytes per second
1898 #
1899 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
1900 # event
1901 #
1902 # Since: 1.3
1903 ##
1904 { 'event': 'BLOCK_JOB_READY',
1905 'data': { 'type' : 'BlockJobType',
1906 'device': 'str',
1907 'len' : 'int',
1908 'offset': 'int',
1909 'speed' : 'int' } }
1911 # @PreallocMode
1912 #
1913 # Preallocation mode of QEMU image file
1914 #
1915 # @off: no preallocation
1916 # @metadata: preallocate only for metadata
1917 # @falloc: like @full preallocation but allocate disk space by
1918 # posix_fallocate() rather than writing zeros.
1919 # @full: preallocate all data by writing zeros to device to ensure disk
1920 # space is really available. @full preallocation also sets up
1921 # metadata correctly.
1922 #
1923 # Since 2.2
1924 ##
1925 { 'enum': 'PreallocMode',
1926 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
1928 ##
1929 # @BLOCK_WRITE_THRESHOLD
1930 #
1931 # Emitted when writes on block device reaches or exceeds the
1932 # configured write threshold. For thin-provisioned devices, this
1933 # means the device should be extended to avoid pausing for
1934 # disk exhaustion.
1935 # The event is one shot. Once triggered, it needs to be
1936 # re-registered with another block-set-threshold command.
1937 #
1938 # @node-name: graph node name on which the threshold was exceeded.
1939 #
1940 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
1941 #
1942 # @write-threshold: last configured threshold, in bytes.
1943 #
1944 # Since: 2.3
1945 ##
1946 { 'event': 'BLOCK_WRITE_THRESHOLD',
1947 'data': { 'node-name': 'str',
1948 'amount-exceeded': 'uint64',
1949 'write-threshold': 'uint64' } }
1951 ##
1952 # @block-set-write-threshold
1953 #
1954 # Change the write threshold for a block drive. An event will be delivered
1955 # if a write to this block drive crosses the configured threshold.
1956 # This is useful to transparently resize thin-provisioned drives without
1957 # the guest OS noticing.
1958 #
1959 # @node-name: graph node name on which the threshold must be set.
1960 #
1961 # @write-threshold: configured threshold for the block device, bytes.
1962 # Use 0 to disable the threshold.
1963 #
1964 # Since: 2.3
1965 ##
1966 { 'command': 'block-set-write-threshold',
1967 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }