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)
351 # @default-cpu-type: default CPU model typename if none is requested via
352 # the -cpu argument. (since 4.2)
356 { 'struct': 'MachineInfo',
357 'data': { 'name': 'str', '*alias': 'str',
358 '*is-default': 'bool', 'cpu-max': 'int',
359 'hotpluggable-cpus': 'bool', 'numa-mem-supported': 'bool',
360 'deprecated': 'bool', '*default-cpu-type': 'str' } }
365 # Return a list of supported machines
367 # Returns: a list of MachineInfo
371 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
374 # @CurrentMachineParams:
376 # Information describing the running machine parameters.
378 # @wakeup-suspend-support: true if the machine supports wake up from
383 { 'struct': 'CurrentMachineParams',
384 'data': { 'wakeup-suspend-support': 'bool'} }
387 # @query-current-machine:
389 # Return information on the current virtual machine.
391 # Returns: CurrentMachineParams
395 { 'command': 'query-current-machine', 'returns': 'CurrentMachineParams' }
400 # Information describing the QEMU target.
402 # @arch: the target architecture
406 { 'struct': 'TargetInfo',
407 'data': { 'arch': 'SysEmuTarget' } }
412 # Return information about the target for this QEMU
414 # Returns: TargetInfo
418 { 'command': 'query-target', 'returns': 'TargetInfo' }
423 # @node: NUMA nodes configuration
425 # @dist: NUMA distance configuration (since 2.10)
427 # @cpu: property based CPU(s) to node mapping (Since: 2.10)
429 # @hmat-lb: memory latency and bandwidth information (Since: 5.0)
433 { 'enum': 'NumaOptionsType',
434 'data': [ 'node', 'dist', 'cpu', 'hmat-lb' ] }
439 # A discriminated record of NUMA options. (for OptsVisitor)
443 { 'union': 'NumaOptions',
444 'base': { 'type': 'NumaOptionsType' },
445 'discriminator': 'type',
447 'node': 'NumaNodeOptions',
448 'dist': 'NumaDistOptions',
449 'cpu': 'NumaCpuOptions',
450 'hmat-lb': 'NumaHmatLBOptions' }}
455 # Create a guest NUMA node. (for OptsVisitor)
457 # @nodeid: NUMA node ID (increase by 1 from 0 if omitted)
459 # @cpus: VCPUs belonging to this node (assign VCPUS round-robin
462 # @mem: memory size of this node; mutually exclusive with @memdev.
463 # Equally divide total memory among nodes if both @mem and @memdev are
466 # @memdev: memory backend object. If specified for one node,
467 # it must be specified for all nodes.
469 # @initiator: defined in ACPI 6.3 Chapter 5.2.27.3 Table 5-145,
470 # points to the nodeid which has the memory controller
471 # responsible for this NUMA node. This field provides
472 # additional information as to the initiator node that
473 # is closest (as in directly attached) to this node, and
474 # therefore has the best performance (since 5.0)
478 { 'struct': 'NumaNodeOptions',
484 '*initiator': 'uint16' }}
489 # Set the distance between 2 NUMA nodes.
491 # @src: source NUMA node.
493 # @dst: destination NUMA node.
495 # @val: NUMA distance from source node to destination node.
496 # When a node is unreachable from another node, set the distance
497 # between them to 255.
501 { 'struct': 'NumaDistOptions',
510 # A X86 32-bit register
514 { 'enum': 'X86CPURegister32',
515 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
518 # @X86CPUFeatureWordInfo:
520 # Information about a X86 CPU feature word
522 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
524 # @cpuid-input-ecx: Input ECX value for CPUID instruction for that
527 # @cpuid-register: Output register containing the feature bits
529 # @features: value of output register, containing the feature bits
533 { 'struct': 'X86CPUFeatureWordInfo',
534 'data': { 'cpuid-input-eax': 'int',
535 '*cpuid-input-ecx': 'int',
536 'cpuid-register': 'X86CPURegister32',
537 'features': 'int' } }
542 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
546 { 'struct': 'DummyForceArrays',
547 'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
552 # Option "-numa cpu" overrides default cpu to node mapping.
553 # It accepts the same set of cpu properties as returned by
554 # query-hotpluggable-cpus[].props, where node-id could be used to
555 # override default node mapping.
559 { 'struct': 'NumaCpuOptions',
560 'base': 'CpuInstanceProperties',
564 # @HmatLBMemoryHierarchy:
566 # The memory hierarchy in the System Locality Latency and Bandwidth
567 # Information Structure of HMAT (Heterogeneous Memory Attribute Table)
569 # For more information about @HmatLBMemoryHierarchy, see chapter
570 # 5.2.27.4: Table 5-146: Field "Flags" of ACPI 6.3 spec.
572 # @memory: the structure represents the memory performance
574 # @first-level: first level of memory side cache
576 # @second-level: second level of memory side cache
578 # @third-level: third level of memory side cache
582 { 'enum': 'HmatLBMemoryHierarchy',
583 'data': [ 'memory', 'first-level', 'second-level', 'third-level' ] }
588 # Data type in the System Locality Latency and Bandwidth
589 # Information Structure of HMAT (Heterogeneous Memory Attribute Table)
591 # For more information about @HmatLBDataType, see chapter
592 # 5.2.27.4: Table 5-146: Field "Data Type" of ACPI 6.3 spec.
594 # @access-latency: access latency (nanoseconds)
596 # @read-latency: read latency (nanoseconds)
598 # @write-latency: write latency (nanoseconds)
600 # @access-bandwidth: access bandwidth (Bytes per second)
602 # @read-bandwidth: read bandwidth (Bytes per second)
604 # @write-bandwidth: write bandwidth (Bytes per second)
608 { 'enum': 'HmatLBDataType',
609 'data': [ 'access-latency', 'read-latency', 'write-latency',
610 'access-bandwidth', 'read-bandwidth', 'write-bandwidth' ] }
613 # @NumaHmatLBOptions:
615 # Set the system locality latency and bandwidth information
616 # between Initiator and Target proximity Domains.
618 # For more information about @NumaHmatLBOptions, see chapter
619 # 5.2.27.4: Table 5-146 of ACPI 6.3 spec.
621 # @initiator: the Initiator Proximity Domain.
623 # @target: the Target Proximity Domain.
625 # @hierarchy: the Memory Hierarchy. Indicates the performance
626 # of memory or side cache.
628 # @data-type: presents the type of data, access/read/write
629 # latency or hit latency.
631 # @latency: the value of latency from @initiator to @target
632 # proximity domain, the latency unit is "ns(nanosecond)".
634 # @bandwidth: the value of bandwidth between @initiator and @target
635 # proximity domain, the bandwidth unit is
636 # "Bytes per second".
640 { 'struct': 'NumaHmatLBOptions',
642 'initiator': 'uint16',
644 'hierarchy': 'HmatLBMemoryHierarchy',
645 'data-type': 'HmatLBDataType',
646 '*latency': 'uint64',
647 '*bandwidth': 'size' }}
652 # Host memory policy types
654 # @default: restore default policy, remove any nondefault policy
656 # @preferred: set the preferred host nodes for allocation
658 # @bind: a strict policy that restricts memory allocation to the
659 # host nodes specified
661 # @interleave: memory allocations are interleaved across the set
662 # of host nodes specified
666 { 'enum': 'HostMemPolicy',
667 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
672 # Information about memory backend
674 # @id: backend's ID if backend has 'id' property (since 2.9)
676 # @size: memory backend size
678 # @merge: enables or disables memory merge support
680 # @dump: includes memory backend's memory in a core dump or not
682 # @prealloc: enables or disables memory preallocation
684 # @host-nodes: host nodes for its memory policy
686 # @policy: memory policy of memory backend
690 { 'struct': 'Memdev',
697 'host-nodes': ['uint16'],
698 'policy': 'HostMemPolicy' }}
703 # Returns information for all memory backends.
705 # Returns: a list of @Memdev.
711 # -> { "execute": "query-memdev" }
719 # "host-nodes": [0, 1],
727 # "host-nodes": [2, 3],
728 # "policy": "preferred"
734 { 'command': 'query-memdev', 'returns': ['Memdev'], 'allow-preconfig': true }
737 # @CpuInstanceProperties:
739 # List of properties to be used for hotplugging a CPU instance,
740 # it should be passed by management with device_add command when
741 # a CPU is being hotplugged.
743 # @node-id: NUMA node ID the CPU belongs to
744 # @socket-id: socket number within node/board the CPU belongs to
745 # @die-id: die number within node/board the CPU belongs to (Since 4.1)
746 # @core-id: core number within die the CPU belongs to# @thread-id: thread number within core the CPU belongs to
748 # Note: currently there are 5 properties that could be present
749 # but management should be prepared to pass through other
750 # properties with device_add command to allow for future
751 # interface extension. This also requires the filed names to be kept in
752 # sync with the properties passed to -device/device_add.
756 { 'struct': 'CpuInstanceProperties',
757 'data': { '*node-id': 'int',
768 # @type: CPU object type for usage with device_add command
769 # @props: list of properties to be used for hotplugging CPU
770 # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
771 # @qom-path: link to existing CPU object if CPU is present or
772 # omitted if CPU is not present.
776 { 'struct': 'HotpluggableCPU',
777 'data': { 'type': 'str',
778 'vcpus-count': 'int',
779 'props': 'CpuInstanceProperties',
785 # @query-hotpluggable-cpus:
787 # TODO: Better documentation; currently there is none.
789 # Returns: a list of HotpluggableCPU objects.
795 # For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8:
797 # -> { "execute": "query-hotpluggable-cpus" }
799 # { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core",
800 # "vcpus-count": 1 },
801 # { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core",
802 # "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
805 # For pc machine type started with -smp 1,maxcpus=2:
807 # -> { "execute": "query-hotpluggable-cpus" }
810 # "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
811 # "props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
814 # "qom-path": "/machine/unattached/device[0]",
815 # "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
816 # "props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
820 # For s390x-virtio-ccw machine type started with -smp 1,maxcpus=2 -cpu qemu
823 # -> { "execute": "query-hotpluggable-cpus" }
826 # "type": "qemu-s390x-cpu", "vcpus-count": 1,
827 # "props": { "core-id": 1 }
830 # "qom-path": "/machine/unattached/device[0]",
831 # "type": "qemu-s390x-cpu", "vcpus-count": 1,
832 # "props": { "core-id": 0 }
837 { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'],
838 'allow-preconfig': true }
843 # Runtime equivalent of '-numa' CLI option, available at
844 # preconfigure stage to configure numa mapping before initializing
849 { 'command': 'set-numa-node', 'boxed': true,
850 'data': 'NumaOptions',
851 'allow-preconfig': true