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