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