3 # This work is licensed under the terms of the GNU GPL, version 2 or later.
4 # See the COPYING file in the top-level directory.
13 # The comprehensive enumeration of QEMU system emulation ("softmmu")
14 # targets. Run "./configure --help" in the project root directory, and
15 # look for the *-softmmu targets near the "--target-list" option. The
16 # individual target constants are not documented here, for the time
19 # Notes: The resulting QMP strings can be appended to the "qemu-system-"
20 # prefix to produce the corresponding QEMU executable name. This
21 # is true even for "qemu-system-x86_64".
23 # ppcemb: dropped in 3.1
27 { 'enum' : 'SysEmuTarget',
28 'data' : [ 'aarch64', 'alpha', 'arm', 'cris', 'hppa', 'i386', 'lm32',
29 'm68k', 'microblaze', 'microblazeel', 'mips', 'mips64',
30 'mips64el', 'mipsel', 'moxie', 'nios2', 'or1k', 'ppc',
31 'ppc64', 'riscv32', 'riscv64', 's390x', 'sh4',
32 'sh4eb', 'sparc', 'sparc64', 'tricore', 'unicore32',
33 'x86_64', 'xtensa', 'xtensaeb' ] }
38 # An enumeration of cpu types that enable additional information during
39 # @query-cpus and @query-cpus-fast.
47 { 'enum': 'CpuInfoArch',
48 'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 's390', 'riscv', 'other' ] }
53 # Information about a virtual CPU
55 # @CPU: the index of the virtual CPU
57 # @current: this only exists for backwards compatibility and should be ignored
59 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
60 # to a processor specific low power mode.
62 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
64 # @thread_id: ID of the underlying host thread
66 # @props: properties describing to which node/socket/core/thread
67 # virtual CPU belongs to, provided if supported by board (since 2.10)
69 # @arch: architecture of the cpu, which determines which additional fields
70 # will be listed (since 2.6)
74 # Notes: @halted is a transient state that changes frequently. By the time the
75 # data is sent to the client, the guest may no longer be halted.
78 'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
79 'qom_path': 'str', 'thread_id': 'int',
80 '*props': 'CpuInstanceProperties', 'arch': 'CpuInfoArch' },
81 'discriminator': 'arch',
82 'data': { 'x86': 'CpuInfoX86',
83 'sparc': 'CpuInfoSPARC',
85 'mips': 'CpuInfoMIPS',
86 'tricore': 'CpuInfoTricore',
87 's390': 'CpuInfoS390',
88 'riscv': 'CpuInfoRISCV' } }
93 # Additional information about a virtual i386 or x86_64 CPU
95 # @pc: the 64-bit instruction pointer
99 { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
104 # Additional information about a virtual SPARC CPU
106 # @pc: the PC component of the instruction pointer
108 # @npc: the NPC component of the instruction pointer
112 { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
117 # Additional information about a virtual PPC CPU
119 # @nip: the instruction pointer
123 { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
128 # Additional information about a virtual MIPS CPU
130 # @PC: the instruction pointer
134 { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
139 # Additional information about a virtual Tricore CPU
141 # @PC: the instruction pointer
145 { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
150 # Additional information about a virtual RISCV CPU
152 # @pc: the instruction pointer
156 { 'struct': 'CpuInfoRISCV', 'data': { 'pc': 'int' } }
161 # An enumeration of cpu states that can be assumed by a virtual
166 { 'enum': 'CpuS390State',
167 'prefix': 'S390_CPU_STATE',
168 'data': [ 'uninitialized', 'stopped', 'check-stop', 'operating', 'load' ] }
173 # Additional information about a virtual S390 CPU
175 # @cpu-state: the virtual CPU's state
179 { 'struct': 'CpuInfoS390', 'data': { 'cpu-state': 'CpuS390State' } }
184 # Returns a list of information about each virtual CPU.
186 # This command causes vCPU threads to exit to userspace, which causes
187 # a small interruption to guest CPU execution. This will have a negative
188 # impact on realtime guests and other latency sensitive guest workloads.
189 # It is recommended to use @query-cpus-fast instead of this command to
190 # avoid the vCPU interruption.
192 # Returns: a list of @CpuInfo for each virtual CPU
198 # -> { "execute": "query-cpus" }
204 # "qom_path":"/machine/unattached/device[0]",
213 # "qom_path":"/machine/unattached/device[2]",
221 # Notes: This interface is deprecated (since 2.12.0), and it is strongly
222 # recommended that you avoid using it. Use @query-cpus-fast to
223 # obtain information about virtual CPUs.
226 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
231 # Information about a virtual CPU
233 # @cpu-index: index of the virtual CPU
235 # @qom-path: path to the CPU object in the QOM tree
237 # @thread-id: ID of the underlying host thread
239 # @props: properties describing to which node/socket/core/thread
240 # virtual CPU belongs to, provided if supported by board
242 # @arch: base architecture of the cpu; deprecated since 3.0.0 in favor
245 # @target: the QEMU system emulation target, which determines which
246 # additional fields will be listed (since 3.0)
251 { 'union' : 'CpuInfoFast',
252 'base' : { 'cpu-index' : 'int',
255 '*props' : 'CpuInstanceProperties',
256 'arch' : 'CpuInfoArch',
257 'target' : 'SysEmuTarget' },
258 'discriminator' : 'target',
259 'data' : { 's390x' : 'CpuInfoS390' } }
264 # Returns information about all virtual CPUs. This command does not
265 # incur a performance penalty and should be used in production
266 # instead of query-cpus.
268 # Returns: list of @CpuInfoFast
274 # -> { "execute": "query-cpus-fast" }
277 # "thread-id": 25627,
283 # "qom-path": "/machine/unattached/device[0]",
289 # "thread-id": 25628,
295 # "qom-path": "/machine/unattached/device[2]",
303 { 'command': 'query-cpus-fast', 'returns': [ 'CpuInfoFast' ] }
308 # Adds CPU with specified ID.
310 # @id: ID of CPU to be created, valid values [0..max_cpus)
312 # Returns: Nothing on success
316 # Note: This command is deprecated. The `device_add` command should be
317 # used instead. See the `query-hotpluggable-cpus` command for
322 # -> { "execute": "cpu-add", "arguments": { "id": 2 } }
323 # <- { "return": {} }
326 { 'command': 'cpu-add', 'data': {'id': 'int'} }
331 # Information describing a machine.
333 # @name: the name of the machine
335 # @alias: an alias for the machine name
337 # @is-default: whether the machine is default
339 # @cpu-max: maximum number of CPUs supported by the machine type
342 # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0)
344 # @numa-mem-supported: true if '-numa node,mem' option is supported by
345 # the machine type and false otherwise (since 4.1)
347 # @deprecated: if true, the machine type is deprecated and may be removed
348 # in future versions of QEMU according to the QEMU deprecation
349 # policy (since 4.1.0)
353 { 'struct': 'MachineInfo',
354 'data': { 'name': 'str', '*alias': 'str',
355 '*is-default': 'bool', 'cpu-max': 'int',
356 'hotpluggable-cpus': 'bool', 'numa-mem-supported': 'bool',
357 'deprecated': 'bool' } }
362 # Return a list of supported machines
364 # Returns: a list of MachineInfo
368 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
371 # @CurrentMachineParams:
373 # Information describing the running machine parameters.
375 # @wakeup-suspend-support: true if the machine supports wake up from
380 { 'struct': 'CurrentMachineParams',
381 'data': { 'wakeup-suspend-support': 'bool'} }
384 # @query-current-machine:
386 # Return information on the current virtual machine.
388 # Returns: CurrentMachineParams
392 { 'command': 'query-current-machine', 'returns': 'CurrentMachineParams' }
397 # Information describing the QEMU target.
399 # @arch: the target architecture
403 { 'struct': 'TargetInfo',
404 'data': { 'arch': 'SysEmuTarget' } }
409 # Return information about the target for this QEMU
411 # Returns: TargetInfo
415 { 'command': 'query-target', 'returns': 'TargetInfo' }
420 # @node: NUMA nodes configuration
422 # @dist: NUMA distance configuration (since 2.10)
424 # @cpu: property based CPU(s) to node mapping (Since: 2.10)
428 { 'enum': 'NumaOptionsType',
429 'data': [ 'node', 'dist', 'cpu' ] }
434 # A discriminated record of NUMA options. (for OptsVisitor)
438 { 'union': 'NumaOptions',
439 'base': { 'type': 'NumaOptionsType' },
440 'discriminator': 'type',
442 'node': 'NumaNodeOptions',
443 'dist': 'NumaDistOptions',
444 'cpu': 'NumaCpuOptions' }}
449 # Create a guest NUMA node. (for OptsVisitor)
451 # @nodeid: NUMA node ID (increase by 1 from 0 if omitted)
453 # @cpus: VCPUs belonging to this node (assign VCPUS round-robin
456 # @mem: memory size of this node; mutually exclusive with @memdev.
457 # Equally divide total memory among nodes if both @mem and @memdev are
460 # @memdev: memory backend object. If specified for one node,
461 # it must be specified for all nodes.
465 { 'struct': 'NumaNodeOptions',
475 # Set the distance between 2 NUMA nodes.
477 # @src: source NUMA node.
479 # @dst: destination NUMA node.
481 # @val: NUMA distance from source node to destination node.
482 # When a node is unreachable from another node, set the distance
483 # between them to 255.
487 { 'struct': 'NumaDistOptions',
496 # A X86 32-bit register
500 { 'enum': 'X86CPURegister32',
501 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
504 # @X86CPUFeatureWordInfo:
506 # Information about a X86 CPU feature word
508 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
510 # @cpuid-input-ecx: Input ECX value for CPUID instruction for that
513 # @cpuid-register: Output register containing the feature bits
515 # @features: value of output register, containing the feature bits
519 { 'struct': 'X86CPUFeatureWordInfo',
520 'data': { 'cpuid-input-eax': 'int',
521 '*cpuid-input-ecx': 'int',
522 'cpuid-register': 'X86CPURegister32',
523 'features': 'int' } }
528 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
532 { 'struct': 'DummyForceArrays',
533 'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
538 # Option "-numa cpu" overrides default cpu to node mapping.
539 # It accepts the same set of cpu properties as returned by
540 # query-hotpluggable-cpus[].props, where node-id could be used to
541 # override default node mapping.
545 { 'struct': 'NumaCpuOptions',
546 'base': 'CpuInstanceProperties',
552 # Host memory policy types
554 # @default: restore default policy, remove any nondefault policy
556 # @preferred: set the preferred host nodes for allocation
558 # @bind: a strict policy that restricts memory allocation to the
559 # host nodes specified
561 # @interleave: memory allocations are interleaved across the set
562 # of host nodes specified
566 { 'enum': 'HostMemPolicy',
567 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
572 # Information about memory backend
574 # @id: backend's ID if backend has 'id' property (since 2.9)
576 # @size: memory backend size
578 # @merge: enables or disables memory merge support
580 # @dump: includes memory backend's memory in a core dump or not
582 # @prealloc: enables or disables memory preallocation
584 # @host-nodes: host nodes for its memory policy
586 # @policy: memory policy of memory backend
590 { 'struct': 'Memdev',
597 'host-nodes': ['uint16'],
598 'policy': 'HostMemPolicy' }}
603 # Returns information for all memory backends.
605 # Returns: a list of @Memdev.
611 # -> { "execute": "query-memdev" }
619 # "host-nodes": [0, 1],
627 # "host-nodes": [2, 3],
628 # "policy": "preferred"
634 { 'command': 'query-memdev', 'returns': ['Memdev'], 'allow-preconfig': true }
637 # @CpuInstanceProperties:
639 # List of properties to be used for hotplugging a CPU instance,
640 # it should be passed by management with device_add command when
641 # a CPU is being hotplugged.
643 # @node-id: NUMA node ID the CPU belongs to
644 # @socket-id: socket number within node/board the CPU belongs to
645 # @die-id: die number within node/board the CPU belongs to (Since 4.1)
646 # @core-id: core number within die the CPU belongs to# @thread-id: thread number within core the CPU belongs to
648 # Note: currently there are 5 properties that could be present
649 # but management should be prepared to pass through other
650 # properties with device_add command to allow for future
651 # interface extension. This also requires the filed names to be kept in
652 # sync with the properties passed to -device/device_add.
656 { 'struct': 'CpuInstanceProperties',
657 'data': { '*node-id': 'int',
668 # @type: CPU object type for usage with device_add command
669 # @props: list of properties to be used for hotplugging CPU
670 # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
671 # @qom-path: link to existing CPU object if CPU is present or
672 # omitted if CPU is not present.
676 { 'struct': 'HotpluggableCPU',
677 'data': { 'type': 'str',
678 'vcpus-count': 'int',
679 'props': 'CpuInstanceProperties',
685 # @query-hotpluggable-cpus:
687 # TODO: Better documentation; currently there is none.
689 # Returns: a list of HotpluggableCPU objects.
695 # For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8:
697 # -> { "execute": "query-hotpluggable-cpus" }
699 # { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core",
700 # "vcpus-count": 1 },
701 # { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core",
702 # "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
705 # For pc machine type started with -smp 1,maxcpus=2:
707 # -> { "execute": "query-hotpluggable-cpus" }
710 # "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
711 # "props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
714 # "qom-path": "/machine/unattached/device[0]",
715 # "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
716 # "props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
720 # For s390x-virtio-ccw machine type started with -smp 1,maxcpus=2 -cpu qemu
723 # -> { "execute": "query-hotpluggable-cpus" }
726 # "type": "qemu-s390x-cpu", "vcpus-count": 1,
727 # "props": { "core-id": 1 }
730 # "qom-path": "/machine/unattached/device[0]",
731 # "type": "qemu-s390x-cpu", "vcpus-count": 1,
732 # "props": { "core-id": 0 }
737 { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'],
738 'allow-preconfig': true }
743 # Runtime equivalent of '-numa' CLI option, available at
744 # preconfigure stage to configure numa mapping before initializing
749 { 'command': 'set-numa-node', 'boxed': true,
750 'data': 'NumaOptions',
751 'allow-preconfig': true