exec: Make stq_*_phys input an AddressSpace
[qemu/ar7.git] / qapi-schema.json
blob05ced9d5729ef2f70b036c09d603be60efc190a7
1 # -*- Mode: Python -*-
3 # QAPI Schema
5 ##
6 # @ErrorClass
8 # QEMU error classes
10 # @GenericError: this is used for errors that don't require a specific error
11 #                class. This should be the default case for most errors
13 # @CommandNotFound: the requested command has not been found
15 # @DeviceEncrypted: the requested operation can't be fulfilled because the
16 #                   selected device is encrypted
18 # @DeviceNotActive: a device has failed to be become active
20 # @DeviceNotFound: the requested device has not been found
22 # @KVMMissingCap: the requested operation can't be fulfilled because a
23 #                 required KVM capability is missing
25 # Since: 1.2
27 { 'enum': 'ErrorClass',
28   'data': [ 'GenericError', 'CommandNotFound', 'DeviceEncrypted',
29             'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] }
32 # @add_client
34 # Allow client connections for VNC, Spice and socket based
35 # character devices to be passed in to QEMU via SCM_RIGHTS.
37 # @protocol: protocol name. Valid names are "vnc", "spice" or the
38 #            name of a character device (eg. from -chardev id=XXXX)
40 # @fdname: file descriptor name previously passed via 'getfd' command
42 # @skipauth: #optional whether to skip authentication. Only applies
43 #            to "vnc" and "spice" protocols
45 # @tls: #optional whether to perform TLS. Only applies to the "spice"
46 #       protocol
48 # Returns: nothing on success.
50 # Since: 0.14.0
52 { 'command': 'add_client',
53   'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
54             '*tls': 'bool' } }
57 # @NameInfo:
59 # Guest name information.
61 # @name: #optional The name of the guest
63 # Since 0.14.0
65 { 'type': 'NameInfo', 'data': {'*name': 'str'} }
68 # @query-name:
70 # Return the name information of a guest.
72 # Returns: @NameInfo of the guest
74 # Since 0.14.0
76 { 'command': 'query-name', 'returns': 'NameInfo' }
79 # @VersionInfo:
81 # A description of QEMU's version.
83 # @qemu.major:  The major version of QEMU
85 # @qemu.minor:  The minor version of QEMU
87 # @qemu.micro:  The micro version of QEMU.  By current convention, a micro
88 #               version of 50 signifies a development branch.  A micro version
89 #               greater than or equal to 90 signifies a release candidate for
90 #               the next minor version.  A micro version of less than 50
91 #               signifies a stable release.
93 # @package:     QEMU will always set this field to an empty string.  Downstream
94 #               versions of QEMU should set this to a non-empty string.  The
95 #               exact format depends on the downstream however it highly
96 #               recommended that a unique name is used.
98 # Since: 0.14.0
100 { 'type': 'VersionInfo',
101   'data': {'qemu': {'major': 'int', 'minor': 'int', 'micro': 'int'},
102            'package': 'str'} }
105 # @query-version:
107 # Returns the current version of QEMU.
109 # Returns:  A @VersionInfo object describing the current version of QEMU.
111 # Since: 0.14.0
113 { 'command': 'query-version', 'returns': 'VersionInfo' }
116 # @KvmInfo:
118 # Information about support for KVM acceleration
120 # @enabled: true if KVM acceleration is active
122 # @present: true if KVM acceleration is built into this executable
124 # Since: 0.14.0
126 { 'type': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
129 # @query-kvm:
131 # Returns information about KVM acceleration
133 # Returns: @KvmInfo
135 # Since: 0.14.0
137 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
140 # @RunState
142 # An enumeration of VM run states.
144 # @debug: QEMU is running on a debugger
146 # @finish-migrate: guest is paused to finish the migration process
148 # @inmigrate: guest is paused waiting for an incoming migration.  Note
149 # that this state does not tell whether the machine will start at the
150 # end of the migration.  This depends on the command-line -S option and
151 # any invocation of 'stop' or 'cont' that has happened since QEMU was
152 # started.
154 # @internal-error: An internal error that prevents further guest execution
155 # has occurred
157 # @io-error: the last IOP has failed and the device is configured to pause
158 # on I/O errors
160 # @paused: guest has been paused via the 'stop' command
162 # @postmigrate: guest is paused following a successful 'migrate'
164 # @prelaunch: QEMU was started with -S and guest has not started
166 # @restore-vm: guest is paused to restore VM state
168 # @running: guest is actively running
170 # @save-vm: guest is paused to save the VM state
172 # @shutdown: guest is shut down (and -no-shutdown is in use)
174 # @suspended: guest is suspended (ACPI S3)
176 # @watchdog: the watchdog action is configured to pause and has been triggered
178 # @guest-panicked: guest has been panicked as a result of guest OS panic
180 { 'enum': 'RunState',
181   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
182             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
183             'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
184             'guest-panicked' ] }
187 # @SnapshotInfo
189 # @id: unique snapshot id
191 # @name: user chosen name
193 # @vm-state-size: size of the VM state
195 # @date-sec: UTC date of the snapshot in seconds
197 # @date-nsec: fractional part in nano seconds to be used with date-sec
199 # @vm-clock-sec: VM clock relative to boot in seconds
201 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
203 # Since: 1.3
207 { 'type': 'SnapshotInfo',
208   'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
209             'date-sec': 'int', 'date-nsec': 'int',
210             'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
213 # @ImageInfoSpecificQCow2:
215 # @compat: compatibility level
217 # @lazy-refcounts: #optional on or off; only valid for compat >= 1.1
219 # Since: 1.7
221 { 'type': 'ImageInfoSpecificQCow2',
222   'data': {
223       'compat': 'str',
224       '*lazy-refcounts': 'bool'
225   } }
228 # @ImageInfoSpecificVmdk:
230 # @create-type: The create type of VMDK image
232 # @cid: Content id of image
234 # @parent-cid: Parent VMDK image's cid
236 # @extents: List of extent files
238 # Since: 1.7
240 { 'type': 'ImageInfoSpecificVmdk',
241   'data': {
242       'create-type': 'str',
243       'cid': 'int',
244       'parent-cid': 'int',
245       'extents': ['ImageInfo']
246   } }
249 # @ImageInfoSpecific:
251 # A discriminated record of image format specific information structures.
253 # Since: 1.7
256 { 'union': 'ImageInfoSpecific',
257   'data': {
258       'qcow2': 'ImageInfoSpecificQCow2',
259       'vmdk': 'ImageInfoSpecificVmdk'
260   } }
263 # @ImageInfo:
265 # Information about a QEMU image file
267 # @filename: name of the image file
269 # @format: format of the image file
271 # @virtual-size: maximum capacity in bytes of the image
273 # @actual-size: #optional actual size on disk in bytes of the image
275 # @dirty-flag: #optional true if image is not cleanly closed
277 # @cluster-size: #optional size of a cluster in bytes
279 # @encrypted: #optional true if the image is encrypted
281 # @compressed: #optional true if the image is compressed (Since 1.7)
283 # @backing-filename: #optional name of the backing file
285 # @full-backing-filename: #optional full path of the backing file
287 # @backing-filename-format: #optional the format of the backing file
289 # @snapshots: #optional list of VM snapshots
291 # @backing-image: #optional info of the backing image (since 1.6)
293 # @format-specific: #optional structure supplying additional format-specific
294 # information (since 1.7)
296 # Since: 1.3
300 { 'type': 'ImageInfo',
301   'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
302            '*actual-size': 'int', 'virtual-size': 'int',
303            '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
304            '*backing-filename': 'str', '*full-backing-filename': 'str',
305            '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
306            '*backing-image': 'ImageInfo',
307            '*format-specific': 'ImageInfoSpecific' } }
310 # @ImageCheck:
312 # Information about a QEMU image file check
314 # @filename: name of the image file checked
316 # @format: format of the image file checked
318 # @check-errors: number of unexpected errors occurred during check
320 # @image-end-offset: #optional offset (in bytes) where the image ends, this
321 #                    field is present if the driver for the image format
322 #                    supports it
324 # @corruptions: #optional number of corruptions found during the check if any
326 # @leaks: #optional number of leaks found during the check if any
328 # @corruptions-fixed: #optional number of corruptions fixed during the check
329 #                     if any
331 # @leaks-fixed: #optional number of leaks fixed during the check if any
333 # @total-clusters: #optional total number of clusters, this field is present
334 #                  if the driver for the image format supports it
336 # @allocated-clusters: #optional total number of allocated clusters, this
337 #                      field is present if the driver for the image format
338 #                      supports it
340 # @fragmented-clusters: #optional total number of fragmented clusters, this
341 #                       field is present if the driver for the image format
342 #                       supports it
344 # @compressed-clusters: #optional total number of compressed clusters, this
345 #                       field is present if the driver for the image format
346 #                       supports it
348 # Since: 1.4
352 { 'type': 'ImageCheck',
353   'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
354            '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
355            '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
356            '*total-clusters': 'int', '*allocated-clusters': 'int',
357            '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
360 # @StatusInfo:
362 # Information about VCPU run state
364 # @running: true if all VCPUs are runnable, false if not runnable
366 # @singlestep: true if VCPUs are in single-step mode
368 # @status: the virtual machine @RunState
370 # Since:  0.14.0
372 # Notes: @singlestep is enabled through the GDB stub
374 { 'type': 'StatusInfo',
375   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
378 # @query-status:
380 # Query the run status of all VCPUs
382 # Returns: @StatusInfo reflecting all VCPUs
384 # Since:  0.14.0
386 { 'command': 'query-status', 'returns': 'StatusInfo' }
389 # @UuidInfo:
391 # Guest UUID information.
393 # @UUID: the UUID of the guest
395 # Since: 0.14.0
397 # Notes: If no UUID was specified for the guest, a null UUID is returned.
399 { 'type': 'UuidInfo', 'data': {'UUID': 'str'} }
402 # @query-uuid:
404 # Query the guest UUID information.
406 # Returns: The @UuidInfo for the guest
408 # Since 0.14.0
410 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
413 # @ChardevInfo:
415 # Information about a character device.
417 # @label: the label of the character device
419 # @filename: the filename of the character device
421 # Notes: @filename is encoded using the QEMU command line character device
422 #        encoding.  See the QEMU man page for details.
424 # Since: 0.14.0
426 { 'type': 'ChardevInfo', 'data': {'label': 'str', 'filename': 'str'} }
429 # @query-chardev:
431 # Returns information about current character devices.
433 # Returns: a list of @ChardevInfo
435 # Since: 0.14.0
437 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
440 # @DataFormat:
442 # An enumeration of data format.
444 # @utf8: Data is a UTF-8 string (RFC 3629)
446 # @base64: Data is Base64 encoded binary (RFC 3548)
448 # Since: 1.4
450 { 'enum': 'DataFormat',
451   'data': [ 'utf8', 'base64' ] }
454 # @ringbuf-write:
456 # Write to a ring buffer character device.
458 # @device: the ring buffer character device name
460 # @data: data to write
462 # @format: #optional data encoding (default 'utf8').
463 #          - base64: data must be base64 encoded text.  Its binary
464 #            decoding gets written.
465 #            Bug: invalid base64 is currently not rejected.
466 #            Whitespace *is* invalid.
467 #          - utf8: data's UTF-8 encoding is written
468 #          - data itself is always Unicode regardless of format, like
469 #            any other string.
471 # Returns: Nothing on success
473 # Since: 1.4
475 { 'command': 'ringbuf-write',
476   'data': {'device': 'str', 'data': 'str',
477            '*format': 'DataFormat'} }
480 # @ringbuf-read:
482 # Read from a ring buffer character device.
484 # @device: the ring buffer character device name
486 # @size: how many bytes to read at most
488 # @format: #optional data encoding (default 'utf8').
489 #          - base64: the data read is returned in base64 encoding.
490 #          - utf8: the data read is interpreted as UTF-8.
491 #            Bug: can screw up when the buffer contains invalid UTF-8
492 #            sequences, NUL characters, after the ring buffer lost
493 #            data, and when reading stops because the size limit is
494 #            reached.
495 #          - The return value is always Unicode regardless of format,
496 #            like any other string.
498 # Returns: data read from the device
500 # Since: 1.4
502 { 'command': 'ringbuf-read',
503   'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
504   'returns': 'str' }
507 # @CommandInfo:
509 # Information about a QMP command
511 # @name: The command name
513 # Since: 0.14.0
515 { 'type': 'CommandInfo', 'data': {'name': 'str'} }
518 # @query-commands:
520 # Return a list of supported QMP commands by this server
522 # Returns: A list of @CommandInfo for all supported commands
524 # Since: 0.14.0
526 { 'command': 'query-commands', 'returns': ['CommandInfo'] }
529 # @EventInfo:
531 # Information about a QMP event
533 # @name: The event name
535 # Since: 1.2.0
537 { 'type': 'EventInfo', 'data': {'name': 'str'} }
540 # @query-events:
542 # Return a list of supported QMP events by this server
544 # Returns: A list of @EventInfo for all supported events
546 # Since: 1.2.0
548 { 'command': 'query-events', 'returns': ['EventInfo'] }
551 # @MigrationStats
553 # Detailed migration status.
555 # @transferred: amount of bytes already transferred to the target VM
557 # @remaining: amount of bytes remaining to be transferred to the target VM
559 # @total: total amount of bytes involved in the migration process
561 # @duplicate: number of duplicate (zero) pages (since 1.2)
563 # @skipped: number of skipped zero pages (since 1.5)
565 # @normal : number of normal pages (since 1.2)
567 # @normal-bytes: number of normal bytes sent (since 1.2)
569 # @dirty-pages-rate: number of pages dirtied by second by the
570 #        guest (since 1.3)
572 # @mbps: throughput in megabits/sec. (since 1.6)
574 # Since: 0.14.0
576 { 'type': 'MigrationStats',
577   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
578            'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
579            'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
580            'mbps' : 'number' } }
583 # @XBZRLECacheStats
585 # Detailed XBZRLE migration cache statistics
587 # @cache-size: XBZRLE cache size
589 # @bytes: amount of bytes already transferred to the target VM
591 # @pages: amount of pages transferred to the target VM
593 # @cache-miss: number of cache miss
595 # @overflow: number of overflows
597 # Since: 1.2
599 { 'type': 'XBZRLECacheStats',
600   'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
601            'cache-miss': 'int', 'overflow': 'int' } }
604 # @MigrationInfo
606 # Information about current migration process.
608 # @status: #optional string describing the current migration status.
609 #          As of 0.14.0 this can be 'active', 'completed', 'failed' or
610 #          'cancelled'. If this field is not returned, no migration process
611 #          has been initiated
613 # @ram: #optional @MigrationStats containing detailed migration
614 #       status, only returned if status is 'active' or
615 #       'completed'. 'comppleted' (since 1.2)
617 # @disk: #optional @MigrationStats containing detailed disk migration
618 #        status, only returned if status is 'active' and it is a block
619 #        migration
621 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
622 #                migration statistics, only returned if XBZRLE feature is on and
623 #                status is 'active' or 'completed' (since 1.2)
625 # @total-time: #optional total amount of milliseconds since migration started.
626 #        If migration has ended, it returns the total migration
627 #        time. (since 1.2)
629 # @downtime: #optional only present when migration finishes correctly
630 #        total downtime in milliseconds for the guest.
631 #        (since 1.3)
633 # @expected-downtime: #optional only present while migration is active
634 #        expected downtime in milliseconds for the guest in last walk
635 #        of the dirty bitmap. (since 1.3)
637 # @setup-time: #optional amount of setup time in milliseconds _before_ the
638 #        iterations begin but _after_ the QMP command is issued. This is designed
639 #        to provide an accounting of any activities (such as RDMA pinning) which
640 #        may be expensive, but do not actually occur during the iterative
641 #        migration rounds themselves. (since 1.6)
643 # Since: 0.14.0
645 { 'type': 'MigrationInfo',
646   'data': {'*status': 'str', '*ram': 'MigrationStats',
647            '*disk': 'MigrationStats',
648            '*xbzrle-cache': 'XBZRLECacheStats',
649            '*total-time': 'int',
650            '*expected-downtime': 'int',
651            '*downtime': 'int',
652            '*setup-time': 'int'} }
655 # @query-migrate
657 # Returns information about current migration process.
659 # Returns: @MigrationInfo
661 # Since: 0.14.0
663 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
666 # @MigrationCapability
668 # Migration capabilities enumeration
670 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
671 #          This feature allows us to minimize migration traffic for certain work
672 #          loads, by sending compressed difference of the pages
674 # @x-rdma-pin-all: Controls whether or not the entire VM memory footprint is
675 #          mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
676 #          Disabled by default. Experimental: may (or may not) be renamed after
677 #          further testing is complete. (since 1.6)
679 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
680 #          essentially saves 1MB of zeroes per block on the wire. Enabling requires
681 #          source and target VM to support this feature. To enable it is sufficient
682 #          to enable the capability on the source VM. The feature is disabled by
683 #          default. (since 1.6)
685 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
686 #          to speed up convergence of RAM migration. (since 1.6)
688 # Since: 1.2
690 { 'enum': 'MigrationCapability',
691   'data': ['xbzrle', 'x-rdma-pin-all', 'auto-converge', 'zero-blocks'] }
694 # @MigrationCapabilityStatus
696 # Migration capability information
698 # @capability: capability enum
700 # @state: capability state bool
702 # Since: 1.2
704 { 'type': 'MigrationCapabilityStatus',
705   'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
708 # @migrate-set-capabilities
710 # Enable/Disable the following migration capabilities (like xbzrle)
712 # @capabilities: json array of capability modifications to make
714 # Since: 1.2
716 { 'command': 'migrate-set-capabilities',
717   'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
720 # @query-migrate-capabilities
722 # Returns information about the current migration capabilities status
724 # Returns: @MigrationCapabilitiesStatus
726 # Since: 1.2
728 { 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}
731 # @MouseInfo:
733 # Information about a mouse device.
735 # @name: the name of the mouse device
737 # @index: the index of the mouse device
739 # @current: true if this device is currently receiving mouse events
741 # @absolute: true if this device supports absolute coordinates as input
743 # Since: 0.14.0
745 { 'type': 'MouseInfo',
746   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
747            'absolute': 'bool'} }
750 # @query-mice:
752 # Returns information about each active mouse device
754 # Returns: a list of @MouseInfo for each device
756 # Since: 0.14.0
758 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
761 # @CpuInfo:
763 # Information about a virtual CPU
765 # @CPU: the index of the virtual CPU
767 # @current: this only exists for backwards compatible and should be ignored
769 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
770 #          to a processor specific low power mode.
772 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
773 #                pointer.
774 #                If the target is Sparc, this is the PC component of the
775 #                instruction pointer.
777 # @nip: #optional If the target is PPC, the instruction pointer
779 # @npc: #optional If the target is Sparc, the NPC component of the instruction
780 #                 pointer
782 # @PC: #optional If the target is MIPS, the instruction pointer
784 # @thread_id: ID of the underlying host thread
786 # Since: 0.14.0
788 # Notes: @halted is a transient state that changes frequently.  By the time the
789 #        data is sent to the client, the guest may no longer be halted.
791 { 'type': 'CpuInfo',
792   'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', '*pc': 'int',
793            '*nip': 'int', '*npc': 'int', '*PC': 'int', 'thread_id': 'int'} }
796 # @query-cpus:
798 # Returns a list of information about each virtual CPU.
800 # Returns: a list of @CpuInfo for each virtual CPU
802 # Since: 0.14.0
804 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
807 # @BlockDeviceInfo:
809 # Information about the backing device for a block device.
811 # @file: the filename of the backing device
813 # @node-name: #optional the name of the block driver node (Since 2.0)
815 # @ro: true if the backing device was open read-only
817 # @drv: the name of the block format used to open the backing device. As of
818 #       0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
819 #       'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
820 #       'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
821 #       'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
823 # @backing_file: #optional the name of the backing file (for copy-on-write)
825 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
827 # @encrypted: true if the backing device is encrypted
829 # @encryption_key_missing: true if the backing device is encrypted but an
830 #                          valid encryption key is missing
832 # @bps: total throughput limit in bytes per second is specified
834 # @bps_rd: read throughput limit in bytes per second is specified
836 # @bps_wr: write throughput limit in bytes per second is specified
838 # @iops: total I/O operations per second is specified
840 # @iops_rd: read I/O operations per second is specified
842 # @iops_wr: write I/O operations per second is specified
844 # @image: the info of image used (since: 1.6)
846 # @bps_max: #optional total max in bytes (Since 1.7)
848 # @bps_rd_max: #optional read max in bytes (Since 1.7)
850 # @bps_wr_max: #optional write max in bytes (Since 1.7)
852 # @iops_max: #optional total I/O operations max (Since 1.7)
854 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
856 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
858 # @iops_size: #optional an I/O size in bytes (Since 1.7)
860 # Since: 0.14.0
863 { 'type': 'BlockDeviceInfo',
864   'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
865             '*backing_file': 'str', 'backing_file_depth': 'int',
866             'encrypted': 'bool', 'encryption_key_missing': 'bool',
867             'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
868             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
869             'image': 'ImageInfo',
870             '*bps_max': 'int', '*bps_rd_max': 'int',
871             '*bps_wr_max': 'int', '*iops_max': 'int',
872             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
873             '*iops_size': 'int' } }
876 # @BlockDeviceIoStatus:
878 # An enumeration of block device I/O status.
880 # @ok: The last I/O operation has succeeded
882 # @failed: The last I/O operation has failed
884 # @nospace: The last I/O operation has failed due to a no-space condition
886 # Since: 1.0
888 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
891 # @BlockDeviceMapEntry:
893 # Entry in the metadata map of the device (returned by "qemu-img map")
895 # @start: Offset in the image of the first byte described by this entry
896 #         (in bytes)
898 # @length: Length of the range described by this entry (in bytes)
900 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
901 #         before reaching one for which the range is allocated.  The value is
902 #         in the range 0 to the depth of the image chain - 1.
904 # @zero: the sectors in this range read as zeros
906 # @data: reading the image will actually read data from a file (in particular,
907 #        if @offset is present this means that the sectors are not simply
908 #        preallocated, but contain actual data in raw format)
910 # @offset: if present, the image file stores the data for this range in
911 #          raw format at the given offset.
913 # Since 1.7
915 { 'type': 'BlockDeviceMapEntry',
916   'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
917             'data': 'bool', '*offset': 'int' } }
920 # @BlockDirtyInfo:
922 # Block dirty bitmap information.
924 # @count: number of dirty bytes according to the dirty bitmap
926 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
928 # Since: 1.3
930 { 'type': 'BlockDirtyInfo',
931   'data': {'count': 'int', 'granularity': 'int'} }
934 # @BlockInfo:
936 # Block device information.  This structure describes a virtual device and
937 # the backing device associated with it.
939 # @device: The device name associated with the virtual device.
941 # @type: This field is returned only for compatibility reasons, it should
942 #        not be used (always returns 'unknown')
944 # @removable: True if the device supports removable media.
946 # @locked: True if the guest has locked this device from having its media
947 #          removed
949 # @tray_open: #optional True if the device has a tray and it is open
950 #             (only present if removable is true)
952 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
953 #                 driver has one or more dirty bitmaps) (Since 2.0)
955 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
956 #             supports it and the VM is configured to stop on errors
958 # @inserted: #optional @BlockDeviceInfo describing the device if media is
959 #            present
961 # Since:  0.14.0
963 { 'type': 'BlockInfo',
964   'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
965            'locked': 'bool', '*inserted': 'BlockDeviceInfo',
966            '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
967            '*dirty-bitmaps': ['BlockDirtyInfo'] } }
970 # @query-block:
972 # Get a list of BlockInfo for all virtual block devices.
974 # Returns: a list of @BlockInfo describing each virtual block device
976 # Since: 0.14.0
978 { 'command': 'query-block', 'returns': ['BlockInfo'] }
981 # @BlockDeviceStats:
983 # Statistics of a virtual block device or a block backing device.
985 # @rd_bytes:      The number of bytes read by the device.
987 # @wr_bytes:      The number of bytes written by the device.
989 # @rd_operations: The number of read operations performed by the device.
991 # @wr_operations: The number of write operations performed by the device.
993 # @flush_operations: The number of cache flush operations performed by the
994 #                    device (since 0.15.0)
996 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
997 #                       (since 0.15.0).
999 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
1001 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
1003 # @wr_highest_offset: The offset after the greatest byte written to the
1004 #                     device.  The intended use of this information is for
1005 #                     growable sparse files (like qcow2) that are used on top
1006 #                     of a physical device.
1008 # Since: 0.14.0
1010 { 'type': 'BlockDeviceStats',
1011   'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
1012            'wr_operations': 'int', 'flush_operations': 'int',
1013            'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
1014            'rd_total_time_ns': 'int', 'wr_highest_offset': 'int' } }
1017 # @BlockStats:
1019 # Statistics of a virtual block device or a block backing device.
1021 # @device: #optional If the stats are for a virtual block device, the name
1022 #          corresponding to the virtual block device.
1024 # @stats:  A @BlockDeviceStats for the device.
1026 # @parent: #optional This describes the file block device if it has one.
1028 # @backing: #optional This describes the backing block device if it has one.
1029 #           (Since 2.0)
1031 # Since: 0.14.0
1033 { 'type': 'BlockStats',
1034   'data': {'*device': 'str', 'stats': 'BlockDeviceStats',
1035            '*parent': 'BlockStats',
1036            '*backing': 'BlockStats'} }
1039 # @query-blockstats:
1041 # Query the @BlockStats for all virtual block devices.
1043 # Returns: A list of @BlockStats for each virtual block devices.
1045 # Since: 0.14.0
1047 { 'command': 'query-blockstats', 'returns': ['BlockStats'] }
1050 # @VncClientInfo:
1052 # Information about a connected VNC client.
1054 # @host: The host name of the client.  QEMU tries to resolve this to a DNS name
1055 #        when possible.
1057 # @family: 'ipv6' if the client is connected via IPv6 and TCP
1058 #          'ipv4' if the client is connected via IPv4 and TCP
1059 #          'unix' if the client is connected via a unix domain socket
1060 #          'unknown' otherwise
1062 # @service: The service name of the client's port.  This may depends on the
1063 #           host system's service database so symbolic names should not be
1064 #           relied on.
1066 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
1067 #              Name of the client.
1069 # @sasl_username: #optional If SASL authentication is in use, the SASL username
1070 #                 used for authentication.
1072 # Since: 0.14.0
1074 { 'type': 'VncClientInfo',
1075   'data': {'host': 'str', 'family': 'str', 'service': 'str',
1076            '*x509_dname': 'str', '*sasl_username': 'str'} }
1079 # @VncInfo:
1081 # Information about the VNC session.
1083 # @enabled: true if the VNC server is enabled, false otherwise
1085 # @host: #optional The hostname the VNC server is bound to.  This depends on
1086 #        the name resolution on the host and may be an IP address.
1088 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
1089 #                    'ipv4' if the host is listening for IPv4 connections
1090 #                    'unix' if the host is listening on a unix domain socket
1091 #                    'unknown' otherwise
1093 # @service: #optional The service name of the server's port.  This may depends
1094 #           on the host system's service database so symbolic names should not
1095 #           be relied on.
1097 # @auth: #optional the current authentication type used by the server
1098 #        'none' if no authentication is being used
1099 #        'vnc' if VNC authentication is being used
1100 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
1101 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
1102 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
1103 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
1104 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
1105 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
1106 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
1107 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
1108 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
1110 # @clients: a list of @VncClientInfo of all currently connected clients
1112 # Since: 0.14.0
1114 { 'type': 'VncInfo',
1115   'data': {'enabled': 'bool', '*host': 'str', '*family': 'str',
1116            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
1119 # @query-vnc:
1121 # Returns information about the current VNC server
1123 # Returns: @VncInfo
1125 # Since: 0.14.0
1127 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1130 # @SpiceChannel
1132 # Information about a SPICE client channel.
1134 # @host: The host name of the client.  QEMU tries to resolve this to a DNS name
1135 #        when possible.
1137 # @family: 'ipv6' if the client is connected via IPv6 and TCP
1138 #          'ipv4' if the client is connected via IPv4 and TCP
1139 #          'unix' if the client is connected via a unix domain socket
1140 #          'unknown' otherwise
1142 # @port: The client's port number.
1144 # @connection-id: SPICE connection id number.  All channels with the same id
1145 #                 belong to the same SPICE session.
1147 # @connection-type: SPICE channel type number.  "1" is the main control
1148 #                   channel, filter for this one if you want to track spice
1149 #                   sessions only
1151 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
1152 #              multiple channels of the same type exist, such as multiple
1153 #              display channels in a multihead setup
1155 # @tls: true if the channel is encrypted, false otherwise.
1157 # Since: 0.14.0
1159 { 'type': 'SpiceChannel',
1160   'data': {'host': 'str', 'family': 'str', 'port': 'str',
1161            'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1162            'tls': 'bool'} }
1165 # @SpiceQueryMouseMode
1167 # An enumeration of Spice mouse states.
1169 # @client: Mouse cursor position is determined by the client.
1171 # @server: Mouse cursor position is determined by the server.
1173 # @unknown: No information is available about mouse mode used by
1174 #           the spice server.
1176 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1178 # Since: 1.1
1180 { 'enum': 'SpiceQueryMouseMode',
1181   'data': [ 'client', 'server', 'unknown' ] }
1184 # @SpiceInfo
1186 # Information about the SPICE session.
1188 # @enabled: true if the SPICE server is enabled, false otherwise
1190 # @migrated: true if the last guest migration completed and spice
1191 #            migration had completed as well. false otherwise.
1193 # @host: #optional The hostname the SPICE server is bound to.  This depends on
1194 #        the name resolution on the host and may be an IP address.
1196 # @port: #optional The SPICE server's port number.
1198 # @compiled-version: #optional SPICE server version.
1200 # @tls-port: #optional The SPICE server's TLS port number.
1202 # @auth: #optional the current authentication type used by the server
1203 #        'none'  if no authentication is being used
1204 #        'spice' uses SASL or direct TLS authentication, depending on command
1205 #                line options
1207 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1208 #              be determined by the client or the server, or unknown if spice
1209 #              server doesn't provide this information.
1211 #              Since: 1.1
1213 # @channels: a list of @SpiceChannel for each active spice channel
1215 # Since: 0.14.0
1217 { 'type': 'SpiceInfo',
1218   'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1219            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1220            'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1223 # @query-spice
1225 # Returns information about the current SPICE server
1227 # Returns: @SpiceInfo
1229 # Since: 0.14.0
1231 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1234 # @BalloonInfo:
1236 # Information about the guest balloon device.
1238 # @actual: the number of bytes the balloon currently contains
1240 # Since: 0.14.0
1243 { 'type': 'BalloonInfo', 'data': {'actual': 'int' } }
1246 # @query-balloon:
1248 # Return information about the balloon device.
1250 # Returns: @BalloonInfo on success
1251 #          If the balloon driver is enabled but not functional because the KVM
1252 #          kernel module cannot support it, KvmMissingCap
1253 #          If no balloon device is present, DeviceNotActive
1255 # Since: 0.14.0
1257 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1260 # @PciMemoryRange:
1262 # A PCI device memory region
1264 # @base: the starting address (guest physical)
1266 # @limit: the ending address (guest physical)
1268 # Since: 0.14.0
1270 { 'type': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1273 # @PciMemoryRegion
1275 # Information about a PCI device I/O region.
1277 # @bar: the index of the Base Address Register for this region
1279 # @type: 'io' if the region is a PIO region
1280 #        'memory' if the region is a MMIO region
1282 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1284 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1286 # Since: 0.14.0
1288 { 'type': 'PciMemoryRegion',
1289   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1290            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1293 # @PciBridgeInfo:
1295 # Information about a PCI Bridge device
1297 # @bus.number: primary bus interface number.  This should be the number of the
1298 #              bus the device resides on.
1300 # @bus.secondary: secondary bus interface number.  This is the number of the
1301 #                 main bus for the bridge
1303 # @bus.subordinate: This is the highest number bus that resides below the
1304 #                   bridge.
1306 # @bus.io_range: The PIO range for all devices on this bridge
1308 # @bus.memory_range: The MMIO range for all devices on this bridge
1310 # @bus.prefetchable_range: The range of prefetchable MMIO for all devices on
1311 #                          this bridge
1313 # @devices: a list of @PciDeviceInfo for each device on this bridge
1315 # Since: 0.14.0
1317 { 'type': 'PciBridgeInfo',
1318   'data': {'bus': { 'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1319                     'io_range': 'PciMemoryRange',
1320                     'memory_range': 'PciMemoryRange',
1321                     'prefetchable_range': 'PciMemoryRange' },
1322            '*devices': ['PciDeviceInfo']} }
1325 # @PciDeviceInfo:
1327 # Information about a PCI device
1329 # @bus: the bus number of the device
1331 # @slot: the slot the device is located in
1333 # @function: the function of the slot used by the device
1335 # @class_info.desc: #optional a string description of the device's class
1337 # @class_info.class: the class code of the device
1339 # @id.device: the PCI device id
1341 # @id.vendor: the PCI vendor id
1343 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1345 # @qdev_id: the device name of the PCI device
1347 # @pci_bridge: if the device is a PCI bridge, the bridge information
1349 # @regions: a list of the PCI I/O regions associated with the device
1351 # Notes: the contents of @class_info.desc are not stable and should only be
1352 #        treated as informational.
1354 # Since: 0.14.0
1356 { 'type': 'PciDeviceInfo',
1357   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1358            'class_info': {'*desc': 'str', 'class': 'int'},
1359            'id': {'device': 'int', 'vendor': 'int'},
1360            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1361            'regions': ['PciMemoryRegion']} }
1364 # @PciInfo:
1366 # Information about a PCI bus
1368 # @bus: the bus index
1370 # @devices: a list of devices on this bus
1372 # Since: 0.14.0
1374 { 'type': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1377 # @query-pci:
1379 # Return information about the PCI bus topology of the guest.
1381 # Returns: a list of @PciInfo for each PCI bus
1383 # Since: 0.14.0
1385 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1388 # @BlockdevOnError:
1390 # An enumeration of possible behaviors for errors on I/O operations.
1391 # The exact meaning depends on whether the I/O was initiated by a guest
1392 # or by a block job
1394 # @report: for guest operations, report the error to the guest;
1395 #          for jobs, cancel the job
1397 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
1398 #          or BLOCK_JOB_ERROR)
1400 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
1402 # @stop: for guest operations, stop the virtual machine;
1403 #        for jobs, pause the job
1405 # Since: 1.3
1407 { 'enum': 'BlockdevOnError',
1408   'data': ['report', 'ignore', 'enospc', 'stop'] }
1411 # @MirrorSyncMode:
1413 # An enumeration of possible behaviors for the initial synchronization
1414 # phase of storage mirroring.
1416 # @top: copies data in the topmost image to the destination
1418 # @full: copies data from all images to the destination
1420 # @none: only copy data written from now on
1422 # Since: 1.3
1424 { 'enum': 'MirrorSyncMode',
1425   'data': ['top', 'full', 'none'] }
1428 # @BlockJobType:
1430 # Type of a block job.
1432 # @commit: block commit job type, see "block-commit"
1434 # @stream: block stream job type, see "block-stream"
1436 # @mirror: drive mirror job type, see "drive-mirror"
1438 # @backup: drive backup job type, see "drive-backup"
1440 # Since: 1.7
1442 { 'enum': 'BlockJobType',
1443   'data': ['commit', 'stream', 'mirror', 'backup'] }
1446 # @BlockJobInfo:
1448 # Information about a long-running block device operation.
1450 # @type: the job type ('stream' for image streaming)
1452 # @device: the block device name
1454 # @len: the maximum progress value
1456 # @busy: false if the job is known to be in a quiescent state, with
1457 #        no pending I/O.  Since 1.3.
1459 # @paused: whether the job is paused or, if @busy is true, will
1460 #          pause itself as soon as possible.  Since 1.3.
1462 # @offset: the current progress value
1464 # @speed: the rate limit, bytes per second
1466 # @io-status: the status of the job (since 1.3)
1468 # Since: 1.1
1470 { 'type': 'BlockJobInfo',
1471   'data': {'type': 'str', 'device': 'str', 'len': 'int',
1472            'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
1473            'io-status': 'BlockDeviceIoStatus'} }
1476 # @query-block-jobs:
1478 # Return information about long-running block device operations.
1480 # Returns: a list of @BlockJobInfo for each active block job
1482 # Since: 1.1
1484 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
1487 # @quit:
1489 # This command will cause the QEMU process to exit gracefully.  While every
1490 # attempt is made to send the QMP response before terminating, this is not
1491 # guaranteed.  When using this interface, a premature EOF would not be
1492 # unexpected.
1494 # Since: 0.14.0
1496 { 'command': 'quit' }
1499 # @stop:
1501 # Stop all guest VCPU execution.
1503 # Since:  0.14.0
1505 # Notes:  This function will succeed even if the guest is already in the stopped
1506 #         state.  In "inmigrate" state, it will ensure that the guest
1507 #         remains paused once migration finishes, as if the -S option was
1508 #         passed on the command line.
1510 { 'command': 'stop' }
1513 # @system_reset:
1515 # Performs a hard reset of a guest.
1517 # Since: 0.14.0
1519 { 'command': 'system_reset' }
1522 # @system_powerdown:
1524 # Requests that a guest perform a powerdown operation.
1526 # Since: 0.14.0
1528 # Notes: A guest may or may not respond to this command.  This command
1529 #        returning does not indicate that a guest has accepted the request or
1530 #        that it has shut down.  Many guests will respond to this command by
1531 #        prompting the user in some way.
1533 { 'command': 'system_powerdown' }
1536 # @cpu:
1538 # This command is a nop that is only provided for the purposes of compatibility.
1540 # Since: 0.14.0
1542 # Notes: Do not use this command.
1544 { 'command': 'cpu', 'data': {'index': 'int'} }
1547 # @cpu-add
1549 # Adds CPU with specified ID
1551 # @id: ID of CPU to be created, valid values [0..max_cpus)
1553 # Returns: Nothing on success
1555 # Since 1.5
1557 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1560 # @memsave:
1562 # Save a portion of guest memory to a file.
1564 # @val: the virtual address of the guest to start from
1566 # @size: the size of memory region to save
1568 # @filename: the file to save the memory to as binary data
1570 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1571 #                       virtual address (defaults to CPU 0)
1573 # Returns: Nothing on success
1575 # Since: 0.14.0
1577 # Notes: Errors were not reliably returned until 1.1
1579 { 'command': 'memsave',
1580   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1583 # @pmemsave:
1585 # Save a portion of guest physical memory to a file.
1587 # @val: the physical address of the guest to start from
1589 # @size: the size of memory region to save
1591 # @filename: the file to save the memory to as binary data
1593 # Returns: Nothing on success
1595 # Since: 0.14.0
1597 # Notes: Errors were not reliably returned until 1.1
1599 { 'command': 'pmemsave',
1600   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1603 # @cont:
1605 # Resume guest VCPU execution.
1607 # Since:  0.14.0
1609 # Returns:  If successful, nothing
1610 #           If QEMU was started with an encrypted block device and a key has
1611 #              not yet been set, DeviceEncrypted.
1613 # Notes:  This command will succeed if the guest is currently running.  It
1614 #         will also succeed if the guest is in the "inmigrate" state; in
1615 #         this case, the effect of the command is to make sure the guest
1616 #         starts once migration finishes, removing the effect of the -S
1617 #         command line option if it was passed.
1619 { 'command': 'cont' }
1622 # @system_wakeup:
1624 # Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
1626 # Since:  1.1
1628 # Returns:  nothing.
1630 { 'command': 'system_wakeup' }
1633 # @inject-nmi:
1635 # Injects an Non-Maskable Interrupt into all guest's VCPUs.
1637 # Returns:  If successful, nothing
1639 # Since:  0.14.0
1641 # Notes: Only x86 Virtual Machines support this command.
1643 { 'command': 'inject-nmi' }
1646 # @set_link:
1648 # Sets the link status of a virtual network adapter.
1650 # @name: the device name of the virtual network adapter
1652 # @up: true to set the link status to be up
1654 # Returns: Nothing on success
1655 #          If @name is not a valid network device, DeviceNotFound
1657 # Since: 0.14.0
1659 # Notes: Not all network adapters support setting link status.  This command
1660 #        will succeed even if the network adapter does not support link status
1661 #        notification.
1663 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1666 # @block_passwd:
1668 # This command sets the password of a block device that has not been open
1669 # with a password and requires one.
1671 # The two cases where this can happen are a block device is created through
1672 # QEMU's initial command line or a block device is changed through the legacy
1673 # @change interface.
1675 # In the event that the block device is created through the initial command
1676 # line, the VM will start in the stopped state regardless of whether '-S' is
1677 # used.  The intention is for a management tool to query the block devices to
1678 # determine which ones are encrypted, set the passwords with this command, and
1679 # then start the guest with the @cont command.
1681 # Either @device or @node-name must be set but not both.
1683 # @device: #optional the name of the block backend device to set the password on
1685 # @node-name: #optional graph node name to set the password on (Since 2.0)
1687 # @password: the password to use for the device
1689 # Returns: nothing on success
1690 #          If @device is not a valid block device, DeviceNotFound
1691 #          If @device is not encrypted, DeviceNotEncrypted
1693 # Notes:  Not all block formats support encryption and some that do are not
1694 #         able to validate that a password is correct.  Disk corruption may
1695 #         occur if an invalid password is specified.
1697 # Since: 0.14.0
1699 { 'command': 'block_passwd', 'data': {'*device': 'str',
1700                                       '*node-name': 'str', 'password': 'str'} }
1703 # @balloon:
1705 # Request the balloon driver to change its balloon size.
1707 # @value: the target size of the balloon in bytes
1709 # Returns: Nothing on success
1710 #          If the balloon driver is enabled but not functional because the KVM
1711 #            kernel module cannot support it, KvmMissingCap
1712 #          If no balloon device is present, DeviceNotActive
1714 # Notes: This command just issues a request to the guest.  When it returns,
1715 #        the balloon size may not have changed.  A guest can change the balloon
1716 #        size independent of this command.
1718 # Since: 0.14.0
1720 { 'command': 'balloon', 'data': {'value': 'int'} }
1723 # @block_resize
1725 # Resize a block image while a guest is running.
1727 # Either @device or @node-name must be set but not both.
1729 # @device: #optional the name of the device to get the image resized
1731 # @node-name: #optional graph node name to get the image resized (Since 2.0)
1733 # @size:  new image size in bytes
1735 # Returns: nothing on success
1736 #          If @device is not a valid block device, DeviceNotFound
1738 # Since: 0.14.0
1740 { 'command': 'block_resize', 'data': { '*device': 'str',
1741                                        '*node-name': 'str',
1742                                        'size': 'int' }}
1745 # @NewImageMode
1747 # An enumeration that tells QEMU how to set the backing file path in
1748 # a new image file.
1750 # @existing: QEMU should look for an existing image file.
1752 # @absolute-paths: QEMU should create a new image with absolute paths
1753 # for the backing file. If there is no backing file available, the new
1754 # image will not be backed either.
1756 # Since: 1.1
1758 { 'enum': 'NewImageMode',
1759   'data': [ 'existing', 'absolute-paths' ] }
1762 # @BlockdevSnapshot
1764 # Either @device or @node-name must be set but not both.
1766 # @device: #optional the name of the device to generate the snapshot from.
1768 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
1770 # @snapshot-file: the target of the new image. A new file will be created.
1772 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
1774 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1776 # @mode: #optional whether and how QEMU should create a new image, default is
1777 #        'absolute-paths'.
1779 { 'type': 'BlockdevSnapshot',
1780   'data': { '*device': 'str', '*node-name': 'str',
1781             'snapshot-file': 'str', '*snapshot-node-name': 'str',
1782             '*format': 'str', '*mode': 'NewImageMode' } }
1785 # @BlockdevSnapshotInternal
1787 # @device: the name of the device to generate the snapshot from
1789 # @name: the name of the internal snapshot to be created
1791 # Notes: In transaction, if @name is empty, or any snapshot matching @name
1792 #        exists, the operation will fail. Only some image formats support it,
1793 #        for example, qcow2, rbd, and sheepdog.
1795 # Since: 1.7
1797 { 'type': 'BlockdevSnapshotInternal',
1798   'data': { 'device': 'str', 'name': 'str' } }
1801 # @DriveBackup
1803 # @device: the name of the device which should be copied.
1805 # @target: the target of the new image. If the file exists, or if it
1806 #          is a device, the existing file/device will be used as the new
1807 #          destination.  If it does not exist, a new file will be created.
1809 # @format: #optional the format of the new destination, default is to
1810 #          probe if @mode is 'existing', else the format of the source
1812 # @sync: what parts of the disk image should be copied to the destination
1813 #        (all the disk, only the sectors allocated in the topmost image, or
1814 #        only new I/O).
1816 # @mode: #optional whether and how QEMU should create a new image, default is
1817 #        'absolute-paths'.
1819 # @speed: #optional the maximum speed, in bytes per second
1821 # @on-source-error: #optional the action to take on an error on the source,
1822 #                   default 'report'.  'stop' and 'enospc' can only be used
1823 #                   if the block device supports io-status (see BlockInfo).
1825 # @on-target-error: #optional the action to take on an error on the target,
1826 #                   default 'report' (no limitations, since this applies to
1827 #                   a different block device than @device).
1829 # Note that @on-source-error and @on-target-error only affect background I/O.
1830 # If an error occurs during a guest write request, the device's rerror/werror
1831 # actions will be used.
1833 # Since: 1.6
1835 { 'type': 'DriveBackup',
1836   'data': { 'device': 'str', 'target': 'str', '*format': 'str',
1837             'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1838             '*speed': 'int',
1839             '*on-source-error': 'BlockdevOnError',
1840             '*on-target-error': 'BlockdevOnError' } }
1843 # @Abort
1845 # This action can be used to test transaction failure.
1847 # Since: 1.6
1849 { 'type': 'Abort',
1850   'data': { } }
1853 # @TransactionAction
1855 # A discriminated record of operations that can be performed with
1856 # @transaction.
1858 { 'union': 'TransactionAction',
1859   'data': {
1860        'blockdev-snapshot-sync': 'BlockdevSnapshot',
1861        'drive-backup': 'DriveBackup',
1862        'abort': 'Abort',
1863        'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal'
1864    } }
1867 # @transaction
1869 # Executes a number of transactionable QMP commands atomically. If any
1870 # operation fails, then the entire set of actions will be abandoned and the
1871 # appropriate error returned.
1873 #  List of:
1874 #  @TransactionAction: information needed for the respective operation
1876 # Returns: nothing on success
1877 #          Errors depend on the operations of the transaction
1879 # Note: The transaction aborts on the first failure.  Therefore, there will be
1880 # information on only one failed operation returned in an error condition, and
1881 # subsequent actions will not have been attempted.
1883 # Since 1.1
1885 { 'command': 'transaction',
1886   'data': { 'actions': [ 'TransactionAction' ] } }
1889 # @blockdev-snapshot-sync
1891 # Generates a synchronous snapshot of a block device.
1893 # For the arguments, see the documentation of BlockdevSnapshot.
1895 # Returns: nothing on success
1896 #          If @device is not a valid block device, DeviceNotFound
1898 # Since 0.14.0
1900 { 'command': 'blockdev-snapshot-sync',
1901   'data': 'BlockdevSnapshot' }
1904 # @blockdev-snapshot-internal-sync
1906 # Synchronously take an internal snapshot of a block device, when the format
1907 # of the image used supports it.
1909 # For the arguments, see the documentation of BlockdevSnapshotInternal.
1911 # Returns: nothing on success
1912 #          If @device is not a valid block device, DeviceNotFound
1913 #          If any snapshot matching @name exists, or @name is empty,
1914 #          GenericError
1915 #          If the format of the image used does not support it,
1916 #          BlockFormatFeatureNotSupported
1918 # Since 1.7
1920 { 'command': 'blockdev-snapshot-internal-sync',
1921   'data': 'BlockdevSnapshotInternal' }
1924 # @blockdev-snapshot-delete-internal-sync
1926 # Synchronously delete an internal snapshot of a block device, when the format
1927 # of the image used support it. The snapshot is identified by name or id or
1928 # both. One of the name or id is required. Return SnapshotInfo for the
1929 # successfully deleted snapshot.
1931 # @device: the name of the device to delete the snapshot from
1933 # @id: optional the snapshot's ID to be deleted
1935 # @name: optional the snapshot's name to be deleted
1937 # Returns: SnapshotInfo on success
1938 #          If @device is not a valid block device, DeviceNotFound
1939 #          If snapshot not found, GenericError
1940 #          If the format of the image used does not support it,
1941 #          BlockFormatFeatureNotSupported
1942 #          If @id and @name are both not specified, GenericError
1944 # Since 1.7
1946 { 'command': 'blockdev-snapshot-delete-internal-sync',
1947   'data': { 'device': 'str', '*id': 'str', '*name': 'str'},
1948   'returns': 'SnapshotInfo' }
1951 # @human-monitor-command:
1953 # Execute a command on the human monitor and return the output.
1955 # @command-line: the command to execute in the human monitor
1957 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1959 # Returns: the output of the command as a string
1961 # Since: 0.14.0
1963 # Notes: This command only exists as a stop-gap.  Its use is highly
1964 #        discouraged.  The semantics of this command are not guaranteed.
1966 #        Known limitations:
1968 #        o This command is stateless, this means that commands that depend
1969 #          on state information (such as getfd) might not work
1971 #       o Commands that prompt the user for data (eg. 'cont' when the block
1972 #         device is encrypted) don't currently work
1974 { 'command': 'human-monitor-command',
1975   'data': {'command-line': 'str', '*cpu-index': 'int'},
1976   'returns': 'str' }
1979 # @block-commit
1981 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1982 # writes data between 'top' and 'base' into 'base'.
1984 # @device:  the name of the device
1986 # @base:   #optional The file name of the backing image to write data into.
1987 #                    If not specified, this is the deepest backing image
1989 # @top:              The file name of the backing image within the image chain,
1990 #                    which contains the topmost data to be committed down.
1992 #                    If top == base, that is an error.
1993 #                    If top == active, the job will not be completed by itself,
1994 #                    user needs to complete the job with the block-job-complete
1995 #                    command after getting the ready event. (Since 2.0)
1997 #                    If the base image is smaller than top, then the base image
1998 #                    will be resized to be the same size as top.  If top is
1999 #                    smaller than the base image, the base will not be
2000 #                    truncated.  If you want the base image size to match the
2001 #                    size of the smaller top, you can safely truncate it
2002 #                    yourself once the commit operation successfully completes.
2005 # @speed:  #optional the maximum speed, in bytes per second
2007 # Returns: Nothing on success
2008 #          If commit or stream is already active on this device, DeviceInUse
2009 #          If @device does not exist, DeviceNotFound
2010 #          If image commit is not supported by this device, NotSupported
2011 #          If @base or @top is invalid, a generic error is returned
2012 #          If @speed is invalid, InvalidParameter
2014 # Since: 1.3
2017 { 'command': 'block-commit',
2018   'data': { 'device': 'str', '*base': 'str', 'top': 'str',
2019             '*speed': 'int' } }
2022 # @drive-backup
2024 # Start a point-in-time copy of a block device to a new destination.  The
2025 # status of ongoing drive-backup operations can be checked with
2026 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
2027 # The operation can be stopped before it has completed using the
2028 # block-job-cancel command.
2030 # For the arguments, see the documentation of DriveBackup.
2032 # Returns: nothing on success
2033 #          If @device is not a valid block device, DeviceNotFound
2035 # Since 1.6
2037 { 'command': 'drive-backup', 'data': 'DriveBackup' }
2040 # @query-named-block-nodes
2042 # Get the named block driver list
2044 # Returns: the list of BlockDeviceInfo
2046 # Since 2.0
2048 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
2051 # @drive-mirror
2053 # Start mirroring a block device's writes to a new destination.
2055 # @device:  the name of the device whose writes should be mirrored.
2057 # @target: the target of the new image. If the file exists, or if it
2058 #          is a device, the existing file/device will be used as the new
2059 #          destination.  If it does not exist, a new file will be created.
2061 # @format: #optional the format of the new destination, default is to
2062 #          probe if @mode is 'existing', else the format of the source
2064 # @mode: #optional whether and how QEMU should create a new image, default is
2065 #        'absolute-paths'.
2067 # @speed:  #optional the maximum speed, in bytes per second
2069 # @sync: what parts of the disk image should be copied to the destination
2070 #        (all the disk, only the sectors allocated in the topmost image, or
2071 #        only new I/O).
2073 # @granularity: #optional granularity of the dirty bitmap, default is 64K
2074 #               if the image format doesn't have clusters, 4K if the clusters
2075 #               are smaller than that, else the cluster size.  Must be a
2076 #               power of 2 between 512 and 64M (since 1.4).
2078 # @buf-size: #optional maximum amount of data in flight from source to
2079 #            target (since 1.4).
2081 # @on-source-error: #optional the action to take on an error on the source,
2082 #                   default 'report'.  'stop' and 'enospc' can only be used
2083 #                   if the block device supports io-status (see BlockInfo).
2085 # @on-target-error: #optional the action to take on an error on the target,
2086 #                   default 'report' (no limitations, since this applies to
2087 #                   a different block device than @device).
2089 # Returns: nothing on success
2090 #          If @device is not a valid block device, DeviceNotFound
2092 # Since 1.3
2094 { 'command': 'drive-mirror',
2095   'data': { 'device': 'str', 'target': 'str', '*format': 'str',
2096             'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
2097             '*speed': 'int', '*granularity': 'uint32',
2098             '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2099             '*on-target-error': 'BlockdevOnError' } }
2102 # @migrate_cancel
2104 # Cancel the current executing migration process.
2106 # Returns: nothing on success
2108 # Notes: This command succeeds even if there is no migration process running.
2110 # Since: 0.14.0
2112 { 'command': 'migrate_cancel' }
2115 # @migrate_set_downtime
2117 # Set maximum tolerated downtime for migration.
2119 # @value: maximum downtime in seconds
2121 # Returns: nothing on success
2123 # Since: 0.14.0
2125 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
2128 # @migrate_set_speed
2130 # Set maximum speed for migration.
2132 # @value: maximum speed in bytes.
2134 # Returns: nothing on success
2136 # Notes: A value lesser than zero will be automatically round up to zero.
2138 # Since: 0.14.0
2140 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
2143 # @migrate-set-cache-size
2145 # Set XBZRLE cache size
2147 # @value: cache size in bytes
2149 # The size will be rounded down to the nearest power of 2.
2150 # The cache size can be modified before and during ongoing migration
2152 # Returns: nothing on success
2154 # Since: 1.2
2156 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
2159 # @query-migrate-cache-size
2161 # query XBZRLE cache size
2163 # Returns: XBZRLE cache size in bytes
2165 # Since: 1.2
2167 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
2170 # @ObjectPropertyInfo:
2172 # @name: the name of the property
2174 # @type: the type of the property.  This will typically come in one of four
2175 #        forms:
2177 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
2178 #           These types are mapped to the appropriate JSON type.
2180 #        2) A legacy type in the form 'legacy<subtype>' where subtype is the
2181 #           legacy qdev typename.  These types are always treated as strings.
2183 #        3) A child type in the form 'child<subtype>' where subtype is a qdev
2184 #           device type name.  Child properties create the composition tree.
2186 #        4) A link type in the form 'link<subtype>' where subtype is a qdev
2187 #           device type name.  Link properties form the device model graph.
2189 # Since: 1.2
2191 { 'type': 'ObjectPropertyInfo',
2192   'data': { 'name': 'str', 'type': 'str' } }
2195 # @qom-list:
2197 # This command will list any properties of a object given a path in the object
2198 # model.
2200 # @path: the path within the object model.  See @qom-get for a description of
2201 #        this parameter.
2203 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
2204 #          object.
2206 # Since: 1.2
2208 { 'command': 'qom-list',
2209   'data': { 'path': 'str' },
2210   'returns': [ 'ObjectPropertyInfo' ] }
2213 # @qom-get:
2215 # This command will get a property from a object model path and return the
2216 # value.
2218 # @path: The path within the object model.  There are two forms of supported
2219 #        paths--absolute and partial paths.
2221 #        Absolute paths are derived from the root object and can follow child<>
2222 #        or link<> properties.  Since they can follow link<> properties, they
2223 #        can be arbitrarily long.  Absolute paths look like absolute filenames
2224 #        and are prefixed  with a leading slash.
2226 #        Partial paths look like relative filenames.  They do not begin
2227 #        with a prefix.  The matching rules for partial paths are subtle but
2228 #        designed to make specifying objects easy.  At each level of the
2229 #        composition tree, the partial path is matched as an absolute path.
2230 #        The first match is not returned.  At least two matches are searched
2231 #        for.  A successful result is only returned if only one match is
2232 #        found.  If more than one match is found, a flag is return to
2233 #        indicate that the match was ambiguous.
2235 # @property: The property name to read
2237 # Returns: The property value.  The type depends on the property type.  legacy<>
2238 #          properties are returned as #str.  child<> and link<> properties are
2239 #          returns as #str pathnames.  All integer property types (u8, u16, etc)
2240 #          are returned as #int.
2242 # Since: 1.2
2244 { 'command': 'qom-get',
2245   'data': { 'path': 'str', 'property': 'str' },
2246   'returns': 'visitor',
2247   'gen': 'no' }
2250 # @qom-set:
2252 # This command will set a property from a object model path.
2254 # @path: see @qom-get for a description of this parameter
2256 # @property: the property name to set
2258 # @value: a value who's type is appropriate for the property type.  See @qom-get
2259 #         for a description of type mapping.
2261 # Since: 1.2
2263 { 'command': 'qom-set',
2264   'data': { 'path': 'str', 'property': 'str', 'value': 'visitor' },
2265   'gen': 'no' }
2268 # @set_password:
2270 # Sets the password of a remote display session.
2272 # @protocol: `vnc' to modify the VNC server password
2273 #            `spice' to modify the Spice server password
2275 # @password: the new password
2277 # @connected: #optional how to handle existing clients when changing the
2278 #                       password.  If nothing is specified, defaults to `keep'
2279 #                       `fail' to fail the command if clients are connected
2280 #                       `disconnect' to disconnect existing clients
2281 #                       `keep' to maintain existing clients
2283 # Returns: Nothing on success
2284 #          If Spice is not enabled, DeviceNotFound
2286 # Since: 0.14.0
2288 { 'command': 'set_password',
2289   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
2292 # @expire_password:
2294 # Expire the password of a remote display server.
2296 # @protocol: the name of the remote display protocol `vnc' or `spice'
2298 # @time: when to expire the password.
2299 #        `now' to expire the password immediately
2300 #        `never' to cancel password expiration
2301 #        `+INT' where INT is the number of seconds from now (integer)
2302 #        `INT' where INT is the absolute time in seconds
2304 # Returns: Nothing on success
2305 #          If @protocol is `spice' and Spice is not active, DeviceNotFound
2307 # Since: 0.14.0
2309 # Notes: Time is relative to the server and currently there is no way to
2310 #        coordinate server time with client time.  It is not recommended to
2311 #        use the absolute time version of the @time parameter unless you're
2312 #        sure you are on the same machine as the QEMU instance.
2314 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
2317 # @eject:
2319 # Ejects a device from a removable drive.
2321 # @device:  The name of the device
2323 # @force:   @optional If true, eject regardless of whether the drive is locked.
2324 #           If not specified, the default value is false.
2326 # Returns:  Nothing on success
2327 #           If @device is not a valid block device, DeviceNotFound
2329 # Notes:    Ejecting a device will no media results in success
2331 # Since: 0.14.0
2333 { 'command': 'eject', 'data': {'device': 'str', '*force': 'bool'} }
2336 # @change-vnc-password:
2338 # Change the VNC server password.
2340 # @target:  the new password to use with VNC authentication
2342 # Since: 1.1
2344 # Notes:  An empty password in this command will set the password to the empty
2345 #         string.  Existing clients are unaffected by executing this command.
2347 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
2350 # @change:
2352 # This command is multiple commands multiplexed together.
2354 # @device: This is normally the name of a block device but it may also be 'vnc'.
2355 #          when it's 'vnc', then sub command depends on @target
2357 # @target: If @device is a block device, then this is the new filename.
2358 #          If @device is 'vnc', then if the value 'password' selects the vnc
2359 #          change password command.   Otherwise, this specifies a new server URI
2360 #          address to listen to for VNC connections.
2362 # @arg:    If @device is a block device, then this is an optional format to open
2363 #          the device with.
2364 #          If @device is 'vnc' and @target is 'password', this is the new VNC
2365 #          password to set.  If this argument is an empty string, then no future
2366 #          logins will be allowed.
2368 # Returns: Nothing on success.
2369 #          If @device is not a valid block device, DeviceNotFound
2370 #          If the new block device is encrypted, DeviceEncrypted.  Note that
2371 #          if this error is returned, the device has been opened successfully
2372 #          and an additional call to @block_passwd is required to set the
2373 #          device's password.  The behavior of reads and writes to the block
2374 #          device between when these calls are executed is undefined.
2376 # Notes:  It is strongly recommended that this interface is not used especially
2377 #         for changing block devices.
2379 # Since: 0.14.0
2381 { 'command': 'change',
2382   'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2385 # @block_set_io_throttle:
2387 # Change I/O throttle limits for a block drive.
2389 # @device: The name of the device
2391 # @bps: total throughput limit in bytes per second
2393 # @bps_rd: read throughput limit in bytes per second
2395 # @bps_wr: write throughput limit in bytes per second
2397 # @iops: total I/O operations per second
2399 # @ops_rd: read I/O operations per second
2401 # @iops_wr: write I/O operations per second
2403 # @bps_max: #optional total max in bytes (Since 1.7)
2405 # @bps_rd_max: #optional read max in bytes (Since 1.7)
2407 # @bps_wr_max: #optional write max in bytes (Since 1.7)
2409 # @iops_max: #optional total I/O operations max (Since 1.7)
2411 # @iops_rd_max: #optional read I/O operations max (Since 1.7)
2413 # @iops_wr_max: #optional write I/O operations max (Since 1.7)
2415 # @iops_size: #optional an I/O size in bytes (Since 1.7)
2417 # Returns: Nothing on success
2418 #          If @device is not a valid block device, DeviceNotFound
2420 # Since: 1.1
2422 { 'command': 'block_set_io_throttle',
2423   'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
2424             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
2425             '*bps_max': 'int', '*bps_rd_max': 'int',
2426             '*bps_wr_max': 'int', '*iops_max': 'int',
2427             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
2428             '*iops_size': 'int' } }
2431 # @block-stream:
2433 # Copy data from a backing file into a block device.
2435 # The block streaming operation is performed in the background until the entire
2436 # backing file has been copied.  This command returns immediately once streaming
2437 # has started.  The status of ongoing block streaming operations can be checked
2438 # with query-block-jobs.  The operation can be stopped before it has completed
2439 # using the block-job-cancel command.
2441 # If a base file is specified then sectors are not copied from that base file and
2442 # its backing chain.  When streaming completes the image file will have the base
2443 # file as its backing file.  This can be used to stream a subset of the backing
2444 # file chain instead of flattening the entire image.
2446 # On successful completion the image file is updated to drop the backing file
2447 # and the BLOCK_JOB_COMPLETED event is emitted.
2449 # @device: the device name
2451 # @base:   #optional the common backing file name
2453 # @speed:  #optional the maximum speed, in bytes per second
2455 # @on-error: #optional the action to take on an error (default report).
2456 #            'stop' and 'enospc' can only be used if the block device
2457 #            supports io-status (see BlockInfo).  Since 1.3.
2459 # Returns: Nothing on success
2460 #          If @device does not exist, DeviceNotFound
2462 # Since: 1.1
2464 { 'command': 'block-stream',
2465   'data': { 'device': 'str', '*base': 'str', '*speed': 'int',
2466             '*on-error': 'BlockdevOnError' } }
2469 # @block-job-set-speed:
2471 # Set maximum speed for a background block operation.
2473 # This command can only be issued when there is an active block job.
2475 # Throttling can be disabled by setting the speed to 0.
2477 # @device: the device name
2479 # @speed:  the maximum speed, in bytes per second, or 0 for unlimited.
2480 #          Defaults to 0.
2482 # Returns: Nothing on success
2483 #          If no background operation is active on this device, DeviceNotActive
2485 # Since: 1.1
2487 { 'command': 'block-job-set-speed',
2488   'data': { 'device': 'str', 'speed': 'int' } }
2491 # @block-job-cancel:
2493 # Stop an active background block operation.
2495 # This command returns immediately after marking the active background block
2496 # operation for cancellation.  It is an error to call this command if no
2497 # operation is in progress.
2499 # The operation will cancel as soon as possible and then emit the
2500 # BLOCK_JOB_CANCELLED event.  Before that happens the job is still visible when
2501 # enumerated using query-block-jobs.
2503 # For streaming, the image file retains its backing file unless the streaming
2504 # operation happens to complete just as it is being cancelled.  A new streaming
2505 # operation can be started at a later time to finish copying all data from the
2506 # backing file.
2508 # @device: the device name
2510 # @force: #optional whether to allow cancellation of a paused job (default
2511 #         false).  Since 1.3.
2513 # Returns: Nothing on success
2514 #          If no background operation is active on this device, DeviceNotActive
2516 # Since: 1.1
2518 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
2521 # @block-job-pause:
2523 # Pause an active background block operation.
2525 # This command returns immediately after marking the active background block
2526 # operation for pausing.  It is an error to call this command if no
2527 # operation is in progress.  Pausing an already paused job has no cumulative
2528 # effect; a single block-job-resume command will resume the job.
2530 # The operation will pause as soon as possible.  No event is emitted when
2531 # the operation is actually paused.  Cancelling a paused job automatically
2532 # resumes it.
2534 # @device: the device name
2536 # Returns: Nothing on success
2537 #          If no background operation is active on this device, DeviceNotActive
2539 # Since: 1.3
2541 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
2544 # @block-job-resume:
2546 # Resume an active background block operation.
2548 # This command returns immediately after resuming a paused background block
2549 # operation.  It is an error to call this command if no operation is in
2550 # progress.  Resuming an already running job is not an error.
2552 # This command also clears the error status of the job.
2554 # @device: the device name
2556 # Returns: Nothing on success
2557 #          If no background operation is active on this device, DeviceNotActive
2559 # Since: 1.3
2561 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
2564 # @block-job-complete:
2566 # Manually trigger completion of an active background block operation.  This
2567 # is supported for drive mirroring, where it also switches the device to
2568 # write to the target path only.  The ability to complete is signaled with
2569 # a BLOCK_JOB_READY event.
2571 # This command completes an active background block operation synchronously.
2572 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
2573 # is not defined.  Note that if an I/O error occurs during the processing of
2574 # this command: 1) the command itself will fail; 2) the error will be processed
2575 # according to the rerror/werror arguments that were specified when starting
2576 # the operation.
2578 # A cancelled or paused job cannot be completed.
2580 # @device: the device name
2582 # Returns: Nothing on success
2583 #          If no background operation is active on this device, DeviceNotActive
2585 # Since: 1.3
2587 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
2590 # @ObjectTypeInfo:
2592 # This structure describes a search result from @qom-list-types
2594 # @name: the type name found in the search
2596 # Since: 1.1
2598 # Notes: This command is experimental and may change syntax in future releases.
2600 { 'type': 'ObjectTypeInfo',
2601   'data': { 'name': 'str' } }
2604 # @qom-list-types:
2606 # This command will return a list of types given search parameters
2608 # @implements: if specified, only return types that implement this type name
2610 # @abstract: if true, include abstract types in the results
2612 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
2614 # Since: 1.1
2616 { 'command': 'qom-list-types',
2617   'data': { '*implements': 'str', '*abstract': 'bool' },
2618   'returns': [ 'ObjectTypeInfo' ] }
2621 # @DevicePropertyInfo:
2623 # Information about device properties.
2625 # @name: the name of the property
2626 # @type: the typename of the property
2628 # Since: 1.2
2630 { 'type': 'DevicePropertyInfo',
2631   'data': { 'name': 'str', 'type': 'str' } }
2634 # @device-list-properties:
2636 # List properties associated with a device.
2638 # @typename: the type name of a device
2640 # Returns: a list of DevicePropertyInfo describing a devices properties
2642 # Since: 1.2
2644 { 'command': 'device-list-properties',
2645   'data': { 'typename': 'str'},
2646   'returns': [ 'DevicePropertyInfo' ] }
2649 # @migrate
2651 # Migrates the current running guest to another Virtual Machine.
2653 # @uri: the Uniform Resource Identifier of the destination VM
2655 # @blk: #optional do block migration (full disk copy)
2657 # @inc: #optional incremental disk copy migration
2659 # @detach: this argument exists only for compatibility reasons and
2660 #          is ignored by QEMU
2662 # Returns: nothing on success
2664 # Since: 0.14.0
2666 { 'command': 'migrate',
2667   'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2669 # @xen-save-devices-state:
2671 # Save the state of all devices to file. The RAM and the block devices
2672 # of the VM are not saved by this command.
2674 # @filename: the file to save the state of the devices to as binary
2675 # data. See xen-save-devices-state.txt for a description of the binary
2676 # format.
2678 # Returns: Nothing on success
2680 # Since: 1.1
2682 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
2685 # @xen-set-global-dirty-log
2687 # Enable or disable the global dirty log mode.
2689 # @enable: true to enable, false to disable.
2691 # Returns: nothing
2693 # Since: 1.3
2695 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
2698 # @device_del:
2700 # Remove a device from a guest
2702 # @id: the name of the device
2704 # Returns: Nothing on success
2705 #          If @id is not a valid device, DeviceNotFound
2707 # Notes: When this command completes, the device may not be removed from the
2708 #        guest.  Hot removal is an operation that requires guest cooperation.
2709 #        This command merely requests that the guest begin the hot removal
2710 #        process.  Completion of the device removal process is signaled with a
2711 #        DEVICE_DELETED event. Guest reset will automatically complete removal
2712 #        for all devices.
2714 # Since: 0.14.0
2716 { 'command': 'device_del', 'data': {'id': 'str'} }
2719 # @dump-guest-memory
2721 # Dump guest's memory to vmcore. It is a synchronous operation that can take
2722 # very long depending on the amount of guest memory. This command is only
2723 # supported on i386 and x86_64.
2725 # @paging: if true, do paging to get guest's memory mapping. This allows
2726 #          using gdb to process the core file.
2728 #          IMPORTANT: this option can make QEMU allocate several gigabytes
2729 #                     of RAM. This can happen for a large guest, or a
2730 #                     malicious guest pretending to be large.
2732 #          Also, paging=true has the following limitations:
2734 #             1. The guest may be in a catastrophic state or can have corrupted
2735 #                memory, which cannot be trusted
2736 #             2. The guest can be in real-mode even if paging is enabled. For
2737 #                example, the guest uses ACPI to sleep, and ACPI sleep state
2738 #                goes in real-mode
2740 # @protocol: the filename or file descriptor of the vmcore. The supported
2741 #            protocols are:
2743 #            1. file: the protocol starts with "file:", and the following
2744 #               string is the file's path.
2745 #            2. fd: the protocol starts with "fd:", and the following string
2746 #               is the fd's name.
2748 # @begin: #optional if specified, the starting physical address.
2750 # @length: #optional if specified, the memory size, in bytes. If you don't
2751 #          want to dump all guest's memory, please specify the start @begin
2752 #          and @length
2754 # Returns: nothing on success
2756 # Since: 1.2
2758 { 'command': 'dump-guest-memory',
2759   'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
2760             '*length': 'int' } }
2763 # @netdev_add:
2765 # Add a network backend.
2767 # @type: the type of network backend.  Current valid values are 'user', 'tap',
2768 #        'vde', 'socket', 'dump' and 'bridge'
2770 # @id: the name of the new network backend
2772 # @props: #optional a list of properties to be passed to the backend in
2773 #         the format 'name=value', like 'ifname=tap0,script=no'
2775 # Notes: The semantics of @props is not well defined.  Future commands will be
2776 #        introduced that provide stronger typing for backend creation.
2778 # Since: 0.14.0
2780 # Returns: Nothing on success
2781 #          If @type is not a valid network backend, DeviceNotFound
2783 { 'command': 'netdev_add',
2784   'data': {'type': 'str', 'id': 'str', '*props': '**'},
2785   'gen': 'no' }
2788 # @netdev_del:
2790 # Remove a network backend.
2792 # @id: the name of the network backend to remove
2794 # Returns: Nothing on success
2795 #          If @id is not a valid network backend, DeviceNotFound
2797 # Since: 0.14.0
2799 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2802 # @object-add:
2804 # Create a QOM object.
2806 # @qom-type: the class name for the object to be created
2808 # @id: the name of the new object
2810 # @props: #optional a dictionary of properties to be passed to the backend
2812 # Returns: Nothing on success
2813 #          Error if @qom-type is not a valid class name
2815 # Since: 2.0
2817 { 'command': 'object-add',
2818   'data': {'qom-type': 'str', 'id': 'str', '*props': 'dict'},
2819   'gen': 'no' }
2822 # @object-del:
2824 # Remove a QOM object.
2826 # @id: the name of the QOM object to remove
2828 # Returns: Nothing on success
2829 #          Error if @id is not a valid id for a QOM object
2831 # Since: 2.0
2833 { 'command': 'object-del', 'data': {'id': 'str'} }
2836 # @NetdevNoneOptions
2838 # Use it alone to have zero network devices.
2840 # Since 1.2
2842 { 'type': 'NetdevNoneOptions',
2843   'data': { } }
2846 # @NetLegacyNicOptions
2848 # Create a new Network Interface Card.
2850 # @netdev: #optional id of -netdev to connect to
2852 # @macaddr: #optional MAC address
2854 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2856 # @addr: #optional PCI device address
2858 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2860 # Since 1.2
2862 { 'type': 'NetLegacyNicOptions',
2863   'data': {
2864     '*netdev':  'str',
2865     '*macaddr': 'str',
2866     '*model':   'str',
2867     '*addr':    'str',
2868     '*vectors': 'uint32' } }
2871 # @String
2873 # A fat type wrapping 'str', to be embedded in lists.
2875 # Since 1.2
2877 { 'type': 'String',
2878   'data': {
2879     'str': 'str' } }
2882 # @NetdevUserOptions
2884 # Use the user mode network stack which requires no administrator privilege to
2885 # run.
2887 # @hostname: #optional client hostname reported by the builtin DHCP server
2889 # @restrict: #optional isolate the guest from the host
2891 # @ip: #optional legacy parameter, use net= instead
2893 # @net: #optional IP address and optional netmask
2895 # @host: #optional guest-visible address of the host
2897 # @tftp: #optional root directory of the built-in TFTP server
2899 # @bootfile: #optional BOOTP filename, for use with tftp=
2901 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2902 #             assign
2904 # @dns: #optional guest-visible address of the virtual nameserver
2906 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2907 #             to the guest
2909 # @smb: #optional root directory of the built-in SMB server
2911 # @smbserver: #optional IP address of the built-in SMB server
2913 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2914 #           endpoints
2916 # @guestfwd: #optional forward guest TCP connections
2918 # Since 1.2
2920 { 'type': 'NetdevUserOptions',
2921   'data': {
2922     '*hostname':  'str',
2923     '*restrict':  'bool',
2924     '*ip':        'str',
2925     '*net':       'str',
2926     '*host':      'str',
2927     '*tftp':      'str',
2928     '*bootfile':  'str',
2929     '*dhcpstart': 'str',
2930     '*dns':       'str',
2931     '*dnssearch': ['String'],
2932     '*smb':       'str',
2933     '*smbserver': 'str',
2934     '*hostfwd':   ['String'],
2935     '*guestfwd':  ['String'] } }
2938 # @NetdevTapOptions
2940 # Connect the host TAP network interface name to the VLAN.
2942 # @ifname: #optional interface name
2944 # @fd: #optional file descriptor of an already opened tap
2946 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2947 # tap
2949 # @script: #optional script to initialize the interface
2951 # @downscript: #optional script to shut down the interface
2953 # @helper: #optional command to execute to configure bridge
2955 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2957 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2959 # @vhost: #optional enable vhost-net network accelerator
2961 # @vhostfd: #optional file descriptor of an already opened vhost net device
2963 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2964 # devices
2966 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2968 # @queues: #optional number of queues to be created for multiqueue capable tap
2970 # Since 1.2
2972 { 'type': 'NetdevTapOptions',
2973   'data': {
2974     '*ifname':     'str',
2975     '*fd':         'str',
2976     '*fds':        'str',
2977     '*script':     'str',
2978     '*downscript': 'str',
2979     '*helper':     'str',
2980     '*sndbuf':     'size',
2981     '*vnet_hdr':   'bool',
2982     '*vhost':      'bool',
2983     '*vhostfd':    'str',
2984     '*vhostfds':   'str',
2985     '*vhostforce': 'bool',
2986     '*queues':     'uint32'} }
2989 # @NetdevSocketOptions
2991 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2992 # socket connection.
2994 # @fd: #optional file descriptor of an already opened socket
2996 # @listen: #optional port number, and optional hostname, to listen on
2998 # @connect: #optional port number, and optional hostname, to connect to
3000 # @mcast: #optional UDP multicast address and port number
3002 # @localaddr: #optional source address and port for multicast and udp packets
3004 # @udp: #optional UDP unicast address and port number
3006 # Since 1.2
3008 { 'type': 'NetdevSocketOptions',
3009   'data': {
3010     '*fd':        'str',
3011     '*listen':    'str',
3012     '*connect':   'str',
3013     '*mcast':     'str',
3014     '*localaddr': 'str',
3015     '*udp':       'str' } }
3018 # @NetdevVdeOptions
3020 # Connect the VLAN to a vde switch running on the host.
3022 # @sock: #optional socket path
3024 # @port: #optional port number
3026 # @group: #optional group owner of socket
3028 # @mode: #optional permissions for socket
3030 # Since 1.2
3032 { 'type': 'NetdevVdeOptions',
3033   'data': {
3034     '*sock':  'str',
3035     '*port':  'uint16',
3036     '*group': 'str',
3037     '*mode':  'uint16' } }
3040 # @NetdevDumpOptions
3042 # Dump VLAN network traffic to a file.
3044 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
3045 # suffixes.
3047 # @file: #optional dump file path (default is qemu-vlan0.pcap)
3049 # Since 1.2
3051 { 'type': 'NetdevDumpOptions',
3052   'data': {
3053     '*len':  'size',
3054     '*file': 'str' } }
3057 # @NetdevBridgeOptions
3059 # Connect a host TAP network interface to a host bridge device.
3061 # @br: #optional bridge name
3063 # @helper: #optional command to execute to configure bridge
3065 # Since 1.2
3067 { 'type': 'NetdevBridgeOptions',
3068   'data': {
3069     '*br':     'str',
3070     '*helper': 'str' } }
3073 # @NetdevHubPortOptions
3075 # Connect two or more net clients through a software hub.
3077 # @hubid: hub identifier number
3079 # Since 1.2
3081 { 'type': 'NetdevHubPortOptions',
3082   'data': {
3083     'hubid':     'int32' } }
3086 # @NetdevNetmapOptions
3088 # Connect a client to a netmap-enabled NIC or to a VALE switch port
3090 # @ifname: Either the name of an existing network interface supported by
3091 #          netmap, or the name of a VALE port (created on the fly).
3092 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
3093 #          YYY are non-negative integers. XXX identifies a switch and
3094 #          YYY identifies a port of the switch. VALE ports having the
3095 #          same XXX are therefore connected to the same switch.
3097 # @devname: #optional path of the netmap device (default: '/dev/netmap').
3099 # Since 2.0
3101 { 'type': 'NetdevNetmapOptions',
3102   'data': {
3103     'ifname':     'str',
3104     '*devname':    'str' } }
3107 # @NetClientOptions
3109 # A discriminated record of network device traits.
3111 # Since 1.2
3113 { 'union': 'NetClientOptions',
3114   'data': {
3115     'none':     'NetdevNoneOptions',
3116     'nic':      'NetLegacyNicOptions',
3117     'user':     'NetdevUserOptions',
3118     'tap':      'NetdevTapOptions',
3119     'socket':   'NetdevSocketOptions',
3120     'vde':      'NetdevVdeOptions',
3121     'dump':     'NetdevDumpOptions',
3122     'bridge':   'NetdevBridgeOptions',
3123     'hubport':  'NetdevHubPortOptions',
3124     'netmap':   'NetdevNetmapOptions' } }
3127 # @NetLegacy
3129 # Captures the configuration of a network device; legacy.
3131 # @vlan: #optional vlan number
3133 # @id: #optional identifier for monitor commands
3135 # @name: #optional identifier for monitor commands, ignored if @id is present
3137 # @opts: device type specific properties (legacy)
3139 # Since 1.2
3141 { 'type': 'NetLegacy',
3142   'data': {
3143     '*vlan': 'int32',
3144     '*id':   'str',
3145     '*name': 'str',
3146     'opts':  'NetClientOptions' } }
3149 # @Netdev
3151 # Captures the configuration of a network device.
3153 # @id: identifier for monitor commands.
3155 # @opts: device type specific properties
3157 # Since 1.2
3159 { 'type': 'Netdev',
3160   'data': {
3161     'id':   'str',
3162     'opts': 'NetClientOptions' } }
3165 # @InetSocketAddress
3167 # Captures a socket address or address range in the Internet namespace.
3169 # @host: host part of the address
3171 # @port: port part of the address, or lowest port if @to is present
3173 # @to: highest port to try
3175 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
3176 #        #optional
3178 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
3179 #        #optional
3181 # Since 1.3
3183 { 'type': 'InetSocketAddress',
3184   'data': {
3185     'host': 'str',
3186     'port': 'str',
3187     '*to': 'uint16',
3188     '*ipv4': 'bool',
3189     '*ipv6': 'bool' } }
3192 # @UnixSocketAddress
3194 # Captures a socket address in the local ("Unix socket") namespace.
3196 # @path: filesystem path to use
3198 # Since 1.3
3200 { 'type': 'UnixSocketAddress',
3201   'data': {
3202     'path': 'str' } }
3205 # @SocketAddress
3207 # Captures the address of a socket, which could also be a named file descriptor
3209 # Since 1.3
3211 { 'union': 'SocketAddress',
3212   'data': {
3213     'inet': 'InetSocketAddress',
3214     'unix': 'UnixSocketAddress',
3215     'fd': 'String' } }
3218 # @getfd:
3220 # Receive a file descriptor via SCM rights and assign it a name
3222 # @fdname: file descriptor name
3224 # Returns: Nothing on success
3226 # Since: 0.14.0
3228 # Notes: If @fdname already exists, the file descriptor assigned to
3229 #        it will be closed and replaced by the received file
3230 #        descriptor.
3231 #        The 'closefd' command can be used to explicitly close the
3232 #        file descriptor when it is no longer needed.
3234 { 'command': 'getfd', 'data': {'fdname': 'str'} }
3237 # @closefd:
3239 # Close a file descriptor previously passed via SCM rights
3241 # @fdname: file descriptor name
3243 # Returns: Nothing on success
3245 # Since: 0.14.0
3247 { 'command': 'closefd', 'data': {'fdname': 'str'} }
3250 # @MachineInfo:
3252 # Information describing a machine.
3254 # @name: the name of the machine
3256 # @alias: #optional an alias for the machine name
3258 # @default: #optional whether the machine is default
3260 # @cpu-max: maximum number of CPUs supported by the machine type
3261 #           (since 1.5.0)
3263 # Since: 1.2.0
3265 { 'type': 'MachineInfo',
3266   'data': { 'name': 'str', '*alias': 'str',
3267             '*is-default': 'bool', 'cpu-max': 'int' } }
3270 # @query-machines:
3272 # Return a list of supported machines
3274 # Returns: a list of MachineInfo
3276 # Since: 1.2.0
3278 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
3281 # @CpuDefinitionInfo:
3283 # Virtual CPU definition.
3285 # @name: the name of the CPU definition
3287 # Since: 1.2.0
3289 { 'type': 'CpuDefinitionInfo',
3290   'data': { 'name': 'str' } }
3293 # @query-cpu-definitions:
3295 # Return a list of supported virtual CPU definitions
3297 # Returns: a list of CpuDefInfo
3299 # Since: 1.2.0
3301 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
3303 # @AddfdInfo:
3305 # Information about a file descriptor that was added to an fd set.
3307 # @fdset-id: The ID of the fd set that @fd was added to.
3309 # @fd: The file descriptor that was received via SCM rights and
3310 #      added to the fd set.
3312 # Since: 1.2.0
3314 { 'type': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
3317 # @add-fd:
3319 # Add a file descriptor, that was passed via SCM rights, to an fd set.
3321 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
3323 # @opaque: #optional A free-form string that can be used to describe the fd.
3325 # Returns: @AddfdInfo on success
3326 #          If file descriptor was not received, FdNotSupplied
3327 #          If @fdset-id is a negative value, InvalidParameterValue
3329 # Notes: The list of fd sets is shared by all monitor connections.
3331 #        If @fdset-id is not specified, a new fd set will be created.
3333 # Since: 1.2.0
3335 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
3336   'returns': 'AddfdInfo' }
3339 # @remove-fd:
3341 # Remove a file descriptor from an fd set.
3343 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
3345 # @fd: #optional The file descriptor that is to be removed.
3347 # Returns: Nothing on success
3348 #          If @fdset-id or @fd is not found, FdNotFound
3350 # Since: 1.2.0
3352 # Notes: The list of fd sets is shared by all monitor connections.
3354 #        If @fd is not specified, all file descriptors in @fdset-id
3355 #        will be removed.
3357 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
3360 # @FdsetFdInfo:
3362 # Information about a file descriptor that belongs to an fd set.
3364 # @fd: The file descriptor value.
3366 # @opaque: #optional A free-form string that can be used to describe the fd.
3368 # Since: 1.2.0
3370 { 'type': 'FdsetFdInfo',
3371   'data': {'fd': 'int', '*opaque': 'str'} }
3374 # @FdsetInfo:
3376 # Information about an fd set.
3378 # @fdset-id: The ID of the fd set.
3380 # @fds: A list of file descriptors that belong to this fd set.
3382 # Since: 1.2.0
3384 { 'type': 'FdsetInfo',
3385   'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
3388 # @query-fdsets:
3390 # Return information describing all fd sets.
3392 # Returns: A list of @FdsetInfo
3394 # Since: 1.2.0
3396 # Note: The list of fd sets is shared by all monitor connections.
3399 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
3402 # @TargetInfo:
3404 # Information describing the QEMU target.
3406 # @arch: the target architecture (eg "x86_64", "i386", etc)
3408 # Since: 1.2.0
3410 { 'type': 'TargetInfo',
3411   'data': { 'arch': 'str' } }
3414 # @query-target:
3416 # Return information about the target for this QEMU
3418 # Returns: TargetInfo
3420 # Since: 1.2.0
3422 { 'command': 'query-target', 'returns': 'TargetInfo' }
3425 # @QKeyCode:
3427 # An enumeration of key name.
3429 # This is used by the send-key command.
3431 # Since: 1.3.0
3433 { 'enum': 'QKeyCode',
3434   'data': [ 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
3435             'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
3436             '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
3437             'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
3438             'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
3439             'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
3440             'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
3441             'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
3442             'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
3443             'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
3444             'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
3445             'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
3446             'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
3447             'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
3448              'lf', 'help', 'meta_l', 'meta_r', 'compose' ] }
3451 # @KeyValue
3453 # Represents a keyboard key.
3455 # Since: 1.3.0
3457 { 'union': 'KeyValue',
3458   'data': {
3459     'number': 'int',
3460     'qcode': 'QKeyCode' } }
3463 # @send-key:
3465 # Send keys to guest.
3467 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
3468 #        simultaneously sent to the guest. A @KeyValue.number value is sent
3469 #        directly to the guest, while @KeyValue.qcode must be a valid
3470 #        @QKeyCode value
3472 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
3473 #             to 100
3475 # Returns: Nothing on success
3476 #          If key is unknown or redundant, InvalidParameter
3478 # Since: 1.3.0
3481 { 'command': 'send-key',
3482   'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
3485 # @screendump:
3487 # Write a PPM of the VGA screen to a file.
3489 # @filename: the path of a new PPM file to store the image
3491 # Returns: Nothing on success
3493 # Since: 0.14.0
3495 { 'command': 'screendump', 'data': {'filename': 'str'} }
3498 # @nbd-server-start:
3500 # Start an NBD server listening on the given host and port.  Block
3501 # devices can then be exported using @nbd-server-add.  The NBD
3502 # server will present them as named exports; for example, another
3503 # QEMU instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
3505 # @addr: Address on which to listen.
3507 # Returns: error if the server is already running.
3509 # Since: 1.3.0
3511 { 'command': 'nbd-server-start',
3512   'data': { 'addr': 'SocketAddress' } }
3515 # @nbd-server-add:
3517 # Export a device to QEMU's embedded NBD server.
3519 # @device: Block device to be exported
3521 # @writable: Whether clients should be able to write to the device via the
3522 #     NBD connection (default false). #optional
3524 # Returns: error if the device is already marked for export.
3526 # Since: 1.3.0
3528 { 'command': 'nbd-server-add', 'data': {'device': 'str', '*writable': 'bool'} }
3531 # @nbd-server-stop:
3533 # Stop QEMU's embedded NBD server, and unregister all devices previously
3534 # added via @nbd-server-add.
3536 # Since: 1.3.0
3538 { 'command': 'nbd-server-stop' }
3541 # @ChardevFile:
3543 # Configuration info for file chardevs.
3545 # @in:  #optional The name of the input file
3546 # @out: The name of the output file
3548 # Since: 1.4
3550 { 'type': 'ChardevFile', 'data': { '*in' : 'str',
3551                                    'out' : 'str' } }
3554 # @ChardevHostdev:
3556 # Configuration info for device and pipe chardevs.
3558 # @device: The name of the special file for the device,
3559 #          i.e. /dev/ttyS0 on Unix or COM1: on Windows
3560 # @type: What kind of device this is.
3562 # Since: 1.4
3564 { 'type': 'ChardevHostdev', 'data': { 'device' : 'str' } }
3567 # @ChardevSocket:
3569 # Configuration info for (stream) socket chardevs.
3571 # @addr: socket address to listen on (server=true)
3572 #        or connect to (server=false)
3573 # @server: #optional create server socket (default: true)
3574 # @wait: #optional wait for incoming connection on server
3575 #        sockets (default: false).
3576 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
3577 # @telnet: #optional enable telnet protocol on server
3578 #          sockets (default: false)
3580 # Since: 1.4
3582 { 'type': 'ChardevSocket', 'data': { 'addr'     : 'SocketAddress',
3583                                      '*server'  : 'bool',
3584                                      '*wait'    : 'bool',
3585                                      '*nodelay' : 'bool',
3586                                      '*telnet'  : 'bool' } }
3589 # @ChardevUdp:
3591 # Configuration info for datagram socket chardevs.
3593 # @remote: remote address
3594 # @local: #optional local address
3596 # Since: 1.5
3598 { 'type': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
3599                                   '*local' : 'SocketAddress' } }
3602 # @ChardevMux:
3604 # Configuration info for mux chardevs.
3606 # @chardev: name of the base chardev.
3608 # Since: 1.5
3610 { 'type': 'ChardevMux', 'data': { 'chardev' : 'str' } }
3613 # @ChardevStdio:
3615 # Configuration info for stdio chardevs.
3617 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
3618 #          be delivered to qemu.  Default: true in -nographic mode,
3619 #          false otherwise.
3621 # Since: 1.5
3623 { 'type': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
3626 # @ChardevSpiceChannel:
3628 # Configuration info for spice vm channel chardevs.
3630 # @type: kind of channel (for example vdagent).
3632 # Since: 1.5
3634 { 'type': 'ChardevSpiceChannel', 'data': { 'type'  : 'str' } }
3637 # @ChardevSpicePort:
3639 # Configuration info for spice port chardevs.
3641 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
3643 # Since: 1.5
3645 { 'type': 'ChardevSpicePort', 'data': { 'fqdn'  : 'str' } }
3648 # @ChardevVC:
3650 # Configuration info for virtual console chardevs.
3652 # @width:  console width,  in pixels
3653 # @height: console height, in pixels
3654 # @cols:   console width,  in chars
3655 # @rows:   console height, in chars
3657 # Since: 1.5
3659 { 'type': 'ChardevVC', 'data': { '*width'  : 'int',
3660                                  '*height' : 'int',
3661                                  '*cols'   : 'int',
3662                                  '*rows'   : 'int' } }
3665 # @ChardevRingbuf:
3667 # Configuration info for ring buffer chardevs.
3669 # @size: #optional ring buffer size, must be power of two, default is 65536
3671 # Since: 1.5
3673 { 'type': 'ChardevRingbuf', 'data': { '*size'  : 'int' } }
3676 # @ChardevBackend:
3678 # Configuration info for the new chardev backend.
3680 # Since: 1.4
3682 { 'type': 'ChardevDummy', 'data': { } }
3684 { 'union': 'ChardevBackend', 'data': { 'file'   : 'ChardevFile',
3685                                        'serial' : 'ChardevHostdev',
3686                                        'parallel': 'ChardevHostdev',
3687                                        'pipe'   : 'ChardevHostdev',
3688                                        'socket' : 'ChardevSocket',
3689                                        'udp'    : 'ChardevUdp',
3690                                        'pty'    : 'ChardevDummy',
3691                                        'null'   : 'ChardevDummy',
3692                                        'mux'    : 'ChardevMux',
3693                                        'msmouse': 'ChardevDummy',
3694                                        'braille': 'ChardevDummy',
3695                                        'stdio'  : 'ChardevStdio',
3696                                        'console': 'ChardevDummy',
3697                                        'spicevmc' : 'ChardevSpiceChannel',
3698                                        'spiceport' : 'ChardevSpicePort',
3699                                        'vc'     : 'ChardevVC',
3700                                        'ringbuf': 'ChardevRingbuf',
3701                                        # next one is just for compatibility
3702                                        'memory' : 'ChardevRingbuf' } }
3705 # @ChardevReturn:
3707 # Return info about the chardev backend just created.
3709 # @pty: #optional name of the slave pseudoterminal device, present if
3710 #       and only if a chardev of type 'pty' was created
3712 # Since: 1.4
3714 { 'type' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3717 # @chardev-add:
3719 # Add a character device backend
3721 # @id: the chardev's ID, must be unique
3722 # @backend: backend type and parameters
3724 # Returns: ChardevReturn.
3726 # Since: 1.4
3728 { 'command': 'chardev-add', 'data': {'id'      : 'str',
3729                                      'backend' : 'ChardevBackend' },
3730   'returns': 'ChardevReturn' }
3733 # @chardev-remove:
3735 # Remove a character device backend
3737 # @id: the chardev's ID, must exist and not be in use
3739 # Returns: Nothing on success
3741 # Since: 1.4
3743 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3746 # @TpmModel:
3748 # An enumeration of TPM models
3750 # @tpm-tis: TPM TIS model
3752 # Since: 1.5
3754 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3757 # @query-tpm-models:
3759 # Return a list of supported TPM models
3761 # Returns: a list of TpmModel
3763 # Since: 1.5
3765 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3768 # @TpmType:
3770 # An enumeration of TPM types
3772 # @passthrough: TPM passthrough type
3774 # Since: 1.5
3776 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3779 # @query-tpm-types:
3781 # Return a list of supported TPM types
3783 # Returns: a list of TpmType
3785 # Since: 1.5
3787 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3790 # @TPMPassthroughOptions:
3792 # Information about the TPM passthrough type
3794 # @path: #optional string describing the path used for accessing the TPM device
3796 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3797 #               for cancellation of TPM commands while they are executing
3799 # Since: 1.5
3801 { 'type': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3802                                              '*cancel-path' : 'str'} }
3805 # @TpmTypeOptions:
3807 # A union referencing different TPM backend types' configuration options
3809 # @passthrough: The configuration options for the TPM passthrough type
3811 # Since: 1.5
3813 { 'union': 'TpmTypeOptions',
3814    'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3817 # @TpmInfo:
3819 # Information about the TPM
3821 # @id: The Id of the TPM
3823 # @model: The TPM frontend model
3825 # @options: The TPM (backend) type configuration options
3827 # Since: 1.5
3829 { 'type': 'TPMInfo',
3830   'data': {'id': 'str',
3831            'model': 'TpmModel',
3832            'options': 'TpmTypeOptions' } }
3835 # @query-tpm:
3837 # Return information about the TPM device
3839 # Returns: @TPMInfo on success
3841 # Since: 1.5
3843 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3846 # @AcpiTableOptions
3848 # Specify an ACPI table on the command line to load.
3850 # At most one of @file and @data can be specified. The list of files specified
3851 # by any one of them is loaded and concatenated in order. If both are omitted,
3852 # @data is implied.
3854 # Other fields / optargs can be used to override fields of the generic ACPI
3855 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3856 # Description Table Header. If a header field is not overridden, then the
3857 # corresponding value from the concatenated blob is used (in case of @file), or
3858 # it is filled in with a hard-coded value (in case of @data).
3860 # String fields are copied into the matching ACPI member from lowest address
3861 # upwards, and silently truncated / NUL-padded to length.
3863 # @sig: #optional table signature / identifier (4 bytes)
3865 # @rev: #optional table revision number (dependent on signature, 1 byte)
3867 # @oem_id: #optional OEM identifier (6 bytes)
3869 # @oem_table_id: #optional OEM table identifier (8 bytes)
3871 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3873 # @asl_compiler_id: #optional identifier of the utility that created the table
3874 #                   (4 bytes)
3876 # @asl_compiler_rev: #optional revision number of the utility that created the
3877 #                    table (4 bytes)
3879 # @file: #optional colon (:) separated list of pathnames to load and
3880 #        concatenate as table data. The resultant binary blob is expected to
3881 #        have an ACPI table header. At least one file is required. This field
3882 #        excludes @data.
3884 # @data: #optional colon (:) separated list of pathnames to load and
3885 #        concatenate as table data. The resultant binary blob must not have an
3886 #        ACPI table header. At least one file is required. This field excludes
3887 #        @file.
3889 # Since 1.5
3891 { 'type': 'AcpiTableOptions',
3892   'data': {
3893     '*sig':               'str',
3894     '*rev':               'uint8',
3895     '*oem_id':            'str',
3896     '*oem_table_id':      'str',
3897     '*oem_rev':           'uint32',
3898     '*asl_compiler_id':   'str',
3899     '*asl_compiler_rev':  'uint32',
3900     '*file':              'str',
3901     '*data':              'str' }}
3904 # @CommandLineParameterType:
3906 # Possible types for an option parameter.
3908 # @string: accepts a character string
3910 # @boolean: accepts "on" or "off"
3912 # @number: accepts a number
3914 # @size: accepts a number followed by an optional suffix (K)ilo,
3915 #        (M)ega, (G)iga, (T)era
3917 # Since 1.5
3919 { 'enum': 'CommandLineParameterType',
3920   'data': ['string', 'boolean', 'number', 'size'] }
3923 # @CommandLineParameterInfo:
3925 # Details about a single parameter of a command line option.
3927 # @name: parameter name
3929 # @type: parameter @CommandLineParameterType
3931 # @help: #optional human readable text string, not suitable for parsing.
3933 # Since 1.5
3935 { 'type': 'CommandLineParameterInfo',
3936   'data': { 'name': 'str',
3937             'type': 'CommandLineParameterType',
3938             '*help': 'str' } }
3941 # @CommandLineOptionInfo:
3943 # Details about a command line option, including its list of parameter details
3945 # @option: option name
3947 # @parameters: an array of @CommandLineParameterInfo
3949 # Since 1.5
3951 { 'type': 'CommandLineOptionInfo',
3952   'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3955 # @query-command-line-options:
3957 # Query command line option schema.
3959 # @option: #optional option name
3961 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3962 #          @option).  Returns an error if the given @option doesn't exist.
3964 # Since 1.5
3966 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3967  'returns': ['CommandLineOptionInfo'] }
3970 # @X86CPURegister32
3972 # A X86 32-bit register
3974 # Since: 1.5
3976 { 'enum': 'X86CPURegister32',
3977   'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3980 # @X86CPUFeatureWordInfo
3982 # Information about a X86 CPU feature word
3984 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3986 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3987 #                   feature word
3989 # @cpuid-register: Output register containing the feature bits
3991 # @features: value of output register, containing the feature bits
3993 # Since: 1.5
3995 { 'type': 'X86CPUFeatureWordInfo',
3996   'data': { 'cpuid-input-eax': 'int',
3997             '*cpuid-input-ecx': 'int',
3998             'cpuid-register': 'X86CPURegister32',
3999             'features': 'int' } }
4002 # @RxState:
4004 # Packets receiving state
4006 # @normal: filter assigned packets according to the mac-table
4008 # @none: don't receive any assigned packet
4010 # @all: receive all assigned packets
4012 # Since: 1.6
4014 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
4017 # @RxFilterInfo:
4019 # Rx-filter information for a NIC.
4021 # @name: net client name
4023 # @promiscuous: whether promiscuous mode is enabled
4025 # @multicast: multicast receive state
4027 # @unicast: unicast receive state
4029 # @broadcast-allowed: whether to receive broadcast
4031 # @multicast-overflow: multicast table is overflowed or not
4033 # @unicast-overflow: unicast table is overflowed or not
4035 # @main-mac: the main macaddr string
4037 # @vlan-table: a list of active vlan id
4039 # @unicast-table: a list of unicast macaddr string
4041 # @multicast-table: a list of multicast macaddr string
4043 # Since 1.6
4046 { 'type': 'RxFilterInfo',
4047   'data': {
4048     'name':               'str',
4049     'promiscuous':        'bool',
4050     'multicast':          'RxState',
4051     'unicast':            'RxState',
4052     'broadcast-allowed':  'bool',
4053     'multicast-overflow': 'bool',
4054     'unicast-overflow':   'bool',
4055     'main-mac':           'str',
4056     'vlan-table':         ['int'],
4057     'unicast-table':      ['str'],
4058     'multicast-table':    ['str'] }}
4061 # @query-rx-filter:
4063 # Return rx-filter information for all NICs (or for the given NIC).
4065 # @name: #optional net client name
4067 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
4068 #          Returns an error if the given @name doesn't exist, or given
4069 #          NIC doesn't support rx-filter querying, or given net client
4070 #          isn't a NIC.
4072 # Since: 1.6
4074 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
4075   'returns': ['RxFilterInfo'] }
4079 # @BlockdevDiscardOptions
4081 # Determines how to handle discard requests.
4083 # @ignore:      Ignore the request
4084 # @unmap:       Forward as an unmap request
4086 # Since: 1.7
4088 { 'enum': 'BlockdevDiscardOptions',
4089   'data': [ 'ignore', 'unmap' ] }
4092 # @BlockdevAioOptions
4094 # Selects the AIO backend to handle I/O requests
4096 # @threads:     Use qemu's thread pool
4097 # @native:      Use native AIO backend (only Linux and Windows)
4099 # Since: 1.7
4101 { 'enum': 'BlockdevAioOptions',
4102   'data': [ 'threads', 'native' ] }
4105 # @BlockdevCacheOptions
4107 # Includes cache-related options for block devices
4109 # @writeback:   #optional enables writeback mode for any caches (default: true)
4110 # @direct:      #optional enables use of O_DIRECT (bypass the host page cache;
4111 #               default: false)
4112 # @no-flush:    #optional ignore any flush requests for the device (default:
4113 #               false)
4115 # Since: 1.7
4117 { 'type': 'BlockdevCacheOptions',
4118   'data': { '*writeback': 'bool',
4119             '*direct': 'bool',
4120             '*no-flush': 'bool' } }
4123 # @BlockdevOptionsBase
4125 # Options that are available for all block devices, independent of the block
4126 # driver.
4128 # @driver:      block driver name
4129 # @id:          #optional id by which the new block device can be referred to.
4130 #               This is a required option on the top level of blockdev-add, and
4131 #               currently not allowed on any other level.
4132 # @node-name:   #optional the name of a block driver state node (Since 2.0)
4133 # @discard:     #optional discard-related options (default: ignore)
4134 # @cache:       #optional cache-related options
4135 # @aio:         #optional AIO backend (default: threads)
4136 # @rerror:      #optional how to handle read errors on the device
4137 #               (default: report)
4138 # @werror:      #optional how to handle write errors on the device
4139 #               (default: enospc)
4140 # @read-only:   #optional whether the block device should be read-only
4141 #               (default: false)
4143 # Since: 1.7
4145 { 'type': 'BlockdevOptionsBase',
4146   'data': { 'driver': 'str',
4147             '*id': 'str',
4148             '*node-name': 'str',
4149             '*discard': 'BlockdevDiscardOptions',
4150             '*cache': 'BlockdevCacheOptions',
4151             '*aio': 'BlockdevAioOptions',
4152             '*rerror': 'BlockdevOnError',
4153             '*werror': 'BlockdevOnError',
4154             '*read-only': 'bool' } }
4157 # @BlockdevOptionsFile
4159 # Driver specific block device options for the file backend and similar
4160 # protocols.
4162 # @filename:    path to the image file
4164 # Since: 1.7
4166 { 'type': 'BlockdevOptionsFile',
4167   'data': { 'filename': 'str' } }
4170 # @BlockdevOptionsVVFAT
4172 # Driver specific block device options for the vvfat protocol.
4174 # @dir:         directory to be exported as FAT image
4175 # @fat-type:    #optional FAT type: 12, 16 or 32
4176 # @floppy:      #optional whether to export a floppy image (true) or
4177 #               partitioned hard disk (false; default)
4178 # @rw:          #optional whether to allow write operations (default: false)
4180 # Since: 1.7
4182 { 'type': 'BlockdevOptionsVVFAT',
4183   'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
4184             '*rw': 'bool' } }
4187 # @BlockdevOptionsGenericFormat
4189 # Driver specific block device options for image format that have no option
4190 # besides their data source.
4192 # @file:        reference to or definition of the data source block device
4194 # Since: 1.7
4196 { 'type': 'BlockdevOptionsGenericFormat',
4197   'data': { 'file': 'BlockdevRef' } }
4200 # @BlockdevOptionsGenericCOWFormat
4202 # Driver specific block device options for image format that have no option
4203 # besides their data source and an optional backing file.
4205 # @backing:     #optional reference to or definition of the backing file block
4206 #               device (if missing, taken from the image file content). It is
4207 #               allowed to pass an empty string here in order to disable the
4208 #               default backing file.
4210 # Since: 1.7
4212 { 'type': 'BlockdevOptionsGenericCOWFormat',
4213   'base': 'BlockdevOptionsGenericFormat',
4214   'data': { '*backing': 'BlockdevRef' } }
4217 # @BlockdevOptionsQcow2
4219 # Driver specific block device options for qcow2.
4221 # @lazy-refcounts:        #optional whether to enable the lazy refcounts
4222 #                         feature (default is taken from the image file)
4224 # @pass-discard-request:  #optional whether discard requests to the qcow2
4225 #                         device should be forwarded to the data source
4227 # @pass-discard-snapshot: #optional whether discard requests for the data source
4228 #                         should be issued when a snapshot operation (e.g.
4229 #                         deleting a snapshot) frees clusters in the qcow2 file
4231 # @pass-discard-other:    #optional whether discard requests for the data source
4232 #                         should be issued on other occasions where a cluster
4233 #                         gets freed
4235 # Since: 1.7
4237 { 'type': 'BlockdevOptionsQcow2',
4238   'base': 'BlockdevOptionsGenericCOWFormat',
4239   'data': { '*lazy-refcounts': 'bool',
4240             '*pass-discard-request': 'bool',
4241             '*pass-discard-snapshot': 'bool',
4242             '*pass-discard-other': 'bool' } }
4245 # @BlkdebugEvent
4247 # Trigger events supported by blkdebug.
4249 { 'enum': 'BlkdebugEvent',
4250   'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table',
4251             'l1_grow.activate_table', 'l2_load', 'l2_update',
4252             'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write',
4253             'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
4254             'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
4255             'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
4256             'refblock_load', 'refblock_update', 'refblock_update_part',
4257             'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write',
4258             'refblock_alloc.write_blocks', 'refblock_alloc.write_table',
4259             'refblock_alloc.switch_table', 'cluster_alloc',
4260             'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
4261             'flush_to_disk' ] }
4264 # @BlkdebugInjectErrorOptions
4266 # Describes a single error injection for blkdebug.
4268 # @event:       trigger event
4270 # @state:       #optional the state identifier blkdebug needs to be in to
4271 #               actually trigger the event; defaults to "any"
4273 # @errno:       #optional error identifier (errno) to be returned; defaults to
4274 #               EIO
4276 # @sector:      #optional specifies the sector index which has to be affected
4277 #               in order to actually trigger the event; defaults to "any
4278 #               sector"
4280 # @once:        #optional disables further events after this one has been
4281 #               triggered; defaults to false
4283 # @immediately: #optional fail immediately; defaults to false
4285 # Since: 2.0
4287 { 'type': 'BlkdebugInjectErrorOptions',
4288   'data': { 'event': 'BlkdebugEvent',
4289             '*state': 'int',
4290             '*errno': 'int',
4291             '*sector': 'int',
4292             '*once': 'bool',
4293             '*immediately': 'bool' } }
4296 # @BlkdebugSetStateOptions
4298 # Describes a single state-change event for blkdebug.
4300 # @event:       trigger event
4302 # @state:       #optional the current state identifier blkdebug needs to be in;
4303 #               defaults to "any"
4305 # @new_state:   the state identifier blkdebug is supposed to assume if
4306 #               this event is triggered
4308 # Since: 2.0
4310 { 'type': 'BlkdebugSetStateOptions',
4311   'data': { 'event': 'BlkdebugEvent',
4312             '*state': 'int',
4313             'new_state': 'int' } }
4316 # @BlockdevOptionsBlkdebug
4318 # Driver specific block device options for blkdebug.
4320 # @image:           underlying raw block device (or image file)
4322 # @config:          #optional filename of the configuration file
4324 # @align:           #optional required alignment for requests in bytes
4326 # @inject-error:    #optional array of error injection descriptions
4328 # @set-state:       #optional array of state-change descriptions
4330 # Since: 2.0
4332 { 'type': 'BlockdevOptionsBlkdebug',
4333   'data': { 'image': 'BlockdevRef',
4334             '*config': 'str',
4335             '*align': 'int',
4336             '*inject-error': ['BlkdebugInjectErrorOptions'],
4337             '*set-state': ['BlkdebugSetStateOptions'] } }
4340 # @BlockdevOptionsBlkverify
4342 # Driver specific block device options for blkverify.
4344 # @test:    block device to be tested
4346 # @raw:     raw image used for verification
4348 # Since: 2.0
4350 { 'type': 'BlockdevOptionsBlkverify',
4351   'data': { 'test': 'BlockdevRef',
4352             'raw': 'BlockdevRef' } }
4355 # @BlockdevOptions
4357 # Options for creating a block device.
4359 # Since: 1.7
4361 { 'union': 'BlockdevOptions',
4362   'base': 'BlockdevOptionsBase',
4363   'discriminator': 'driver',
4364   'data': {
4365       'file':       'BlockdevOptionsFile',
4366       'http':       'BlockdevOptionsFile',
4367       'https':      'BlockdevOptionsFile',
4368       'ftp':        'BlockdevOptionsFile',
4369       'ftps':       'BlockdevOptionsFile',
4370       'tftp':       'BlockdevOptionsFile',
4371 # TODO gluster: Wait for structured options
4372 # TODO iscsi: Wait for structured options
4373 # TODO nbd: Should take InetSocketAddress for 'host'?
4374 # TODO rbd: Wait for structured options
4375 # TODO sheepdog: Wait for structured options
4376 # TODO ssh: Should take InetSocketAddress for 'host'?
4377       'vvfat':      'BlockdevOptionsVVFAT',
4378       'blkdebug':   'BlockdevOptionsBlkdebug',
4379       'blkverify':  'BlockdevOptionsBlkverify',
4380       'bochs':      'BlockdevOptionsGenericFormat',
4381       'cloop':      'BlockdevOptionsGenericFormat',
4382       'cow':        'BlockdevOptionsGenericCOWFormat',
4383       'dmg':        'BlockdevOptionsGenericFormat',
4384       'parallels':  'BlockdevOptionsGenericFormat',
4385       'qcow':       'BlockdevOptionsGenericCOWFormat',
4386       'qcow2':      'BlockdevOptionsQcow2',
4387       'qed':        'BlockdevOptionsGenericCOWFormat',
4388       'raw':        'BlockdevOptionsGenericFormat',
4389       'vdi':        'BlockdevOptionsGenericFormat',
4390       'vhdx':       'BlockdevOptionsGenericFormat',
4391       'vmdk':       'BlockdevOptionsGenericCOWFormat',
4392       'vpc':        'BlockdevOptionsGenericFormat'
4393   } }
4396 # @BlockdevRef
4398 # Reference to a block device.
4400 # @definition:      defines a new block device inline
4401 # @reference:       references the ID of an existing block device. An
4402 #                   empty string means that no block device should be
4403 #                   referenced.
4405 # Since: 1.7
4407 { 'union': 'BlockdevRef',
4408   'discriminator': {},
4409   'data': { 'definition': 'BlockdevOptions',
4410             'reference': 'str' } }
4413 # @blockdev-add:
4415 # Creates a new block device.
4417 # @options: block device options for the new device
4419 # Since: 1.7
4421 { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } }