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