target/arm: Convert Neon VCVT fixed-point to gvec
[qemu.git] / qapi / block-core.json
1 # -*- Mode: Python -*-
2 # vim: filetype=python
3
4 ##
5 # == Block core (VM unrelated)
6 ##
7
8 { 'include': 'common.json' }
9 { 'include': 'crypto.json' }
10 { 'include': 'job.json' }
11 { 'include': 'sockets.json' }
12
13 ##
14 # @SnapshotInfo:
15 #
16 # @id: unique snapshot id
17 #
18 # @name: user chosen name
19 #
20 # @vm-state-size: size of the VM state
21 #
22 # @date-sec: UTC date of the snapshot in seconds
23 #
24 # @date-nsec: fractional part in nano seconds to be used with date-sec
25 #
26 # @vm-clock-sec: VM clock relative to boot in seconds
27 #
28 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
29 #
30 # Since: 1.3
31 #
32 ##
33 { 'struct': 'SnapshotInfo',
34   'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
35             'date-sec': 'int', 'date-nsec': 'int',
36             'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
37
38 ##
39 # @ImageInfoSpecificQCow2EncryptionBase:
40 #
41 # @format: The encryption format
42 #
43 # Since: 2.10
44 ##
45 { 'struct': 'ImageInfoSpecificQCow2EncryptionBase',
46   'data': { 'format': 'BlockdevQcow2EncryptionFormat'}}
47
48 ##
49 # @ImageInfoSpecificQCow2Encryption:
50 #
51 # Since: 2.10
52 ##
53 { 'union': 'ImageInfoSpecificQCow2Encryption',
54   'base': 'ImageInfoSpecificQCow2EncryptionBase',
55   'discriminator': 'format',
56   'data': { 'luks': 'QCryptoBlockInfoLUKS' } }
57
58 ##
59 # @ImageInfoSpecificQCow2:
60 #
61 # @compat: compatibility level
62 #
63 # @data-file: the filename of the external data file that is stored in the
64 #             image and used as a default for opening the image (since: 4.0)
65 #
66 # @data-file-raw: True if the external data file must stay valid as a
67 #                 standalone (read-only) raw image without looking at qcow2
68 #                 metadata (since: 4.0)
69 #
70 # @extended-l2: true if the image has extended L2 entries; only valid for
71 #               compat >= 1.1 (since 5.2)
72 #
73 # @lazy-refcounts: on or off; only valid for compat >= 1.1
74 #
75 # @corrupt: true if the image has been marked corrupt; only valid for
76 #           compat >= 1.1 (since 2.2)
77 #
78 # @refcount-bits: width of a refcount entry in bits (since 2.3)
79 #
80 # @encrypt: details about encryption parameters; only set if image
81 #           is encrypted (since 2.10)
82 #
83 # @bitmaps: A list of qcow2 bitmap details (since 4.0)
84 #
85 # @compression-type: the image cluster compression method (since 5.1)
86 #
87 # Since: 1.7
88 ##
89 { 'struct': 'ImageInfoSpecificQCow2',
90   'data': {
91       'compat': 'str',
92       '*data-file': 'str',
93       '*data-file-raw': 'bool',
94       '*extended-l2': 'bool',
95       '*lazy-refcounts': 'bool',
96       '*corrupt': 'bool',
97       'refcount-bits': 'int',
98       '*encrypt': 'ImageInfoSpecificQCow2Encryption',
99       '*bitmaps': ['Qcow2BitmapInfo'],
100       'compression-type': 'Qcow2CompressionType'
101   } }
102
103 ##
104 # @ImageInfoSpecificVmdk:
105 #
106 # @create-type: The create type of VMDK image
107 #
108 # @cid: Content id of image
109 #
110 # @parent-cid: Parent VMDK image's cid
111 #
112 # @extents: List of extent files
113 #
114 # Since: 1.7
115 ##
116 { 'struct': 'ImageInfoSpecificVmdk',
117   'data': {
118       'create-type': 'str',
119       'cid': 'int',
120       'parent-cid': 'int',
121       'extents': ['ImageInfo']
122   } }
123
124 ##
125 # @ImageInfoSpecific:
126 #
127 # A discriminated record of image format specific information structures.
128 #
129 # Since: 1.7
130 ##
131 { 'union': 'ImageInfoSpecific',
132   'data': {
133       'qcow2': 'ImageInfoSpecificQCow2',
134       'vmdk': 'ImageInfoSpecificVmdk',
135       # If we need to add block driver specific parameters for
136       # LUKS in future, then we'll subclass QCryptoBlockInfoLUKS
137       # to define a ImageInfoSpecificLUKS
138       'luks': 'QCryptoBlockInfoLUKS'
139   } }
140
141 ##
142 # @ImageInfo:
143 #
144 # Information about a QEMU image file
145 #
146 # @filename: name of the image file
147 #
148 # @format: format of the image file
149 #
150 # @virtual-size: maximum capacity in bytes of the image
151 #
152 # @actual-size: actual size on disk in bytes of the image
153 #
154 # @dirty-flag: true if image is not cleanly closed
155 #
156 # @cluster-size: size of a cluster in bytes
157 #
158 # @encrypted: true if the image is encrypted
159 #
160 # @compressed: true if the image is compressed (Since 1.7)
161 #
162 # @backing-filename: name of the backing file
163 #
164 # @full-backing-filename: full path of the backing file
165 #
166 # @backing-filename-format: the format of the backing file
167 #
168 # @snapshots: list of VM snapshots
169 #
170 # @backing-image: info of the backing image (since 1.6)
171 #
172 # @format-specific: structure supplying additional format-specific
173 #                   information (since 1.7)
174 #
175 # Since: 1.3
176 #
177 ##
178 { 'struct': 'ImageInfo',
179   'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
180            '*actual-size': 'int', 'virtual-size': 'int',
181            '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
182            '*backing-filename': 'str', '*full-backing-filename': 'str',
183            '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
184            '*backing-image': 'ImageInfo',
185            '*format-specific': 'ImageInfoSpecific' } }
186
187 ##
188 # @ImageCheck:
189 #
190 # Information about a QEMU image file check
191 #
192 # @filename: name of the image file checked
193 #
194 # @format: format of the image file checked
195 #
196 # @check-errors: number of unexpected errors occurred during check
197 #
198 # @image-end-offset: offset (in bytes) where the image ends, this
199 #                    field is present if the driver for the image format
200 #                    supports it
201 #
202 # @corruptions: number of corruptions found during the check if any
203 #
204 # @leaks: number of leaks found during the check if any
205 #
206 # @corruptions-fixed: number of corruptions fixed during the check
207 #                     if any
208 #
209 # @leaks-fixed: number of leaks fixed during the check if any
210 #
211 # @total-clusters: total number of clusters, this field is present
212 #                  if the driver for the image format supports it
213 #
214 # @allocated-clusters: total number of allocated clusters, this
215 #                      field is present if the driver for the image format
216 #                      supports it
217 #
218 # @fragmented-clusters: total number of fragmented clusters, this
219 #                       field is present if the driver for the image format
220 #                       supports it
221 #
222 # @compressed-clusters: total number of compressed clusters, this
223 #                       field is present if the driver for the image format
224 #                       supports it
225 #
226 # Since: 1.4
227 #
228 ##
229 { 'struct': 'ImageCheck',
230   'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
231            '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
232            '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
233            '*total-clusters': 'int', '*allocated-clusters': 'int',
234            '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
235
236 ##
237 # @MapEntry:
238 #
239 # Mapping information from a virtual block range to a host file range
240 #
241 # @start: the start byte of the mapped virtual range
242 #
243 # @length: the number of bytes of the mapped virtual range
244 #
245 # @data: whether the mapped range has data
246 #
247 # @zero: whether the virtual blocks are zeroed
248 #
249 # @depth: the depth of the mapping
250 #
251 # @offset: the offset in file that the virtual sectors are mapped to
252 #
253 # @filename: filename that is referred to by @offset
254 #
255 # Since: 2.6
256 #
257 ##
258 { 'struct': 'MapEntry',
259   'data': {'start': 'int', 'length': 'int', 'data': 'bool',
260            'zero': 'bool', 'depth': 'int', '*offset': 'int',
261            '*filename': 'str' } }
262
263 ##
264 # @BlockdevCacheInfo:
265 #
266 # Cache mode information for a block device
267 #
268 # @writeback:   true if writeback mode is enabled
269 # @direct:      true if the host page cache is bypassed (O_DIRECT)
270 # @no-flush:    true if flush requests are ignored for the device
271 #
272 # Since: 2.3
273 ##
274 { 'struct': 'BlockdevCacheInfo',
275   'data': { 'writeback': 'bool',
276             'direct': 'bool',
277             'no-flush': 'bool' } }
278
279 ##
280 # @BlockDeviceInfo:
281 #
282 # Information about the backing device for a block device.
283 #
284 # @file: the filename of the backing device
285 #
286 # @node-name: the name of the block driver node (Since 2.0)
287 #
288 # @ro: true if the backing device was open read-only
289 #
290 # @drv: the name of the block format used to open the backing device. As of
291 #       0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
292 #       'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
293 #       'http', 'https', 'luks', 'nbd', 'parallels', 'qcow',
294 #       'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat'
295 #       2.2: 'archipelago' added, 'cow' dropped
296 #       2.3: 'host_floppy' deprecated
297 #       2.5: 'host_floppy' dropped
298 #       2.6: 'luks' added
299 #       2.8: 'replication' added, 'tftp' dropped
300 #       2.9: 'archipelago' dropped
301 #
302 # @backing_file: the name of the backing file (for copy-on-write)
303 #
304 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
305 #
306 # @encrypted: true if the backing device is encrypted
307 #
308 # @encryption_key_missing: always false
309 #
310 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
311 #
312 # @bps: total throughput limit in bytes per second is specified
313 #
314 # @bps_rd: read throughput limit in bytes per second is specified
315 #
316 # @bps_wr: write throughput limit in bytes per second is specified
317 #
318 # @iops: total I/O operations per second is specified
319 #
320 # @iops_rd: read I/O operations per second is specified
321 #
322 # @iops_wr: write I/O operations per second is specified
323 #
324 # @image: the info of image used (since: 1.6)
325 #
326 # @bps_max: total throughput limit during bursts,
327 #                     in bytes (Since 1.7)
328 #
329 # @bps_rd_max: read throughput limit during bursts,
330 #                        in bytes (Since 1.7)
331 #
332 # @bps_wr_max: write throughput limit during bursts,
333 #                        in bytes (Since 1.7)
334 #
335 # @iops_max: total I/O operations per second during bursts,
336 #                      in bytes (Since 1.7)
337 #
338 # @iops_rd_max: read I/O operations per second during bursts,
339 #                         in bytes (Since 1.7)
340 #
341 # @iops_wr_max: write I/O operations per second during bursts,
342 #                         in bytes (Since 1.7)
343 #
344 # @bps_max_length: maximum length of the @bps_max burst
345 #                            period, in seconds. (Since 2.6)
346 #
347 # @bps_rd_max_length: maximum length of the @bps_rd_max
348 #                               burst period, in seconds. (Since 2.6)
349 #
350 # @bps_wr_max_length: maximum length of the @bps_wr_max
351 #                               burst period, in seconds. (Since 2.6)
352 #
353 # @iops_max_length: maximum length of the @iops burst
354 #                             period, in seconds. (Since 2.6)
355 #
356 # @iops_rd_max_length: maximum length of the @iops_rd_max
357 #                                burst period, in seconds. (Since 2.6)
358 #
359 # @iops_wr_max_length: maximum length of the @iops_wr_max
360 #                                burst period, in seconds. (Since 2.6)
361 #
362 # @iops_size: an I/O size in bytes (Since 1.7)
363 #
364 # @group: throttle group name (Since 2.4)
365 #
366 # @cache: the cache mode used for the block device (since: 2.3)
367 #
368 # @write_threshold: configured write threshold for the device.
369 #                   0 if disabled. (Since 2.3)
370 #
371 # @dirty-bitmaps: dirty bitmaps information (only present if node
372 #                 has one or more dirty bitmaps) (Since 4.2)
373 #
374 # Features:
375 # @deprecated: Member @encryption_key_missing is deprecated.  It is
376 #     always false.
377 #
378 # Since: 0.14.0
379 #
380 ##
381 { 'struct': 'BlockDeviceInfo',
382   'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
383             '*backing_file': 'str', 'backing_file_depth': 'int',
384             'encrypted': 'bool',
385             'encryption_key_missing': { 'type': 'bool',
386                                         'features': [ 'deprecated' ] },
387             'detect_zeroes': 'BlockdevDetectZeroesOptions',
388             'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
389             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
390             'image': 'ImageInfo',
391             '*bps_max': 'int', '*bps_rd_max': 'int',
392             '*bps_wr_max': 'int', '*iops_max': 'int',
393             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
394             '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
395             '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
396             '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
397             '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
398             'write_threshold': 'int', '*dirty-bitmaps': ['BlockDirtyInfo'] } }
399
400 ##
401 # @BlockDeviceIoStatus:
402 #
403 # An enumeration of block device I/O status.
404 #
405 # @ok: The last I/O operation has succeeded
406 #
407 # @failed: The last I/O operation has failed
408 #
409 # @nospace: The last I/O operation has failed due to a no-space condition
410 #
411 # Since: 1.0
412 ##
413 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
414
415 ##
416 # @BlockDeviceMapEntry:
417 #
418 # Entry in the metadata map of the device (returned by "qemu-img map")
419 #
420 # @start: Offset in the image of the first byte described by this entry
421 #         (in bytes)
422 #
423 # @length: Length of the range described by this entry (in bytes)
424 #
425 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
426 #         before reaching one for which the range is allocated.  The value is
427 #         in the range 0 to the depth of the image chain - 1.
428 #
429 # @zero: the sectors in this range read as zeros
430 #
431 # @data: reading the image will actually read data from a file (in particular,
432 #        if @offset is present this means that the sectors are not simply
433 #        preallocated, but contain actual data in raw format)
434 #
435 # @offset: if present, the image file stores the data for this range in
436 #          raw format at the given offset.
437 #
438 # Since: 1.7
439 ##
440 { 'struct': 'BlockDeviceMapEntry',
441   'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
442             'data': 'bool', '*offset': 'int' } }
443
444 ##
445 # @DirtyBitmapStatus:
446 #
447 # An enumeration of possible states that a dirty bitmap can report to the user.
448 #
449 # @frozen: The bitmap is currently in-use by some operation and is immutable.
450 #          If the bitmap was @active prior to the operation, new writes by the
451 #          guest are being recorded in a temporary buffer, and will not be lost.
452 #          Generally, bitmaps are cleared on successful use in an operation and
453 #          the temporary buffer is committed into the bitmap. On failure, the
454 #          temporary buffer is merged back into the bitmap without first
455 #          clearing it.
456 #          Please refer to the documentation for each bitmap-using operation,
457 #          See also @blockdev-backup, @drive-backup.
458 #
459 # @disabled: The bitmap is not currently recording new writes by the guest.
460 #            This is requested explicitly via @block-dirty-bitmap-disable.
461 #            It can still be cleared, deleted, or used for backup operations.
462 #
463 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
464 #          deleted, or used for backup operations.
465 #
466 # @locked: The bitmap is currently in-use by some operation and is immutable.
467 #          If the bitmap was @active prior to the operation, it is still
468 #          recording new writes. If the bitmap was @disabled, it is not
469 #          recording new writes. (Since 2.12)
470 #
471 # @inconsistent: This is a persistent dirty bitmap that was marked in-use on
472 #                disk, and is unusable by QEMU. It can only be deleted.
473 #                Please rely on the inconsistent field in @BlockDirtyInfo
474 #                instead, as the status field is deprecated. (Since 4.0)
475 #
476 # Since: 2.4
477 ##
478 { 'enum': 'DirtyBitmapStatus',
479   'data': ['active', 'disabled', 'frozen', 'locked', 'inconsistent'] }
480
481 ##
482 # @BlockDirtyInfo:
483 #
484 # Block dirty bitmap information.
485 #
486 # @name: the name of the dirty bitmap (Since 2.4)
487 #
488 # @count: number of dirty bytes according to the dirty bitmap
489 #
490 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
491 #
492 # @status: current status of the dirty bitmap (since 2.4)
493 #
494 # @recording: true if the bitmap is recording new writes from the guest.
495 #             Replaces `active` and `disabled` statuses. (since 4.0)
496 #
497 # @busy: true if the bitmap is in-use by some operation (NBD or jobs)
498 #        and cannot be modified via QMP or used by another operation.
499 #        Replaces `locked` and `frozen` statuses. (since 4.0)
500 #
501 # @persistent: true if the bitmap was stored on disk, is scheduled to be stored
502 #              on disk, or both. (since 4.0)
503 #
504 # @inconsistent: true if this is a persistent bitmap that was improperly
505 #                stored. Implies @persistent to be true; @recording and
506 #                @busy to be false. This bitmap cannot be used. To remove
507 #                it, use @block-dirty-bitmap-remove. (Since 4.0)
508 #
509 # Features:
510 # @deprecated: Member @status is deprecated.  Use @recording and
511 #     @locked instead.
512 #
513 # Since: 1.3
514 ##
515 { 'struct': 'BlockDirtyInfo',
516   'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
517            'recording': 'bool', 'busy': 'bool',
518            'status': { 'type': 'DirtyBitmapStatus',
519                        'features': [ 'deprecated' ] },
520            'persistent': 'bool', '*inconsistent': 'bool' } }
521
522 ##
523 # @Qcow2BitmapInfoFlags:
524 #
525 # An enumeration of flags that a bitmap can report to the user.
526 #
527 # @in-use: This flag is set by any process actively modifying the qcow2 file,
528 #          and cleared when the updated bitmap is flushed to the qcow2 image.
529 #          The presence of this flag in an offline image means that the bitmap
530 #          was not saved correctly after its last usage, and may contain
531 #          inconsistent data.
532 #
533 # @auto: The bitmap must reflect all changes of the virtual disk by any
534 #        application that would write to this qcow2 file.
535 #
536 # Since: 4.0
537 ##
538 { 'enum': 'Qcow2BitmapInfoFlags',
539   'data': ['in-use', 'auto'] }
540
541 ##
542 # @Qcow2BitmapInfo:
543 #
544 # Qcow2 bitmap information.
545 #
546 # @name: the name of the bitmap
547 #
548 # @granularity: granularity of the bitmap in bytes
549 #
550 # @flags: flags of the bitmap
551 #
552 # Since: 4.0
553 ##
554 { 'struct': 'Qcow2BitmapInfo',
555   'data': {'name': 'str', 'granularity': 'uint32',
556            'flags': ['Qcow2BitmapInfoFlags'] } }
557
558 ##
559 # @BlockLatencyHistogramInfo:
560 #
561 # Block latency histogram.
562 #
563 # @boundaries: list of interval boundary values in nanoseconds, all greater
564 #              than zero and in ascending order.
565 #              For example, the list [10, 50, 100] produces the following
566 #              histogram intervals: [0, 10), [10, 50), [50, 100), [100, +inf).
567 #
568 # @bins: list of io request counts corresponding to histogram intervals.
569 #        len(@bins) = len(@boundaries) + 1
570 #        For the example above, @bins may be something like [3, 1, 5, 2],
571 #        and corresponding histogram looks like:
572 #
573 # |      5|           *
574 # |      4|           *
575 # |      3| *         *
576 # |      2| *         *    *
577 # |      1| *    *    *    *
578 # |       +------------------
579 # |           10   50   100
580 #
581 # Since: 4.0
582 ##
583 { 'struct': 'BlockLatencyHistogramInfo',
584   'data': {'boundaries': ['uint64'], 'bins': ['uint64'] } }
585
586 ##
587 # @BlockInfo:
588 #
589 # Block device information.  This structure describes a virtual device and
590 # the backing device associated with it.
591 #
592 # @device: The device name associated with the virtual device.
593 #
594 # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
595 #        device. (since 2.10)
596 #
597 # @type: This field is returned only for compatibility reasons, it should
598 #        not be used (always returns 'unknown')
599 #
600 # @removable: True if the device supports removable media.
601 #
602 # @locked: True if the guest has locked this device from having its media
603 #          removed
604 #
605 # @tray_open: True if the device's tray is open
606 #             (only present if it has a tray)
607 #
608 # @dirty-bitmaps: dirty bitmaps information (only present if the
609 #                 driver has one or more dirty bitmaps) (Since 2.0)
610 #
611 # @io-status: @BlockDeviceIoStatus. Only present if the device
612 #             supports it and the VM is configured to stop on errors
613 #             (supported device models: virtio-blk, IDE, SCSI except
614 #             scsi-generic)
615 #
616 # @inserted: @BlockDeviceInfo describing the device if media is
617 #            present
618 #
619 # Features:
620 # @deprecated: Member @dirty-bitmaps is deprecated.  Use @inserted
621 #     member @dirty-bitmaps instead.
622 #
623 # Since:  0.14.0
624 ##
625 { 'struct': 'BlockInfo',
626   'data': {'device': 'str', '*qdev': 'str', 'type': 'str', 'removable': 'bool',
627            'locked': 'bool', '*inserted': 'BlockDeviceInfo',
628            '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
629            '*dirty-bitmaps': { 'type': ['BlockDirtyInfo'],
630                                'features': [ 'deprecated' ] } } }
631
632 ##
633 # @BlockMeasureInfo:
634 #
635 # Image file size calculation information.  This structure describes the size
636 # requirements for creating a new image file.
637 #
638 # The size requirements depend on the new image file format.  File size always
639 # equals virtual disk size for the 'raw' format, even for sparse POSIX files.
640 # Compact formats such as 'qcow2' represent unallocated and zero regions
641 # efficiently so file size may be smaller than virtual disk size.
642 #
643 # The values are upper bounds that are guaranteed to fit the new image file.
644 # Subsequent modification, such as internal snapshot or further bitmap
645 # creation, may require additional space and is not covered here.
646 #
647 # @required: Size required for a new image file, in bytes, when copying just
648 #            allocated guest-visible contents.
649 #
650 # @fully-allocated: Image file size, in bytes, once data has been written
651 #                   to all sectors, when copying just guest-visible contents.
652 #
653 # @bitmaps: Additional size required if all the top-level bitmap metadata
654 #           in the source image were to be copied to the destination,
655 #           present only when source and destination both support
656 #           persistent bitmaps. (since 5.1)
657 #
658 # Since: 2.10
659 ##
660 { 'struct': 'BlockMeasureInfo',
661   'data': {'required': 'int', 'fully-allocated': 'int', '*bitmaps': 'int'} }
662
663 ##
664 # @query-block:
665 #
666 # Get a list of BlockInfo for all virtual block devices.
667 #
668 # Returns: a list of @BlockInfo describing each virtual block device. Filter
669 #          nodes that were created implicitly are skipped over.
670 #
671 # Since: 0.14.0
672 #
673 # Example:
674 #
675 # -> { "execute": "query-block" }
676 # <- {
677 #       "return":[
678 #          {
679 #             "io-status": "ok",
680 #             "device":"ide0-hd0",
681 #             "locked":false,
682 #             "removable":false,
683 #             "inserted":{
684 #                "ro":false,
685 #                "drv":"qcow2",
686 #                "encrypted":false,
687 #                "file":"disks/test.qcow2",
688 #                "backing_file_depth":1,
689 #                "bps":1000000,
690 #                "bps_rd":0,
691 #                "bps_wr":0,
692 #                "iops":1000000,
693 #                "iops_rd":0,
694 #                "iops_wr":0,
695 #                "bps_max": 8000000,
696 #                "bps_rd_max": 0,
697 #                "bps_wr_max": 0,
698 #                "iops_max": 0,
699 #                "iops_rd_max": 0,
700 #                "iops_wr_max": 0,
701 #                "iops_size": 0,
702 #                "detect_zeroes": "on",
703 #                "write_threshold": 0,
704 #                "image":{
705 #                   "filename":"disks/test.qcow2",
706 #                   "format":"qcow2",
707 #                   "virtual-size":2048000,
708 #                   "backing_file":"base.qcow2",
709 #                   "full-backing-filename":"disks/base.qcow2",
710 #                   "backing-filename-format":"qcow2",
711 #                   "snapshots":[
712 #                      {
713 #                         "id": "1",
714 #                         "name": "snapshot1",
715 #                         "vm-state-size": 0,
716 #                         "date-sec": 10000200,
717 #                         "date-nsec": 12,
718 #                         "vm-clock-sec": 206,
719 #                         "vm-clock-nsec": 30
720 #                      }
721 #                   ],
722 #                   "backing-image":{
723 #                       "filename":"disks/base.qcow2",
724 #                       "format":"qcow2",
725 #                       "virtual-size":2048000
726 #                   }
727 #                }
728 #             },
729 #             "qdev": "ide_disk",
730 #             "type":"unknown"
731 #          },
732 #          {
733 #             "io-status": "ok",
734 #             "device":"ide1-cd0",
735 #             "locked":false,
736 #             "removable":true,
737 #             "qdev": "/machine/unattached/device[23]",
738 #             "tray_open": false,
739 #             "type":"unknown"
740 #          },
741 #          {
742 #             "device":"floppy0",
743 #             "locked":false,
744 #             "removable":true,
745 #             "qdev": "/machine/unattached/device[20]",
746 #             "type":"unknown"
747 #          },
748 #          {
749 #             "device":"sd0",
750 #             "locked":false,
751 #             "removable":true,
752 #             "type":"unknown"
753 #          }
754 #       ]
755 #    }
756 #
757 ##
758 { 'command': 'query-block', 'returns': ['BlockInfo'] }
759
760
761 ##
762 # @BlockDeviceTimedStats:
763 #
764 # Statistics of a block device during a given interval of time.
765 #
766 # @interval_length: Interval used for calculating the statistics,
767 #                   in seconds.
768 #
769 # @min_rd_latency_ns: Minimum latency of read operations in the
770 #                     defined interval, in nanoseconds.
771 #
772 # @min_wr_latency_ns: Minimum latency of write operations in the
773 #                     defined interval, in nanoseconds.
774 #
775 # @min_flush_latency_ns: Minimum latency of flush operations in the
776 #                        defined interval, in nanoseconds.
777 #
778 # @max_rd_latency_ns: Maximum latency of read operations in the
779 #                     defined interval, in nanoseconds.
780 #
781 # @max_wr_latency_ns: Maximum latency of write operations in the
782 #                     defined interval, in nanoseconds.
783 #
784 # @max_flush_latency_ns: Maximum latency of flush operations in the
785 #                        defined interval, in nanoseconds.
786 #
787 # @avg_rd_latency_ns: Average latency of read operations in the
788 #                     defined interval, in nanoseconds.
789 #
790 # @avg_wr_latency_ns: Average latency of write operations in the
791 #                     defined interval, in nanoseconds.
792 #
793 # @avg_flush_latency_ns: Average latency of flush operations in the
794 #                        defined interval, in nanoseconds.
795 #
796 # @avg_rd_queue_depth: Average number of pending read operations
797 #                      in the defined interval.
798 #
799 # @avg_wr_queue_depth: Average number of pending write operations
800 #                      in the defined interval.
801 #
802 # Since: 2.5
803 ##
804 { 'struct': 'BlockDeviceTimedStats',
805   'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
806             'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
807             'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
808             'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
809             'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
810             'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
811
812 ##
813 # @BlockDeviceStats:
814 #
815 # Statistics of a virtual block device or a block backing device.
816 #
817 # @rd_bytes:      The number of bytes read by the device.
818 #
819 # @wr_bytes:      The number of bytes written by the device.
820 #
821 # @unmap_bytes: The number of bytes unmapped by the device (Since 4.2)
822 #
823 # @rd_operations: The number of read operations performed by the device.
824 #
825 # @wr_operations: The number of write operations performed by the device.
826 #
827 # @flush_operations: The number of cache flush operations performed by the
828 #                    device (since 0.15.0)
829 #
830 # @unmap_operations: The number of unmap operations performed by the device
831 #                    (Since 4.2)
832 #
833 # @rd_total_time_ns: Total time spent on reads in nanoseconds (since 0.15.0).
834 #
835 # @wr_total_time_ns: Total time spent on writes in nanoseconds (since 0.15.0).
836 #
837 # @flush_total_time_ns: Total time spent on cache flushes in nanoseconds
838 #                       (since 0.15.0).
839 #
840 # @unmap_total_time_ns: Total time spent on unmap operations in nanoseconds
841 #                       (Since 4.2)
842 #
843 # @wr_highest_offset: The offset after the greatest byte written to the
844 #                     device.  The intended use of this information is for
845 #                     growable sparse files (like qcow2) that are used on top
846 #                     of a physical device.
847 #
848 # @rd_merged: Number of read requests that have been merged into another
849 #             request (Since 2.3).
850 #
851 # @wr_merged: Number of write requests that have been merged into another
852 #             request (Since 2.3).
853 #
854 # @unmap_merged: Number of unmap requests that have been merged into another
855 #                request (Since 4.2)
856 #
857 # @idle_time_ns: Time since the last I/O operation, in
858 #                nanoseconds. If the field is absent it means that
859 #                there haven't been any operations yet (Since 2.5).
860 #
861 # @failed_rd_operations: The number of failed read operations
862 #                        performed by the device (Since 2.5)
863 #
864 # @failed_wr_operations: The number of failed write operations
865 #                        performed by the device (Since 2.5)
866 #
867 # @failed_flush_operations: The number of failed flush operations
868 #                           performed by the device (Since 2.5)
869 #
870 # @failed_unmap_operations: The number of failed unmap operations performed
871 #                           by the device (Since 4.2)
872 #
873 # @invalid_rd_operations: The number of invalid read operations
874 #                          performed by the device (Since 2.5)
875 #
876 # @invalid_wr_operations: The number of invalid write operations
877 #                         performed by the device (Since 2.5)
878 #
879 # @invalid_flush_operations: The number of invalid flush operations
880 #                            performed by the device (Since 2.5)
881 #
882 # @invalid_unmap_operations: The number of invalid unmap operations performed
883 #                            by the device (Since 4.2)
884 #
885 # @account_invalid: Whether invalid operations are included in the
886 #                   last access statistics (Since 2.5)
887 #
888 # @account_failed: Whether failed operations are included in the
889 #                  latency and last access statistics (Since 2.5)
890 #
891 # @timed_stats: Statistics specific to the set of previously defined
892 #               intervals of time (Since 2.5)
893 #
894 # @rd_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
895 #
896 # @wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
897 #
898 # @flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0)
899 #
900 # Since: 0.14.0
901 ##
902 { 'struct': 'BlockDeviceStats',
903   'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'unmap_bytes' : 'int',
904            'rd_operations': 'int', 'wr_operations': 'int',
905            'flush_operations': 'int', 'unmap_operations': 'int',
906            'rd_total_time_ns': 'int', 'wr_total_time_ns': 'int',
907            'flush_total_time_ns': 'int', 'unmap_total_time_ns': 'int',
908            'wr_highest_offset': 'int',
909            'rd_merged': 'int', 'wr_merged': 'int', 'unmap_merged': 'int',
910            '*idle_time_ns': 'int',
911            'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
912            'failed_flush_operations': 'int', 'failed_unmap_operations': 'int',
913            'invalid_rd_operations': 'int', 'invalid_wr_operations': 'int',
914            'invalid_flush_operations': 'int', 'invalid_unmap_operations': 'int',
915            'account_invalid': 'bool', 'account_failed': 'bool',
916            'timed_stats': ['BlockDeviceTimedStats'],
917            '*rd_latency_histogram': 'BlockLatencyHistogramInfo',
918            '*wr_latency_histogram': 'BlockLatencyHistogramInfo',
919            '*flush_latency_histogram': 'BlockLatencyHistogramInfo' } }
920
921 ##
922 # @BlockStatsSpecificFile:
923 #
924 # File driver statistics
925 #
926 # @discard-nb-ok: The number of successful discard operations performed by
927 #                 the driver.
928 #
929 # @discard-nb-failed: The number of failed discard operations performed by
930 #                     the driver.
931 #
932 # @discard-bytes-ok: The number of bytes discarded by the driver.
933 #
934 # Since: 4.2
935 ##
936 { 'struct': 'BlockStatsSpecificFile',
937   'data': {
938       'discard-nb-ok': 'uint64',
939       'discard-nb-failed': 'uint64',
940       'discard-bytes-ok': 'uint64' } }
941
942 ##
943 # @BlockStatsSpecific:
944 #
945 # Block driver specific statistics
946 #
947 # Since: 4.2
948 ##
949 { 'union': 'BlockStatsSpecific',
950   'base': { 'driver': 'BlockdevDriver' },
951   'discriminator': 'driver',
952   'data': {
953       'file': 'BlockStatsSpecificFile',
954       'host_device': 'BlockStatsSpecificFile' } }
955
956 ##
957 # @BlockStats:
958 #
959 # Statistics of a virtual block device or a block backing device.
960 #
961 # @device: If the stats are for a virtual block device, the name
962 #          corresponding to the virtual block device.
963 #
964 # @node-name: The node name of the device. (Since 2.3)
965 #
966 # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
967 #        device. (since 3.0)
968 #
969 # @stats:  A @BlockDeviceStats for the device.
970 #
971 # @driver-specific: Optional driver-specific stats. (Since 4.2)
972 #
973 # @parent: This describes the file block device if it has one.
974 #          Contains recursively the statistics of the underlying
975 #          protocol (e.g. the host file for a qcow2 image). If there is
976 #          no underlying protocol, this field is omitted
977 #
978 # @backing: This describes the backing block device if it has one.
979 #           (Since 2.0)
980 #
981 # Since: 0.14.0
982 ##
983 { 'struct': 'BlockStats',
984   'data': {'*device': 'str', '*qdev': 'str', '*node-name': 'str',
985            'stats': 'BlockDeviceStats',
986            '*driver-specific': 'BlockStatsSpecific',
987            '*parent': 'BlockStats',
988            '*backing': 'BlockStats'} }
989
990 ##
991 # @query-blockstats:
992 #
993 # Query the @BlockStats for all virtual block devices.
994 #
995 # @query-nodes: If true, the command will query all the block nodes
996 #               that have a node name, in a list which will include "parent"
997 #               information, but not "backing".
998 #               If false or omitted, the behavior is as before - query all the
999 #               device backends, recursively including their "parent" and
1000 #               "backing". Filter nodes that were created implicitly are
1001 #               skipped over in this mode. (Since 2.3)
1002 #
1003 # Returns: A list of @BlockStats for each virtual block devices.
1004 #
1005 # Since: 0.14.0
1006 #
1007 # Example:
1008 #
1009 # -> { "execute": "query-blockstats" }
1010 # <- {
1011 #       "return":[
1012 #          {
1013 #             "device":"ide0-hd0",
1014 #             "parent":{
1015 #                "stats":{
1016 #                   "wr_highest_offset":3686448128,
1017 #                   "wr_bytes":9786368,
1018 #                   "wr_operations":751,
1019 #                   "rd_bytes":122567168,
1020 #                   "rd_operations":36772
1021 #                   "wr_total_times_ns":313253456
1022 #                   "rd_total_times_ns":3465673657
1023 #                   "flush_total_times_ns":49653
1024 #                   "flush_operations":61,
1025 #                   "rd_merged":0,
1026 #                   "wr_merged":0,
1027 #                   "idle_time_ns":2953431879,
1028 #                   "account_invalid":true,
1029 #                   "account_failed":false
1030 #                }
1031 #             },
1032 #             "stats":{
1033 #                "wr_highest_offset":2821110784,
1034 #                "wr_bytes":9786368,
1035 #                "wr_operations":692,
1036 #                "rd_bytes":122739200,
1037 #                "rd_operations":36604
1038 #                "flush_operations":51,
1039 #                "wr_total_times_ns":313253456
1040 #                "rd_total_times_ns":3465673657
1041 #                "flush_total_times_ns":49653,
1042 #                "rd_merged":0,
1043 #                "wr_merged":0,
1044 #                "idle_time_ns":2953431879,
1045 #                "account_invalid":true,
1046 #                "account_failed":false
1047 #             },
1048 #             "qdev": "/machine/unattached/device[23]"
1049 #          },
1050 #          {
1051 #             "device":"ide1-cd0",
1052 #             "stats":{
1053 #                "wr_highest_offset":0,
1054 #                "wr_bytes":0,
1055 #                "wr_operations":0,
1056 #                "rd_bytes":0,
1057 #                "rd_operations":0
1058 #                "flush_operations":0,
1059 #                "wr_total_times_ns":0
1060 #                "rd_total_times_ns":0
1061 #                "flush_total_times_ns":0,
1062 #                "rd_merged":0,
1063 #                "wr_merged":0,
1064 #                "account_invalid":false,
1065 #                "account_failed":false
1066 #             },
1067 #             "qdev": "/machine/unattached/device[24]"
1068 #          },
1069 #          {
1070 #             "device":"floppy0",
1071 #             "stats":{
1072 #                "wr_highest_offset":0,
1073 #                "wr_bytes":0,
1074 #                "wr_operations":0,
1075 #                "rd_bytes":0,
1076 #                "rd_operations":0
1077 #                "flush_operations":0,
1078 #                "wr_total_times_ns":0
1079 #                "rd_total_times_ns":0
1080 #                "flush_total_times_ns":0,
1081 #                "rd_merged":0,
1082 #                "wr_merged":0,
1083 #                "account_invalid":false,
1084 #                "account_failed":false
1085 #             },
1086 #             "qdev": "/machine/unattached/device[16]"
1087 #          },
1088 #          {
1089 #             "device":"sd0",
1090 #             "stats":{
1091 #                "wr_highest_offset":0,
1092 #                "wr_bytes":0,
1093 #                "wr_operations":0,
1094 #                "rd_bytes":0,
1095 #                "rd_operations":0
1096 #                "flush_operations":0,
1097 #                "wr_total_times_ns":0
1098 #                "rd_total_times_ns":0
1099 #                "flush_total_times_ns":0,
1100 #                "rd_merged":0,
1101 #                "wr_merged":0,
1102 #                "account_invalid":false,
1103 #                "account_failed":false
1104 #             }
1105 #          }
1106 #       ]
1107 #    }
1108 #
1109 ##
1110 { 'command': 'query-blockstats',
1111   'data': { '*query-nodes': 'bool' },
1112   'returns': ['BlockStats'] }
1113
1114 ##
1115 # @BlockdevOnError:
1116 #
1117 # An enumeration of possible behaviors for errors on I/O operations.
1118 # The exact meaning depends on whether the I/O was initiated by a guest
1119 # or by a block job
1120 #
1121 # @report: for guest operations, report the error to the guest;
1122 #          for jobs, cancel the job
1123 #
1124 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
1125 #          or BLOCK_JOB_ERROR). The backup, mirror and commit block jobs retry
1126 #          the failing request later and may still complete successfully. The
1127 #          stream block job continues to stream and will complete with an
1128 #          error.
1129 #
1130 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
1131 #
1132 # @stop: for guest operations, stop the virtual machine;
1133 #        for jobs, pause the job
1134 #
1135 # @auto: inherit the error handling policy of the backend (since: 2.7)
1136 #
1137 # Since: 1.3
1138 ##
1139 { 'enum': 'BlockdevOnError',
1140   'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] }
1141
1142 ##
1143 # @MirrorSyncMode:
1144 #
1145 # An enumeration of possible behaviors for the initial synchronization
1146 # phase of storage mirroring.
1147 #
1148 # @top: copies data in the topmost image to the destination
1149 #
1150 # @full: copies data from all images to the destination
1151 #
1152 # @none: only copy data written from now on
1153 #
1154 # @incremental: only copy data described by the dirty bitmap. (since: 2.4)
1155 #
1156 # @bitmap: only copy data described by the dirty bitmap. (since: 4.2)
1157 #          Behavior on completion is determined by the BitmapSyncMode.
1158 #
1159 # Since: 1.3
1160 ##
1161 { 'enum': 'MirrorSyncMode',
1162   'data': ['top', 'full', 'none', 'incremental', 'bitmap'] }
1163
1164 ##
1165 # @BitmapSyncMode:
1166 #
1167 # An enumeration of possible behaviors for the synchronization of a bitmap
1168 # when used for data copy operations.
1169 #
1170 # @on-success: The bitmap is only synced when the operation is successful.
1171 #              This is the behavior always used for 'INCREMENTAL' backups.
1172 #
1173 # @never: The bitmap is never synchronized with the operation, and is
1174 #         treated solely as a read-only manifest of blocks to copy.
1175 #
1176 # @always: The bitmap is always synchronized with the operation,
1177 #          regardless of whether or not the operation was successful.
1178 #
1179 # Since: 4.2
1180 ##
1181 { 'enum': 'BitmapSyncMode',
1182   'data': ['on-success', 'never', 'always'] }
1183
1184 ##
1185 # @MirrorCopyMode:
1186 #
1187 # An enumeration whose values tell the mirror block job when to
1188 # trigger writes to the target.
1189 #
1190 # @background: copy data in background only.
1191 #
1192 # @write-blocking: when data is written to the source, write it
1193 #                  (synchronously) to the target as well.  In
1194 #                  addition, data is copied in background just like in
1195 #                  @background mode.
1196 #
1197 # Since: 3.0
1198 ##
1199 { 'enum': 'MirrorCopyMode',
1200   'data': ['background', 'write-blocking'] }
1201
1202 ##
1203 # @BlockJobInfo:
1204 #
1205 # Information about a long-running block device operation.
1206 #
1207 # @type: the job type ('stream' for image streaming)
1208 #
1209 # @device: The job identifier. Originally the device name but other
1210 #          values are allowed since QEMU 2.7
1211 #
1212 # @len: Estimated @offset value at the completion of the job. This value can
1213 #       arbitrarily change while the job is running, in both directions.
1214 #
1215 # @offset: Progress made until now. The unit is arbitrary and the value can
1216 #          only meaningfully be used for the ratio of @offset to @len. The
1217 #          value is monotonically increasing.
1218 #
1219 # @busy: false if the job is known to be in a quiescent state, with
1220 #        no pending I/O.  Since 1.3.
1221 #
1222 # @paused: whether the job is paused or, if @busy is true, will
1223 #          pause itself as soon as possible.  Since 1.3.
1224 #
1225 # @speed: the rate limit, bytes per second
1226 #
1227 # @io-status: the status of the job (since 1.3)
1228 #
1229 # @ready: true if the job may be completed (since 2.2)
1230 #
1231 # @status: Current job state/status (since 2.12)
1232 #
1233 # @auto-finalize: Job will finalize itself when PENDING, moving to
1234 #                 the CONCLUDED state. (since 2.12)
1235 #
1236 # @auto-dismiss: Job will dismiss itself when CONCLUDED, moving to the NULL
1237 #                state and disappearing from the query list. (since 2.12)
1238 #
1239 # @error: Error information if the job did not complete successfully.
1240 #         Not set if the job completed successfully. (since 2.12.1)
1241 #
1242 # Since: 1.1
1243 ##
1244 { 'struct': 'BlockJobInfo',
1245   'data': {'type': 'str', 'device': 'str', 'len': 'int',
1246            'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
1247            'io-status': 'BlockDeviceIoStatus', 'ready': 'bool',
1248            'status': 'JobStatus',
1249            'auto-finalize': 'bool', 'auto-dismiss': 'bool',
1250            '*error': 'str' } }
1251
1252 ##
1253 # @query-block-jobs:
1254 #
1255 # Return information about long-running block device operations.
1256 #
1257 # Returns: a list of @BlockJobInfo for each active block job
1258 #
1259 # Since: 1.1
1260 ##
1261 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
1262
1263 ##
1264 # @block_passwd:
1265 #
1266 # This command sets the password of a block device that has not been open
1267 # with a password and requires one.
1268 #
1269 # This command is now obsolete and will always return an error since 2.10
1270 #
1271 ##
1272 { 'command': 'block_passwd',
1273   'data': { '*device': 'str',
1274             '*node-name': 'str',
1275             'password': 'str' } }
1276
1277 ##
1278 # @block_resize:
1279 #
1280 # Resize a block image while a guest is running.
1281 #
1282 # Either @device or @node-name must be set but not both.
1283 #
1284 # @device: the name of the device to get the image resized
1285 #
1286 # @node-name: graph node name to get the image resized (Since 2.0)
1287 #
1288 # @size:  new image size in bytes
1289 #
1290 # Returns: - nothing on success
1291 #          - If @device is not a valid block device, DeviceNotFound
1292 #
1293 # Since: 0.14.0
1294 #
1295 # Example:
1296 #
1297 # -> { "execute": "block_resize",
1298 #      "arguments": { "device": "scratch", "size": 1073741824 } }
1299 # <- { "return": {} }
1300 #
1301 ##
1302 { 'command': 'block_resize',
1303   'data': { '*device': 'str',
1304             '*node-name': 'str',
1305             'size': 'int' } }
1306
1307 ##
1308 # @NewImageMode:
1309 #
1310 # An enumeration that tells QEMU how to set the backing file path in
1311 # a new image file.
1312 #
1313 # @existing: QEMU should look for an existing image file.
1314 #
1315 # @absolute-paths: QEMU should create a new image with absolute paths
1316 #                  for the backing file. If there is no backing file available, the new
1317 #                  image will not be backed either.
1318 #
1319 # Since: 1.1
1320 ##
1321 { 'enum': 'NewImageMode',
1322   'data': [ 'existing', 'absolute-paths' ] }
1323
1324 ##
1325 # @BlockdevSnapshotSync:
1326 #
1327 # Either @device or @node-name must be set but not both.
1328 #
1329 # @device: the name of the device to take a snapshot of.
1330 #
1331 # @node-name: graph node name to generate the snapshot from (Since 2.0)
1332 #
1333 # @snapshot-file: the target of the new overlay image. If the file
1334 #                 exists, or if it is a device, the overlay will be created in the
1335 #                 existing file/device. Otherwise, a new file will be created.
1336 #
1337 # @snapshot-node-name: the graph node name of the new image (Since 2.0)
1338 #
1339 # @format: the format of the overlay image, default is 'qcow2'.
1340 #
1341 # @mode: whether and how QEMU should create a new image, default is
1342 #        'absolute-paths'.
1343 ##
1344 { 'struct': 'BlockdevSnapshotSync',
1345   'data': { '*device': 'str', '*node-name': 'str',
1346             'snapshot-file': 'str', '*snapshot-node-name': 'str',
1347             '*format': 'str', '*mode': 'NewImageMode' } }
1348
1349 ##
1350 # @BlockdevSnapshot:
1351 #
1352 # @node: device or node name that will have a snapshot taken.
1353 #
1354 # @overlay: reference to the existing block device that will become
1355 #           the overlay of @node, as part of taking the snapshot.
1356 #           It must not have a current backing file (this can be
1357 #           achieved by passing "backing": null to blockdev-add).
1358 #
1359 # Since: 2.5
1360 ##
1361 { 'struct': 'BlockdevSnapshot',
1362   'data': { 'node': 'str', 'overlay': 'str' } }
1363
1364 ##
1365 # @BackupCommon:
1366 #
1367 # @job-id: identifier for the newly-created block job. If
1368 #          omitted, the device name will be used. (Since 2.7)
1369 #
1370 # @device: the device name or node-name of a root node which should be copied.
1371 #
1372 # @sync: what parts of the disk image should be copied to the destination
1373 #        (all the disk, only the sectors allocated in the topmost image, from a
1374 #        dirty bitmap, or only new I/O).
1375 #
1376 # @speed: the maximum speed, in bytes per second. The default is 0,
1377 #         for unlimited.
1378 #
1379 # @bitmap: The name of a dirty bitmap to use.
1380 #          Must be present if sync is "bitmap" or "incremental".
1381 #          Can be present if sync is "full" or "top".
1382 #          Must not be present otherwise.
1383 #          (Since 2.4 (drive-backup), 3.1 (blockdev-backup))
1384 #
1385 # @bitmap-mode: Specifies the type of data the bitmap should contain after
1386 #               the operation concludes.
1387 #               Must be present if a bitmap was provided,
1388 #               Must NOT be present otherwise. (Since 4.2)
1389 #
1390 # @compress: true to compress data, if the target format supports it.
1391 #            (default: false) (since 2.8)
1392 #
1393 # @on-source-error: the action to take on an error on the source,
1394 #                   default 'report'.  'stop' and 'enospc' can only be used
1395 #                   if the block device supports io-status (see BlockInfo).
1396 #
1397 # @on-target-error: the action to take on an error on the target,
1398 #                   default 'report' (no limitations, since this applies to
1399 #                   a different block device than @device).
1400 #
1401 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1402 #                 finished its work, waiting for @block-job-finalize before
1403 #                 making any block graph changes.
1404 #                 When true, this job will automatically
1405 #                 perform its abort or commit actions.
1406 #                 Defaults to true. (Since 2.12)
1407 #
1408 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1409 #                has completely ceased all work, and awaits @block-job-dismiss.
1410 #                When true, this job will automatically disappear from the query
1411 #                list without user intervention.
1412 #                Defaults to true. (Since 2.12)
1413 #
1414 # @filter-node-name: the node name that should be assigned to the
1415 #                    filter driver that the backup job inserts into the graph
1416 #                    above node specified by @drive. If this option is not given,
1417 #                    a node name is autogenerated. (Since: 4.2)
1418 #
1419 # Note: @on-source-error and @on-target-error only affect background
1420 #       I/O.  If an error occurs during a guest write request, the device's
1421 #       rerror/werror actions will be used.
1422 #
1423 # Since: 4.2
1424 ##
1425 { 'struct': 'BackupCommon',
1426   'data': { '*job-id': 'str', 'device': 'str',
1427             'sync': 'MirrorSyncMode', '*speed': 'int',
1428             '*bitmap': 'str', '*bitmap-mode': 'BitmapSyncMode',
1429             '*compress': 'bool',
1430             '*on-source-error': 'BlockdevOnError',
1431             '*on-target-error': 'BlockdevOnError',
1432             '*auto-finalize': 'bool', '*auto-dismiss': 'bool',
1433             '*filter-node-name': 'str' } }
1434
1435 ##
1436 # @DriveBackup:
1437 #
1438 # @target: the target of the new image. If the file exists, or if it
1439 #          is a device, the existing file/device will be used as the new
1440 #          destination.  If it does not exist, a new file will be created.
1441 #
1442 # @format: the format of the new destination, default is to
1443 #          probe if @mode is 'existing', else the format of the source
1444 #
1445 # @mode: whether and how QEMU should create a new image, default is
1446 #        'absolute-paths'.
1447 #
1448 # Since: 1.6
1449 ##
1450 { 'struct': 'DriveBackup',
1451   'base': 'BackupCommon',
1452   'data': { 'target': 'str',
1453             '*format': 'str',
1454             '*mode': 'NewImageMode' } }
1455
1456 ##
1457 # @BlockdevBackup:
1458 #
1459 # @target: the device name or node-name of the backup target node.
1460 #
1461 # Since: 2.3
1462 ##
1463 { 'struct': 'BlockdevBackup',
1464   'base': 'BackupCommon',
1465   'data': { 'target': 'str' } }
1466
1467 ##
1468 # @blockdev-snapshot-sync:
1469 #
1470 # Takes a synchronous snapshot of a block device.
1471 #
1472 # For the arguments, see the documentation of BlockdevSnapshotSync.
1473 #
1474 # Returns: - nothing on success
1475 #          - If @device is not a valid block device, DeviceNotFound
1476 #
1477 # Since: 0.14.0
1478 #
1479 # Example:
1480 #
1481 # -> { "execute": "blockdev-snapshot-sync",
1482 #      "arguments": { "device": "ide-hd0",
1483 #                     "snapshot-file":
1484 #                     "/some/place/my-image",
1485 #                     "format": "qcow2" } }
1486 # <- { "return": {} }
1487 #
1488 ##
1489 { 'command': 'blockdev-snapshot-sync',
1490   'data': 'BlockdevSnapshotSync' }
1491
1492
1493 ##
1494 # @blockdev-snapshot:
1495 #
1496 # Takes a snapshot of a block device.
1497 #
1498 # Take a snapshot, by installing 'node' as the backing image of
1499 # 'overlay'. Additionally, if 'node' is associated with a block
1500 # device, the block device changes to using 'overlay' as its new active
1501 # image.
1502 #
1503 # For the arguments, see the documentation of BlockdevSnapshot.
1504 #
1505 # Features:
1506 # @allow-write-only-overlay: If present, the check whether this operation is safe
1507 #                            was relaxed so that it can be used to change
1508 #                            backing file of a destination of a blockdev-mirror.
1509 #                            (since 5.0)
1510 #
1511 # Since: 2.5
1512 #
1513 # Example:
1514 #
1515 # -> { "execute": "blockdev-add",
1516 #      "arguments": { "driver": "qcow2",
1517 #                     "node-name": "node1534",
1518 #                     "file": { "driver": "file",
1519 #                               "filename": "hd1.qcow2" },
1520 #                     "backing": null } }
1521 #
1522 # <- { "return": {} }
1523 #
1524 # -> { "execute": "blockdev-snapshot",
1525 #      "arguments": { "node": "ide-hd0",
1526 #                     "overlay": "node1534" } }
1527 # <- { "return": {} }
1528 #
1529 ##
1530 { 'command': 'blockdev-snapshot',
1531   'data': 'BlockdevSnapshot',
1532   'features': [ 'allow-write-only-overlay' ] }
1533
1534 ##
1535 # @change-backing-file:
1536 #
1537 # Change the backing file in the image file metadata.  This does not
1538 # cause QEMU to reopen the image file to reparse the backing filename
1539 # (it may, however, perform a reopen to change permissions from
1540 # r/o -> r/w -> r/o, if needed). The new backing file string is written
1541 # into the image file metadata, and the QEMU internal strings are
1542 # updated.
1543 #
1544 # @image-node-name: The name of the block driver state node of the
1545 #                   image to modify. The "device" argument is used
1546 #                   to verify "image-node-name" is in the chain
1547 #                   described by "device".
1548 #
1549 # @device: The device name or node-name of the root node that owns
1550 #          image-node-name.
1551 #
1552 # @backing-file: The string to write as the backing file.  This
1553 #                string is not validated, so care should be taken
1554 #                when specifying the string or the image chain may
1555 #                not be able to be reopened again.
1556 #
1557 # Returns: - Nothing on success
1558 #          - If "device" does not exist or cannot be determined, DeviceNotFound
1559 #
1560 # Since: 2.1
1561 ##
1562 { 'command': 'change-backing-file',
1563   'data': { 'device': 'str', 'image-node-name': 'str',
1564             'backing-file': 'str' } }
1565
1566 ##
1567 # @block-commit:
1568 #
1569 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1570 # writes data between 'top' and 'base' into 'base'.
1571 #
1572 # @job-id: identifier for the newly-created block job. If
1573 #          omitted, the device name will be used. (Since 2.7)
1574 #
1575 # @device: the device name or node-name of a root node
1576 #
1577 # @base-node: The node name of the backing image to write data into.
1578 #             If not specified, this is the deepest backing image.
1579 #             (since: 3.1)
1580 #
1581 # @base: Same as @base-node, except that it is a file name rather than a node
1582 #        name. This must be the exact filename string that was used to open the
1583 #        node; other strings, even if addressing the same file, are not
1584 #        accepted
1585 #
1586 # @top-node: The node name of the backing image within the image chain
1587 #            which contains the topmost data to be committed down. If
1588 #            not specified, this is the active layer. (since: 3.1)
1589 #
1590 # @top: Same as @top-node, except that it is a file name rather than a node
1591 #       name. This must be the exact filename string that was used to open the
1592 #       node; other strings, even if addressing the same file, are not
1593 #       accepted
1594 #
1595 # @backing-file: The backing file string to write into the overlay
1596 #                image of 'top'.  If 'top' is the active layer,
1597 #                specifying a backing file string is an error. This
1598 #                filename is not validated.
1599 #
1600 #                If a pathname string is such that it cannot be
1601 #                resolved by QEMU, that means that subsequent QMP or
1602 #                HMP commands must use node-names for the image in
1603 #                question, as filename lookup methods will fail.
1604 #
1605 #                If not specified, QEMU will automatically determine
1606 #                the backing file string to use, or error out if
1607 #                there is no obvious choice. Care should be taken
1608 #                when specifying the string, to specify a valid
1609 #                filename or protocol.
1610 #                (Since 2.1)
1611 #
1612 #                If top == base, that is an error.
1613 #                If top == active, the job will not be completed by itself,
1614 #                user needs to complete the job with the block-job-complete
1615 #                command after getting the ready event. (Since 2.0)
1616 #
1617 #                If the base image is smaller than top, then the base image
1618 #                will be resized to be the same size as top.  If top is
1619 #                smaller than the base image, the base will not be
1620 #                truncated.  If you want the base image size to match the
1621 #                size of the smaller top, you can safely truncate it
1622 #                yourself once the commit operation successfully completes.
1623 #
1624 # @speed: the maximum speed, in bytes per second
1625 #
1626 # @on-error: the action to take on an error. 'ignore' means that the request
1627 #            should be retried. (default: report; Since: 5.0)
1628 #
1629 # @filter-node-name: the node name that should be assigned to the
1630 #                    filter driver that the commit job inserts into the graph
1631 #                    above @top. If this option is not given, a node name is
1632 #                    autogenerated. (Since: 2.9)
1633 #
1634 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1635 #                 finished its work, waiting for @block-job-finalize before
1636 #                 making any block graph changes.
1637 #                 When true, this job will automatically
1638 #                 perform its abort or commit actions.
1639 #                 Defaults to true. (Since 3.1)
1640 #
1641 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1642 #                has completely ceased all work, and awaits @block-job-dismiss.
1643 #                When true, this job will automatically disappear from the query
1644 #                list without user intervention.
1645 #                Defaults to true. (Since 3.1)
1646 #
1647 # Features:
1648 # @deprecated: Members @base and @top are deprecated.  Use @base-node
1649 #     and @top-node instead.
1650 #
1651 # Returns: - Nothing on success
1652 #          - If @device does not exist, DeviceNotFound
1653 #          - Any other error returns a GenericError.
1654 #
1655 # Since: 1.3
1656 #
1657 # Example:
1658 #
1659 # -> { "execute": "block-commit",
1660 #      "arguments": { "device": "virtio0",
1661 #                     "top": "/tmp/snap1.qcow2" } }
1662 # <- { "return": {} }
1663 #
1664 ##
1665 { 'command': 'block-commit',
1666   'data': { '*job-id': 'str', 'device': 'str', '*base-node': 'str',
1667             '*base': { 'type': 'str', 'features': [ 'deprecated' ] },
1668             '*top-node': 'str',
1669             '*top': { 'type': 'str', 'features': [ 'deprecated' ] },
1670             '*backing-file': 'str', '*speed': 'int',
1671             '*on-error': 'BlockdevOnError',
1672             '*filter-node-name': 'str',
1673             '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
1674
1675 ##
1676 # @drive-backup:
1677 #
1678 # Start a point-in-time copy of a block device to a new destination.  The
1679 # status of ongoing drive-backup operations can be checked with
1680 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1681 # The operation can be stopped before it has completed using the
1682 # block-job-cancel command.
1683 #
1684 # Returns: - nothing on success
1685 #          - If @device is not a valid block device, GenericError
1686 #
1687 # Since: 1.6
1688 #
1689 # Example:
1690 #
1691 # -> { "execute": "drive-backup",
1692 #      "arguments": { "device": "drive0",
1693 #                     "sync": "full",
1694 #                     "target": "backup.img" } }
1695 # <- { "return": {} }
1696 #
1697 ##
1698 { 'command': 'drive-backup', 'boxed': true,
1699   'data': 'DriveBackup' }
1700
1701 ##
1702 # @blockdev-backup:
1703 #
1704 # Start a point-in-time copy of a block device to a new destination.  The
1705 # status of ongoing blockdev-backup operations can be checked with
1706 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1707 # The operation can be stopped before it has completed using the
1708 # block-job-cancel command.
1709 #
1710 # Returns: - nothing on success
1711 #          - If @device is not a valid block device, DeviceNotFound
1712 #
1713 # Since: 2.3
1714 #
1715 # Example:
1716 # -> { "execute": "blockdev-backup",
1717 #      "arguments": { "device": "src-id",
1718 #                     "sync": "full",
1719 #                     "target": "tgt-id" } }
1720 # <- { "return": {} }
1721 #
1722 ##
1723 { 'command': 'blockdev-backup', 'boxed': true,
1724   'data': 'BlockdevBackup' }
1725
1726
1727 ##
1728 # @query-named-block-nodes:
1729 #
1730 # Get the named block driver list
1731 #
1732 # @flat: Omit the nested data about backing image ("backing-image" key) if true.
1733 #        Default is false (Since 5.0)
1734 #
1735 # Returns: the list of BlockDeviceInfo
1736 #
1737 # Since: 2.0
1738 #
1739 # Example:
1740 #
1741 # -> { "execute": "query-named-block-nodes" }
1742 # <- { "return": [ { "ro":false,
1743 #                    "drv":"qcow2",
1744 #                    "encrypted":false,
1745 #                    "file":"disks/test.qcow2",
1746 #                    "node-name": "my-node",
1747 #                    "backing_file_depth":1,
1748 #                    "bps":1000000,
1749 #                    "bps_rd":0,
1750 #                    "bps_wr":0,
1751 #                    "iops":1000000,
1752 #                    "iops_rd":0,
1753 #                    "iops_wr":0,
1754 #                    "bps_max": 8000000,
1755 #                    "bps_rd_max": 0,
1756 #                    "bps_wr_max": 0,
1757 #                    "iops_max": 0,
1758 #                    "iops_rd_max": 0,
1759 #                    "iops_wr_max": 0,
1760 #                    "iops_size": 0,
1761 #                    "write_threshold": 0,
1762 #                    "image":{
1763 #                       "filename":"disks/test.qcow2",
1764 #                       "format":"qcow2",
1765 #                       "virtual-size":2048000,
1766 #                       "backing_file":"base.qcow2",
1767 #                       "full-backing-filename":"disks/base.qcow2",
1768 #                       "backing-filename-format":"qcow2",
1769 #                       "snapshots":[
1770 #                          {
1771 #                             "id": "1",
1772 #                             "name": "snapshot1",
1773 #                             "vm-state-size": 0,
1774 #                             "date-sec": 10000200,
1775 #                             "date-nsec": 12,
1776 #                             "vm-clock-sec": 206,
1777 #                             "vm-clock-nsec": 30
1778 #                          }
1779 #                       ],
1780 #                       "backing-image":{
1781 #                           "filename":"disks/base.qcow2",
1782 #                           "format":"qcow2",
1783 #                           "virtual-size":2048000
1784 #                       }
1785 #                    } } ] }
1786 #
1787 ##
1788 { 'command': 'query-named-block-nodes',
1789   'returns': [ 'BlockDeviceInfo' ],
1790   'data': { '*flat': 'bool' } }
1791
1792 ##
1793 # @XDbgBlockGraphNodeType:
1794 #
1795 # @block-backend: corresponds to BlockBackend
1796 #
1797 # @block-job: corresonds to BlockJob
1798 #
1799 # @block-driver: corresponds to BlockDriverState
1800 #
1801 # Since: 4.0
1802 ##
1803 { 'enum': 'XDbgBlockGraphNodeType',
1804   'data': [ 'block-backend', 'block-job', 'block-driver' ] }
1805
1806 ##
1807 # @XDbgBlockGraphNode:
1808 #
1809 # @id: Block graph node identifier. This @id is generated only for
1810 #      x-debug-query-block-graph and does not relate to any other identifiers in
1811 #      Qemu.
1812 #
1813 # @type: Type of graph node. Can be one of block-backend, block-job or
1814 #        block-driver-state.
1815 #
1816 # @name: Human readable name of the node. Corresponds to node-name for
1817 #        block-driver-state nodes; is not guaranteed to be unique in the whole
1818 #        graph (with block-jobs and block-backends).
1819 #
1820 # Since: 4.0
1821 ##
1822 { 'struct': 'XDbgBlockGraphNode',
1823   'data': { 'id': 'uint64', 'type': 'XDbgBlockGraphNodeType', 'name': 'str' } }
1824
1825 ##
1826 # @BlockPermission:
1827 #
1828 # Enum of base block permissions.
1829 #
1830 # @consistent-read: A user that has the "permission" of consistent reads is
1831 #                   guaranteed that their view of the contents of the block
1832 #                   device is complete and self-consistent, representing the
1833 #                   contents of a disk at a specific point.
1834 #                   For most block devices (including their backing files) this
1835 #                   is true, but the property cannot be maintained in a few
1836 #                   situations like for intermediate nodes of a commit block
1837 #                   job.
1838 #
1839 # @write: This permission is required to change the visible disk contents.
1840 #
1841 # @write-unchanged: This permission (which is weaker than BLK_PERM_WRITE) is
1842 #                   both enough and required for writes to the block node when
1843 #                   the caller promises that the visible disk content doesn't
1844 #                   change.
1845 #                   As the BLK_PERM_WRITE permission is strictly stronger,
1846 #                   either is sufficient to perform an unchanging write.
1847 #
1848 # @resize: This permission is required to change the size of a block node.
1849 #
1850 # @graph-mod: This permission is required to change the node that this
1851 #             BdrvChild points to.
1852 #
1853 # Since: 4.0
1854 ##
1855 { 'enum': 'BlockPermission',
1856   'data': [ 'consistent-read', 'write', 'write-unchanged', 'resize',
1857             'graph-mod' ] }
1858 ##
1859 # @XDbgBlockGraphEdge:
1860 #
1861 # Block Graph edge description for x-debug-query-block-graph.
1862 #
1863 # @parent: parent id
1864 #
1865 # @child: child id
1866 #
1867 # @name: name of the relation (examples are 'file' and 'backing')
1868 #
1869 # @perm: granted permissions for the parent operating on the child
1870 #
1871 # @shared-perm: permissions that can still be granted to other users of the
1872 #               child while it is still attached to this parent
1873 #
1874 # Since: 4.0
1875 ##
1876 { 'struct': 'XDbgBlockGraphEdge',
1877   'data': { 'parent': 'uint64', 'child': 'uint64',
1878             'name': 'str', 'perm': [ 'BlockPermission' ],
1879             'shared-perm': [ 'BlockPermission' ] } }
1880
1881 ##
1882 # @XDbgBlockGraph:
1883 #
1884 # Block Graph - list of nodes and list of edges.
1885 #
1886 # Since: 4.0
1887 ##
1888 { 'struct': 'XDbgBlockGraph',
1889   'data': { 'nodes': ['XDbgBlockGraphNode'], 'edges': ['XDbgBlockGraphEdge'] } }
1890
1891 ##
1892 # @x-debug-query-block-graph:
1893 #
1894 # Get the block graph.
1895 #
1896 # Since: 4.0
1897 ##
1898 { 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph' }
1899
1900 ##
1901 # @drive-mirror:
1902 #
1903 # Start mirroring a block device's writes to a new destination. target
1904 # specifies the target of the new image. If the file exists, or if it
1905 # is a device, it will be used as the new destination for writes. If
1906 # it does not exist, a new file will be created. format specifies the
1907 # format of the mirror image, default is to probe if mode='existing',
1908 # else the format of the source.
1909 #
1910 # Returns: - nothing on success
1911 #          - If @device is not a valid block device, GenericError
1912 #
1913 # Since: 1.3
1914 #
1915 # Example:
1916 #
1917 # -> { "execute": "drive-mirror",
1918 #      "arguments": { "device": "ide-hd0",
1919 #                     "target": "/some/place/my-image",
1920 #                     "sync": "full",
1921 #                     "format": "qcow2" } }
1922 # <- { "return": {} }
1923 #
1924 ##
1925 { 'command': 'drive-mirror', 'boxed': true,
1926   'data': 'DriveMirror' }
1927
1928 ##
1929 # @DriveMirror:
1930 #
1931 # A set of parameters describing drive mirror setup.
1932 #
1933 # @job-id: identifier for the newly-created block job. If
1934 #          omitted, the device name will be used. (Since 2.7)
1935 #
1936 # @device:  the device name or node-name of a root node whose writes should be
1937 #           mirrored.
1938 #
1939 # @target: the target of the new image. If the file exists, or if it
1940 #          is a device, the existing file/device will be used as the new
1941 #          destination.  If it does not exist, a new file will be created.
1942 #
1943 # @format: the format of the new destination, default is to
1944 #          probe if @mode is 'existing', else the format of the source
1945 #
1946 # @node-name: the new block driver state node name in the graph
1947 #             (Since 2.1)
1948 #
1949 # @replaces: with sync=full graph node name to be replaced by the new
1950 #            image when a whole image copy is done. This can be used to repair
1951 #            broken Quorum files. (Since 2.1)
1952 #
1953 # @mode: whether and how QEMU should create a new image, default is
1954 #        'absolute-paths'.
1955 #
1956 # @speed:  the maximum speed, in bytes per second
1957 #
1958 # @sync: what parts of the disk image should be copied to the destination
1959 #        (all the disk, only the sectors allocated in the topmost image, or
1960 #        only new I/O).
1961 #
1962 # @granularity: granularity of the dirty bitmap, default is 64K
1963 #               if the image format doesn't have clusters, 4K if the clusters
1964 #               are smaller than that, else the cluster size.  Must be a
1965 #               power of 2 between 512 and 64M (since 1.4).
1966 #
1967 # @buf-size: maximum amount of data in flight from source to
1968 #            target (since 1.4).
1969 #
1970 # @on-source-error: the action to take on an error on the source,
1971 #                   default 'report'.  'stop' and 'enospc' can only be used
1972 #                   if the block device supports io-status (see BlockInfo).
1973 #
1974 # @on-target-error: the action to take on an error on the target,
1975 #                   default 'report' (no limitations, since this applies to
1976 #                   a different block device than @device).
1977 # @unmap: Whether to try to unmap target sectors where source has
1978 #         only zero. If true, and target unallocated sectors will read as zero,
1979 #         target image sectors will be unmapped; otherwise, zeroes will be
1980 #         written. Both will result in identical contents.
1981 #         Default is true. (Since 2.4)
1982 #
1983 # @copy-mode: when to copy data to the destination; defaults to 'background'
1984 #             (Since: 3.0)
1985 #
1986 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1987 #                 finished its work, waiting for @block-job-finalize before
1988 #                 making any block graph changes.
1989 #                 When true, this job will automatically
1990 #                 perform its abort or commit actions.
1991 #                 Defaults to true. (Since 3.1)
1992 #
1993 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1994 #                has completely ceased all work, and awaits @block-job-dismiss.
1995 #                When true, this job will automatically disappear from the query
1996 #                list without user intervention.
1997 #                Defaults to true. (Since 3.1)
1998 # Since: 1.3
1999 ##
2000 { 'struct': 'DriveMirror',
2001   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2002             '*format': 'str', '*node-name': 'str', '*replaces': 'str',
2003             'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
2004             '*speed': 'int', '*granularity': 'uint32',
2005             '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2006             '*on-target-error': 'BlockdevOnError',
2007             '*unmap': 'bool', '*copy-mode': 'MirrorCopyMode',
2008             '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2009
2010 ##
2011 # @BlockDirtyBitmap:
2012 #
2013 # @node: name of device/node which the bitmap is tracking
2014 #
2015 # @name: name of the dirty bitmap
2016 #
2017 # Since: 2.4
2018 ##
2019 { 'struct': 'BlockDirtyBitmap',
2020   'data': { 'node': 'str', 'name': 'str' } }
2021
2022 ##
2023 # @BlockDirtyBitmapAdd:
2024 #
2025 # @node: name of device/node which the bitmap is tracking
2026 #
2027 # @name: name of the dirty bitmap (must be less than 1024 bytes)
2028 #
2029 # @granularity: the bitmap granularity, default is 64k for
2030 #               block-dirty-bitmap-add
2031 #
2032 # @persistent: the bitmap is persistent, i.e. it will be saved to the
2033 #              corresponding block device image file on its close. For now only
2034 #              Qcow2 disks support persistent bitmaps. Default is false for
2035 #              block-dirty-bitmap-add. (Since: 2.10)
2036 #
2037 # @disabled: the bitmap is created in the disabled state, which means that
2038 #            it will not track drive changes. The bitmap may be enabled with
2039 #            block-dirty-bitmap-enable. Default is false. (Since: 4.0)
2040 #
2041 # Since: 2.4
2042 ##
2043 { 'struct': 'BlockDirtyBitmapAdd',
2044   'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32',
2045             '*persistent': 'bool', '*disabled': 'bool' } }
2046
2047 ##
2048 # @BlockDirtyBitmapMergeSource:
2049 #
2050 # @local: name of the bitmap, attached to the same node as target bitmap.
2051 #
2052 # @external: bitmap with specified node
2053 #
2054 # Since: 4.1
2055 ##
2056 { 'alternate': 'BlockDirtyBitmapMergeSource',
2057   'data': { 'local': 'str',
2058             'external': 'BlockDirtyBitmap' } }
2059
2060 ##
2061 # @BlockDirtyBitmapMerge:
2062 #
2063 # @node: name of device/node which the @target bitmap is tracking
2064 #
2065 # @target: name of the destination dirty bitmap
2066 #
2067 # @bitmaps: name(s) of the source dirty bitmap(s) at @node and/or fully
2068 #           specifed BlockDirtyBitmap elements. The latter are supported
2069 #           since 4.1.
2070 #
2071 # Since: 4.0
2072 ##
2073 { 'struct': 'BlockDirtyBitmapMerge',
2074   'data': { 'node': 'str', 'target': 'str',
2075             'bitmaps': ['BlockDirtyBitmapMergeSource'] } }
2076
2077 ##
2078 # @block-dirty-bitmap-add:
2079 #
2080 # Create a dirty bitmap with a name on the node, and start tracking the writes.
2081 #
2082 # Returns: - nothing on success
2083 #          - If @node is not a valid block device or node, DeviceNotFound
2084 #          - If @name is already taken, GenericError with an explanation
2085 #
2086 # Since: 2.4
2087 #
2088 # Example:
2089 #
2090 # -> { "execute": "block-dirty-bitmap-add",
2091 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
2092 # <- { "return": {} }
2093 #
2094 ##
2095 { 'command': 'block-dirty-bitmap-add',
2096   'data': 'BlockDirtyBitmapAdd' }
2097
2098 ##
2099 # @block-dirty-bitmap-remove:
2100 #
2101 # Stop write tracking and remove the dirty bitmap that was created
2102 # with block-dirty-bitmap-add. If the bitmap is persistent, remove it from its
2103 # storage too.
2104 #
2105 # Returns: - nothing on success
2106 #          - If @node is not a valid block device or node, DeviceNotFound
2107 #          - If @name is not found, GenericError with an explanation
2108 #          - if @name is frozen by an operation, GenericError
2109 #
2110 # Since: 2.4
2111 #
2112 # Example:
2113 #
2114 # -> { "execute": "block-dirty-bitmap-remove",
2115 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
2116 # <- { "return": {} }
2117 #
2118 ##
2119 { 'command': 'block-dirty-bitmap-remove',
2120   'data': 'BlockDirtyBitmap' }
2121
2122 ##
2123 # @block-dirty-bitmap-clear:
2124 #
2125 # Clear (reset) a dirty bitmap on the device, so that an incremental
2126 # backup from this point in time forward will only backup clusters
2127 # modified after this clear operation.
2128 #
2129 # Returns: - nothing on success
2130 #          - If @node is not a valid block device, DeviceNotFound
2131 #          - If @name is not found, GenericError with an explanation
2132 #
2133 # Since: 2.4
2134 #
2135 # Example:
2136 #
2137 # -> { "execute": "block-dirty-bitmap-clear",
2138 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
2139 # <- { "return": {} }
2140 #
2141 ##
2142 { 'command': 'block-dirty-bitmap-clear',
2143   'data': 'BlockDirtyBitmap' }
2144
2145 ##
2146 # @block-dirty-bitmap-enable:
2147 #
2148 # Enables a dirty bitmap so that it will begin tracking disk changes.
2149 #
2150 # Returns: - nothing on success
2151 #          - If @node is not a valid block device, DeviceNotFound
2152 #          - If @name is not found, GenericError with an explanation
2153 #
2154 # Since: 4.0
2155 #
2156 # Example:
2157 #
2158 # -> { "execute": "block-dirty-bitmap-enable",
2159 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
2160 # <- { "return": {} }
2161 #
2162 ##
2163 { 'command': 'block-dirty-bitmap-enable',
2164   'data': 'BlockDirtyBitmap' }
2165
2166 ##
2167 # @block-dirty-bitmap-disable:
2168 #
2169 # Disables a dirty bitmap so that it will stop tracking disk changes.
2170 #
2171 # Returns: - nothing on success
2172 #          - If @node is not a valid block device, DeviceNotFound
2173 #          - If @name is not found, GenericError with an explanation
2174 #
2175 # Since: 4.0
2176 #
2177 # Example:
2178 #
2179 # -> { "execute": "block-dirty-bitmap-disable",
2180 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
2181 # <- { "return": {} }
2182 #
2183 ##
2184 { 'command': 'block-dirty-bitmap-disable',
2185   'data': 'BlockDirtyBitmap' }
2186
2187 ##
2188 # @block-dirty-bitmap-merge:
2189 #
2190 # Merge dirty bitmaps listed in @bitmaps to the @target dirty bitmap.
2191 # Dirty bitmaps in @bitmaps will be unchanged, except if it also appears
2192 # as the @target bitmap. Any bits already set in @target will still be
2193 # set after the merge, i.e., this operation does not clear the target.
2194 # On error, @target is unchanged.
2195 #
2196 # The resulting bitmap will count as dirty any clusters that were dirty in any
2197 # of the source bitmaps. This can be used to achieve backup checkpoints, or in
2198 # simpler usages, to copy bitmaps.
2199 #
2200 # Returns: - nothing on success
2201 #          - If @node is not a valid block device, DeviceNotFound
2202 #          - If any bitmap in @bitmaps or @target is not found, GenericError
2203 #          - If any of the bitmaps have different sizes or granularities,
2204 #            GenericError
2205 #
2206 # Since: 4.0
2207 #
2208 # Example:
2209 #
2210 # -> { "execute": "block-dirty-bitmap-merge",
2211 #      "arguments": { "node": "drive0", "target": "bitmap0",
2212 #                     "bitmaps": ["bitmap1"] } }
2213 # <- { "return": {} }
2214 #
2215 ##
2216 { 'command': 'block-dirty-bitmap-merge',
2217   'data': 'BlockDirtyBitmapMerge' }
2218
2219 ##
2220 # @BlockDirtyBitmapSha256:
2221 #
2222 # SHA256 hash of dirty bitmap data
2223 #
2224 # @sha256: ASCII representation of SHA256 bitmap hash
2225 #
2226 # Since: 2.10
2227 ##
2228 { 'struct': 'BlockDirtyBitmapSha256',
2229   'data': {'sha256': 'str'} }
2230
2231 ##
2232 # @x-debug-block-dirty-bitmap-sha256:
2233 #
2234 # Get bitmap SHA256.
2235 #
2236 # Returns: - BlockDirtyBitmapSha256 on success
2237 #          - If @node is not a valid block device, DeviceNotFound
2238 #          - If @name is not found or if hashing has failed, GenericError with an
2239 #            explanation
2240 #
2241 # Since: 2.10
2242 ##
2243 { 'command': 'x-debug-block-dirty-bitmap-sha256',
2244   'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256' }
2245
2246 ##
2247 # @blockdev-mirror:
2248 #
2249 # Start mirroring a block device's writes to a new destination.
2250 #
2251 # @job-id: identifier for the newly-created block job. If
2252 #          omitted, the device name will be used. (Since 2.7)
2253 #
2254 # @device: The device name or node-name of a root node whose writes should be
2255 #          mirrored.
2256 #
2257 # @target: the id or node-name of the block device to mirror to. This mustn't be
2258 #          attached to guest.
2259 #
2260 # @replaces: with sync=full graph node name to be replaced by the new
2261 #            image when a whole image copy is done. This can be used to repair
2262 #            broken Quorum files.
2263 #
2264 # @speed:  the maximum speed, in bytes per second
2265 #
2266 # @sync: what parts of the disk image should be copied to the destination
2267 #        (all the disk, only the sectors allocated in the topmost image, or
2268 #        only new I/O).
2269 #
2270 # @granularity: granularity of the dirty bitmap, default is 64K
2271 #               if the image format doesn't have clusters, 4K if the clusters
2272 #               are smaller than that, else the cluster size.  Must be a
2273 #               power of 2 between 512 and 64M
2274 #
2275 # @buf-size: maximum amount of data in flight from source to
2276 #            target
2277 #
2278 # @on-source-error: the action to take on an error on the source,
2279 #                   default 'report'.  'stop' and 'enospc' can only be used
2280 #                   if the block device supports io-status (see BlockInfo).
2281 #
2282 # @on-target-error: the action to take on an error on the target,
2283 #                   default 'report' (no limitations, since this applies to
2284 #                   a different block device than @device).
2285 #
2286 # @filter-node-name: the node name that should be assigned to the
2287 #                    filter driver that the mirror job inserts into the graph
2288 #                    above @device. If this option is not given, a node name is
2289 #                    autogenerated. (Since: 2.9)
2290 #
2291 # @copy-mode: when to copy data to the destination; defaults to 'background'
2292 #             (Since: 3.0)
2293 #
2294 # @auto-finalize: When false, this job will wait in a PENDING state after it has
2295 #                 finished its work, waiting for @block-job-finalize before
2296 #                 making any block graph changes.
2297 #                 When true, this job will automatically
2298 #                 perform its abort or commit actions.
2299 #                 Defaults to true. (Since 3.1)
2300 #
2301 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
2302 #                has completely ceased all work, and awaits @block-job-dismiss.
2303 #                When true, this job will automatically disappear from the query
2304 #                list without user intervention.
2305 #                Defaults to true. (Since 3.1)
2306 # Returns: nothing on success.
2307 #
2308 # Since: 2.6
2309 #
2310 # Example:
2311 #
2312 # -> { "execute": "blockdev-mirror",
2313 #      "arguments": { "device": "ide-hd0",
2314 #                     "target": "target0",
2315 #                     "sync": "full" } }
2316 # <- { "return": {} }
2317 #
2318 ##
2319 { 'command': 'blockdev-mirror',
2320   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2321             '*replaces': 'str',
2322             'sync': 'MirrorSyncMode',
2323             '*speed': 'int', '*granularity': 'uint32',
2324             '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2325             '*on-target-error': 'BlockdevOnError',
2326             '*filter-node-name': 'str',
2327             '*copy-mode': 'MirrorCopyMode',
2328             '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2329
2330 ##
2331 # @BlockIOThrottle:
2332 #
2333 # A set of parameters describing block throttling.
2334 #
2335 # @device: Block device name
2336 #
2337 # @id: The name or QOM path of the guest device (since: 2.8)
2338 #
2339 # @bps: total throughput limit in bytes per second
2340 #
2341 # @bps_rd: read throughput limit in bytes per second
2342 #
2343 # @bps_wr: write throughput limit in bytes per second
2344 #
2345 # @iops: total I/O operations per second
2346 #
2347 # @iops_rd: read I/O operations per second
2348 #
2349 # @iops_wr: write I/O operations per second
2350 #
2351 # @bps_max: total throughput limit during bursts,
2352 #           in bytes (Since 1.7)
2353 #
2354 # @bps_rd_max: read throughput limit during bursts,
2355 #              in bytes (Since 1.7)
2356 #
2357 # @bps_wr_max: write throughput limit during bursts,
2358 #              in bytes (Since 1.7)
2359 #
2360 # @iops_max: total I/O operations per second during bursts,
2361 #            in bytes (Since 1.7)
2362 #
2363 # @iops_rd_max: read I/O operations per second during bursts,
2364 #               in bytes (Since 1.7)
2365 #
2366 # @iops_wr_max: write I/O operations per second during bursts,
2367 #               in bytes (Since 1.7)
2368 #
2369 # @bps_max_length: maximum length of the @bps_max burst
2370 #                  period, in seconds. It must only
2371 #                  be set if @bps_max is set as well.
2372 #                  Defaults to 1. (Since 2.6)
2373 #
2374 # @bps_rd_max_length: maximum length of the @bps_rd_max
2375 #                     burst period, in seconds. It must only
2376 #                     be set if @bps_rd_max is set as well.
2377 #                     Defaults to 1. (Since 2.6)
2378 #
2379 # @bps_wr_max_length: maximum length of the @bps_wr_max
2380 #                     burst period, in seconds. It must only
2381 #                     be set if @bps_wr_max is set as well.
2382 #                     Defaults to 1. (Since 2.6)
2383 #
2384 # @iops_max_length: maximum length of the @iops burst
2385 #                   period, in seconds. It must only
2386 #                   be set if @iops_max is set as well.
2387 #                   Defaults to 1. (Since 2.6)
2388 #
2389 # @iops_rd_max_length: maximum length of the @iops_rd_max
2390 #                      burst period, in seconds. It must only
2391 #                      be set if @iops_rd_max is set as well.
2392 #                      Defaults to 1. (Since 2.6)
2393 #
2394 # @iops_wr_max_length: maximum length of the @iops_wr_max
2395 #                      burst period, in seconds. It must only
2396 #                      be set if @iops_wr_max is set as well.
2397 #                      Defaults to 1. (Since 2.6)
2398 #
2399 # @iops_size: an I/O size in bytes (Since 1.7)
2400 #
2401 # @group: throttle group name (Since 2.4)
2402 #
2403 # Features:
2404 # @deprecated: Member @device is deprecated.  Use @id instead.
2405 #
2406 # Since: 1.1
2407 ##
2408 { 'struct': 'BlockIOThrottle',
2409   'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] },
2410             '*id': 'str', 'bps': 'int', 'bps_rd': 'int',
2411             'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
2412             '*bps_max': 'int', '*bps_rd_max': 'int',
2413             '*bps_wr_max': 'int', '*iops_max': 'int',
2414             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
2415             '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
2416             '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
2417             '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
2418             '*iops_size': 'int', '*group': 'str' } }
2419
2420 ##
2421 # @ThrottleLimits:
2422 #
2423 # Limit parameters for throttling.
2424 # Since some limit combinations are illegal, limits should always be set in one
2425 # transaction. All fields are optional. When setting limits, if a field is
2426 # missing the current value is not changed.
2427 #
2428 # @iops-total: limit total I/O operations per second
2429 # @iops-total-max: I/O operations burst
2430 # @iops-total-max-length: length of the iops-total-max burst period, in seconds
2431 #                         It must only be set if @iops-total-max is set as well.
2432 # @iops-read: limit read operations per second
2433 # @iops-read-max: I/O operations read burst
2434 # @iops-read-max-length: length of the iops-read-max burst period, in seconds
2435 #                        It must only be set if @iops-read-max is set as well.
2436 # @iops-write: limit write operations per second
2437 # @iops-write-max: I/O operations write burst
2438 # @iops-write-max-length: length of the iops-write-max burst period, in seconds
2439 #                         It must only be set if @iops-write-max is set as well.
2440 # @bps-total: limit total bytes per second
2441 # @bps-total-max: total bytes burst
2442 # @bps-total-max-length: length of the bps-total-max burst period, in seconds.
2443 #                        It must only be set if @bps-total-max is set as well.
2444 # @bps-read: limit read bytes per second
2445 # @bps-read-max: total bytes read burst
2446 # @bps-read-max-length: length of the bps-read-max burst period, in seconds
2447 #                       It must only be set if @bps-read-max is set as well.
2448 # @bps-write: limit write bytes per second
2449 # @bps-write-max: total bytes write burst
2450 # @bps-write-max-length: length of the bps-write-max burst period, in seconds
2451 #                        It must only be set if @bps-write-max is set as well.
2452 # @iops-size: when limiting by iops max size of an I/O in bytes
2453 #
2454 # Since: 2.11
2455 ##
2456 { 'struct': 'ThrottleLimits',
2457   'data': { '*iops-total' : 'int', '*iops-total-max' : 'int',
2458             '*iops-total-max-length' : 'int', '*iops-read' : 'int',
2459             '*iops-read-max' : 'int', '*iops-read-max-length' : 'int',
2460             '*iops-write' : 'int', '*iops-write-max' : 'int',
2461             '*iops-write-max-length' : 'int', '*bps-total' : 'int',
2462             '*bps-total-max' : 'int', '*bps-total-max-length' : 'int',
2463             '*bps-read' : 'int', '*bps-read-max' : 'int',
2464             '*bps-read-max-length' : 'int', '*bps-write' : 'int',
2465             '*bps-write-max' : 'int', '*bps-write-max-length' : 'int',
2466             '*iops-size' : 'int' } }
2467
2468 ##
2469 # @block-stream:
2470 #
2471 # Copy data from a backing file into a block device.
2472 #
2473 # The block streaming operation is performed in the background until the entire
2474 # backing file has been copied.  This command returns immediately once streaming
2475 # has started.  The status of ongoing block streaming operations can be checked
2476 # with query-block-jobs.  The operation can be stopped before it has completed
2477 # using the block-job-cancel command.
2478 #
2479 # The node that receives the data is called the top image, can be located in
2480 # any part of the chain (but always above the base image; see below) and can be
2481 # specified using its device or node name. Earlier qemu versions only allowed
2482 # 'device' to name the top level node; presence of the 'base-node' parameter
2483 # during introspection can be used as a witness of the enhanced semantics
2484 # of 'device'.
2485 #
2486 # If a base file is specified then sectors are not copied from that base file and
2487 # its backing chain.  When streaming completes the image file will have the base
2488 # file as its backing file.  This can be used to stream a subset of the backing
2489 # file chain instead of flattening the entire image.
2490 #
2491 # On successful completion the image file is updated to drop the backing file
2492 # and the BLOCK_JOB_COMPLETED event is emitted.
2493 #
2494 # @job-id: identifier for the newly-created block job. If
2495 #          omitted, the device name will be used. (Since 2.7)
2496 #
2497 # @device: the device or node name of the top image
2498 #
2499 # @base: the common backing file name.
2500 #        It cannot be set if @base-node is also set.
2501 #
2502 # @base-node: the node name of the backing file.
2503 #             It cannot be set if @base is also set. (Since 2.8)
2504 #
2505 # @backing-file: The backing file string to write into the top
2506 #                image. This filename is not validated.
2507 #
2508 #                If a pathname string is such that it cannot be
2509 #                resolved by QEMU, that means that subsequent QMP or
2510 #                HMP commands must use node-names for the image in
2511 #                question, as filename lookup methods will fail.
2512 #
2513 #                If not specified, QEMU will automatically determine
2514 #                the backing file string to use, or error out if there
2515 #                is no obvious choice.  Care should be taken when
2516 #                specifying the string, to specify a valid filename or
2517 #                protocol.
2518 #                (Since 2.1)
2519 #
2520 # @speed: the maximum speed, in bytes per second
2521 #
2522 # @on-error: the action to take on an error (default report).
2523 #            'stop' and 'enospc' can only be used if the block device
2524 #            supports io-status (see BlockInfo).  Since 1.3.
2525 #
2526 # @auto-finalize: When false, this job will wait in a PENDING state after it has
2527 #                 finished its work, waiting for @block-job-finalize before
2528 #                 making any block graph changes.
2529 #                 When true, this job will automatically
2530 #                 perform its abort or commit actions.
2531 #                 Defaults to true. (Since 3.1)
2532 #
2533 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
2534 #                has completely ceased all work, and awaits @block-job-dismiss.
2535 #                When true, this job will automatically disappear from the query
2536 #                list without user intervention.
2537 #                Defaults to true. (Since 3.1)
2538 #
2539 # Returns: - Nothing on success.
2540 #          - If @device does not exist, DeviceNotFound.
2541 #
2542 # Since: 1.1
2543 #
2544 # Example:
2545 #
2546 # -> { "execute": "block-stream",
2547 #      "arguments": { "device": "virtio0",
2548 #                     "base": "/tmp/master.qcow2" } }
2549 # <- { "return": {} }
2550 #
2551 ##
2552 { 'command': 'block-stream',
2553   'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
2554             '*base-node': 'str', '*backing-file': 'str', '*speed': 'int',
2555             '*on-error': 'BlockdevOnError',
2556             '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2557
2558 ##
2559 # @block-job-set-speed:
2560 #
2561 # Set maximum speed for a background block operation.
2562 #
2563 # This command can only be issued when there is an active block job.
2564 #
2565 # Throttling can be disabled by setting the speed to 0.
2566 #
2567 # @device: The job identifier. This used to be a device name (hence
2568 #          the name of the parameter), but since QEMU 2.7 it can have
2569 #          other values.
2570 #
2571 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
2572 #         Defaults to 0.
2573 #
2574 # Returns: - Nothing on success
2575 #          - If no background operation is active on this device, DeviceNotActive
2576 #
2577 # Since: 1.1
2578 ##
2579 { 'command': 'block-job-set-speed',
2580   'data': { 'device': 'str', 'speed': 'int' } }
2581
2582 ##
2583 # @block-job-cancel:
2584 #
2585 # Stop an active background block operation.
2586 #
2587 # This command returns immediately after marking the active background block
2588 # operation for cancellation.  It is an error to call this command if no
2589 # operation is in progress.
2590 #
2591 # The operation will cancel as soon as possible and then emit the
2592 # BLOCK_JOB_CANCELLED event.  Before that happens the job is still visible when
2593 # enumerated using query-block-jobs.
2594 #
2595 # Note that if you issue 'block-job-cancel' after 'drive-mirror' has indicated
2596 # (via the event BLOCK_JOB_READY) that the source and destination are
2597 # synchronized, then the event triggered by this command changes to
2598 # BLOCK_JOB_COMPLETED, to indicate that the mirroring has ended and the
2599 # destination now has a point-in-time copy tied to the time of the cancellation.
2600 #
2601 # For streaming, the image file retains its backing file unless the streaming
2602 # operation happens to complete just as it is being cancelled.  A new streaming
2603 # operation can be started at a later time to finish copying all data from the
2604 # backing file.
2605 #
2606 # @device: The job identifier. This used to be a device name (hence
2607 #          the name of the parameter), but since QEMU 2.7 it can have
2608 #          other values.
2609 #
2610 # @force: If true, and the job has already emitted the event BLOCK_JOB_READY,
2611 #         abandon the job immediately (even if it is paused) instead of waiting
2612 #         for the destination to complete its final synchronization (since 1.3)
2613 #
2614 # Returns: - Nothing on success
2615 #          - If no background operation is active on this device, DeviceNotActive
2616 #
2617 # Since: 1.1
2618 ##
2619 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
2620
2621 ##
2622 # @block-job-pause:
2623 #
2624 # Pause an active background block operation.
2625 #
2626 # This command returns immediately after marking the active background block
2627 # operation for pausing.  It is an error to call this command if no
2628 # operation is in progress or if the job is already paused.
2629 #
2630 # The operation will pause as soon as possible.  No event is emitted when
2631 # the operation is actually paused.  Cancelling a paused job automatically
2632 # resumes it.
2633 #
2634 # @device: The job identifier. This used to be a device name (hence
2635 #          the name of the parameter), but since QEMU 2.7 it can have
2636 #          other values.
2637 #
2638 # Returns: - Nothing on success
2639 #          - If no background operation is active on this device, DeviceNotActive
2640 #
2641 # Since: 1.3
2642 ##
2643 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
2644
2645 ##
2646 # @block-job-resume:
2647 #
2648 # Resume an active background block operation.
2649 #
2650 # This command returns immediately after resuming a paused background block
2651 # operation.  It is an error to call this command if no operation is in
2652 # progress or if the job is not paused.
2653 #
2654 # This command also clears the error status of the job.
2655 #
2656 # @device: The job identifier. This used to be a device name (hence
2657 #          the name of the parameter), but since QEMU 2.7 it can have
2658 #          other values.
2659 #
2660 # Returns: - Nothing on success
2661 #          - If no background operation is active on this device, DeviceNotActive
2662 #
2663 # Since: 1.3
2664 ##
2665 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
2666
2667 ##
2668 # @block-job-complete:
2669 #
2670 # Manually trigger completion of an active background block operation.  This
2671 # is supported for drive mirroring, where it also switches the device to
2672 # write to the target path only.  The ability to complete is signaled with
2673 # a BLOCK_JOB_READY event.
2674 #
2675 # This command completes an active background block operation synchronously.
2676 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
2677 # is not defined.  Note that if an I/O error occurs during the processing of
2678 # this command: 1) the command itself will fail; 2) the error will be processed
2679 # according to the rerror/werror arguments that were specified when starting
2680 # the operation.
2681 #
2682 # A cancelled or paused job cannot be completed.
2683 #
2684 # @device: The job identifier. This used to be a device name (hence
2685 #          the name of the parameter), but since QEMU 2.7 it can have
2686 #          other values.
2687 #
2688 # Returns: - Nothing on success
2689 #          - If no background operation is active on this device, DeviceNotActive
2690 #
2691 # Since: 1.3
2692 ##
2693 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
2694
2695 ##
2696 # @block-job-dismiss:
2697 #
2698 # For jobs that have already concluded, remove them from the block-job-query
2699 # list. This command only needs to be run for jobs which were started with
2700 # QEMU 2.12+ job lifetime management semantics.
2701 #
2702 # This command will refuse to operate on any job that has not yet reached
2703 # its terminal state, JOB_STATUS_CONCLUDED. For jobs that make use of the
2704 # BLOCK_JOB_READY event, block-job-cancel or block-job-complete will still need
2705 # to be used as appropriate.
2706 #
2707 # @id: The job identifier.
2708 #
2709 # Returns: Nothing on success
2710 #
2711 # Since: 2.12
2712 ##
2713 { 'command': 'block-job-dismiss', 'data': { 'id': 'str' } }
2714
2715 ##
2716 # @block-job-finalize:
2717 #
2718 # Once a job that has manual=true reaches the pending state, it can be
2719 # instructed to finalize any graph changes and do any necessary cleanup
2720 # via this command.
2721 # For jobs in a transaction, instructing one job to finalize will force
2722 # ALL jobs in the transaction to finalize, so it is only necessary to instruct
2723 # a single member job to finalize.
2724 #
2725 # @id: The job identifier.
2726 #
2727 # Returns: Nothing on success
2728 #
2729 # Since: 2.12
2730 ##
2731 { 'command': 'block-job-finalize', 'data': { 'id': 'str' } }
2732
2733 ##
2734 # @BlockdevDiscardOptions:
2735 #
2736 # Determines how to handle discard requests.
2737 #
2738 # @ignore: Ignore the request
2739 # @unmap: Forward as an unmap request
2740 #
2741 # Since: 2.9
2742 ##
2743 { 'enum': 'BlockdevDiscardOptions',
2744   'data': [ 'ignore', 'unmap' ] }
2745
2746 ##
2747 # @BlockdevDetectZeroesOptions:
2748 #
2749 # Describes the operation mode for the automatic conversion of plain
2750 # zero writes by the OS to driver specific optimized zero write commands.
2751 #
2752 # @off: Disabled (default)
2753 # @on: Enabled
2754 # @unmap: Enabled and even try to unmap blocks if possible. This requires
2755 #         also that @BlockdevDiscardOptions is set to unmap for this device.
2756 #
2757 # Since: 2.1
2758 ##
2759 { 'enum': 'BlockdevDetectZeroesOptions',
2760   'data': [ 'off', 'on', 'unmap' ] }
2761
2762 ##
2763 # @BlockdevAioOptions:
2764 #
2765 # Selects the AIO backend to handle I/O requests
2766 #
2767 # @threads: Use qemu's thread pool
2768 # @native: Use native AIO backend (only Linux and Windows)
2769 # @io_uring: Use linux io_uring (since 5.0)
2770 #
2771 # Since: 2.9
2772 ##
2773 { 'enum': 'BlockdevAioOptions',
2774   'data': [ 'threads', 'native',
2775             { 'name': 'io_uring', 'if': 'defined(CONFIG_LINUX_IO_URING)' } ] }
2776
2777 ##
2778 # @BlockdevCacheOptions:
2779 #
2780 # Includes cache-related options for block devices
2781 #
2782 # @direct: enables use of O_DIRECT (bypass the host page cache;
2783 #          default: false)
2784 # @no-flush: ignore any flush requests for the device (default:
2785 #            false)
2786 #
2787 # Since: 2.9
2788 ##
2789 { 'struct': 'BlockdevCacheOptions',
2790   'data': { '*direct': 'bool',
2791             '*no-flush': 'bool' } }
2792
2793 ##
2794 # @BlockdevDriver:
2795 #
2796 # Drivers that are supported in block device operations.
2797 #
2798 # @throttle: Since 2.11
2799 # @nvme: Since 2.12
2800 # @copy-on-read: Since 3.0
2801 # @blklogwrites: Since 3.0
2802 # @blkreplay: Since 4.2
2803 # @compress: Since 5.0
2804 #
2805 # Since: 2.9
2806 ##
2807 { 'enum': 'BlockdevDriver',
2808   'data': [ 'blkdebug', 'blklogwrites', 'blkreplay', 'blkverify', 'bochs',
2809             'cloop', 'compress', 'copy-on-read', 'dmg', 'file', 'ftp', 'ftps',
2810             'gluster', 'host_cdrom', 'host_device', 'http', 'https', 'iscsi',
2811             'luks', 'nbd', 'nfs', 'null-aio', 'null-co', 'nvme', 'parallels',
2812             'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'rbd',
2813             { 'name': 'replication', 'if': 'defined(CONFIG_REPLICATION)' },
2814             'sheepdog',
2815             'ssh', 'throttle', 'vdi', 'vhdx', 'vmdk', 'vpc', 'vvfat' ] }
2816
2817 ##
2818 # @BlockdevOptionsFile:
2819 #
2820 # Driver specific block device options for the file backend.
2821 #
2822 # @filename: path to the image file
2823 # @pr-manager: the id for the object that will handle persistent reservations
2824 #              for this device (default: none, forward the commands via SG_IO;
2825 #              since 2.11)
2826 # @aio: AIO backend (default: threads) (since: 2.8)
2827 # @locking: whether to enable file locking. If set to 'auto', only enable
2828 #           when Open File Descriptor (OFD) locking API is available
2829 #           (default: auto, since 2.10)
2830 # @drop-cache: invalidate page cache during live migration.  This prevents
2831 #              stale data on the migration destination with cache.direct=off.
2832 #              Currently only supported on Linux hosts.
2833 #              (default: on, since: 4.0)
2834 # @x-check-cache-dropped: whether to check that page cache was dropped on live
2835 #                         migration.  May cause noticeable delays if the image
2836 #                         file is large, do not use in production.
2837 #                         (default: off) (since: 3.0)
2838 #
2839 # Features:
2840 # @dynamic-auto-read-only: If present, enabled auto-read-only means that the
2841 #                          driver will open the image read-only at first,
2842 #                          dynamically reopen the image file read-write when
2843 #                          the first writer is attached to the node and reopen
2844 #                          read-only when the last writer is detached. This
2845 #                          allows giving QEMU write permissions only on demand
2846 #                          when an operation actually needs write access.
2847 #
2848 # Since: 2.9
2849 ##
2850 { 'struct': 'BlockdevOptionsFile',
2851   'data': { 'filename': 'str',
2852             '*pr-manager': 'str',
2853             '*locking': 'OnOffAuto',
2854             '*aio': 'BlockdevAioOptions',
2855             '*drop-cache': {'type': 'bool',
2856                             'if': 'defined(CONFIG_LINUX)'},
2857             '*x-check-cache-dropped': 'bool' },
2858   'features': [ { 'name': 'dynamic-auto-read-only',
2859                   'if': 'defined(CONFIG_POSIX)' } ] }
2860
2861 ##
2862 # @BlockdevOptionsNull:
2863 #
2864 # Driver specific block device options for the null backend.
2865 #
2866 # @size: size of the device in bytes.
2867 # @latency-ns: emulated latency (in nanoseconds) in processing
2868 #              requests. Default to zero which completes requests immediately.
2869 #              (Since 2.4)
2870 # @read-zeroes: if true, reads from the device produce zeroes; if false, the
2871 #               buffer is left unchanged. (default: false; since: 4.1)
2872 #
2873 # Since: 2.9
2874 ##
2875 { 'struct': 'BlockdevOptionsNull',
2876   'data': { '*size': 'int', '*latency-ns': 'uint64', '*read-zeroes': 'bool' } }
2877
2878 ##
2879 # @BlockdevOptionsNVMe:
2880 #
2881 # Driver specific block device options for the NVMe backend.
2882 #
2883 # @device: PCI controller address of the NVMe device in
2884 #          format hhhh:bb:ss.f (host:bus:slot.function)
2885 # @namespace: namespace number of the device, starting from 1.
2886 #
2887 # Note that the PCI @device must have been unbound from any host
2888 # kernel driver before instructing QEMU to add the blockdev.
2889 #
2890 # Since: 2.12
2891 ##
2892 { 'struct': 'BlockdevOptionsNVMe',
2893   'data': { 'device': 'str', 'namespace': 'int' } }
2894
2895 ##
2896 # @BlockdevOptionsVVFAT:
2897 #
2898 # Driver specific block device options for the vvfat protocol.
2899 #
2900 # @dir: directory to be exported as FAT image
2901 # @fat-type: FAT type: 12, 16 or 32
2902 # @floppy: whether to export a floppy image (true) or
2903 #          partitioned hard disk (false; default)
2904 # @label: set the volume label, limited to 11 bytes. FAT16 and
2905 #         FAT32 traditionally have some restrictions on labels, which are
2906 #         ignored by most operating systems. Defaults to "QEMU VVFAT".
2907 #         (since 2.4)
2908 # @rw: whether to allow write operations (default: false)
2909 #
2910 # Since: 2.9
2911 ##
2912 { 'struct': 'BlockdevOptionsVVFAT',
2913   'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
2914             '*label': 'str', '*rw': 'bool' } }
2915
2916 ##
2917 # @BlockdevOptionsGenericFormat:
2918 #
2919 # Driver specific block device options for image format that have no option
2920 # besides their data source.
2921 #
2922 # @file: reference to or definition of the data source block device
2923 #
2924 # Since: 2.9
2925 ##
2926 { 'struct': 'BlockdevOptionsGenericFormat',
2927   'data': { 'file': 'BlockdevRef' } }
2928
2929 ##
2930 # @BlockdevOptionsLUKS:
2931 #
2932 # Driver specific block device options for LUKS.
2933 #
2934 # @key-secret: the ID of a QCryptoSecret object providing
2935 #              the decryption key (since 2.6). Mandatory except when
2936 #              doing a metadata-only probe of the image.
2937 #
2938 # Since: 2.9
2939 ##
2940 { 'struct': 'BlockdevOptionsLUKS',
2941   'base': 'BlockdevOptionsGenericFormat',
2942   'data': { '*key-secret': 'str' } }
2943
2944
2945 ##
2946 # @BlockdevOptionsGenericCOWFormat:
2947 #
2948 # Driver specific block device options for image format that have no option
2949 # besides their data source and an optional backing file.
2950 #
2951 # @backing: reference to or definition of the backing file block
2952 #           device, null disables the backing file entirely.
2953 #           Defaults to the backing file stored the image file.
2954 #
2955 # Since: 2.9
2956 ##
2957 { 'struct': 'BlockdevOptionsGenericCOWFormat',
2958   'base': 'BlockdevOptionsGenericFormat',
2959   'data': { '*backing': 'BlockdevRefOrNull' } }
2960
2961 ##
2962 # @Qcow2OverlapCheckMode:
2963 #
2964 # General overlap check modes.
2965 #
2966 # @none: Do not perform any checks
2967 #
2968 # @constant: Perform only checks which can be done in constant time and
2969 #            without reading anything from disk
2970 #
2971 # @cached: Perform only checks which can be done without reading anything
2972 #          from disk
2973 #
2974 # @all: Perform all available overlap checks
2975 #
2976 # Since: 2.9
2977 ##
2978 { 'enum': 'Qcow2OverlapCheckMode',
2979   'data': [ 'none', 'constant', 'cached', 'all' ] }
2980
2981 ##
2982 # @Qcow2OverlapCheckFlags:
2983 #
2984 # Structure of flags for each metadata structure. Setting a field to 'true'
2985 # makes qemu guard that structure against unintended overwriting. The default
2986 # value is chosen according to the template given.
2987 #
2988 # @template: Specifies a template mode which can be adjusted using the other
2989 #            flags, defaults to 'cached'
2990 #
2991 # @bitmap-directory: since 3.0
2992 #
2993 # Since: 2.9
2994 ##
2995 { 'struct': 'Qcow2OverlapCheckFlags',
2996   'data': { '*template':         'Qcow2OverlapCheckMode',
2997             '*main-header':      'bool',
2998             '*active-l1':        'bool',
2999             '*active-l2':        'bool',
3000             '*refcount-table':   'bool',
3001             '*refcount-block':   'bool',
3002             '*snapshot-table':   'bool',
3003             '*inactive-l1':      'bool',
3004             '*inactive-l2':      'bool',
3005             '*bitmap-directory': 'bool' } }
3006
3007 ##
3008 # @Qcow2OverlapChecks:
3009 #
3010 # Specifies which metadata structures should be guarded against unintended
3011 # overwriting.
3012 #
3013 # @flags: set of flags for separate specification of each metadata structure
3014 #         type
3015 #
3016 # @mode: named mode which chooses a specific set of flags
3017 #
3018 # Since: 2.9
3019 ##
3020 { 'alternate': 'Qcow2OverlapChecks',
3021   'data': { 'flags': 'Qcow2OverlapCheckFlags',
3022             'mode':  'Qcow2OverlapCheckMode' } }
3023
3024 ##
3025 # @BlockdevQcowEncryptionFormat:
3026 #
3027 # @aes: AES-CBC with plain64 initialization vectors
3028 #
3029 # Since: 2.10
3030 ##
3031 { 'enum': 'BlockdevQcowEncryptionFormat',
3032   'data': [ 'aes' ] }
3033
3034 ##
3035 # @BlockdevQcowEncryption:
3036 #
3037 # Since: 2.10
3038 ##
3039 { 'union': 'BlockdevQcowEncryption',
3040   'base': { 'format': 'BlockdevQcowEncryptionFormat' },
3041   'discriminator': 'format',
3042   'data': { 'aes': 'QCryptoBlockOptionsQCow' } }
3043
3044 ##
3045 # @BlockdevOptionsQcow:
3046 #
3047 # Driver specific block device options for qcow.
3048 #
3049 # @encrypt: Image decryption options. Mandatory for
3050 #           encrypted images, except when doing a metadata-only
3051 #           probe of the image.
3052 #
3053 # Since: 2.10
3054 ##
3055 { 'struct': 'BlockdevOptionsQcow',
3056   'base': 'BlockdevOptionsGenericCOWFormat',
3057   'data': { '*encrypt': 'BlockdevQcowEncryption' } }
3058
3059
3060
3061 ##
3062 # @BlockdevQcow2EncryptionFormat:
3063 # @aes: AES-CBC with plain64 initialization vectors
3064 #
3065 # Since: 2.10
3066 ##
3067 { 'enum': 'BlockdevQcow2EncryptionFormat',
3068   'data': [ 'aes', 'luks' ] }
3069
3070 ##
3071 # @BlockdevQcow2Encryption:
3072 #
3073 # Since: 2.10
3074 ##
3075 { 'union': 'BlockdevQcow2Encryption',
3076   'base': { 'format': 'BlockdevQcow2EncryptionFormat' },
3077   'discriminator': 'format',
3078   'data': { 'aes': 'QCryptoBlockOptionsQCow',
3079             'luks': 'QCryptoBlockOptionsLUKS'} }
3080
3081 ##
3082 # @BlockdevOptionsQcow2:
3083 #
3084 # Driver specific block device options for qcow2.
3085 #
3086 # @lazy-refcounts: whether to enable the lazy refcounts
3087 #                  feature (default is taken from the image file)
3088 #
3089 # @pass-discard-request: whether discard requests to the qcow2
3090 #                        device should be forwarded to the data source
3091 #
3092 # @pass-discard-snapshot: whether discard requests for the data source
3093 #                         should be issued when a snapshot operation (e.g.
3094 #                         deleting a snapshot) frees clusters in the qcow2 file
3095 #
3096 # @pass-discard-other: whether discard requests for the data source
3097 #                      should be issued on other occasions where a cluster
3098 #                      gets freed
3099 #
3100 # @overlap-check: which overlap checks to perform for writes
3101 #                 to the image, defaults to 'cached' (since 2.2)
3102 #
3103 # @cache-size: the maximum total size of the L2 table and
3104 #              refcount block caches in bytes (since 2.2)
3105 #
3106 # @l2-cache-size: the maximum size of the L2 table cache in
3107 #                 bytes (since 2.2)
3108 #
3109 # @l2-cache-entry-size: the size of each entry in the L2 cache in
3110 #                       bytes. It must be a power of two between 512
3111 #                       and the cluster size. The default value is
3112 #                       the cluster size (since 2.12)
3113 #
3114 # @refcount-cache-size: the maximum size of the refcount block cache
3115 #                       in bytes (since 2.2)
3116 #
3117 # @cache-clean-interval: clean unused entries in the L2 and refcount
3118 #                        caches. The interval is in seconds. The default value
3119 #                        is 600 on supporting platforms, and 0 on other
3120 #                        platforms. 0 disables this feature. (since 2.5)
3121 #
3122 # @encrypt: Image decryption options. Mandatory for
3123 #           encrypted images, except when doing a metadata-only
3124 #           probe of the image. (since 2.10)
3125 #
3126 # @data-file: reference to or definition of the external data file.
3127 #             This may only be specified for images that require an
3128 #             external data file. If it is not specified for such
3129 #             an image, the data file name is loaded from the image
3130 #             file. (since 4.0)
3131 #
3132 # Since: 2.9
3133 ##
3134 { 'struct': 'BlockdevOptionsQcow2',
3135   'base': 'BlockdevOptionsGenericCOWFormat',
3136   'data': { '*lazy-refcounts': 'bool',
3137             '*pass-discard-request': 'bool',
3138             '*pass-discard-snapshot': 'bool',
3139             '*pass-discard-other': 'bool',
3140             '*overlap-check': 'Qcow2OverlapChecks',
3141             '*cache-size': 'int',
3142             '*l2-cache-size': 'int',
3143             '*l2-cache-entry-size': 'int',
3144             '*refcount-cache-size': 'int',
3145             '*cache-clean-interval': 'int',
3146             '*encrypt': 'BlockdevQcow2Encryption',
3147             '*data-file': 'BlockdevRef' } }
3148
3149 ##
3150 # @SshHostKeyCheckMode:
3151 #
3152 # @none: Don't check the host key at all
3153 # @hash: Compare the host key with a given hash
3154 # @known_hosts: Check the host key against the known_hosts file
3155 #
3156 # Since: 2.12
3157 ##
3158 { 'enum': 'SshHostKeyCheckMode',
3159   'data': [ 'none', 'hash', 'known_hosts' ] }
3160
3161 ##
3162 # @SshHostKeyCheckHashType:
3163 #
3164 # @md5: The given hash is an md5 hash
3165 # @sha1: The given hash is an sha1 hash
3166 #
3167 # Since: 2.12
3168 ##
3169 { 'enum': 'SshHostKeyCheckHashType',
3170   'data': [ 'md5', 'sha1' ] }
3171
3172 ##
3173 # @SshHostKeyHash:
3174 #
3175 # @type: The hash algorithm used for the hash
3176 # @hash: The expected hash value
3177 #
3178 # Since: 2.12
3179 ##
3180 { 'struct': 'SshHostKeyHash',
3181   'data': { 'type': 'SshHostKeyCheckHashType',
3182             'hash': 'str' }}
3183
3184 ##
3185 # @SshHostKeyCheck:
3186 #
3187 # Since: 2.12
3188 ##
3189 { 'union': 'SshHostKeyCheck',
3190   'base': { 'mode': 'SshHostKeyCheckMode' },
3191   'discriminator': 'mode',
3192   'data': { 'hash': 'SshHostKeyHash' } }
3193
3194 ##
3195 # @BlockdevOptionsSsh:
3196 #
3197 # @server:              host address
3198 #
3199 # @path:                path to the image on the host
3200 #
3201 # @user:                user as which to connect, defaults to current
3202 #                       local user name
3203 #
3204 # @host-key-check:      Defines how and what to check the host key against
3205 #                       (default: known_hosts)
3206 #
3207 # Since: 2.9
3208 ##
3209 { 'struct': 'BlockdevOptionsSsh',
3210   'data': { 'server': 'InetSocketAddress',
3211             'path': 'str',
3212             '*user': 'str',
3213             '*host-key-check': 'SshHostKeyCheck' } }
3214
3215
3216 ##
3217 # @BlkdebugEvent:
3218 #
3219 # Trigger events supported by blkdebug.
3220 #
3221 # @l1_shrink_write_table: write zeros to the l1 table to shrink image.
3222 #                         (since 2.11)
3223 #
3224 # @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11)
3225 #
3226 # @cor_write: a write due to copy-on-read (since 2.11)
3227 #
3228 # @cluster_alloc_space: an allocation of file space for a cluster (since 4.1)
3229 #
3230 # @none: triggers once at creation of the blkdebug node (since 4.1)
3231 #
3232 # Since: 2.9
3233 ##
3234 { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
3235   'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
3236             'l1_grow_activate_table', 'l2_load', 'l2_update',
3237             'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
3238             'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
3239             'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
3240             'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
3241             'refblock_load', 'refblock_update', 'refblock_update_part',
3242             'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
3243             'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
3244             'refblock_alloc_switch_table', 'cluster_alloc',
3245             'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
3246             'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
3247             'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
3248             'pwritev_zero', 'pwritev_done', 'empty_image_prepare',
3249             'l1_shrink_write_table', 'l1_shrink_free_l2_clusters',
3250             'cor_write', 'cluster_alloc_space', 'none'] }
3251
3252 ##
3253 # @BlkdebugIOType:
3254 #
3255 # Kinds of I/O that blkdebug can inject errors in.
3256 #
3257 # @read: .bdrv_co_preadv()
3258 #
3259 # @write: .bdrv_co_pwritev()
3260 #
3261 # @write-zeroes: .bdrv_co_pwrite_zeroes()
3262 #
3263 # @discard: .bdrv_co_pdiscard()
3264 #
3265 # @flush: .bdrv_co_flush_to_disk()
3266 #
3267 # @block-status: .bdrv_co_block_status()
3268 #
3269 # Since: 4.1
3270 ##
3271 { 'enum': 'BlkdebugIOType', 'prefix': 'BLKDEBUG_IO_TYPE',
3272   'data': [ 'read', 'write', 'write-zeroes', 'discard', 'flush',
3273             'block-status' ] }
3274
3275 ##
3276 # @BlkdebugInjectErrorOptions:
3277 #
3278 # Describes a single error injection for blkdebug.
3279 #
3280 # @event: trigger event
3281 #
3282 # @state: the state identifier blkdebug needs to be in to
3283 #         actually trigger the event; defaults to "any"
3284 #
3285 # @iotype: the type of I/O operations on which this error should
3286 #          be injected; defaults to "all read, write,
3287 #          write-zeroes, discard, and flush operations"
3288 #          (since: 4.1)
3289 #
3290 # @errno: error identifier (errno) to be returned; defaults to
3291 #         EIO
3292 #
3293 # @sector: specifies the sector index which has to be affected
3294 #          in order to actually trigger the event; defaults to "any
3295 #          sector"
3296 #
3297 # @once: disables further events after this one has been
3298 #        triggered; defaults to false
3299 #
3300 # @immediately: fail immediately; defaults to false
3301 #
3302 # Since: 2.9
3303 ##
3304 { 'struct': 'BlkdebugInjectErrorOptions',
3305   'data': { 'event': 'BlkdebugEvent',
3306             '*state': 'int',
3307             '*iotype': 'BlkdebugIOType',
3308             '*errno': 'int',
3309             '*sector': 'int',
3310             '*once': 'bool',
3311             '*immediately': 'bool' } }
3312
3313 ##
3314 # @BlkdebugSetStateOptions:
3315 #
3316 # Describes a single state-change event for blkdebug.
3317 #
3318 # @event: trigger event
3319 #
3320 # @state: the current state identifier blkdebug needs to be in;
3321 #         defaults to "any"
3322 #
3323 # @new_state: the state identifier blkdebug is supposed to assume if
3324 #             this event is triggered
3325 #
3326 # Since: 2.9
3327 ##
3328 { 'struct': 'BlkdebugSetStateOptions',
3329   'data': { 'event': 'BlkdebugEvent',
3330             '*state': 'int',
3331             'new_state': 'int' } }
3332
3333 ##
3334 # @BlockdevOptionsBlkdebug:
3335 #
3336 # Driver specific block device options for blkdebug.
3337 #
3338 # @image: underlying raw block device (or image file)
3339 #
3340 # @config: filename of the configuration file
3341 #
3342 # @align: required alignment for requests in bytes, must be
3343 #         positive power of 2, or 0 for default
3344 #
3345 # @max-transfer: maximum size for I/O transfers in bytes, must be
3346 #                positive multiple of @align and of the underlying
3347 #                file's request alignment (but need not be a power of
3348 #                2), or 0 for default (since 2.10)
3349 #
3350 # @opt-write-zero: preferred alignment for write zero requests in bytes,
3351 #                  must be positive multiple of @align and of the
3352 #                  underlying file's request alignment (but need not be a
3353 #                  power of 2), or 0 for default (since 2.10)
3354 #
3355 # @max-write-zero: maximum size for write zero requests in bytes, must be
3356 #                  positive multiple of @align, of @opt-write-zero, and of
3357 #                  the underlying file's request alignment (but need not
3358 #                  be a power of 2), or 0 for default (since 2.10)
3359 #
3360 # @opt-discard: preferred alignment for discard requests in bytes, must
3361 #               be positive multiple of @align and of the underlying
3362 #               file's request alignment (but need not be a power of
3363 #               2), or 0 for default (since 2.10)
3364 #
3365 # @max-discard: maximum size for discard requests in bytes, must be
3366 #               positive multiple of @align, of @opt-discard, and of
3367 #               the underlying file's request alignment (but need not
3368 #               be a power of 2), or 0 for default (since 2.10)
3369 #
3370 # @inject-error: array of error injection descriptions
3371 #
3372 # @set-state: array of state-change descriptions
3373 #
3374 # @take-child-perms: Permissions to take on @image in addition to what
3375 #                    is necessary anyway (which depends on how the
3376 #                    blkdebug node is used).  Defaults to none.
3377 #                    (since 5.0)
3378 #
3379 # @unshare-child-perms: Permissions not to share on @image in addition
3380 #                       to what cannot be shared anyway (which depends
3381 #                       on how the blkdebug node is used).  Defaults
3382 #                       to none.  (since 5.0)
3383 #
3384 # Since: 2.9
3385 ##
3386 { 'struct': 'BlockdevOptionsBlkdebug',
3387   'data': { 'image': 'BlockdevRef',
3388             '*config': 'str',
3389             '*align': 'int', '*max-transfer': 'int32',
3390             '*opt-write-zero': 'int32', '*max-write-zero': 'int32',
3391             '*opt-discard': 'int32', '*max-discard': 'int32',
3392             '*inject-error': ['BlkdebugInjectErrorOptions'],
3393             '*set-state': ['BlkdebugSetStateOptions'],
3394             '*take-child-perms': ['BlockPermission'],
3395             '*unshare-child-perms': ['BlockPermission'] } }
3396
3397 ##
3398 # @BlockdevOptionsBlklogwrites:
3399 #
3400 # Driver specific block device options for blklogwrites.
3401 #
3402 # @file: block device
3403 #
3404 # @log: block device used to log writes to @file
3405 #
3406 # @log-sector-size: sector size used in logging writes to @file, determines
3407 #                   granularity of offsets and sizes of writes (default: 512)
3408 #
3409 # @log-append: append to an existing log (default: false)
3410 #
3411 # @log-super-update-interval: interval of write requests after which the log
3412 #                             super block is updated to disk (default: 4096)
3413 #
3414 # Since: 3.0
3415 ##
3416 { 'struct': 'BlockdevOptionsBlklogwrites',
3417   'data': { 'file': 'BlockdevRef',
3418             'log': 'BlockdevRef',
3419             '*log-sector-size': 'uint32',
3420             '*log-append': 'bool',
3421             '*log-super-update-interval': 'uint64' } }
3422
3423 ##
3424 # @BlockdevOptionsBlkverify:
3425 #
3426 # Driver specific block device options for blkverify.
3427 #
3428 # @test: block device to be tested
3429 #
3430 # @raw: raw image used for verification
3431 #
3432 # Since: 2.9
3433 ##
3434 { 'struct': 'BlockdevOptionsBlkverify',
3435   'data': { 'test': 'BlockdevRef',
3436             'raw': 'BlockdevRef' } }
3437
3438 ##
3439 # @BlockdevOptionsBlkreplay:
3440 #
3441 # Driver specific block device options for blkreplay.
3442 #
3443 # @image: disk image which should be controlled with blkreplay
3444 #
3445 # Since: 4.2
3446 ##
3447 { 'struct': 'BlockdevOptionsBlkreplay',
3448   'data': { 'image': 'BlockdevRef' } }
3449
3450 ##
3451 # @QuorumReadPattern:
3452 #
3453 # An enumeration of quorum read patterns.
3454 #
3455 # @quorum: read all the children and do a quorum vote on reads
3456 #
3457 # @fifo: read only from the first child that has not failed
3458 #
3459 # Since: 2.9
3460 ##
3461 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
3462
3463 ##
3464 # @BlockdevOptionsQuorum:
3465 #
3466 # Driver specific block device options for Quorum
3467 #
3468 # @blkverify: true if the driver must print content mismatch
3469 #                  set to false by default
3470 #
3471 # @children: the children block devices to use
3472 #
3473 # @vote-threshold: the vote limit under which a read will fail
3474 #
3475 # @rewrite-corrupted: rewrite corrupted data when quorum is reached
3476 #                     (Since 2.1)
3477 #
3478 # @read-pattern: choose read pattern and set to quorum by default
3479 #                (Since 2.2)
3480 #
3481 # Since: 2.9
3482 ##
3483 { 'struct': 'BlockdevOptionsQuorum',
3484   'data': { '*blkverify': 'bool',
3485             'children': [ 'BlockdevRef' ],
3486             'vote-threshold': 'int',
3487             '*rewrite-corrupted': 'bool',
3488             '*read-pattern': 'QuorumReadPattern' } }
3489
3490 ##
3491 # @BlockdevOptionsGluster:
3492 #
3493 # Driver specific block device options for Gluster
3494 #
3495 # @volume: name of gluster volume where VM image resides
3496 #
3497 # @path: absolute path to image file in gluster volume
3498 #
3499 # @server: gluster servers description
3500 #
3501 # @debug: libgfapi log level (default '4' which is Error)
3502 #         (Since 2.8)
3503 #
3504 # @logfile: libgfapi log file (default /dev/stderr) (Since 2.8)
3505 #
3506 # Since: 2.9
3507 ##
3508 { 'struct': 'BlockdevOptionsGluster',
3509   'data': { 'volume': 'str',
3510             'path': 'str',
3511             'server': ['SocketAddress'],
3512             '*debug': 'int',
3513             '*logfile': 'str' } }
3514
3515 ##
3516 # @IscsiTransport:
3517 #
3518 # An enumeration of libiscsi transport types
3519 #
3520 # Since: 2.9
3521 ##
3522 { 'enum': 'IscsiTransport',
3523   'data': [ 'tcp', 'iser' ] }
3524
3525 ##
3526 # @IscsiHeaderDigest:
3527 #
3528 # An enumeration of header digests supported by libiscsi
3529 #
3530 # Since: 2.9
3531 ##
3532 { 'enum': 'IscsiHeaderDigest',
3533   'prefix': 'QAPI_ISCSI_HEADER_DIGEST',
3534   'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] }
3535
3536 ##
3537 # @BlockdevOptionsIscsi:
3538 #
3539 # @transport: The iscsi transport type
3540 #
3541 # @portal: The address of the iscsi portal
3542 #
3543 # @target: The target iqn name
3544 #
3545 # @lun: LUN to connect to. Defaults to 0.
3546 #
3547 # @user: User name to log in with. If omitted, no CHAP
3548 #        authentication is performed.
3549 #
3550 # @password-secret: The ID of a QCryptoSecret object providing
3551 #                   the password for the login. This option is required if
3552 #                   @user is specified.
3553 #
3554 # @initiator-name: The iqn name we want to identify to the target
3555 #                  as. If this option is not specified, an initiator name is
3556 #                  generated automatically.
3557 #
3558 # @header-digest: The desired header digest. Defaults to
3559 #                 none-crc32c.
3560 #
3561 # @timeout: Timeout in seconds after which a request will
3562 #           timeout. 0 means no timeout and is the default.
3563 #
3564 # Driver specific block device options for iscsi
3565 #
3566 # Since: 2.9
3567 ##
3568 { 'struct': 'BlockdevOptionsIscsi',
3569   'data': { 'transport': 'IscsiTransport',
3570             'portal': 'str',
3571             'target': 'str',
3572             '*lun': 'int',
3573             '*user': 'str',
3574             '*password-secret': 'str',
3575             '*initiator-name': 'str',
3576             '*header-digest': 'IscsiHeaderDigest',
3577             '*timeout': 'int' } }
3578
3579
3580 ##
3581 # @RbdAuthMode:
3582 #
3583 # Since: 3.0
3584 ##
3585 { 'enum': 'RbdAuthMode',
3586   'data': [ 'cephx', 'none' ] }
3587
3588 ##
3589 # @BlockdevOptionsRbd:
3590 #
3591 # @pool: Ceph pool name.
3592 #
3593 # @namespace: Rados namespace name in the Ceph pool. (Since 5.0)
3594 #
3595 # @image: Image name in the Ceph pool.
3596 #
3597 # @conf: path to Ceph configuration file.  Values
3598 #        in the configuration file will be overridden by
3599 #        options specified via QAPI.
3600 #
3601 # @snapshot: Ceph snapshot name.
3602 #
3603 # @user: Ceph id name.
3604 #
3605 # @auth-client-required: Acceptable authentication modes.
3606 #                        This maps to Ceph configuration option
3607 #                        "auth_client_required".  (Since 3.0)
3608 #
3609 # @key-secret: ID of a QCryptoSecret object providing a key
3610 #              for cephx authentication.
3611 #              This maps to Ceph configuration option
3612 #              "key".  (Since 3.0)
3613 #
3614 # @server: Monitor host address and port.  This maps
3615 #          to the "mon_host" Ceph option.
3616 #
3617 # Since: 2.9
3618 ##
3619 { 'struct': 'BlockdevOptionsRbd',
3620   'data': { 'pool': 'str',
3621             '*namespace': 'str',
3622             'image': 'str',
3623             '*conf': 'str',
3624             '*snapshot': 'str',
3625             '*user': 'str',
3626             '*auth-client-required': ['RbdAuthMode'],
3627             '*key-secret': 'str',
3628             '*server': ['InetSocketAddressBase'] } }
3629
3630 ##
3631 # @BlockdevOptionsSheepdog:
3632 #
3633 # Driver specific block device options for sheepdog
3634 #
3635 # @vdi: Virtual disk image name
3636 # @server: The Sheepdog server to connect to
3637 # @snap-id: Snapshot ID
3638 # @tag: Snapshot tag name
3639 #
3640 # Only one of @snap-id and @tag may be present.
3641 #
3642 # Since: 2.9
3643 ##
3644 { 'struct': 'BlockdevOptionsSheepdog',
3645   'data': { 'server': 'SocketAddress',
3646             'vdi': 'str',
3647             '*snap-id': 'uint32',
3648             '*tag': 'str' } }
3649
3650 ##
3651 # @ReplicationMode:
3652 #
3653 # An enumeration of replication modes.
3654 #
3655 # @primary: Primary mode, the vm's state will be sent to secondary QEMU.
3656 #
3657 # @secondary: Secondary mode, receive the vm's state from primary QEMU.
3658 #
3659 # Since: 2.9
3660 ##
3661 { 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ],
3662   'if': 'defined(CONFIG_REPLICATION)' }
3663
3664 ##
3665 # @BlockdevOptionsReplication:
3666 #
3667 # Driver specific block device options for replication
3668 #
3669 # @mode: the replication mode
3670 #
3671 # @top-id: In secondary mode, node name or device ID of the root
3672 #          node who owns the replication node chain. Must not be given in
3673 #          primary mode.
3674 #
3675 # Since: 2.9
3676 ##
3677 { 'struct': 'BlockdevOptionsReplication',
3678   'base': 'BlockdevOptionsGenericFormat',
3679   'data': { 'mode': 'ReplicationMode',
3680             '*top-id': 'str' },
3681   'if': 'defined(CONFIG_REPLICATION)' }
3682
3683 ##
3684 # @NFSTransport:
3685 #
3686 # An enumeration of NFS transport types
3687 #
3688 # @inet: TCP transport
3689 #
3690 # Since: 2.9
3691 ##
3692 { 'enum': 'NFSTransport',
3693   'data': [ 'inet' ] }
3694
3695 ##
3696 # @NFSServer:
3697 #
3698 # Captures the address of the socket
3699 #
3700 # @type: transport type used for NFS (only TCP supported)
3701 #
3702 # @host: host address for NFS server
3703 #
3704 # Since: 2.9
3705 ##
3706 { 'struct': 'NFSServer',
3707   'data': { 'type': 'NFSTransport',
3708             'host': 'str' } }
3709
3710 ##
3711 # @BlockdevOptionsNfs:
3712 #
3713 # Driver specific block device option for NFS
3714 #
3715 # @server: host address
3716 #
3717 # @path: path of the image on the host
3718 #
3719 # @user: UID value to use when talking to the
3720 #        server (defaults to 65534 on Windows and getuid()
3721 #        on unix)
3722 #
3723 # @group: GID value to use when talking to the
3724 #         server (defaults to 65534 on Windows and getgid()
3725 #         in unix)
3726 #
3727 # @tcp-syn-count: number of SYNs during the session
3728 #                 establishment (defaults to libnfs default)
3729 #
3730 # @readahead-size: set the readahead size in bytes (defaults
3731 #                  to libnfs default)
3732 #
3733 # @page-cache-size: set the pagecache size in bytes (defaults
3734 #                   to libnfs default)
3735 #
3736 # @debug: set the NFS debug level (max 2) (defaults
3737 #         to libnfs default)
3738 #
3739 # Since: 2.9
3740 ##
3741 { 'struct': 'BlockdevOptionsNfs',
3742   'data': { 'server': 'NFSServer',
3743             'path': 'str',
3744             '*user': 'int',
3745             '*group': 'int',
3746             '*tcp-syn-count': 'int',
3747             '*readahead-size': 'int',
3748             '*page-cache-size': 'int',
3749             '*debug': 'int' } }
3750
3751 ##
3752 # @BlockdevOptionsCurlBase:
3753 #
3754 # Driver specific block device options shared by all protocols supported by the
3755 # curl backend.
3756 #
3757 # @url: URL of the image file
3758 #
3759 # @readahead: Size of the read-ahead cache; must be a multiple of
3760 #             512 (defaults to 256 kB)
3761 #
3762 # @timeout: Timeout for connections, in seconds (defaults to 5)
3763 #
3764 # @username: Username for authentication (defaults to none)
3765 #
3766 # @password-secret: ID of a QCryptoSecret object providing a password
3767 #                   for authentication (defaults to no password)
3768 #
3769 # @proxy-username: Username for proxy authentication (defaults to none)
3770 #
3771 # @proxy-password-secret: ID of a QCryptoSecret object providing a password