hw/arm/virt: use VirtMachineState.gic_version
[qemu.git] / qapi / block-core.json
1 # -*- Mode: Python -*-
2 #
3 # QAPI block core definitions (vm unrelated)
4
5 # QAPI common definitions
6 { 'include': 'common.json' }
7
8 ##
9 # @SnapshotInfo:
10 #
11 # @id: unique snapshot id
12 #
13 # @name: user chosen name
14 #
15 # @vm-state-size: size of the VM state
16 #
17 # @date-sec: UTC date of the snapshot in seconds
18 #
19 # @date-nsec: fractional part in nano seconds to be used with date-sec
20 #
21 # @vm-clock-sec: VM clock relative to boot in seconds
22 #
23 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
24 #
25 # Since: 1.3
26 #
27 ##
28 { 'struct': 'SnapshotInfo',
29   'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
30             'date-sec': 'int', 'date-nsec': 'int',
31             'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
32
33 ##
34 # @ImageInfoSpecificQCow2:
35 #
36 # @compat: compatibility level
37 #
38 # @lazy-refcounts: #optional on or off; only valid for compat >= 1.1
39 #
40 # @corrupt: #optional true if the image has been marked corrupt; only valid for
41 #           compat >= 1.1 (since 2.2)
42 #
43 # @refcount-bits: width of a refcount entry in bits (since 2.3)
44 #
45 # Since: 1.7
46 ##
47 { 'struct': 'ImageInfoSpecificQCow2',
48   'data': {
49       'compat': 'str',
50       '*lazy-refcounts': 'bool',
51       '*corrupt': 'bool',
52       'refcount-bits': 'int'
53   } }
54
55 ##
56 # @ImageInfoSpecificVmdk:
57 #
58 # @create-type: The create type of VMDK image
59 #
60 # @cid: Content id of image
61 #
62 # @parent-cid: Parent VMDK image's cid
63 #
64 # @extents: List of extent files
65 #
66 # Since: 1.7
67 ##
68 { 'struct': 'ImageInfoSpecificVmdk',
69   'data': {
70       'create-type': 'str',
71       'cid': 'int',
72       'parent-cid': 'int',
73       'extents': ['ImageInfo']
74   } }
75
76 ##
77 # @ImageInfoSpecific:
78 #
79 # A discriminated record of image format specific information structures.
80 #
81 # Since: 1.7
82 ##
83 { 'union': 'ImageInfoSpecific',
84   'data': {
85       'qcow2': 'ImageInfoSpecificQCow2',
86       'vmdk': 'ImageInfoSpecificVmdk',
87       # If we need to add block driver specific parameters for
88       # LUKS in future, then we'll subclass QCryptoBlockInfoLUKS
89       # to define a ImageInfoSpecificLUKS
90       'luks': 'QCryptoBlockInfoLUKS'
91   } }
92
93 ##
94 # @ImageInfo:
95 #
96 # Information about a QEMU image file
97 #
98 # @filename: name of the image file
99 #
100 # @format: format of the image file
101 #
102 # @virtual-size: maximum capacity in bytes of the image
103 #
104 # @actual-size: #optional actual size on disk in bytes of the image
105 #
106 # @dirty-flag: #optional true if image is not cleanly closed
107 #
108 # @cluster-size: #optional size of a cluster in bytes
109 #
110 # @encrypted: #optional true if the image is encrypted
111 #
112 # @compressed: #optional true if the image is compressed (Since 1.7)
113 #
114 # @backing-filename: #optional name of the backing file
115 #
116 # @full-backing-filename: #optional full path of the backing file
117 #
118 # @backing-filename-format: #optional the format of the backing file
119 #
120 # @snapshots: #optional list of VM snapshots
121 #
122 # @backing-image: #optional info of the backing image (since 1.6)
123 #
124 # @format-specific: #optional structure supplying additional format-specific
125 # information (since 1.7)
126 #
127 # Since: 1.3
128 #
129 ##
130 { 'struct': 'ImageInfo',
131   'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
132            '*actual-size': 'int', 'virtual-size': 'int',
133            '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
134            '*backing-filename': 'str', '*full-backing-filename': 'str',
135            '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
136            '*backing-image': 'ImageInfo',
137            '*format-specific': 'ImageInfoSpecific' } }
138
139 ##
140 # @ImageCheck:
141 #
142 # Information about a QEMU image file check
143 #
144 # @filename: name of the image file checked
145 #
146 # @format: format of the image file checked
147 #
148 # @check-errors: number of unexpected errors occurred during check
149 #
150 # @image-end-offset: #optional offset (in bytes) where the image ends, this
151 #                    field is present if the driver for the image format
152 #                    supports it
153 #
154 # @corruptions: #optional number of corruptions found during the check if any
155 #
156 # @leaks: #optional number of leaks found during the check if any
157 #
158 # @corruptions-fixed: #optional number of corruptions fixed during the check
159 #                     if any
160 #
161 # @leaks-fixed: #optional number of leaks fixed during the check if any
162 #
163 # @total-clusters: #optional total number of clusters, this field is present
164 #                  if the driver for the image format supports it
165 #
166 # @allocated-clusters: #optional total number of allocated clusters, this
167 #                      field is present if the driver for the image format
168 #                      supports it
169 #
170 # @fragmented-clusters: #optional total number of fragmented clusters, this
171 #                       field is present if the driver for the image format
172 #                       supports it
173 #
174 # @compressed-clusters: #optional total number of compressed clusters, this
175 #                       field is present if the driver for the image format
176 #                       supports it
177 #
178 # Since: 1.4
179 #
180 ##
181 { 'struct': 'ImageCheck',
182   'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
183            '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
184            '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
185            '*total-clusters': 'int', '*allocated-clusters': 'int',
186            '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
187
188 ##
189 # @MapEntry:
190 #
191 # Mapping information from a virtual block range to a host file range
192 #
193 # @start: the start byte of the mapped virtual range
194 #
195 # @length: the number of bytes of the mapped virtual range
196 #
197 # @data: whether the mapped range has data
198 #
199 # @zero: whether the virtual blocks are zeroed
200 #
201 # @depth: the depth of the mapping
202 #
203 # @offset: #optional the offset in file that the virtual sectors are mapped to
204 #
205 # @filename: #optional filename that is referred to by @offset
206 #
207 # Since: 2.6
208 #
209 ##
210 { 'struct': 'MapEntry',
211   'data': {'start': 'int', 'length': 'int', 'data': 'bool',
212            'zero': 'bool', 'depth': 'int', '*offset': 'int',
213            '*filename': 'str' } }
214
215 ##
216 # @BlockdevCacheInfo:
217 #
218 # Cache mode information for a block device
219 #
220 # @writeback:   true if writeback mode is enabled
221 # @direct:      true if the host page cache is bypassed (O_DIRECT)
222 # @no-flush:    true if flush requests are ignored for the device
223 #
224 # Since: 2.3
225 ##
226 { 'struct': 'BlockdevCacheInfo',
227   'data': { 'writeback': 'bool',
228             'direct': 'bool',
229             'no-flush': 'bool' } }
230
231 ##
232 # @BlockDeviceInfo:
233 #
234 # Information about the backing device for a block device.
235 #
236 # @file: the filename of the backing device
237 #
238 # @node-name: #optional the name of the block driver node (Since 2.0)
239 #
240 # @ro: true if the backing device was open read-only
241 #
242 # @drv: the name of the block format used to open the backing device. As of
243 #       0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
244 #       'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
245 #       'http', 'https', 'luks', 'nbd', 'parallels', 'qcow',
246 #       'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat'
247 #       2.2: 'archipelago' added, 'cow' dropped
248 #       2.3: 'host_floppy' deprecated
249 #       2.5: 'host_floppy' dropped
250 #       2.6: 'luks' added
251 #       2.8: 'replication' added, 'tftp' dropped
252 #
253 # @backing_file: #optional the name of the backing file (for copy-on-write)
254 #
255 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
256 #
257 # @encrypted: true if the backing device is encrypted
258 #
259 # @encryption_key_missing: true if the backing device is encrypted but an
260 #                          valid encryption key is missing
261 #
262 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
263 #
264 # @bps: total throughput limit in bytes per second is specified
265 #
266 # @bps_rd: read throughput limit in bytes per second is specified
267 #
268 # @bps_wr: write throughput limit in bytes per second is specified
269 #
270 # @iops: total I/O operations per second is specified
271 #
272 # @iops_rd: read I/O operations per second is specified
273 #
274 # @iops_wr: write I/O operations per second is specified
275 #
276 # @image: the info of image used (since: 1.6)
277 #
278 # @bps_max: #optional total throughput limit during bursts,
279 #                     in bytes (Since 1.7)
280 #
281 # @bps_rd_max: #optional read throughput limit during bursts,
282 #                        in bytes (Since 1.7)
283 #
284 # @bps_wr_max: #optional write throughput limit during bursts,
285 #                        in bytes (Since 1.7)
286 #
287 # @iops_max: #optional total I/O operations per second during bursts,
288 #                      in bytes (Since 1.7)
289 #
290 # @iops_rd_max: #optional read I/O operations per second during bursts,
291 #                         in bytes (Since 1.7)
292 #
293 # @iops_wr_max: #optional write I/O operations per second during bursts,
294 #                         in bytes (Since 1.7)
295 #
296 # @bps_max_length: #optional maximum length of the @bps_max burst
297 #                            period, in seconds. (Since 2.6)
298 #
299 # @bps_rd_max_length: #optional maximum length of the @bps_rd_max
300 #                               burst period, in seconds. (Since 2.6)
301 #
302 # @bps_wr_max_length: #optional maximum length of the @bps_wr_max
303 #                               burst period, in seconds. (Since 2.6)
304 #
305 # @iops_max_length: #optional maximum length of the @iops burst
306 #                             period, in seconds. (Since 2.6)
307 #
308 # @iops_rd_max_length: #optional maximum length of the @iops_rd_max
309 #                                burst period, in seconds. (Since 2.6)
310 #
311 # @iops_wr_max_length: #optional maximum length of the @iops_wr_max
312 #                                burst period, in seconds. (Since 2.6)
313 #
314 # @iops_size: #optional an I/O size in bytes (Since 1.7)
315 #
316 # @group: #optional throttle group name (Since 2.4)
317 #
318 # @cache: the cache mode used for the block device (since: 2.3)
319 #
320 # @write_threshold: configured write threshold for the device.
321 #                   0 if disabled. (Since 2.3)
322 #
323 # Since: 0.14.0
324 #
325 ##
326 { 'struct': 'BlockDeviceInfo',
327   'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
328             '*backing_file': 'str', 'backing_file_depth': 'int',
329             'encrypted': 'bool', 'encryption_key_missing': 'bool',
330             'detect_zeroes': 'BlockdevDetectZeroesOptions',
331             'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
332             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
333             'image': 'ImageInfo',
334             '*bps_max': 'int', '*bps_rd_max': 'int',
335             '*bps_wr_max': 'int', '*iops_max': 'int',
336             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
337             '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
338             '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
339             '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
340             '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
341             'write_threshold': 'int' } }
342
343 ##
344 # @BlockDeviceIoStatus:
345 #
346 # An enumeration of block device I/O status.
347 #
348 # @ok: The last I/O operation has succeeded
349 #
350 # @failed: The last I/O operation has failed
351 #
352 # @nospace: The last I/O operation has failed due to a no-space condition
353 #
354 # Since: 1.0
355 ##
356 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
357
358 ##
359 # @BlockDeviceMapEntry:
360 #
361 # Entry in the metadata map of the device (returned by "qemu-img map")
362 #
363 # @start: Offset in the image of the first byte described by this entry
364 #         (in bytes)
365 #
366 # @length: Length of the range described by this entry (in bytes)
367 #
368 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
369 #         before reaching one for which the range is allocated.  The value is
370 #         in the range 0 to the depth of the image chain - 1.
371 #
372 # @zero: the sectors in this range read as zeros
373 #
374 # @data: reading the image will actually read data from a file (in particular,
375 #        if @offset is present this means that the sectors are not simply
376 #        preallocated, but contain actual data in raw format)
377 #
378 # @offset: if present, the image file stores the data for this range in
379 #          raw format at the given offset.
380 #
381 # Since: 1.7
382 ##
383 { 'struct': 'BlockDeviceMapEntry',
384   'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
385             'data': 'bool', '*offset': 'int' } }
386
387 ##
388 # @DirtyBitmapStatus:
389 #
390 # An enumeration of possible states that a dirty bitmap can report to the user.
391 #
392 # @frozen: The bitmap is currently in-use by a backup operation or block job,
393 #          and is immutable.
394 #
395 # @disabled: The bitmap is currently in-use by an internal operation and is
396 #            read-only. It can still be deleted.
397 #
398 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
399 #          deleted, or used for backup operations.
400 #
401 # Since: 2.4
402 ##
403 { 'enum': 'DirtyBitmapStatus',
404   'data': ['active', 'disabled', 'frozen'] }
405
406 ##
407 # @BlockDirtyInfo:
408 #
409 # Block dirty bitmap information.
410 #
411 # @name: #optional the name of the dirty bitmap (Since 2.4)
412 #
413 # @count: number of dirty bytes according to the dirty bitmap
414 #
415 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
416 #
417 # @status: current status of the dirty bitmap (since 2.4)
418 #
419 # Since: 1.3
420 ##
421 { 'struct': 'BlockDirtyInfo',
422   'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
423            'status': 'DirtyBitmapStatus'} }
424
425 ##
426 # @BlockInfo:
427 #
428 # Block device information.  This structure describes a virtual device and
429 # the backing device associated with it.
430 #
431 # @device: The device name associated with the virtual device.
432 #
433 # @type: This field is returned only for compatibility reasons, it should
434 #        not be used (always returns 'unknown')
435 #
436 # @removable: True if the device supports removable media.
437 #
438 # @locked: True if the guest has locked this device from having its media
439 #          removed
440 #
441 # @tray_open: #optional True if the device's tray is open
442 #             (only present if it has a tray)
443 #
444 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
445 #                 driver has one or more dirty bitmaps) (Since 2.0)
446 #
447 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
448 #             supports it and the VM is configured to stop on errors
449 #             (supported device models: virtio-blk, ide, scsi-disk)
450 #
451 # @inserted: #optional @BlockDeviceInfo describing the device if media is
452 #            present
453 #
454 # Since:  0.14.0
455 ##
456 { 'struct': 'BlockInfo',
457   'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
458            'locked': 'bool', '*inserted': 'BlockDeviceInfo',
459            '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
460            '*dirty-bitmaps': ['BlockDirtyInfo'] } }
461
462 ##
463 # @query-block:
464 #
465 # Get a list of BlockInfo for all virtual block devices.
466 #
467 # Returns: a list of @BlockInfo describing each virtual block device
468 #
469 # Since: 0.14.0
470 ##
471 { 'command': 'query-block', 'returns': ['BlockInfo'] }
472
473
474 ##
475 # @BlockDeviceTimedStats:
476 #
477 # Statistics of a block device during a given interval of time.
478 #
479 # @interval_length: Interval used for calculating the statistics,
480 #                   in seconds.
481 #
482 # @min_rd_latency_ns: Minimum latency of read operations in the
483 #                     defined interval, in nanoseconds.
484 #
485 # @min_wr_latency_ns: Minimum latency of write operations in the
486 #                     defined interval, in nanoseconds.
487 #
488 # @min_flush_latency_ns: Minimum latency of flush operations in the
489 #                        defined interval, in nanoseconds.
490 #
491 # @max_rd_latency_ns: Maximum latency of read operations in the
492 #                     defined interval, in nanoseconds.
493 #
494 # @max_wr_latency_ns: Maximum latency of write operations in the
495 #                     defined interval, in nanoseconds.
496 #
497 # @max_flush_latency_ns: Maximum latency of flush operations in the
498 #                        defined interval, in nanoseconds.
499 #
500 # @avg_rd_latency_ns: Average latency of read operations in the
501 #                     defined interval, in nanoseconds.
502 #
503 # @avg_wr_latency_ns: Average latency of write operations in the
504 #                     defined interval, in nanoseconds.
505 #
506 # @avg_flush_latency_ns: Average latency of flush operations in the
507 #                        defined interval, in nanoseconds.
508 #
509 # @avg_rd_queue_depth: Average number of pending read operations
510 #                      in the defined interval.
511 #
512 # @avg_wr_queue_depth: Average number of pending write operations
513 #                      in the defined interval.
514 #
515 # Since: 2.5
516 ##
517 { 'struct': 'BlockDeviceTimedStats',
518   'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
519             'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
520             'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
521             'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
522             'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
523             'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
524
525 ##
526 # @BlockDeviceStats:
527 #
528 # Statistics of a virtual block device or a block backing device.
529 #
530 # @rd_bytes:      The number of bytes read by the device.
531 #
532 # @wr_bytes:      The number of bytes written by the device.
533 #
534 # @rd_operations: The number of read operations performed by the device.
535 #
536 # @wr_operations: The number of write operations performed by the device.
537 #
538 # @flush_operations: The number of cache flush operations performed by the
539 #                    device (since 0.15.0)
540 #
541 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
542 #                       (since 0.15.0).
543 #
544 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
545 #
546 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
547 #
548 # @wr_highest_offset: The offset after the greatest byte written to the
549 #                     device.  The intended use of this information is for
550 #                     growable sparse files (like qcow2) that are used on top
551 #                     of a physical device.
552 #
553 # @rd_merged: Number of read requests that have been merged into another
554 #             request (Since 2.3).
555 #
556 # @wr_merged: Number of write requests that have been merged into another
557 #             request (Since 2.3).
558 #
559 # @idle_time_ns: #optional Time since the last I/O operation, in
560 #                nanoseconds. If the field is absent it means that
561 #                there haven't been any operations yet (Since 2.5).
562 #
563 # @failed_rd_operations: The number of failed read operations
564 #                        performed by the device (Since 2.5)
565 #
566 # @failed_wr_operations: The number of failed write operations
567 #                        performed by the device (Since 2.5)
568 #
569 # @failed_flush_operations: The number of failed flush operations
570 #                           performed by the device (Since 2.5)
571 #
572 # @invalid_rd_operations: The number of invalid read operations
573 #                          performed by the device (Since 2.5)
574 #
575 # @invalid_wr_operations: The number of invalid write operations
576 #                         performed by the device (Since 2.5)
577 #
578 # @invalid_flush_operations: The number of invalid flush operations
579 #                            performed by the device (Since 2.5)
580 #
581 # @account_invalid: Whether invalid operations are included in the
582 #                   last access statistics (Since 2.5)
583 #
584 # @account_failed: Whether failed operations are included in the
585 #                  latency and last access statistics (Since 2.5)
586 #
587 # @timed_stats: Statistics specific to the set of previously defined
588 #               intervals of time (Since 2.5)
589 #
590 # Since: 0.14.0
591 ##
592 { 'struct': 'BlockDeviceStats',
593   'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
594            'wr_operations': 'int', 'flush_operations': 'int',
595            'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
596            'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
597            'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int',
598            'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
599            'failed_flush_operations': 'int', 'invalid_rd_operations': 'int',
600            'invalid_wr_operations': 'int', 'invalid_flush_operations': 'int',
601            'account_invalid': 'bool', 'account_failed': 'bool',
602            'timed_stats': ['BlockDeviceTimedStats'] } }
603
604 ##
605 # @BlockStats:
606 #
607 # Statistics of a virtual block device or a block backing device.
608 #
609 # @device: #optional If the stats are for a virtual block device, the name
610 #          corresponding to the virtual block device.
611 #
612 # @node-name: #optional The node name of the device. (Since 2.3)
613 #
614 # @stats:  A @BlockDeviceStats for the device.
615 #
616 # @parent: #optional This describes the file block device if it has one.
617 #
618 # @backing: #optional This describes the backing block device if it has one.
619 #           (Since 2.0)
620 #
621 # Since: 0.14.0
622 ##
623 { 'struct': 'BlockStats',
624   'data': {'*device': 'str', '*node-name': 'str',
625            'stats': 'BlockDeviceStats',
626            '*parent': 'BlockStats',
627            '*backing': 'BlockStats'} }
628
629 ##
630 # @query-blockstats:
631 #
632 # Query the @BlockStats for all virtual block devices.
633 #
634 # @query-nodes: #optional If true, the command will query all the block nodes
635 #               that have a node name, in a list which will include "parent"
636 #               information, but not "backing".
637 #               If false or omitted, the behavior is as before - query all the
638 #               device backends, recursively including their "parent" and
639 #               "backing". (Since 2.3)
640 #
641 # Returns: A list of @BlockStats for each virtual block devices.
642 #
643 # Since: 0.14.0
644 ##
645 { 'command': 'query-blockstats',
646   'data': { '*query-nodes': 'bool' },
647   'returns': ['BlockStats'] }
648
649 ##
650 # @BlockdevOnError:
651 #
652 # An enumeration of possible behaviors for errors on I/O operations.
653 # The exact meaning depends on whether the I/O was initiated by a guest
654 # or by a block job
655 #
656 # @report: for guest operations, report the error to the guest;
657 #          for jobs, cancel the job
658 #
659 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
660 #          or BLOCK_JOB_ERROR)
661 #
662 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
663 #
664 # @stop: for guest operations, stop the virtual machine;
665 #        for jobs, pause the job
666 #
667 # @auto: inherit the error handling policy of the backend (since: 2.7)
668 #
669 # Since: 1.3
670 ##
671 { 'enum': 'BlockdevOnError',
672   'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] }
673
674 ##
675 # @MirrorSyncMode:
676 #
677 # An enumeration of possible behaviors for the initial synchronization
678 # phase of storage mirroring.
679 #
680 # @top: copies data in the topmost image to the destination
681 #
682 # @full: copies data from all images to the destination
683 #
684 # @none: only copy data written from now on
685 #
686 # @incremental: only copy data described by the dirty bitmap. Since: 2.4
687 #
688 # Since: 1.3
689 ##
690 { 'enum': 'MirrorSyncMode',
691   'data': ['top', 'full', 'none', 'incremental'] }
692
693 ##
694 # @BlockJobType:
695 #
696 # Type of a block job.
697 #
698 # @commit: block commit job type, see "block-commit"
699 #
700 # @stream: block stream job type, see "block-stream"
701 #
702 # @mirror: drive mirror job type, see "drive-mirror"
703 #
704 # @backup: drive backup job type, see "drive-backup"
705 #
706 # Since: 1.7
707 ##
708 { 'enum': 'BlockJobType',
709   'data': ['commit', 'stream', 'mirror', 'backup'] }
710
711 ##
712 # @BlockJobInfo:
713 #
714 # Information about a long-running block device operation.
715 #
716 # @type: the job type ('stream' for image streaming)
717 #
718 # @device: The job identifier. Originally the device name but other
719 #          values are allowed since QEMU 2.7
720 #
721 # @len: the maximum progress value
722 #
723 # @busy: false if the job is known to be in a quiescent state, with
724 #        no pending I/O.  Since 1.3.
725 #
726 # @paused: whether the job is paused or, if @busy is true, will
727 #          pause itself as soon as possible.  Since 1.3.
728 #
729 # @offset: the current progress value
730 #
731 # @speed: the rate limit, bytes per second
732 #
733 # @io-status: the status of the job (since 1.3)
734 #
735 # @ready: true if the job may be completed (since 2.2)
736 #
737 # Since: 1.1
738 ##
739 { 'struct': 'BlockJobInfo',
740   'data': {'type': 'str', 'device': 'str', 'len': 'int',
741            'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
742            'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
743
744 ##
745 # @query-block-jobs:
746 #
747 # Return information about long-running block device operations.
748 #
749 # Returns: a list of @BlockJobInfo for each active block job
750 #
751 # Since: 1.1
752 ##
753 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
754
755 ##
756 # @block_passwd:
757 #
758 # This command sets the password of a block device that has not been open
759 # with a password and requires one.
760 #
761 # The two cases where this can happen are a block device is created through
762 # QEMU's initial command line or a block device is changed through the legacy
763 # @change interface.
764 #
765 # In the event that the block device is created through the initial command
766 # line, the VM will start in the stopped state regardless of whether '-S' is
767 # used.  The intention is for a management tool to query the block devices to
768 # determine which ones are encrypted, set the passwords with this command, and
769 # then start the guest with the @cont command.
770 #
771 # Either @device or @node-name must be set but not both.
772 #
773 # @device: #optional the name of the block backend device to set the password on
774 #
775 # @node-name: #optional graph node name to set the password on (Since 2.0)
776 #
777 # @password: the password to use for the device
778 #
779 # Returns: nothing on success
780 #          If @device is not a valid block device, DeviceNotFound
781 #          If @device is not encrypted, DeviceNotEncrypted
782 #
783 # Notes:  Not all block formats support encryption and some that do are not
784 #         able to validate that a password is correct.  Disk corruption may
785 #         occur if an invalid password is specified.
786 #
787 # Since: 0.14.0
788 ##
789 { 'command': 'block_passwd', 'data': {'*device': 'str',
790                                       '*node-name': 'str', 'password': 'str'} }
791
792 ##
793 # @block_resize:
794 #
795 # Resize a block image while a guest is running.
796 #
797 # Either @device or @node-name must be set but not both.
798 #
799 # @device: #optional the name of the device to get the image resized
800 #
801 # @node-name: #optional graph node name to get the image resized (Since 2.0)
802 #
803 # @size:  new image size in bytes
804 #
805 # Returns: nothing on success
806 #          If @device is not a valid block device, DeviceNotFound
807 #
808 # Since: 0.14.0
809 ##
810 { 'command': 'block_resize', 'data': { '*device': 'str',
811                                        '*node-name': 'str',
812                                        'size': 'int' }}
813
814 ##
815 # @NewImageMode:
816 #
817 # An enumeration that tells QEMU how to set the backing file path in
818 # a new image file.
819 #
820 # @existing: QEMU should look for an existing image file.
821 #
822 # @absolute-paths: QEMU should create a new image with absolute paths
823 # for the backing file. If there is no backing file available, the new
824 # image will not be backed either.
825 #
826 # Since: 1.1
827 ##
828 { 'enum': 'NewImageMode',
829   'data': [ 'existing', 'absolute-paths' ] }
830
831 ##
832 # @BlockdevSnapshotSync:
833 #
834 # Either @device or @node-name must be set but not both.
835 #
836 # @device: #optional the name of the device to generate the snapshot from.
837 #
838 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
839 #
840 # @snapshot-file: the target of the new image. A new file will be created.
841 #
842 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
843 #
844 # @format: #optional the format of the snapshot image, default is 'qcow2'.
845 #
846 # @mode: #optional whether and how QEMU should create a new image, default is
847 #        'absolute-paths'.
848 ##
849 { 'struct': 'BlockdevSnapshotSync',
850   'data': { '*device': 'str', '*node-name': 'str',
851             'snapshot-file': 'str', '*snapshot-node-name': 'str',
852             '*format': 'str', '*mode': 'NewImageMode' } }
853
854 ##
855 # @BlockdevSnapshot:
856 #
857 # @node: device or node name that will have a snapshot created.
858 #
859 # @overlay: reference to the existing block device that will become
860 #           the overlay of @node, as part of creating the snapshot.
861 #           It must not have a current backing file (this can be
862 #           achieved by passing "backing": "" to blockdev-add).
863 #
864 # Since: 2.5
865 ##
866 { 'struct': 'BlockdevSnapshot',
867   'data': { 'node': 'str', 'overlay': 'str' } }
868
869 ##
870 # @DriveBackup:
871 #
872 # @job-id: #optional identifier for the newly-created block job. If
873 #          omitted, the device name will be used. (Since 2.7)
874 #
875 # @device: the device name or node-name of a root node which should be copied.
876 #
877 # @target: the target of the new image. If the file exists, or if it
878 #          is a device, the existing file/device will be used as the new
879 #          destination.  If it does not exist, a new file will be created.
880 #
881 # @format: #optional the format of the new destination, default is to
882 #          probe if @mode is 'existing', else the format of the source
883 #
884 # @sync: what parts of the disk image should be copied to the destination
885 #        (all the disk, only the sectors allocated in the topmost image, from a
886 #        dirty bitmap, or only new I/O).
887 #
888 # @mode: #optional whether and how QEMU should create a new image, default is
889 #        'absolute-paths'.
890 #
891 # @speed: #optional the maximum speed, in bytes per second
892 #
893 # @bitmap: #optional the name of dirty bitmap if sync is "incremental".
894 #          Must be present if sync is "incremental", must NOT be present
895 #          otherwise. (Since 2.4)
896 #
897 # @compress: #optional true to compress data, if the target format supports it.
898 #            (default: false) (since 2.8)
899 #
900 # @on-source-error: #optional the action to take on an error on the source,
901 #                   default 'report'.  'stop' and 'enospc' can only be used
902 #                   if the block device supports io-status (see BlockInfo).
903 #
904 # @on-target-error: #optional the action to take on an error on the target,
905 #                   default 'report' (no limitations, since this applies to
906 #                   a different block device than @device).
907 #
908 # Note: @on-source-error and @on-target-error only affect background
909 # I/O.  If an error occurs during a guest write request, the device's
910 # rerror/werror actions will be used.
911 #
912 # Since: 1.6
913 ##
914 { 'struct': 'DriveBackup',
915   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
916             '*format': 'str', 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
917             '*speed': 'int', '*bitmap': 'str', '*compress': 'bool',
918             '*on-source-error': 'BlockdevOnError',
919             '*on-target-error': 'BlockdevOnError' } }
920
921 ##
922 # @BlockdevBackup:
923 #
924 # @job-id: #optional identifier for the newly-created block job. If
925 #          omitted, the device name will be used. (Since 2.7)
926 #
927 # @device: the device name or node-name of a root node which should be copied.
928 #
929 # @target: the device name or node-name of the backup target node.
930 #
931 # @sync: what parts of the disk image should be copied to the destination
932 #        (all the disk, only the sectors allocated in the topmost image, or
933 #        only new I/O).
934 #
935 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
936 #         for unlimited.
937 #
938 # @compress: #optional true to compress data, if the target format supports it.
939 #            (default: false) (since 2.8)
940 #
941 # @on-source-error: #optional the action to take on an error on the source,
942 #                   default 'report'.  'stop' and 'enospc' can only be used
943 #                   if the block device supports io-status (see BlockInfo).
944 #
945 # @on-target-error: #optional the action to take on an error on the target,
946 #                   default 'report' (no limitations, since this applies to
947 #                   a different block device than @device).
948 #
949 # Note: @on-source-error and @on-target-error only affect background
950 # I/O.  If an error occurs during a guest write request, the device's
951 # rerror/werror actions will be used.
952 #
953 # Since: 2.3
954 ##
955 { 'struct': 'BlockdevBackup',
956   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
957             'sync': 'MirrorSyncMode',
958             '*speed': 'int',
959             '*compress': 'bool',
960             '*on-source-error': 'BlockdevOnError',
961             '*on-target-error': 'BlockdevOnError' } }
962
963 ##
964 # @blockdev-snapshot-sync:
965 #
966 # Generates a synchronous snapshot of a block device.
967 #
968 # For the arguments, see the documentation of BlockdevSnapshotSync.
969 #
970 # Returns: nothing on success
971 #          If @device is not a valid block device, DeviceNotFound
972 #
973 # Since: 0.14.0
974 ##
975 { 'command': 'blockdev-snapshot-sync',
976   'data': 'BlockdevSnapshotSync' }
977
978
979 ##
980 # @blockdev-snapshot:
981 #
982 # Generates a snapshot of a block device.
983 #
984 # For the arguments, see the documentation of BlockdevSnapshot.
985 #
986 # Since: 2.5
987 ##
988 { 'command': 'blockdev-snapshot',
989   'data': 'BlockdevSnapshot' }
990
991 ##
992 # @change-backing-file:
993 #
994 # Change the backing file in the image file metadata.  This does not
995 # cause QEMU to reopen the image file to reparse the backing filename
996 # (it may, however, perform a reopen to change permissions from
997 # r/o -> r/w -> r/o, if needed). The new backing file string is written
998 # into the image file metadata, and the QEMU internal strings are
999 # updated.
1000 #
1001 # @image-node-name: The name of the block driver state node of the
1002 #                   image to modify.
1003 #
1004 # @device:          The device name or node-name of the root node that owns
1005 #                   image-node-name.
1006 #
1007 # @backing-file:    The string to write as the backing file.  This
1008 #                   string is not validated, so care should be taken
1009 #                   when specifying the string or the image chain may
1010 #                   not be able to be reopened again.
1011 #
1012 # Since: 2.1
1013 ##
1014 { 'command': 'change-backing-file',
1015   'data': { 'device': 'str', 'image-node-name': 'str',
1016             'backing-file': 'str' } }
1017
1018 ##
1019 # @block-commit:
1020 #
1021 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1022 # writes data between 'top' and 'base' into 'base'.
1023 #
1024 # @job-id: #optional identifier for the newly-created block job. If
1025 #          omitted, the device name will be used. (Since 2.7)
1026 #
1027 # @device:  the device name or node-name of a root node
1028 #
1029 # @base:   #optional The file name of the backing image to write data into.
1030 #                    If not specified, this is the deepest backing image
1031 #
1032 # @top:    #optional The file name of the backing image within the image chain,
1033 #                    which contains the topmost data to be committed down. If
1034 #                    not specified, this is the active layer.
1035 #
1036 # @backing-file:  #optional The backing file string to write into the overlay
1037 #                           image of 'top'.  If 'top' is the active layer,
1038 #                           specifying a backing file string is an error. This
1039 #                           filename is not validated.
1040 #
1041 #                           If a pathname string is such that it cannot be
1042 #                           resolved by QEMU, that means that subsequent QMP or
1043 #                           HMP commands must use node-names for the image in
1044 #                           question, as filename lookup methods will fail.
1045 #
1046 #                           If not specified, QEMU will automatically determine
1047 #                           the backing file string to use, or error out if
1048 #                           there is no obvious choice. Care should be taken
1049 #                           when specifying the string, to specify a valid
1050 #                           filename or protocol.
1051 #                           (Since 2.1)
1052 #
1053 #                    If top == base, that is an error.
1054 #                    If top == active, the job will not be completed by itself,
1055 #                    user needs to complete the job with the block-job-complete
1056 #                    command after getting the ready event. (Since 2.0)
1057 #
1058 #                    If the base image is smaller than top, then the base image
1059 #                    will be resized to be the same size as top.  If top is
1060 #                    smaller than the base image, the base will not be
1061 #                    truncated.  If you want the base image size to match the
1062 #                    size of the smaller top, you can safely truncate it
1063 #                    yourself once the commit operation successfully completes.
1064 #
1065 # @speed:  #optional the maximum speed, in bytes per second
1066 #
1067 # Returns: Nothing on success
1068 #          If commit or stream is already active on this device, DeviceInUse
1069 #          If @device does not exist, DeviceNotFound
1070 #          If image commit is not supported by this device, NotSupported
1071 #          If @base or @top is invalid, a generic error is returned
1072 #          If @speed is invalid, InvalidParameter
1073 #
1074 # Since: 1.3
1075 #
1076 ##
1077 { 'command': 'block-commit',
1078   'data': { '*job-id': 'str', 'device': 'str', '*base': 'str', '*top': 'str',
1079             '*backing-file': 'str', '*speed': 'int' } }
1080
1081 ##
1082 # @drive-backup:
1083 #
1084 # Start a point-in-time copy of a block device to a new destination.  The
1085 # status of ongoing drive-backup operations can be checked with
1086 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1087 # The operation can be stopped before it has completed using the
1088 # block-job-cancel command.
1089 #
1090 # For the arguments, see the documentation of DriveBackup.
1091 #
1092 # Returns: nothing on success
1093 #          If @device is not a valid block device, GenericError
1094 #
1095 # Since: 1.6
1096 ##
1097 { 'command': 'drive-backup', 'boxed': true,
1098   'data': 'DriveBackup' }
1099
1100 ##
1101 # @blockdev-backup:
1102 #
1103 # Start a point-in-time copy of a block device to a new destination.  The
1104 # status of ongoing blockdev-backup operations can be checked with
1105 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1106 # The operation can be stopped before it has completed using the
1107 # block-job-cancel command.
1108 #
1109 # For the arguments, see the documentation of BlockdevBackup.
1110 #
1111 # Returns: nothing on success
1112 #          If @device is not a valid block device, DeviceNotFound
1113 #
1114 # Since: 2.3
1115 ##
1116 { 'command': 'blockdev-backup', 'boxed': true,
1117   'data': 'BlockdevBackup' }
1118
1119
1120 ##
1121 # @query-named-block-nodes:
1122 #
1123 # Get the named block driver list
1124 #
1125 # Returns: the list of BlockDeviceInfo
1126 #
1127 # Since: 2.0
1128 ##
1129 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
1130
1131 ##
1132 # @drive-mirror:
1133 #
1134 # Start mirroring a block device's writes to a new destination.
1135 #
1136 # See DriveMirror for parameter descriptions
1137 #
1138 # Returns: nothing on success
1139 #          If @device is not a valid block device, GenericError
1140 #
1141 # Since: 1.3
1142 ##
1143 { 'command': 'drive-mirror', 'boxed': true,
1144   'data': 'DriveMirror' }
1145
1146 ##
1147 # @DriveMirror:
1148 #
1149 # A set of parameters describing drive mirror setup.
1150 #
1151 # @job-id: #optional identifier for the newly-created block job. If
1152 #          omitted, the device name will be used. (Since 2.7)
1153 #
1154 # @device:  the device name or node-name of a root node whose writes should be
1155 #           mirrored.
1156 #
1157 # @target: the target of the new image. If the file exists, or if it
1158 #          is a device, the existing file/device will be used as the new
1159 #          destination.  If it does not exist, a new file will be created.
1160 #
1161 # @format: #optional the format of the new destination, default is to
1162 #          probe if @mode is 'existing', else the format of the source
1163 #
1164 # @node-name: #optional the new block driver state node name in the graph
1165 #             (Since 2.1)
1166 #
1167 # @replaces: #optional with sync=full graph node name to be replaced by the new
1168 #            image when a whole image copy is done. This can be used to repair
1169 #            broken Quorum files. (Since 2.1)
1170 #
1171 # @mode: #optional whether and how QEMU should create a new image, default is
1172 #        'absolute-paths'.
1173 #
1174 # @speed:  #optional the maximum speed, in bytes per second
1175 #
1176 # @sync: what parts of the disk image should be copied to the destination
1177 #        (all the disk, only the sectors allocated in the topmost image, or
1178 #        only new I/O).
1179 #
1180 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1181 #               if the image format doesn't have clusters, 4K if the clusters
1182 #               are smaller than that, else the cluster size.  Must be a
1183 #               power of 2 between 512 and 64M (since 1.4).
1184 #
1185 # @buf-size: #optional maximum amount of data in flight from source to
1186 #            target (since 1.4).
1187 #
1188 # @on-source-error: #optional the action to take on an error on the source,
1189 #                   default 'report'.  'stop' and 'enospc' can only be used
1190 #                   if the block device supports io-status (see BlockInfo).
1191 #
1192 # @on-target-error: #optional the action to take on an error on the target,
1193 #                   default 'report' (no limitations, since this applies to
1194 #                   a different block device than @device).
1195 # @unmap: #optional Whether to try to unmap target sectors where source has
1196 #         only zero. If true, and target unallocated sectors will read as zero,
1197 #         target image sectors will be unmapped; otherwise, zeroes will be
1198 #         written. Both will result in identical contents.
1199 #         Default is true. (Since 2.4)
1200 #
1201 # Since: 1.3
1202 ##
1203 { 'struct': 'DriveMirror',
1204   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1205             '*format': 'str', '*node-name': 'str', '*replaces': 'str',
1206             'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1207             '*speed': 'int', '*granularity': 'uint32',
1208             '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1209             '*on-target-error': 'BlockdevOnError',
1210             '*unmap': 'bool' } }
1211
1212 ##
1213 # @BlockDirtyBitmap:
1214 #
1215 # @node: name of device/node which the bitmap is tracking
1216 #
1217 # @name: name of the dirty bitmap
1218 #
1219 # Since: 2.4
1220 ##
1221 { 'struct': 'BlockDirtyBitmap',
1222   'data': { 'node': 'str', 'name': 'str' } }
1223
1224 ##
1225 # @BlockDirtyBitmapAdd:
1226 #
1227 # @node: name of device/node which the bitmap is tracking
1228 #
1229 # @name: name of the dirty bitmap
1230 #
1231 # @granularity: #optional the bitmap granularity, default is 64k for
1232 #               block-dirty-bitmap-add
1233 #
1234 # Since: 2.4
1235 ##
1236 { 'struct': 'BlockDirtyBitmapAdd',
1237   'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } }
1238
1239 ##
1240 # @block-dirty-bitmap-add:
1241 #
1242 # Create a dirty bitmap with a name on the node
1243 #
1244 # Returns: nothing on success
1245 #          If @node is not a valid block device or node, DeviceNotFound
1246 #          If @name is already taken, GenericError with an explanation
1247 #
1248 # Since: 2.4
1249 ##
1250 { 'command': 'block-dirty-bitmap-add',
1251   'data': 'BlockDirtyBitmapAdd' }
1252
1253 ##
1254 # @block-dirty-bitmap-remove:
1255 #
1256 # Remove a dirty bitmap on the node
1257 #
1258 # Returns: nothing on success
1259 #          If @node is not a valid block device or node, DeviceNotFound
1260 #          If @name is not found, GenericError with an explanation
1261 #          if @name is frozen by an operation, GenericError
1262 #
1263 # Since: 2.4
1264 ##
1265 { 'command': 'block-dirty-bitmap-remove',
1266   'data': 'BlockDirtyBitmap' }
1267
1268 ##
1269 # @block-dirty-bitmap-clear:
1270 #
1271 # Clear (reset) a dirty bitmap on the device
1272 #
1273 # Returns: nothing on success
1274 #          If @node is not a valid block device, DeviceNotFound
1275 #          If @name is not found, GenericError with an explanation
1276 #
1277 # Since: 2.4
1278 ##
1279 { 'command': 'block-dirty-bitmap-clear',
1280   'data': 'BlockDirtyBitmap' }
1281
1282 ##
1283 # @blockdev-mirror:
1284 #
1285 # Start mirroring a block device's writes to a new destination.
1286 #
1287 # @job-id: #optional identifier for the newly-created block job. If
1288 #          omitted, the device name will be used. (Since 2.7)
1289 #
1290 # @device: The device name or node-name of a root node whose writes should be
1291 #          mirrored.
1292 #
1293 # @target: the id or node-name of the block device to mirror to. This mustn't be
1294 #          attached to guest.
1295 #
1296 # @replaces: #optional with sync=full graph node name to be replaced by the new
1297 #            image when a whole image copy is done. This can be used to repair
1298 #            broken Quorum files.
1299 #
1300 # @speed:  #optional the maximum speed, in bytes per second
1301 #
1302 # @sync: what parts of the disk image should be copied to the destination
1303 #        (all the disk, only the sectors allocated in the topmost image, or
1304 #        only new I/O).
1305 #
1306 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1307 #               if the image format doesn't have clusters, 4K if the clusters
1308 #               are smaller than that, else the cluster size.  Must be a
1309 #               power of 2 between 512 and 64M
1310 #
1311 # @buf-size: #optional maximum amount of data in flight from source to
1312 #            target
1313 #
1314 # @on-source-error: #optional the action to take on an error on the source,
1315 #                   default 'report'.  'stop' and 'enospc' can only be used
1316 #                   if the block device supports io-status (see BlockInfo).
1317 #
1318 # @on-target-error: #optional the action to take on an error on the target,
1319 #                   default 'report' (no limitations, since this applies to
1320 #                   a different block device than @device).
1321 #
1322 # Returns: nothing on success.
1323 #
1324 # Since: 2.6
1325 ##
1326 { 'command': 'blockdev-mirror',
1327   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1328             '*replaces': 'str',
1329             'sync': 'MirrorSyncMode',
1330             '*speed': 'int', '*granularity': 'uint32',
1331             '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1332             '*on-target-error': 'BlockdevOnError' } }
1333
1334 ##
1335 # @block_set_io_throttle:
1336 #
1337 # Change I/O throttle limits for a block drive.
1338 #
1339 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1340 # group.
1341 #
1342 # If two or more devices are members of the same group, the limits
1343 # will apply to the combined I/O of the whole group in a round-robin
1344 # fashion. Therefore, setting new I/O limits to a device will affect
1345 # the whole group.
1346 #
1347 # The name of the group can be specified using the 'group' parameter.
1348 # If the parameter is unset, it is assumed to be the current group of
1349 # that device. If it's not in any group yet, the name of the device
1350 # will be used as the name for its group.
1351 #
1352 # The 'group' parameter can also be used to move a device to a
1353 # different group. In this case the limits specified in the parameters
1354 # will be applied to the new group only.
1355 #
1356 # I/O limits can be disabled by setting all of them to 0. In this case
1357 # the device will be removed from its group and the rest of its
1358 # members will not be affected. The 'group' parameter is ignored.
1359 #
1360 # See BlockIOThrottle for parameter descriptions.
1361 #
1362 # Returns: Nothing on success
1363 #          If @device is not a valid block device, DeviceNotFound
1364 #
1365 # Since: 1.1
1366 ##
1367 { 'command': 'block_set_io_throttle', 'boxed': true,
1368   'data': 'BlockIOThrottle' }
1369
1370 ##
1371 # @BlockIOThrottle:
1372 #
1373 # A set of parameters describing block throttling.
1374 #
1375 # @device: #optional Block device name (deprecated, use @id instead)
1376 #
1377 # @id: #optional The name or QOM path of the guest device (since: 2.8)
1378 #
1379 # @bps: total throughput limit in bytes per second
1380 #
1381 # @bps_rd: read throughput limit in bytes per second
1382 #
1383 # @bps_wr: write throughput limit in bytes per second
1384 #
1385 # @iops: total I/O operations per second
1386 #
1387 # @iops_rd: read I/O operations per second
1388 #
1389 # @iops_wr: write I/O operations per second
1390 #
1391 # @bps_max: #optional total throughput limit during bursts,
1392 #                     in bytes (Since 1.7)
1393 #
1394 # @bps_rd_max: #optional read throughput limit during bursts,
1395 #                        in bytes (Since 1.7)
1396 #
1397 # @bps_wr_max: #optional write throughput limit during bursts,
1398 #                        in bytes (Since 1.7)
1399 #
1400 # @iops_max: #optional total I/O operations per second during bursts,
1401 #                      in bytes (Since 1.7)
1402 #
1403 # @iops_rd_max: #optional read I/O operations per second during bursts,
1404 #                         in bytes (Since 1.7)
1405 #
1406 # @iops_wr_max: #optional write I/O operations per second during bursts,
1407 #                         in bytes (Since 1.7)
1408 #
1409 # @bps_max_length: #optional maximum length of the @bps_max burst
1410 #                            period, in seconds. It must only
1411 #                            be set if @bps_max is set as well.
1412 #                            Defaults to 1. (Since 2.6)
1413 #
1414 # @bps_rd_max_length: #optional maximum length of the @bps_rd_max
1415 #                               burst period, in seconds. It must only
1416 #                               be set if @bps_rd_max is set as well.
1417 #                               Defaults to 1. (Since 2.6)
1418 #
1419 # @bps_wr_max_length: #optional maximum length of the @bps_wr_max
1420 #                               burst period, in seconds. It must only
1421 #                               be set if @bps_wr_max is set as well.
1422 #                               Defaults to 1. (Since 2.6)
1423 #
1424 # @iops_max_length: #optional maximum length of the @iops burst
1425 #                             period, in seconds. It must only
1426 #                             be set if @iops_max is set as well.
1427 #                             Defaults to 1. (Since 2.6)
1428 #
1429 # @iops_rd_max_length: #optional maximum length of the @iops_rd_max
1430 #                                burst period, in seconds. It must only
1431 #                                be set if @iops_rd_max is set as well.
1432 #                                Defaults to 1. (Since 2.6)
1433 #
1434 # @iops_wr_max_length: #optional maximum length of the @iops_wr_max
1435 #                                burst period, in seconds. It must only
1436 #                                be set if @iops_wr_max is set as well.
1437 #                                Defaults to 1. (Since 2.6)
1438 #
1439 # @iops_size: #optional an I/O size in bytes (Since 1.7)
1440 #
1441 # @group: #optional throttle group name (Since 2.4)
1442 #
1443 # Since: 1.1
1444 ##
1445 { 'struct': 'BlockIOThrottle',
1446   'data': { '*device': 'str', '*id': 'str', 'bps': 'int', 'bps_rd': 'int',
1447             'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1448             '*bps_max': 'int', '*bps_rd_max': 'int',
1449             '*bps_wr_max': 'int', '*iops_max': 'int',
1450             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1451             '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
1452             '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
1453             '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
1454             '*iops_size': 'int', '*group': 'str' } }
1455
1456 ##
1457 # @block-stream:
1458 #
1459 # Copy data from a backing file into a block device.
1460 #
1461 # The block streaming operation is performed in the background until the entire
1462 # backing file has been copied.  This command returns immediately once streaming
1463 # has started.  The status of ongoing block streaming operations can be checked
1464 # with query-block-jobs.  The operation can be stopped before it has completed
1465 # using the block-job-cancel command.
1466 #
1467 # The node that receives the data is called the top image, can be located in
1468 # any part of the chain (but always above the base image; see below) and can be
1469 # specified using its device or node name. Earlier qemu versions only allowed
1470 # 'device' to name the top level node; presence of the 'base-node' parameter
1471 # during introspection can be used as a witness of the enhanced semantics
1472 # of 'device'.
1473 #
1474 # If a base file is specified then sectors are not copied from that base file and
1475 # its backing chain.  When streaming completes the image file will have the base
1476 # file as its backing file.  This can be used to stream a subset of the backing
1477 # file chain instead of flattening the entire image.
1478 #
1479 # On successful completion the image file is updated to drop the backing file
1480 # and the BLOCK_JOB_COMPLETED event is emitted.
1481 #
1482 # @job-id: #optional identifier for the newly-created block job. If
1483 #          omitted, the device name will be used. (Since 2.7)
1484 #
1485 # @device: the device or node name of the top image
1486 #
1487 # @base:   #optional the common backing file name.
1488 #                    It cannot be set if @base-node is also set.
1489 #
1490 # @base-node: #optional the node name of the backing file.
1491 #                       It cannot be set if @base is also set. (Since 2.8)
1492 #
1493 # @backing-file: #optional The backing file string to write into the top
1494 #                          image. This filename is not validated.
1495 #
1496 #                          If a pathname string is such that it cannot be
1497 #                          resolved by QEMU, that means that subsequent QMP or
1498 #                          HMP commands must use node-names for the image in
1499 #                          question, as filename lookup methods will fail.
1500 #
1501 #                          If not specified, QEMU will automatically determine
1502 #                          the backing file string to use, or error out if there
1503 #                          is no obvious choice.  Care should be taken when
1504 #                          specifying the string, to specify a valid filename or
1505 #                          protocol.
1506 #                          (Since 2.1)
1507 #
1508 # @speed:  #optional the maximum speed, in bytes per second
1509 #
1510 # @on-error: #optional the action to take on an error (default report).
1511 #            'stop' and 'enospc' can only be used if the block device
1512 #            supports io-status (see BlockInfo).  Since 1.3.
1513 #
1514 # Since: 1.1
1515 ##
1516 { 'command': 'block-stream',
1517   'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
1518             '*base-node': 'str', '*backing-file': 'str', '*speed': 'int',
1519             '*on-error': 'BlockdevOnError' } }
1520
1521 ##
1522 # @block-job-set-speed:
1523 #
1524 # Set maximum speed for a background block operation.
1525 #
1526 # This command can only be issued when there is an active block job.
1527 #
1528 # Throttling can be disabled by setting the speed to 0.
1529 #
1530 # @device: The job identifier. This used to be a device name (hence
1531 #          the name of the parameter), but since QEMU 2.7 it can have
1532 #          other values.
1533 #
1534 # @speed:  the maximum speed, in bytes per second, or 0 for unlimited.
1535 #          Defaults to 0.
1536 #
1537 # Returns: Nothing on success
1538 #          If no background operation is active on this device, DeviceNotActive
1539 #
1540 # Since: 1.1
1541 ##
1542 { 'command': 'block-job-set-speed',
1543   'data': { 'device': 'str', 'speed': 'int' } }
1544
1545 ##
1546 # @block-job-cancel:
1547 #
1548 # Stop an active background block operation.
1549 #
1550 # This command returns immediately after marking the active background block
1551 # operation for cancellation.  It is an error to call this command if no
1552 # operation is in progress.
1553 #
1554 # The operation will cancel as soon as possible and then emit the
1555 # BLOCK_JOB_CANCELLED event.  Before that happens the job is still visible when
1556 # enumerated using query-block-jobs.
1557 #
1558 # For streaming, the image file retains its backing file unless the streaming
1559 # operation happens to complete just as it is being cancelled.  A new streaming
1560 # operation can be started at a later time to finish copying all data from the
1561 # backing file.
1562 #
1563 # @device: The job identifier. This used to be a device name (hence
1564 #          the name of the parameter), but since QEMU 2.7 it can have
1565 #          other values.
1566 #
1567 # @force: #optional whether to allow cancellation of a paused job (default
1568 #         false).  Since 1.3.
1569 #
1570 # Returns: Nothing on success
1571 #          If no background operation is active on this device, DeviceNotActive
1572 #
1573 # Since: 1.1
1574 ##
1575 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1576
1577 ##
1578 # @block-job-pause:
1579 #
1580 # Pause an active background block operation.
1581 #
1582 # This command returns immediately after marking the active background block
1583 # operation for pausing.  It is an error to call this command if no
1584 # operation is in progress.  Pausing an already paused job has no cumulative
1585 # effect; a single block-job-resume command will resume the job.
1586 #
1587 # The operation will pause as soon as possible.  No event is emitted when
1588 # the operation is actually paused.  Cancelling a paused job automatically
1589 # resumes it.
1590 #
1591 # @device: The job identifier. This used to be a device name (hence
1592 #          the name of the parameter), but since QEMU 2.7 it can have
1593 #          other values.
1594 #
1595 # Returns: Nothing on success
1596 #          If no background operation is active on this device, DeviceNotActive
1597 #
1598 # Since: 1.3
1599 ##
1600 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1601
1602 ##
1603 # @block-job-resume:
1604 #
1605 # Resume an active background block operation.
1606 #
1607 # This command returns immediately after resuming a paused background block
1608 # operation.  It is an error to call this command if no operation is in
1609 # progress.  Resuming an already running job is not an error.
1610 #
1611 # This command also clears the error status of the job.
1612 #
1613 # @device: The job identifier. This used to be a device name (hence
1614 #          the name of the parameter), but since QEMU 2.7 it can have
1615 #          other values.
1616 #
1617 # Returns: Nothing on success
1618 #          If no background operation is active on this device, DeviceNotActive
1619 #
1620 # Since: 1.3
1621 ##
1622 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1623
1624 ##
1625 # @block-job-complete:
1626 #
1627 # Manually trigger completion of an active background block operation.  This
1628 # is supported for drive mirroring, where it also switches the device to
1629 # write to the target path only.  The ability to complete is signaled with
1630 # a BLOCK_JOB_READY event.
1631 #
1632 # This command completes an active background block operation synchronously.
1633 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1634 # is not defined.  Note that if an I/O error occurs during the processing of
1635 # this command: 1) the command itself will fail; 2) the error will be processed
1636 # according to the rerror/werror arguments that were specified when starting
1637 # the operation.
1638 #
1639 # A cancelled or paused job cannot be completed.
1640 #
1641 # @device: The job identifier. This used to be a device name (hence
1642 #          the name of the parameter), but since QEMU 2.7 it can have
1643 #          other values.
1644 #
1645 # Returns: Nothing on success
1646 #          If no background operation is active on this device, DeviceNotActive
1647 #
1648 # Since: 1.3
1649 ##
1650 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1651
1652 ##
1653 # @BlockdevDiscardOptions:
1654 #
1655 # Determines how to handle discard requests.
1656 #
1657 # @ignore:      Ignore the request
1658 # @unmap:       Forward as an unmap request
1659 #
1660 # Since: 1.7
1661 ##
1662 { 'enum': 'BlockdevDiscardOptions',
1663   'data': [ 'ignore', 'unmap' ] }
1664
1665 ##
1666 # @BlockdevDetectZeroesOptions:
1667 #
1668 # Describes the operation mode for the automatic conversion of plain
1669 # zero writes by the OS to driver specific optimized zero write commands.
1670 #
1671 # @off:      Disabled (default)
1672 # @on:       Enabled
1673 # @unmap:    Enabled and even try to unmap blocks if possible. This requires
1674 #            also that @BlockdevDiscardOptions is set to unmap for this device.
1675 #
1676 # Since: 2.1
1677 ##
1678 { 'enum': 'BlockdevDetectZeroesOptions',
1679   'data': [ 'off', 'on', 'unmap' ] }
1680
1681 ##
1682 # @BlockdevAioOptions:
1683 #
1684 # Selects the AIO backend to handle I/O requests
1685 #
1686 # @threads:     Use qemu's thread pool
1687 # @native:      Use native AIO backend (only Linux and Windows)
1688 #
1689 # Since: 1.7
1690 ##
1691 { 'enum': 'BlockdevAioOptions',
1692   'data': [ 'threads', 'native' ] }
1693
1694 ##
1695 # @BlockdevCacheOptions:
1696 #
1697 # Includes cache-related options for block devices
1698 #
1699 # @direct:      #optional enables use of O_DIRECT (bypass the host page cache;
1700 #               default: false)
1701 # @no-flush:    #optional ignore any flush requests for the device (default:
1702 #               false)
1703 #
1704 # Since: 1.7
1705 ##
1706 { 'struct': 'BlockdevCacheOptions',
1707   'data': { '*direct': 'bool',
1708             '*no-flush': 'bool' } }
1709
1710 ##
1711 # @BlockdevDriver:
1712 #
1713 # Drivers that are supported in block device operations.
1714 #
1715 # @host_device: Since 2.1
1716 # @host_cdrom: Since 2.1
1717 # @gluster: Since 2.7
1718 # @nbd: Since 2.8
1719 # @nfs: Since 2.8
1720 # @replication: Since 2.8
1721 # @ssh: Since 2.8
1722 #
1723 # Since: 2.0
1724 ##
1725 { 'enum': 'BlockdevDriver',
1726   'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1727             'dmg', 'file', 'ftp', 'ftps', 'gluster', 'host_cdrom',
1728             'host_device', 'http', 'https', 'luks', 'nbd', 'nfs', 'null-aio',
1729             'null-co', 'parallels', 'qcow', 'qcow2', 'qed', 'quorum', 'raw',
1730             'replication', 'ssh', 'vdi', 'vhdx', 'vmdk', 'vpc',
1731             'vvfat' ] }
1732
1733 ##
1734 # @BlockdevOptionsFile:
1735 #
1736 # Driver specific block device options for the file backend.
1737 #
1738 # @filename:    path to the image file
1739 # @aio:         #optional AIO backend (default: threads) (since: 2.8)
1740 #
1741 # Since: 1.7
1742 ##
1743 { 'struct': 'BlockdevOptionsFile',
1744   'data': { 'filename': 'str',
1745             '*aio': 'BlockdevAioOptions' } }
1746
1747 ##
1748 # @BlockdevOptionsNull:
1749 #
1750 # Driver specific block device options for the null backend.
1751 #
1752 # @size:    #optional size of the device in bytes.
1753 # @latency-ns: #optional emulated latency (in nanoseconds) in processing
1754 #              requests. Default to zero which completes requests immediately.
1755 #              (Since 2.4)
1756 #
1757 # Since: 2.2
1758 ##
1759 { 'struct': 'BlockdevOptionsNull',
1760   'data': { '*size': 'int', '*latency-ns': 'uint64' } }
1761
1762 ##
1763 # @BlockdevOptionsVVFAT:
1764 #
1765 # Driver specific block device options for the vvfat protocol.
1766 #
1767 # @dir:         directory to be exported as FAT image
1768 # @fat-type:    #optional FAT type: 12, 16 or 32
1769 # @floppy:      #optional whether to export a floppy image (true) or
1770 #               partitioned hard disk (false; default)
1771 # @label:       #optional set the volume label, limited to 11 bytes. FAT16 and
1772 #               FAT32 traditionally have some restrictions on labels, which are
1773 #               ignored by most operating systems. Defaults to "QEMU VVFAT".
1774 #               (since 2.4)
1775 # @rw:          #optional whether to allow write operations (default: false)
1776 #
1777 # Since: 1.7
1778 ##
1779 { 'struct': 'BlockdevOptionsVVFAT',
1780   'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1781             '*label': 'str', '*rw': 'bool' } }
1782
1783 ##
1784 # @BlockdevOptionsGenericFormat:
1785 #
1786 # Driver specific block device options for image format that have no option
1787 # besides their data source.
1788 #
1789 # @file:        reference to or definition of the data source block device
1790 #
1791 # Since: 1.7
1792 ##
1793 { 'struct': 'BlockdevOptionsGenericFormat',
1794   'data': { 'file': 'BlockdevRef' } }
1795
1796 ##
1797 # @BlockdevOptionsLUKS:
1798 #
1799 # Driver specific block device options for LUKS.
1800 #
1801 # @key-secret: #optional the ID of a QCryptoSecret object providing
1802 #              the decryption key (since 2.6). Mandatory except when
1803 #              doing a metadata-only probe of the image.
1804 #
1805 # Since: 2.6
1806 ##
1807 { 'struct': 'BlockdevOptionsLUKS',
1808   'base': 'BlockdevOptionsGenericFormat',
1809   'data': { '*key-secret': 'str' } }
1810
1811
1812 ##
1813 # @BlockdevOptionsGenericCOWFormat:
1814 #
1815 # Driver specific block device options for image format that have no option
1816 # besides their data source and an optional backing file.
1817 #
1818 # @backing:     #optional reference to or definition of the backing file block
1819 #               device (if missing, taken from the image file content). It is
1820 #               allowed to pass an empty string here in order to disable the
1821 #               default backing file.
1822 #
1823 # Since: 1.7
1824 ##
1825 { 'struct': 'BlockdevOptionsGenericCOWFormat',
1826   'base': 'BlockdevOptionsGenericFormat',
1827   'data': { '*backing': 'BlockdevRef' } }
1828
1829 ##
1830 # @Qcow2OverlapCheckMode:
1831 #
1832 # General overlap check modes.
1833 #
1834 # @none:        Do not perform any checks
1835 #
1836 # @constant:    Perform only checks which can be done in constant time and
1837 #               without reading anything from disk
1838 #
1839 # @cached:      Perform only checks which can be done without reading anything
1840 #               from disk
1841 #
1842 # @all:         Perform all available overlap checks
1843 #
1844 # Since: 2.2
1845 ##
1846 { 'enum': 'Qcow2OverlapCheckMode',
1847   'data': [ 'none', 'constant', 'cached', 'all' ] }
1848
1849 ##
1850 # @Qcow2OverlapCheckFlags:
1851 #
1852 # Structure of flags for each metadata structure. Setting a field to 'true'
1853 # makes qemu guard that structure against unintended overwriting. The default
1854 # value is chosen according to the template given.
1855 #
1856 # @template: Specifies a template mode which can be adjusted using the other
1857 #            flags, defaults to 'cached'
1858 #
1859 # Since: 2.2
1860 ##
1861 { 'struct': 'Qcow2OverlapCheckFlags',
1862   'data': { '*template':       'Qcow2OverlapCheckMode',
1863             '*main-header':    'bool',
1864             '*active-l1':      'bool',
1865             '*active-l2':      'bool',
1866             '*refcount-table': 'bool',
1867             '*refcount-block': 'bool',
1868             '*snapshot-table': 'bool',
1869             '*inactive-l1':    'bool',
1870             '*inactive-l2':    'bool' } }
1871
1872 ##
1873 # @Qcow2OverlapChecks:
1874 #
1875 # Specifies which metadata structures should be guarded against unintended
1876 # overwriting.
1877 #
1878 # @flags:   set of flags for separate specification of each metadata structure
1879 #           type
1880 #
1881 # @mode:    named mode which chooses a specific set of flags
1882 #
1883 # Since: 2.2
1884 ##
1885 { 'alternate': 'Qcow2OverlapChecks',
1886   'data': { 'flags': 'Qcow2OverlapCheckFlags',
1887             'mode':  'Qcow2OverlapCheckMode' } }
1888
1889 ##
1890 # @BlockdevOptionsQcow2:
1891 #
1892 # Driver specific block device options for qcow2.
1893 #
1894 # @lazy-refcounts:        #optional whether to enable the lazy refcounts
1895 #                         feature (default is taken from the image file)
1896 #
1897 # @pass-discard-request:  #optional whether discard requests to the qcow2
1898 #                         device should be forwarded to the data source
1899 #
1900 # @pass-discard-snapshot: #optional whether discard requests for the data source
1901 #                         should be issued when a snapshot operation (e.g.
1902 #                         deleting a snapshot) frees clusters in the qcow2 file
1903 #
1904 # @pass-discard-other:    #optional whether discard requests for the data source
1905 #                         should be issued on other occasions where a cluster
1906 #                         gets freed
1907 #
1908 # @overlap-check:         #optional which overlap checks to perform for writes
1909 #                         to the image, defaults to 'cached' (since 2.2)
1910 #
1911 # @cache-size:            #optional the maximum total size of the L2 table and
1912 #                         refcount block caches in bytes (since 2.2)
1913 #
1914 # @l2-cache-size:         #optional the maximum size of the L2 table cache in
1915 #                         bytes (since 2.2)
1916 #
1917 # @refcount-cache-size:   #optional the maximum size of the refcount block cache
1918 #                         in bytes (since 2.2)
1919 #
1920 # @cache-clean-interval:  #optional clean unused entries in the L2 and refcount
1921 #                         caches. The interval is in seconds. The default value
1922 #                         is 0 and it disables this feature (since 2.5)
1923 #
1924 # Since: 1.7
1925 ##
1926 { 'struct': 'BlockdevOptionsQcow2',
1927   'base': 'BlockdevOptionsGenericCOWFormat',
1928   'data': { '*lazy-refcounts': 'bool',
1929             '*pass-discard-request': 'bool',
1930             '*pass-discard-snapshot': 'bool',
1931             '*pass-discard-other': 'bool',
1932             '*overlap-check': 'Qcow2OverlapChecks',
1933             '*cache-size': 'int',
1934             '*l2-cache-size': 'int',
1935             '*refcount-cache-size': 'int',
1936             '*cache-clean-interval': 'int' } }
1937
1938
1939 ##
1940 # @BlockdevOptionsArchipelago:
1941 #
1942 # Driver specific block device options for Archipelago.
1943 #
1944 # @volume:              Name of the Archipelago volume image
1945 #
1946 # @mport:               #optional The port number on which mapperd is
1947 #                       listening. This is optional
1948 #                       and if not specified, QEMU will make Archipelago
1949 #                       use the default port (1001).
1950 #
1951 # @vport:               #optional The port number on which vlmcd is
1952 #                       listening. This is optional
1953 #                       and if not specified, QEMU will make Archipelago
1954 #                       use the default port (501).
1955 #
1956 # @segment:             #optional The name of the shared memory segment
1957 #                       Archipelago stack is using. This is optional
1958 #                       and if not specified, QEMU will make Archipelago
1959 #                       use the default value, 'archipelago'.
1960 # Since: 2.2
1961 ##
1962 { 'struct': 'BlockdevOptionsArchipelago',
1963   'data': { 'volume': 'str',
1964             '*mport': 'int',
1965             '*vport': 'int',
1966             '*segment': 'str' } }
1967
1968 ##
1969 # @BlockdevOptionsSsh:
1970 #
1971 # @server:              host address
1972 #
1973 # @path:                path to the image on the host
1974 #
1975 # @user:                #optional user as which to connect, defaults to current
1976 #                       local user name
1977 #
1978 # TODO: Expose the host_key_check option in QMP
1979 #
1980 # Since: 2.8
1981 ##
1982 { 'struct': 'BlockdevOptionsSsh',
1983   'data': { 'server': 'InetSocketAddress',
1984             'path': 'str',
1985             '*user': 'str' } }
1986
1987
1988 ##
1989 # @BlkdebugEvent:
1990 #
1991 # Trigger events supported by blkdebug.
1992 #
1993 # Since: 2.0
1994 ##
1995 { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
1996   'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
1997             'l1_grow_activate_table', 'l2_load', 'l2_update',
1998             'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
1999             'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
2000             'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
2001             'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
2002             'refblock_load', 'refblock_update', 'refblock_update_part',
2003             'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
2004             'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
2005             'refblock_alloc_switch_table', 'cluster_alloc',
2006             'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
2007             'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
2008             'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
2009             'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
2010
2011 ##
2012 # @BlkdebugInjectErrorOptions:
2013 #
2014 # Describes a single error injection for blkdebug.
2015 #
2016 # @event:       trigger event
2017 #
2018 # @state:       #optional the state identifier blkdebug needs to be in to
2019 #               actually trigger the event; defaults to "any"
2020 #
2021 # @errno:       #optional error identifier (errno) to be returned; defaults to
2022 #               EIO
2023 #
2024 # @sector:      #optional specifies the sector index which has to be affected
2025 #               in order to actually trigger the event; defaults to "any
2026 #               sector"
2027 #
2028 # @once:        #optional disables further events after this one has been
2029 #               triggered; defaults to false
2030 #
2031 # @immediately: #optional fail immediately; defaults to false
2032 #
2033 # Since: 2.0
2034 ##
2035 { 'struct': 'BlkdebugInjectErrorOptions',
2036   'data': { 'event': 'BlkdebugEvent',
2037             '*state': 'int',
2038             '*errno': 'int',
2039             '*sector': 'int',
2040             '*once': 'bool',
2041             '*immediately': 'bool' } }
2042
2043 ##
2044 # @BlkdebugSetStateOptions:
2045 #
2046 # Describes a single state-change event for blkdebug.
2047 #
2048 # @event:       trigger event
2049 #
2050 # @state:       #optional the current state identifier blkdebug needs to be in;
2051 #               defaults to "any"
2052 #
2053 # @new_state:   the state identifier blkdebug is supposed to assume if
2054 #               this event is triggered
2055 #
2056 # Since: 2.0
2057 ##
2058 { 'struct': 'BlkdebugSetStateOptions',
2059   'data': { 'event': 'BlkdebugEvent',
2060             '*state': 'int',
2061             'new_state': 'int' } }
2062
2063 ##
2064 # @BlockdevOptionsBlkdebug:
2065 #
2066 # Driver specific block device options for blkdebug.
2067 #
2068 # @image:           underlying raw block device (or image file)
2069 #
2070 # @config:          #optional filename of the configuration file
2071 #
2072 # @align:           #optional required alignment for requests in bytes,
2073 #                   must be power of 2, or 0 for default
2074 #
2075 # @inject-error:    #optional array of error injection descriptions
2076 #
2077 # @set-state:       #optional array of state-change descriptions
2078 #
2079 # Since: 2.0
2080 ##
2081 { 'struct': 'BlockdevOptionsBlkdebug',
2082   'data': { 'image': 'BlockdevRef',
2083             '*config': 'str',
2084             '*align': 'int',
2085             '*inject-error': ['BlkdebugInjectErrorOptions'],
2086             '*set-state': ['BlkdebugSetStateOptions'] } }
2087
2088 ##
2089 # @BlockdevOptionsBlkverify:
2090 #
2091 # Driver specific block device options for blkverify.
2092 #
2093 # @test:    block device to be tested
2094 #
2095 # @raw:     raw image used for verification
2096 #
2097 # Since: 2.0
2098 ##
2099 { 'struct': 'BlockdevOptionsBlkverify',
2100   'data': { 'test': 'BlockdevRef',
2101             'raw': 'BlockdevRef' } }
2102
2103 ##
2104 # @QuorumReadPattern:
2105 #
2106 # An enumeration of quorum read patterns.
2107 #
2108 # @quorum: read all the children and do a quorum vote on reads
2109 #
2110 # @fifo: read only from the first child that has not failed
2111 #
2112 # Since: 2.2
2113 ##
2114 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
2115
2116 ##
2117 # @BlockdevOptionsQuorum:
2118 #
2119 # Driver specific block device options for Quorum
2120 #
2121 # @blkverify:      #optional true if the driver must print content mismatch
2122 #                  set to false by default
2123 #
2124 # @children:       the children block devices to use
2125 #
2126 # @vote-threshold: the vote limit under which a read will fail
2127 #
2128 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
2129 #                     (Since 2.1)
2130 #
2131 # @read-pattern: #optional choose read pattern and set to quorum by default
2132 #                (Since 2.2)
2133 #
2134 # Since: 2.0
2135 ##
2136 { 'struct': 'BlockdevOptionsQuorum',
2137   'data': { '*blkverify': 'bool',
2138             'children': [ 'BlockdevRef' ],
2139             'vote-threshold': 'int',
2140             '*rewrite-corrupted': 'bool',
2141             '*read-pattern': 'QuorumReadPattern' } }
2142
2143 ##
2144 # @GlusterTransport:
2145 #
2146 # An enumeration of Gluster transport types
2147 #
2148 # @tcp:   TCP   - Transmission Control Protocol
2149 #
2150 # @unix:  UNIX  - Unix domain socket
2151 #
2152 # Since: 2.7
2153 ##
2154 { 'enum': 'GlusterTransport',
2155   'data': [ 'unix', 'tcp' ] }
2156
2157
2158 ##
2159 # @GlusterServer:
2160 #
2161 # Captures the address of a socket
2162 #
2163 # Details for connecting to a gluster server
2164 #
2165 # @type:       Transport type used for gluster connection
2166 #
2167 # This is similar to SocketAddress, only distinction:
2168 #
2169 # 1. GlusterServer is a flat union, SocketAddress is a simple union.
2170 #    A flat union is nicer than simple because it avoids nesting
2171 #    (i.e. more {}) on the wire.
2172 #
2173 # 2. GlusterServer lacks case 'fd', since gluster doesn't let you
2174 #    pass in a file descriptor.
2175 #
2176 # GlusterServer is actually not Gluster-specific, its a
2177 # compatibility evolved into an alternate for SocketAddress.
2178 #
2179 # Since: 2.7
2180 ##
2181 { 'union': 'GlusterServer',
2182   'base': { 'type': 'GlusterTransport' },
2183   'discriminator': 'type',
2184   'data': { 'unix': 'UnixSocketAddress',
2185             'tcp': 'InetSocketAddress' } }
2186
2187 ##
2188 # @BlockdevOptionsGluster:
2189 #
2190 # Driver specific block device options for Gluster
2191 #
2192 # @volume:      name of gluster volume where VM image resides
2193 #
2194 # @path:        absolute path to image file in gluster volume
2195 #
2196 # @server:      gluster servers description
2197 #
2198 # @debug:       #optional libgfapi log level (default '4' which is Error)
2199 #               (Since 2.8)
2200 #
2201 # @logfile:     #optional libgfapi log file (default /dev/stderr) (Since 2.8)
2202 #
2203 # Since: 2.7
2204 ##
2205 { 'struct': 'BlockdevOptionsGluster',
2206   'data': { 'volume': 'str',
2207             'path': 'str',
2208             'server': ['GlusterServer'],
2209             '*debug': 'int',
2210             '*logfile': 'str' } }
2211
2212 ##
2213 # @ReplicationMode:
2214 #
2215 # An enumeration of replication modes.
2216 #
2217 # @primary: Primary mode, the vm's state will be sent to secondary QEMU.
2218 #
2219 # @secondary: Secondary mode, receive the vm's state from primary QEMU.
2220 #
2221 # Since: 2.8
2222 ##
2223 { 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ] }
2224
2225 ##
2226 # @BlockdevOptionsReplication:
2227 #
2228 # Driver specific block device options for replication
2229 #
2230 # @mode: the replication mode
2231 #
2232 # @top-id: #optional In secondary mode, node name or device ID of the root
2233 #          node who owns the replication node chain. Must not be given in
2234 #          primary mode.
2235 #
2236 # Since: 2.8
2237 ##
2238 { 'struct': 'BlockdevOptionsReplication',
2239   'base': 'BlockdevOptionsGenericFormat',
2240   'data': { 'mode': 'ReplicationMode',
2241             '*top-id': 'str' } }
2242
2243 ##
2244 # @NFSTransport:
2245 #
2246 # An enumeration of NFS transport types
2247 #
2248 # @inet:        TCP transport
2249 #
2250 # Since: 2.8
2251 ##
2252 { 'enum': 'NFSTransport',
2253   'data': [ 'inet' ] }
2254
2255 ##
2256 # @NFSServer:
2257 #
2258 # Captures the address of the socket
2259 #
2260 # @type:        transport type used for NFS (only TCP supported)
2261 #
2262 # @host:        host address for NFS server
2263 #
2264 # Since: 2.8
2265 ##
2266 { 'struct': 'NFSServer',
2267   'data': { 'type': 'NFSTransport',
2268             'host': 'str' } }
2269
2270 ##
2271 # @BlockdevOptionsNfs:
2272 #
2273 # Driver specific block device option for NFS
2274 #
2275 # @server:                  host address
2276 #
2277 # @path:                    path of the image on the host
2278 #
2279 # @user:                    #optional UID value to use when talking to the
2280 #                           server (defaults to 65534 on Windows and getuid()
2281 #                           on unix)
2282 #
2283 # @group:                   #optional GID value to use when talking to the
2284 #                           server (defaults to 65534 on Windows and getgid()
2285 #                           in unix)
2286 #
2287 # @tcp-syn-count:           #optional number of SYNs during the session
2288 #                           establishment (defaults to libnfs default)
2289 #
2290 # @readahead-size:          #optional set the readahead size in bytes (defaults
2291 #                           to libnfs default)
2292 #
2293 # @page-cache-size:         #optional set the pagecache size in bytes (defaults
2294 #                           to libnfs default)
2295 #
2296 # @debug:                   #optional set the NFS debug level (max 2) (defaults
2297 #                           to libnfs default)
2298 #
2299 # Since: 2.8
2300 ##
2301 { 'struct': 'BlockdevOptionsNfs',
2302   'data': { 'server': 'NFSServer',
2303             'path': 'str',
2304             '*user': 'int',
2305             '*group': 'int',
2306             '*tcp-syn-count': 'int',
2307             '*readahead-size': 'int',
2308             '*page-cache-size': 'int',
2309             '*debug': 'int' } }
2310
2311 ##
2312 # @BlockdevOptionsCurl:
2313 #
2314 # Driver specific block device options for the curl backend.
2315 #
2316 # @filename:    path to the image file
2317 #
2318 # Since: 1.7
2319 ##
2320 { 'struct': 'BlockdevOptionsCurl',
2321   'data': { 'filename': 'str' } }
2322
2323 ##
2324 # @BlockdevOptionsNbd:
2325 #
2326 # Driver specific block device options for NBD.
2327 #
2328 # @server:      NBD server address
2329 #
2330 # @export:      #optional export name
2331 #
2332 # @tls-creds:   #optional TLS credentials ID
2333 #
2334 # Since: 2.8
2335 ##
2336 { 'struct': 'BlockdevOptionsNbd',
2337   'data': { 'server': 'SocketAddress',
2338             '*export': 'str',
2339             '*tls-creds': 'str' } }
2340
2341 ##
2342 # @BlockdevOptionsRaw:
2343 #
2344 # Driver specific block device options for the raw driver.
2345 #
2346 # @offset:      #optional position where the block device starts
2347 # @size:        #optional the assumed size of the device
2348 #
2349 # Since: 2.8
2350 ##
2351 { 'struct': 'BlockdevOptionsRaw',
2352   'base': 'BlockdevOptionsGenericFormat',
2353   'data': { '*offset': 'int', '*size': 'int' } }
2354
2355 ##
2356 # @BlockdevOptions:
2357 #
2358 # Options for creating a block device.  Many options are available for all
2359 # block devices, independent of the block driver:
2360 #
2361 # @driver:        block driver name
2362 # @node-name:     #optional the node name of the new node (Since 2.0).
2363 #                 This option is required on the top level of blockdev-add.
2364 # @discard:       #optional discard-related options (default: ignore)
2365 # @cache:         #optional cache-related options
2366 # @read-only:     #optional whether the block device should be read-only
2367 #                 (default: false)
2368 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
2369 #                 (default: off)
2370 #
2371 # Remaining options are determined by the block driver.
2372 #
2373 # Since: 1.7
2374 ##
2375 { 'union': 'BlockdevOptions',
2376   'base': { 'driver': 'BlockdevDriver',
2377             '*node-name': 'str',
2378             '*discard': 'BlockdevDiscardOptions',
2379             '*cache': 'BlockdevCacheOptions',
2380             '*read-only': 'bool',
2381             '*detect-zeroes': 'BlockdevDetectZeroesOptions' },
2382   'discriminator': 'driver',
2383   'data': {
2384       'archipelago':'BlockdevOptionsArchipelago',
2385       'blkdebug':   'BlockdevOptionsBlkdebug',
2386       'blkverify':  'BlockdevOptionsBlkverify',
2387       'bochs':      'BlockdevOptionsGenericFormat',
2388       'cloop':      'BlockdevOptionsGenericFormat',
2389       'dmg':        'BlockdevOptionsGenericFormat',
2390       'file':       'BlockdevOptionsFile',
2391       'ftp':        'BlockdevOptionsCurl',
2392       'ftps':       'BlockdevOptionsCurl',
2393       'gluster':    'BlockdevOptionsGluster',
2394       'host_cdrom': 'BlockdevOptionsFile',
2395       'host_device':'BlockdevOptionsFile',
2396       'http':       'BlockdevOptionsCurl',
2397       'https':      'BlockdevOptionsCurl',
2398 # TODO iscsi: Wait for structured options
2399       'luks':       'BlockdevOptionsLUKS',
2400       'nbd':        'BlockdevOptionsNbd',
2401       'nfs':        'BlockdevOptionsNfs',
2402       'null-aio':   'BlockdevOptionsNull',
2403       'null-co':    'BlockdevOptionsNull',
2404       'parallels':  'BlockdevOptionsGenericFormat',
2405       'qcow2':      'BlockdevOptionsQcow2',
2406       'qcow':       'BlockdevOptionsGenericCOWFormat',
2407       'qed':        'BlockdevOptionsGenericCOWFormat',
2408       'quorum':     'BlockdevOptionsQuorum',
2409       'raw':        'BlockdevOptionsRaw',
2410 # TODO rbd: Wait for structured options
2411       'replication':'BlockdevOptionsReplication',
2412 # TODO sheepdog: Wait for structured options
2413       'ssh':        'BlockdevOptionsSsh',
2414       'vdi':        'BlockdevOptionsGenericFormat',
2415       'vhdx':       'BlockdevOptionsGenericFormat',
2416       'vmdk':       'BlockdevOptionsGenericCOWFormat',
2417       'vpc':        'BlockdevOptionsGenericFormat',
2418       'vvfat':      'BlockdevOptionsVVFAT'
2419   } }
2420
2421 ##
2422 # @BlockdevRef:
2423 #
2424 # Reference to a block device.
2425 #
2426 # @definition:      defines a new block device inline
2427 # @reference:       references the ID of an existing block device. An
2428 #                   empty string means that no block device should be
2429 #                   referenced.
2430 #
2431 # Since: 1.7
2432 ##
2433 { 'alternate': 'BlockdevRef',
2434   'data': { 'definition': 'BlockdevOptions',
2435             'reference': 'str' } }
2436
2437 ##
2438 # @blockdev-add:
2439 #
2440 # Creates a new block device. If the @id option is given at the top level, a
2441 # BlockBackend will be created; otherwise, @node-name is mandatory at the top
2442 # level and no BlockBackend will be created.
2443 #
2444 # This command is still a work in progress.  It doesn't support all
2445 # block drivers among other things.  Stay away from it unless you want
2446 # to help with its development.
2447 #
2448 # For the arguments, see the documentation of BlockdevOptions.
2449 #
2450 # Since: 1.7
2451 ##
2452 { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true }
2453
2454 ##
2455 # @x-blockdev-del:
2456 #
2457 # Deletes a block device that has been added using blockdev-add.
2458 # The command will fail if the node is attached to a device or is
2459 # otherwise being used.
2460 #
2461 # This command is still a work in progress and is considered
2462 # experimental. Stay away from it unless you want to help with its
2463 # development.
2464 #
2465 # @node-name: Name of the graph node to delete.
2466 #
2467 # Since: 2.5
2468 ##
2469 { 'command': 'x-blockdev-del', 'data': { 'node-name': 'str' } }
2470
2471 ##
2472 # @blockdev-open-tray:
2473 #
2474 # Opens a block device's tray. If there is a block driver state tree inserted as
2475 # a medium, it will become inaccessible to the guest (but it will remain
2476 # associated to the block device, so closing the tray will make it accessible
2477 # again).
2478 #
2479 # If the tray was already open before, this will be a no-op.
2480 #
2481 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
2482 # which no such event will be generated, these include:
2483 # - if the guest has locked the tray, @force is false and the guest does not
2484 #   respond to the eject request
2485 # - if the BlockBackend denoted by @device does not have a guest device attached
2486 #   to it
2487 # - if the guest device does not have an actual tray
2488 #
2489 # @device: #optional Block device name (deprecated, use @id instead)
2490 #
2491 # @id:     #optional The name or QOM path of the guest device (since: 2.8)
2492 #
2493 # @force:  #optional if false (the default), an eject request will be sent to
2494 #          the guest if it has locked the tray (and the tray will not be opened
2495 #          immediately); if true, the tray will be opened regardless of whether
2496 #          it is locked
2497 #
2498 # Since: 2.5
2499 ##
2500 { 'command': 'blockdev-open-tray',
2501   'data': { '*device': 'str',
2502             '*id': 'str',
2503             '*force': 'bool' } }
2504
2505 ##
2506 # @blockdev-close-tray:
2507 #
2508 # Closes a block device's tray. If there is a block driver state tree associated
2509 # with the block device (which is currently ejected), that tree will be loaded
2510 # as the medium.
2511 #
2512 # If the tray was already closed before, this will be a no-op.
2513 #
2514 # @device:  #optional Block device name (deprecated, use @id instead)
2515 #
2516 # @id:      #optional The name or QOM path of the guest device (since: 2.8)
2517 #
2518 # Since: 2.5
2519 ##
2520 { 'command': 'blockdev-close-tray',
2521   'data': { '*device': 'str',
2522             '*id': 'str' } }
2523
2524 ##
2525 # @x-blockdev-remove-medium:
2526 #
2527 # Removes a medium (a block driver state tree) from a block device. That block
2528 # device's tray must currently be open (unless there is no attached guest
2529 # device).
2530 #
2531 # If the tray is open and there is no medium inserted, this will be a no-op.
2532 #
2533 # This command is still a work in progress and is considered experimental.
2534 # Stay away from it unless you want to help with its development.
2535 #
2536 # @device: #optional Block device name (deprecated, use @id instead)
2537 #
2538 # @id:     #optional The name or QOM path of the guest device (since: 2.8)
2539 #
2540 # Since: 2.5
2541 ##
2542 { 'command': 'x-blockdev-remove-medium',
2543   'data': { '*device': 'str',
2544             '*id': 'str' } }
2545
2546 ##
2547 # @x-blockdev-insert-medium:
2548 #
2549 # Inserts a medium (a block driver state tree) into a block device. That block
2550 # device's tray must currently be open (unless there is no attached guest
2551 # device) and there must be no medium inserted already.
2552 #
2553 # This command is still a work in progress and is considered experimental.
2554 # Stay away from it unless you want to help with its development.
2555 #
2556 # @device:    #optional Block device name (deprecated, use @id instead)
2557 #
2558 # @id:        #optional The name or QOM path of the guest device (since: 2.8)
2559 #
2560 # @node-name: name of a node in the block driver state graph
2561 #
2562 # Since: 2.5
2563 ##
2564 { 'command': 'x-blockdev-insert-medium',
2565   'data': { '*device': 'str',
2566             '*id': 'str',
2567             'node-name': 'str'} }
2568
2569
2570 ##
2571 # @BlockdevChangeReadOnlyMode:
2572 #
2573 # Specifies the new read-only mode of a block device subject to the
2574 # @blockdev-change-medium command.
2575 #
2576 # @retain:      Retains the current read-only mode
2577 #
2578 # @read-only:   Makes the device read-only
2579 #
2580 # @read-write:  Makes the device writable
2581 #
2582 # Since: 2.3
2583 ##
2584 { 'enum': 'BlockdevChangeReadOnlyMode',
2585   'data': ['retain', 'read-only', 'read-write'] }
2586
2587
2588 ##
2589 # @blockdev-change-medium:
2590 #
2591 # Changes the medium inserted into a block device by ejecting the current medium
2592 # and loading a new image file which is inserted as the new medium (this command
2593 # combines blockdev-open-tray, x-blockdev-remove-medium,
2594 # x-blockdev-insert-medium and blockdev-close-tray).
2595 #
2596 # @device:          #optional Block device name (deprecated, use @id instead)
2597 #
2598 # @id:              #optional The name or QOM path of the guest device
2599 #                   (since: 2.8)
2600 #
2601 # @filename:        filename of the new image to be loaded
2602 #
2603 # @format:          #optional, format to open the new image with (defaults to
2604 #                   the probed format)
2605 #
2606 # @read-only-mode:  #optional, change the read-only mode of the device; defaults
2607 #                   to 'retain'
2608 #
2609 # Since: 2.5
2610 ##
2611 { 'command': 'blockdev-change-medium',
2612   'data': { '*device': 'str',
2613             '*id': 'str',
2614             'filename': 'str',
2615             '*format': 'str',
2616             '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
2617
2618
2619 ##
2620 # @BlockErrorAction:
2621 #
2622 # An enumeration of action that has been taken when a DISK I/O occurs
2623 #
2624 # @ignore: error has been ignored
2625 #
2626 # @report: error has been reported to the device
2627 #
2628 # @stop: error caused VM to be stopped
2629 #
2630 # Since: 2.1
2631 ##
2632 { 'enum': 'BlockErrorAction',
2633   'data': [ 'ignore', 'report', 'stop' ] }
2634
2635
2636 ##
2637 # @BLOCK_IMAGE_CORRUPTED:
2638 #
2639 # Emitted when a corruption has been detected in a disk image
2640 #
2641 # @device: device name. This is always present for compatibility
2642 #          reasons, but it can be empty ("") if the image does not
2643 #          have a device name associated.
2644 #
2645 # @node-name: #optional node name (Since: 2.4)
2646 #
2647 # @msg: informative message for human consumption, such as the kind of
2648 #       corruption being detected. It should not be parsed by machine as it is
2649 #       not guaranteed to be stable
2650 #
2651 # @offset: #optional, if the corruption resulted from an image access, this is
2652 #          the host's access offset into the image
2653 #
2654 # @size: #optional, if the corruption resulted from an image access, this is
2655 #        the access size
2656 #
2657 # fatal: if set, the image is marked corrupt and therefore unusable after this
2658 #        event and must be repaired (Since 2.2; before, every
2659 #        BLOCK_IMAGE_CORRUPTED event was fatal)
2660 #
2661 # Since: 1.7
2662 ##
2663 { 'event': 'BLOCK_IMAGE_CORRUPTED',
2664   'data': { 'device'     : 'str',
2665             '*node-name' : 'str',
2666             'msg'        : 'str',
2667             '*offset'    : 'int',
2668             '*size'      : 'int',
2669             'fatal'      : 'bool' } }
2670
2671 ##
2672 # @BLOCK_IO_ERROR:
2673 #
2674 # Emitted when a disk I/O error occurs
2675 #
2676 # @device: device name. This is always present for compatibility
2677 #          reasons, but it can be empty ("") if the image does not
2678 #          have a device name associated.
2679 #
2680 # @node-name: node name. Note that errors may be reported for the root node
2681 #             that is directly attached to a guest device rather than for the
2682 #             node where the error occurred. (Since: 2.8)
2683 #
2684 # @operation: I/O operation
2685 #
2686 # @action: action that has been taken
2687 #
2688 # @nospace: #optional true if I/O error was caused due to a no-space
2689 #           condition. This key is only present if query-block's
2690 #           io-status is present, please see query-block documentation
2691 #           for more information (since: 2.2)
2692 #
2693 # @reason: human readable string describing the error cause.
2694 #          (This field is a debugging aid for humans, it should not
2695 #           be parsed by applications) (since: 2.2)
2696 #
2697 # Note: If action is "stop", a STOP event will eventually follow the
2698 # BLOCK_IO_ERROR event
2699 #
2700 # Since: 0.13.0
2701 ##
2702 { 'event': 'BLOCK_IO_ERROR',
2703   'data': { 'device': 'str', 'node-name': 'str', 'operation': 'IoOperationType',
2704             'action': 'BlockErrorAction', '*nospace': 'bool',
2705             'reason': 'str' } }
2706
2707 ##
2708 # @BLOCK_JOB_COMPLETED:
2709 #
2710 # Emitted when a block job has completed
2711 #
2712 # @type: job type
2713 #
2714 # @device: The job identifier. Originally the device name but other
2715 #          values are allowed since QEMU 2.7
2716 #
2717 # @len: maximum progress value
2718 #
2719 # @offset: current progress value. On success this is equal to len.
2720 #          On failure this is less than len
2721 #
2722 # @speed: rate limit, bytes per second
2723 #
2724 # @error: #optional, error message. Only present on failure. This field
2725 #         contains a human-readable error message. There are no semantics
2726 #         other than that streaming has failed and clients should not try to
2727 #         interpret the error string
2728 #
2729 # Since: 1.1
2730 ##
2731 { 'event': 'BLOCK_JOB_COMPLETED',
2732   'data': { 'type'  : 'BlockJobType',
2733             'device': 'str',
2734             'len'   : 'int',
2735             'offset': 'int',
2736             'speed' : 'int',
2737             '*error': 'str' } }
2738
2739 ##
2740 # @BLOCK_JOB_CANCELLED:
2741 #
2742 # Emitted when a block job has been cancelled
2743 #
2744 # @type: job type
2745 #
2746 # @device: The job identifier. Originally the device name but other
2747 #          values are allowed since QEMU 2.7
2748 #
2749 # @len: maximum progress value
2750 #
2751 # @offset: current progress value. On success this is equal to len.
2752 #          On failure this is less than len
2753 #
2754 # @speed: rate limit, bytes per second
2755 #
2756 # Since: 1.1
2757 ##
2758 { 'event': 'BLOCK_JOB_CANCELLED',
2759   'data': { 'type'  : 'BlockJobType',
2760             'device': 'str',
2761             'len'   : 'int',
2762             'offset': 'int',
2763             'speed' : 'int' } }
2764
2765 ##
2766 # @BLOCK_JOB_ERROR:
2767 #
2768 # Emitted when a block job encounters an error
2769 #
2770 # @device: The job identifier. Originally the device name but other
2771 #          values are allowed since QEMU 2.7
2772 #
2773 # @operation: I/O operation
2774 #
2775 # @action: action that has been taken
2776 #
2777 # Since: 1.3
2778 ##
2779 { 'event': 'BLOCK_JOB_ERROR',
2780   'data': { 'device'   : 'str',
2781             'operation': 'IoOperationType',
2782             'action'   : 'BlockErrorAction' } }
2783
2784 ##
2785 # @BLOCK_JOB_READY:
2786 #
2787 # Emitted when a block job is ready to complete
2788 #
2789 # @type: job type
2790 #
2791 # @device: The job identifier. Originally the device name but other
2792 #          values are allowed since QEMU 2.7
2793 #
2794 # @len: maximum progress value
2795 #
2796 # @offset: current progress value. On success this is equal to len.
2797 #          On failure this is less than len
2798 #
2799 # @speed: rate limit, bytes per second
2800 #
2801 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
2802 # event
2803 #
2804 # Since: 1.3
2805 ##
2806 { 'event': 'BLOCK_JOB_READY',
2807   'data': { 'type'  : 'BlockJobType',
2808             'device': 'str',
2809             'len'   : 'int',
2810             'offset': 'int',
2811             'speed' : 'int' } }
2812
2813 ##
2814 # @PreallocMode:
2815 #
2816 # Preallocation mode of QEMU image file
2817 #
2818 # @off: no preallocation
2819 # @metadata: preallocate only for metadata
2820 # @falloc: like @full preallocation but allocate disk space by
2821 #          posix_fallocate() rather than writing zeros.
2822 # @full: preallocate all data by writing zeros to device to ensure disk
2823 #        space is really available. @full preallocation also sets up
2824 #        metadata correctly.
2825 #
2826 # Since: 2.2
2827 ##
2828 { 'enum': 'PreallocMode',
2829   'data': [ 'off', 'metadata', 'falloc', 'full' ] }
2830
2831 ##
2832 # @BLOCK_WRITE_THRESHOLD:
2833 #
2834 # Emitted when writes on block device reaches or exceeds the
2835 # configured write threshold. For thin-provisioned devices, this
2836 # means the device should be extended to avoid pausing for
2837 # disk exhaustion.
2838 # The event is one shot. Once triggered, it needs to be
2839 # re-registered with another block-set-threshold command.
2840 #
2841 # @node-name: graph node name on which the threshold was exceeded.
2842 #
2843 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
2844 #
2845 # @write-threshold: last configured threshold, in bytes.
2846 #
2847 # Since: 2.3
2848 ##
2849 { 'event': 'BLOCK_WRITE_THRESHOLD',
2850   'data': { 'node-name': 'str',
2851             'amount-exceeded': 'uint64',
2852             'write-threshold': 'uint64' } }
2853
2854 ##
2855 # @block-set-write-threshold:
2856 #
2857 # Change the write threshold for a block drive. An event will be delivered
2858 # if a write to this block drive crosses the configured threshold.
2859 # This is useful to transparently resize thin-provisioned drives without
2860 # the guest OS noticing.
2861 #
2862 # @node-name: graph node name on which the threshold must be set.
2863 #
2864 # @write-threshold: configured threshold for the block device, bytes.
2865 #                   Use 0 to disable the threshold.
2866 #
2867 # Since: 2.3
2868 ##
2869 { 'command': 'block-set-write-threshold',
2870   'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }
2871
2872 ##
2873 # @x-blockdev-change:
2874 #
2875 # Dynamically reconfigure the block driver state graph. It can be used
2876 # to add, remove, insert or replace a graph node. Currently only the
2877 # Quorum driver implements this feature to add or remove its child. This
2878 # is useful to fix a broken quorum child.
2879 #
2880 # If @node is specified, it will be inserted under @parent. @child
2881 # may not be specified in this case. If both @parent and @child are
2882 # specified but @node is not, @child will be detached from @parent.
2883 #
2884 # @parent: the id or name of the parent node.
2885 #
2886 # @child: #optional the name of a child under the given parent node.
2887 #
2888 # @node: #optional the name of the node that will be added.
2889 #
2890 # Note: this command is experimental, and its API is not stable. It
2891 # does not support all kinds of operations, all kinds of children, nor
2892 # all block drivers.
2893 #
2894 # Warning: The data in a new quorum child MUST be consistent with that of
2895 # the rest of the array.
2896 #
2897 # Since: 2.7
2898 ##
2899 { 'command': 'x-blockdev-change',
2900   'data' : { 'parent': 'str',
2901              '*child': 'str',
2902              '*node': 'str' } }