xref: /qemu/qapi/machine.json (revision 209e64d9)
1# -*- Mode: Python -*-
2# vim: filetype=python
3#
4# This work is licensed under the terms of the GNU GPL, version 2 or later.
5# See the COPYING file in the top-level directory.
6
7##
8# = Machines
9##
10
11{ 'include': 'common.json' }
12{ 'include': 'machine-common.json' }
13
14##
15# @SysEmuTarget:
16#
17# The comprehensive enumeration of QEMU system emulation ("softmmu")
18# targets.  Run "./configure --help" in the project root directory,
19# and look for the \*-softmmu targets near the "--target-list" option.
20# The individual target constants are not documented here, for the
21# time being.
22#
23# @rx: since 5.0
24#
25# @avr: since 5.1
26#
27# Notes: The resulting QMP strings can be appended to the
28#     "qemu-system-" prefix to produce the corresponding QEMU
29#     executable name.  This is true even for "qemu-system-x86_64".
30#
31# Since: 3.0
32##
33{ 'enum' : 'SysEmuTarget',
34  'data' : [ 'aarch64', 'alpha', 'arm', 'avr', 'cris', 'hppa', 'i386',
35             'loongarch64', 'm68k', 'microblaze', 'microblazeel', 'mips', 'mips64',
36             'mips64el', 'mipsel', 'nios2', 'or1k', 'ppc',
37             'ppc64', 'riscv32', 'riscv64', 'rx', 's390x', 'sh4',
38             'sh4eb', 'sparc', 'sparc64', 'tricore',
39             'x86_64', 'xtensa', 'xtensaeb' ] }
40
41##
42# @CpuS390State:
43#
44# An enumeration of cpu states that can be assumed by a virtual S390
45# CPU
46#
47# Since: 2.12
48##
49{ 'enum': 'CpuS390State',
50  'prefix': 'S390_CPU_STATE',
51  'data': [ 'uninitialized', 'stopped', 'check-stop', 'operating', 'load' ] }
52
53##
54# @CpuInfoS390:
55#
56# Additional information about a virtual S390 CPU
57#
58# @cpu-state: the virtual CPU's state
59#
60# @dedicated: the virtual CPU's dedication (since 8.2)
61#
62# @entitlement: the virtual CPU's entitlement (since 8.2)
63#
64# Since: 2.12
65##
66{ 'struct': 'CpuInfoS390',
67  'data': { 'cpu-state': 'CpuS390State',
68            '*dedicated': 'bool',
69            '*entitlement': 'CpuS390Entitlement' } }
70
71##
72# @CpuInfoFast:
73#
74# Information about a virtual CPU
75#
76# @cpu-index: index of the virtual CPU
77#
78# @qom-path: path to the CPU object in the QOM tree
79#
80# @thread-id: ID of the underlying host thread
81#
82# @props: properties associated with a virtual CPU, e.g. the socket id
83#
84# @target: the QEMU system emulation target, which determines which
85#     additional fields will be listed (since 3.0)
86#
87# Since: 2.12
88##
89{ 'union'         : 'CpuInfoFast',
90  'base'          : { 'cpu-index'    : 'int',
91                      'qom-path'     : 'str',
92                      'thread-id'    : 'int',
93                      '*props'       : 'CpuInstanceProperties',
94                      'target'       : 'SysEmuTarget' },
95  'discriminator' : 'target',
96  'data'          : { 's390x'        : 'CpuInfoS390' } }
97
98##
99# @query-cpus-fast:
100#
101# Returns information about all virtual CPUs.
102#
103# Returns: list of @CpuInfoFast
104#
105# Since: 2.12
106#
107# Example:
108#
109#     -> { "execute": "query-cpus-fast" }
110#     <- { "return": [
111#             {
112#                 "thread-id": 25627,
113#                 "props": {
114#                     "core-id": 0,
115#                     "thread-id": 0,
116#                     "socket-id": 0
117#                 },
118#                 "qom-path": "/machine/unattached/device[0]",
119#                 "target":"x86_64",
120#                 "cpu-index": 0
121#             },
122#             {
123#                 "thread-id": 25628,
124#                 "props": {
125#                     "core-id": 0,
126#                     "thread-id": 0,
127#                     "socket-id": 1
128#                 },
129#                 "qom-path": "/machine/unattached/device[2]",
130#                 "target":"x86_64",
131#                 "cpu-index": 1
132#             }
133#         ]
134#     }
135##
136{ 'command': 'query-cpus-fast', 'returns': [ 'CpuInfoFast' ] }
137
138##
139# @MachineInfo:
140#
141# Information describing a machine.
142#
143# @name: the name of the machine
144#
145# @alias: an alias for the machine name
146#
147# @is-default: whether the machine is default
148#
149# @cpu-max: maximum number of CPUs supported by the machine type
150#     (since 1.5)
151#
152# @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7)
153#
154# @numa-mem-supported: true if '-numa node,mem' option is supported by
155#     the machine type and false otherwise (since 4.1)
156#
157# @deprecated: if true, the machine type is deprecated and may be
158#     removed in future versions of QEMU according to the QEMU
159#     deprecation policy (since 4.1)
160#
161# @default-cpu-type: default CPU model typename if none is requested
162#     via the -cpu argument.  (since 4.2)
163#
164# @default-ram-id: the default ID of initial RAM memory backend (since
165#     5.2)
166#
167# @acpi: machine type supports ACPI (since 8.0)
168#
169# Since: 1.2
170##
171{ 'struct': 'MachineInfo',
172  'data': { 'name': 'str', '*alias': 'str',
173            '*is-default': 'bool', 'cpu-max': 'int',
174            'hotpluggable-cpus': 'bool',  'numa-mem-supported': 'bool',
175            'deprecated': 'bool', '*default-cpu-type': 'str',
176            '*default-ram-id': 'str', 'acpi': 'bool' } }
177
178##
179# @query-machines:
180#
181# Return a list of supported machines
182#
183# Returns: a list of MachineInfo
184#
185# Since: 1.2
186##
187{ 'command': 'query-machines', 'returns': ['MachineInfo'] }
188
189##
190# @CurrentMachineParams:
191#
192# Information describing the running machine parameters.
193#
194# @wakeup-suspend-support: true if the machine supports wake up from
195#     suspend
196#
197# Since: 4.0
198##
199{ 'struct': 'CurrentMachineParams',
200  'data': { 'wakeup-suspend-support': 'bool'} }
201
202##
203# @query-current-machine:
204#
205# Return information on the current virtual machine.
206#
207# Returns: CurrentMachineParams
208#
209# Since: 4.0
210##
211{ 'command': 'query-current-machine', 'returns': 'CurrentMachineParams' }
212
213##
214# @TargetInfo:
215#
216# Information describing the QEMU target.
217#
218# @arch: the target architecture
219#
220# Since: 1.2
221##
222{ 'struct': 'TargetInfo',
223  'data': { 'arch': 'SysEmuTarget' } }
224
225##
226# @query-target:
227#
228# Return information about the target for this QEMU
229#
230# Returns: TargetInfo
231#
232# Since: 1.2
233##
234{ 'command': 'query-target', 'returns': 'TargetInfo' }
235
236##
237# @UuidInfo:
238#
239# Guest UUID information (Universally Unique Identifier).
240#
241# @UUID: the UUID of the guest
242#
243# Since: 0.14
244#
245# Notes: If no UUID was specified for the guest, a null UUID is
246#     returned.
247##
248{ 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
249
250##
251# @query-uuid:
252#
253# Query the guest UUID information.
254#
255# Returns: The @UuidInfo for the guest
256#
257# Since: 0.14
258#
259# Example:
260#
261#     -> { "execute": "query-uuid" }
262#     <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
263##
264{ 'command': 'query-uuid', 'returns': 'UuidInfo', 'allow-preconfig': true }
265
266##
267# @GuidInfo:
268#
269# GUID information.
270#
271# @guid: the globally unique identifier
272#
273# Since: 2.9
274##
275{ 'struct': 'GuidInfo', 'data': {'guid': 'str'} }
276
277##
278# @query-vm-generation-id:
279#
280# Show Virtual Machine Generation ID
281#
282# Since: 2.9
283##
284{ 'command': 'query-vm-generation-id', 'returns': 'GuidInfo' }
285
286##
287# @system_reset:
288#
289# Performs a hard reset of a guest.
290#
291# Since: 0.14
292#
293# Example:
294#
295#     -> { "execute": "system_reset" }
296#     <- { "return": {} }
297##
298{ 'command': 'system_reset' }
299
300##
301# @system_powerdown:
302#
303# Requests that a guest perform a powerdown operation.
304#
305# Since: 0.14
306#
307# Notes: A guest may or may not respond to this command.  This command
308#     returning does not indicate that a guest has accepted the
309#     request or that it has shut down.  Many guests will respond to
310#     this command by prompting the user in some way.
311#
312# Example:
313#
314#     -> { "execute": "system_powerdown" }
315#     <- { "return": {} }
316##
317{ 'command': 'system_powerdown' }
318
319##
320# @system_wakeup:
321#
322# Wake up guest from suspend.  If the guest has wake-up from suspend
323# support enabled (wakeup-suspend-support flag from
324# query-current-machine), wake-up guest from suspend if the guest is
325# in SUSPENDED state.  Return an error otherwise.
326#
327# Since: 1.1
328#
329# Note: prior to 4.0, this command does nothing in case the guest
330#     isn't suspended.
331#
332# Example:
333#
334#     -> { "execute": "system_wakeup" }
335#     <- { "return": {} }
336##
337{ 'command': 'system_wakeup' }
338
339##
340# @LostTickPolicy:
341#
342# Policy for handling lost ticks in timer devices.  Ticks end up
343# getting lost when, for example, the guest is paused.
344#
345# @discard: throw away the missed ticks and continue with future
346#     injection normally.  The guest OS will see the timer jump ahead
347#     by a potentially quite significant amount all at once, as if the
348#     intervening chunk of time had simply not existed; needless to
349#     say, such a sudden jump can easily confuse a guest OS which is
350#     not specifically prepared to deal with it.  Assuming the guest
351#     OS can deal correctly with the time jump, the time in the guest
352#     and in the host should now match.
353#
354# @delay: continue to deliver ticks at the normal rate.  The guest OS
355#     will not notice anything is amiss, as from its point of view
356#     time will have continued to flow normally.  The time in the
357#     guest should now be behind the time in the host by exactly the
358#     amount of time during which ticks have been missed.
359#
360# @slew: deliver ticks at a higher rate to catch up with the missed
361#     ticks.  The guest OS will not notice anything is amiss, as from
362#     its point of view time will have continued to flow normally.
363#     Once the timer has managed to catch up with all the missing
364#     ticks, the time in the guest and in the host should match.
365#
366# Since: 2.0
367##
368{ 'enum': 'LostTickPolicy',
369  'data': ['discard', 'delay', 'slew' ] }
370
371##
372# @inject-nmi:
373#
374# Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or
375# all CPUs (ppc64). The command fails when the guest doesn't support
376# injecting.
377#
378# Since: 0.14
379#
380# Note: prior to 2.1, this command was only supported for x86 and s390
381#     VMs
382#
383# Example:
384#
385#     -> { "execute": "inject-nmi" }
386#     <- { "return": {} }
387##
388{ 'command': 'inject-nmi' }
389
390##
391# @KvmInfo:
392#
393# Information about support for KVM acceleration
394#
395# @enabled: true if KVM acceleration is active
396#
397# @present: true if KVM acceleration is built into this executable
398#
399# Since: 0.14
400##
401{ 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
402
403##
404# @query-kvm:
405#
406# Returns information about KVM acceleration
407#
408# Returns: @KvmInfo
409#
410# Since: 0.14
411#
412# Example:
413#
414#     -> { "execute": "query-kvm" }
415#     <- { "return": { "enabled": true, "present": true } }
416##
417{ 'command': 'query-kvm', 'returns': 'KvmInfo' }
418
419##
420# @NumaOptionsType:
421#
422# @node: NUMA nodes configuration
423#
424# @dist: NUMA distance configuration (since 2.10)
425#
426# @cpu: property based CPU(s) to node mapping (Since: 2.10)
427#
428# @hmat-lb: memory latency and bandwidth information (Since: 5.0)
429#
430# @hmat-cache: memory side cache information (Since: 5.0)
431#
432# Since: 2.1
433##
434{ 'enum': 'NumaOptionsType',
435  'data': [ 'node', 'dist', 'cpu', 'hmat-lb', 'hmat-cache' ] }
436
437##
438# @NumaOptions:
439#
440# A discriminated record of NUMA options.  (for OptsVisitor)
441#
442# @type: NUMA option type
443#
444# Since: 2.1
445##
446{ 'union': 'NumaOptions',
447  'base': { 'type': 'NumaOptionsType' },
448  'discriminator': 'type',
449  'data': {
450    'node': 'NumaNodeOptions',
451    'dist': 'NumaDistOptions',
452    'cpu': 'NumaCpuOptions',
453    'hmat-lb': 'NumaHmatLBOptions',
454    'hmat-cache': 'NumaHmatCacheOptions' }}
455
456##
457# @NumaNodeOptions:
458#
459# Create a guest NUMA node.  (for OptsVisitor)
460#
461# @nodeid: NUMA node ID (increase by 1 from 0 if omitted)
462#
463# @cpus: VCPUs belonging to this node (assign VCPUS round-robin if
464#     omitted)
465#
466# @mem: memory size of this node; mutually exclusive with @memdev.
467#     Equally divide total memory among nodes if both @mem and @memdev
468#     are omitted.
469#
470# @memdev: memory backend object.  If specified for one node, it must
471#     be specified for all nodes.
472#
473# @initiator: defined in ACPI 6.3 Chapter 5.2.27.3 Table 5-145, points
474#     to the nodeid which has the memory controller responsible for
475#     this NUMA node.  This field provides additional information as
476#     to the initiator node that is closest (as in directly attached)
477#     to this node, and therefore has the best performance (since 5.0)
478#
479# Since: 2.1
480##
481{ 'struct': 'NumaNodeOptions',
482  'data': {
483   '*nodeid': 'uint16',
484   '*cpus':   ['uint16'],
485   '*mem':    'size',
486   '*memdev': 'str',
487   '*initiator': 'uint16' }}
488
489##
490# @NumaDistOptions:
491#
492# Set the distance between 2 NUMA nodes.
493#
494# @src: source NUMA node.
495#
496# @dst: destination NUMA node.
497#
498# @val: NUMA distance from source node to destination node.  When a
499#     node is unreachable from another node, set the distance between
500#     them to 255.
501#
502# Since: 2.10
503##
504{ 'struct': 'NumaDistOptions',
505  'data': {
506   'src': 'uint16',
507   'dst': 'uint16',
508   'val': 'uint8' }}
509
510##
511# @CXLFixedMemoryWindowOptions:
512#
513# Create a CXL Fixed Memory Window
514#
515# @size: Size of the Fixed Memory Window in bytes.  Must be a multiple
516#     of 256MiB.
517#
518# @interleave-granularity: Number of contiguous bytes for which
519#     accesses will go to a given interleave target.  Accepted values
520#     [256, 512, 1k, 2k, 4k, 8k, 16k]
521#
522# @targets: Target root bridge IDs from -device ...,id=<ID> for each
523#     root bridge.
524#
525# Since: 7.1
526##
527{ 'struct': 'CXLFixedMemoryWindowOptions',
528  'data': {
529      'size': 'size',
530      '*interleave-granularity': 'size',
531      'targets': ['str'] }}
532
533##
534# @CXLFMWProperties:
535#
536# List of CXL Fixed Memory Windows.
537#
538# @cxl-fmw: List of CXLFixedMemoryWindowOptions
539#
540# Since: 7.1
541##
542{ 'struct' : 'CXLFMWProperties',
543  'data': { 'cxl-fmw': ['CXLFixedMemoryWindowOptions'] }
544}
545
546##
547# @X86CPURegister32:
548#
549# A X86 32-bit register
550#
551# Since: 1.5
552##
553{ 'enum': 'X86CPURegister32',
554  'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
555
556##
557# @X86CPUFeatureWordInfo:
558#
559# Information about a X86 CPU feature word
560#
561# @cpuid-input-eax: Input EAX value for CPUID instruction for that
562#     feature word
563#
564# @cpuid-input-ecx: Input ECX value for CPUID instruction for that
565#     feature word
566#
567# @cpuid-register: Output register containing the feature bits
568#
569# @features: value of output register, containing the feature bits
570#
571# Since: 1.5
572##
573{ 'struct': 'X86CPUFeatureWordInfo',
574  'data': { 'cpuid-input-eax': 'int',
575            '*cpuid-input-ecx': 'int',
576            'cpuid-register': 'X86CPURegister32',
577            'features': 'int' } }
578
579##
580# @DummyForceArrays:
581#
582# Not used by QMP; hack to let us use X86CPUFeatureWordInfoList
583# internally
584#
585# Since: 2.5
586##
587{ 'struct': 'DummyForceArrays',
588  'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
589
590##
591# @NumaCpuOptions:
592#
593# Option "-numa cpu" overrides default cpu to node mapping.  It
594# accepts the same set of cpu properties as returned by
595# query-hotpluggable-cpus[].props, where node-id could be used to
596# override default node mapping.
597#
598# Since: 2.10
599##
600{ 'struct': 'NumaCpuOptions',
601   'base': 'CpuInstanceProperties',
602   'data' : {} }
603
604##
605# @HmatLBMemoryHierarchy:
606#
607# The memory hierarchy in the System Locality Latency and Bandwidth
608# Information Structure of HMAT (Heterogeneous Memory Attribute Table)
609#
610# For more information about @HmatLBMemoryHierarchy, see chapter
611# 5.2.27.4: Table 5-146: Field "Flags" of ACPI 6.3 spec.
612#
613# @memory: the structure represents the memory performance
614#
615# @first-level: first level of memory side cache
616#
617# @second-level: second level of memory side cache
618#
619# @third-level: third level of memory side cache
620#
621# Since: 5.0
622##
623{ 'enum': 'HmatLBMemoryHierarchy',
624  'data': [ 'memory', 'first-level', 'second-level', 'third-level' ] }
625
626##
627# @HmatLBDataType:
628#
629# Data type in the System Locality Latency and Bandwidth Information
630# Structure of HMAT (Heterogeneous Memory Attribute Table)
631#
632# For more information about @HmatLBDataType, see chapter 5.2.27.4:
633# Table 5-146:  Field "Data Type" of ACPI 6.3 spec.
634#
635# @access-latency: access latency (nanoseconds)
636#
637# @read-latency: read latency (nanoseconds)
638#
639# @write-latency: write latency (nanoseconds)
640#
641# @access-bandwidth: access bandwidth (Bytes per second)
642#
643# @read-bandwidth: read bandwidth (Bytes per second)
644#
645# @write-bandwidth: write bandwidth (Bytes per second)
646#
647# Since: 5.0
648##
649{ 'enum': 'HmatLBDataType',
650  'data': [ 'access-latency', 'read-latency', 'write-latency',
651            'access-bandwidth', 'read-bandwidth', 'write-bandwidth' ] }
652
653##
654# @NumaHmatLBOptions:
655#
656# Set the system locality latency and bandwidth information between
657# Initiator and Target proximity Domains.
658#
659# For more information about @NumaHmatLBOptions, see chapter 5.2.27.4:
660# Table 5-146 of ACPI 6.3 spec.
661#
662# @initiator: the Initiator Proximity Domain.
663#
664# @target: the Target Proximity Domain.
665#
666# @hierarchy: the Memory Hierarchy.  Indicates the performance of
667#     memory or side cache.
668#
669# @data-type: presents the type of data, access/read/write latency or
670#     hit latency.
671#
672# @latency: the value of latency from @initiator to @target proximity
673#     domain, the latency unit is "ns(nanosecond)".
674#
675# @bandwidth: the value of bandwidth between @initiator and @target
676#     proximity domain, the bandwidth unit is "Bytes per second".
677#
678# Since: 5.0
679##
680{ 'struct': 'NumaHmatLBOptions',
681    'data': {
682    'initiator': 'uint16',
683    'target': 'uint16',
684    'hierarchy': 'HmatLBMemoryHierarchy',
685    'data-type': 'HmatLBDataType',
686    '*latency': 'uint64',
687    '*bandwidth': 'size' }}
688
689##
690# @HmatCacheAssociativity:
691#
692# Cache associativity in the Memory Side Cache Information Structure
693# of HMAT
694#
695# For more information of @HmatCacheAssociativity, see chapter
696# 5.2.27.5: Table 5-147 of ACPI 6.3 spec.
697#
698# @none: None (no memory side cache in this proximity domain, or cache
699#     associativity unknown)
700#
701# @direct: Direct Mapped
702#
703# @complex: Complex Cache Indexing (implementation specific)
704#
705# Since: 5.0
706##
707{ 'enum': 'HmatCacheAssociativity',
708  'data': [ 'none', 'direct', 'complex' ] }
709
710##
711# @HmatCacheWritePolicy:
712#
713# Cache write policy in the Memory Side Cache Information Structure of
714# HMAT
715#
716# For more information of @HmatCacheWritePolicy, see chapter 5.2.27.5:
717# Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
718#
719# @none: None (no memory side cache in this proximity domain, or cache
720#     write policy unknown)
721#
722# @write-back: Write Back (WB)
723#
724# @write-through: Write Through (WT)
725#
726# Since: 5.0
727##
728{ 'enum': 'HmatCacheWritePolicy',
729  'data': [ 'none', 'write-back', 'write-through' ] }
730
731##
732# @NumaHmatCacheOptions:
733#
734# Set the memory side cache information for a given memory domain.
735#
736# For more information of @NumaHmatCacheOptions, see chapter 5.2.27.5:
737# Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
738#
739# @node-id: the memory proximity domain to which the memory belongs.
740#
741# @size: the size of memory side cache in bytes.
742#
743# @level: the cache level described in this structure.
744#
745# @associativity: the cache associativity,
746#     none/direct-mapped/complex(complex cache indexing).
747#
748# @policy: the write policy, none/write-back/write-through.
749#
750# @line: the cache Line size in bytes.
751#
752# Since: 5.0
753##
754{ 'struct': 'NumaHmatCacheOptions',
755  'data': {
756   'node-id': 'uint32',
757   'size': 'size',
758   'level': 'uint8',
759   'associativity': 'HmatCacheAssociativity',
760   'policy': 'HmatCacheWritePolicy',
761   'line': 'uint16' }}
762
763##
764# @memsave:
765#
766# Save a portion of guest memory to a file.
767#
768# @val: the virtual address of the guest to start from
769#
770# @size: the size of memory region to save
771#
772# @filename: the file to save the memory to as binary data
773#
774# @cpu-index: the index of the virtual CPU to use for translating the
775#     virtual address (defaults to CPU 0)
776#
777# Since: 0.14
778#
779# Notes: Errors were not reliably returned until 1.1
780#
781# Example:
782#
783#     -> { "execute": "memsave",
784#          "arguments": { "val": 10,
785#                         "size": 100,
786#                         "filename": "/tmp/virtual-mem-dump" } }
787#     <- { "return": {} }
788##
789{ 'command': 'memsave',
790  'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
791
792##
793# @pmemsave:
794#
795# Save a portion of guest physical memory to a file.
796#
797# @val: the physical address of the guest to start from
798#
799# @size: the size of memory region to save
800#
801# @filename: the file to save the memory to as binary data
802#
803# Since: 0.14
804#
805# Notes: Errors were not reliably returned until 1.1
806#
807# Example:
808#
809#     -> { "execute": "pmemsave",
810#          "arguments": { "val": 10,
811#                         "size": 100,
812#                         "filename": "/tmp/physical-mem-dump" } }
813#     <- { "return": {} }
814##
815{ 'command': 'pmemsave',
816  'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
817
818##
819# @Memdev:
820#
821# Information about memory backend
822#
823# @id: backend's ID if backend has 'id' property (since 2.9)
824#
825# @size: memory backend size
826#
827# @merge: whether memory merge support is enabled
828#
829# @dump: whether memory backend's memory is included in a core dump
830#
831# @prealloc: whether memory was preallocated
832#
833# @share: whether memory is private to QEMU or shared (since 6.1)
834#
835# @reserve: whether swap space (or huge pages) was reserved if
836#     applicable.  This corresponds to the user configuration and not
837#     the actual behavior implemented in the OS to perform the
838#     reservation.  For example, Linux will never reserve swap space
839#     for shared file mappings.  (since 6.1)
840#
841# @host-nodes: host nodes for its memory policy
842#
843# @policy: memory policy of memory backend
844#
845# Since: 2.1
846##
847{ 'struct': 'Memdev',
848  'data': {
849    '*id':        'str',
850    'size':       'size',
851    'merge':      'bool',
852    'dump':       'bool',
853    'prealloc':   'bool',
854    'share':      'bool',
855    '*reserve':    'bool',
856    'host-nodes': ['uint16'],
857    'policy':     'HostMemPolicy' }}
858
859##
860# @query-memdev:
861#
862# Returns information for all memory backends.
863#
864# Returns: a list of @Memdev.
865#
866# Since: 2.1
867#
868# Example:
869#
870#     -> { "execute": "query-memdev" }
871#     <- { "return": [
872#            {
873#              "id": "mem1",
874#              "size": 536870912,
875#              "merge": false,
876#              "dump": true,
877#              "prealloc": false,
878#              "share": false,
879#              "host-nodes": [0, 1],
880#              "policy": "bind"
881#            },
882#            {
883#              "size": 536870912,
884#              "merge": false,
885#              "dump": true,
886#              "prealloc": true,
887#              "share": false,
888#              "host-nodes": [2, 3],
889#              "policy": "preferred"
890#            }
891#          ]
892#        }
893##
894{ 'command': 'query-memdev', 'returns': ['Memdev'], 'allow-preconfig': true }
895
896##
897# @CpuInstanceProperties:
898#
899# List of properties to be used for hotplugging a CPU instance, it
900# should be passed by management with device_add command when a CPU is
901# being hotplugged.
902#
903# Which members are optional and which mandatory depends on the
904# architecture and board.
905#
906# For s390x see :ref:`cpu-topology-s390x`.
907#
908# The ids other than the node-id specify the position of the CPU
909# within the CPU topology (as defined by the machine property "smp",
910# thus see also type @SMPConfiguration)
911#
912# @node-id: NUMA node ID the CPU belongs to
913#
914# @drawer-id: drawer number within CPU topology the CPU belongs to
915#     (since 8.2)
916#
917# @book-id: book number within parent container the CPU belongs to
918#     (since 8.2)
919#
920# @socket-id: socket number within parent container the CPU belongs to
921#
922# @die-id: die number within the parent container the CPU belongs to
923#    (since 4.1)
924#
925# @cluster-id: cluster number within the parent container the CPU
926#     belongs to (since 7.1)
927#
928# @core-id: core number within the parent container the CPU belongs to
929#
930# @thread-id: thread number within the core the CPU  belongs to
931#
932# Note: management should be prepared to pass through additional
933#     properties with device_add.
934#
935# Since: 2.7
936##
937{ 'struct': 'CpuInstanceProperties',
938  # Keep these in sync with the properties device_add accepts
939  'data': { '*node-id': 'int',
940            '*drawer-id': 'int',
941            '*book-id': 'int',
942            '*socket-id': 'int',
943            '*die-id': 'int',
944            '*cluster-id': 'int',
945            '*core-id': 'int',
946            '*thread-id': 'int'
947  }
948}
949
950##
951# @HotpluggableCPU:
952#
953# @type: CPU object type for usage with device_add command
954#
955# @props: list of properties to be used for hotplugging CPU
956#
957# @vcpus-count: number of logical VCPU threads @HotpluggableCPU
958#     provides
959#
960# @qom-path: link to existing CPU object if CPU is present or omitted
961#     if CPU is not present.
962#
963# Since: 2.7
964##
965{ 'struct': 'HotpluggableCPU',
966  'data': { 'type': 'str',
967            'vcpus-count': 'int',
968            'props': 'CpuInstanceProperties',
969            '*qom-path': 'str'
970          }
971}
972
973##
974# @query-hotpluggable-cpus:
975#
976# TODO: Better documentation; currently there is none.
977#
978# Returns: a list of HotpluggableCPU objects.
979#
980# Since: 2.7
981#
982# Examples:
983#
984#     For pseries machine type started with -smp 2,cores=2,maxcpus=4
985#     -cpu POWER8:
986#
987#     -> { "execute": "query-hotpluggable-cpus" }
988#     <- {"return": [
989#          { "props": { "core-id": 8 }, "type": "POWER8-spapr-cpu-core",
990#            "vcpus-count": 1 },
991#          { "props": { "core-id": 0 }, "type": "POWER8-spapr-cpu-core",
992#            "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
993#        ]}'
994#
995#     For pc machine type started with -smp 1,maxcpus=2:
996#
997#     -> { "execute": "query-hotpluggable-cpus" }
998#     <- {"return": [
999#          {
1000#             "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
1001#             "props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
1002#          },
1003#          {
1004#             "qom-path": "/machine/unattached/device[0]",
1005#             "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
1006#             "props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
1007#          }
1008#        ]}
1009#
1010#     For s390x-virtio-ccw machine type started with -smp 1,maxcpus=2
1011#     -cpu qemu (Since: 2.11):
1012#
1013#     -> { "execute": "query-hotpluggable-cpus" }
1014#     <- {"return": [
1015#          {
1016#             "type": "qemu-s390x-cpu", "vcpus-count": 1,
1017#             "props": { "core-id": 1 }
1018#          },
1019#          {
1020#             "qom-path": "/machine/unattached/device[0]",
1021#             "type": "qemu-s390x-cpu", "vcpus-count": 1,
1022#             "props": { "core-id": 0 }
1023#          }
1024#        ]}
1025##
1026{ 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'],
1027             'allow-preconfig': true }
1028
1029##
1030# @set-numa-node:
1031#
1032# Runtime equivalent of '-numa' CLI option, available at preconfigure
1033# stage to configure numa mapping before initializing machine.
1034#
1035# Since: 3.0
1036##
1037{ 'command': 'set-numa-node', 'boxed': true,
1038  'data': 'NumaOptions',
1039  'allow-preconfig': true
1040}
1041
1042##
1043# @balloon:
1044#
1045# Request the balloon driver to change its balloon size.
1046#
1047# @value: the target logical size of the VM in bytes.  We can deduce
1048#     the size of the balloon using this formula:
1049#
1050#        logical_vm_size = vm_ram_size - balloon_size
1051#
1052#     From it we have: balloon_size = vm_ram_size - @value
1053#
1054# Errors:
1055#     - If the balloon driver is enabled but not functional because
1056#       the KVM kernel module cannot support it, KVMMissingCap
1057#     - If no balloon device is present, DeviceNotActive
1058#
1059# Notes: This command just issues a request to the guest.  When it
1060#     returns, the balloon size may not have changed.  A guest can
1061#     change the balloon size independent of this command.
1062#
1063# Since: 0.14
1064#
1065# Example:
1066#
1067#     -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1068#     <- { "return": {} }
1069#
1070#     With a 2.5GiB guest this command inflated the ballon to 3GiB.
1071##
1072{ 'command': 'balloon', 'data': {'value': 'int'} }
1073
1074##
1075# @BalloonInfo:
1076#
1077# Information about the guest balloon device.
1078#
1079# @actual: the logical size of the VM in bytes Formula used:
1080#     logical_vm_size = vm_ram_size - balloon_size
1081#
1082# Since: 0.14
1083##
1084{ 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1085
1086##
1087# @query-balloon:
1088#
1089# Return information about the balloon device.
1090#
1091# Returns:
1092#     @BalloonInfo
1093#
1094# Errors:
1095#     - If the balloon driver is enabled but not functional because
1096#       the KVM kernel module cannot support it, KVMMissingCap
1097#     - If no balloon device is present, DeviceNotActive
1098#
1099# Since: 0.14
1100#
1101# Example:
1102#
1103#     -> { "execute": "query-balloon" }
1104#     <- { "return": {
1105#              "actual": 1073741824
1106#           }
1107#        }
1108##
1109{ 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1110
1111##
1112# @BALLOON_CHANGE:
1113#
1114# Emitted when the guest changes the actual BALLOON level.  This value
1115# is equivalent to the @actual field return by the 'query-balloon'
1116# command
1117#
1118# @actual: the logical size of the VM in bytes Formula used:
1119#     logical_vm_size = vm_ram_size - balloon_size
1120#
1121# Note: this event is rate-limited.
1122#
1123# Since: 1.2
1124#
1125# Example:
1126#
1127#     <- { "event": "BALLOON_CHANGE",
1128#          "data": { "actual": 944766976 },
1129#          "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
1130##
1131{ 'event': 'BALLOON_CHANGE',
1132  'data': { 'actual': 'int' } }
1133
1134##
1135# @HvBalloonInfo:
1136#
1137# hv-balloon guest-provided memory status information.
1138#
1139# @committed: the amount of memory in use inside the guest plus the
1140#     amount of the memory unusable inside the guest (ballooned out,
1141#     offline, etc.)
1142#
1143# @available: the amount of the memory inside the guest available for
1144#     new allocations ("free")
1145#
1146# Since: 8.2
1147##
1148{ 'struct': 'HvBalloonInfo',
1149  'data': { 'committed': 'size', 'available': 'size' } }
1150
1151##
1152# @query-hv-balloon-status-report:
1153#
1154# Returns the hv-balloon driver data contained in the last received
1155# "STATUS" message from the guest.
1156#
1157# Returns:
1158#     @HvBalloonInfo
1159#
1160# Errors:
1161#     - If no hv-balloon device is present, guest memory status
1162#       reporting is not enabled or no guest memory status report
1163#       received yet, GenericError
1164#
1165# Since: 8.2
1166#
1167# Example:
1168#
1169#     -> { "execute": "query-hv-balloon-status-report" }
1170#     <- { "return": {
1171#              "committed": 816640000,
1172#              "available": 3333054464
1173#           }
1174#        }
1175##
1176{ 'command': 'query-hv-balloon-status-report', 'returns': 'HvBalloonInfo' }
1177
1178##
1179# @HV_BALLOON_STATUS_REPORT:
1180#
1181# Emitted when the hv-balloon driver receives a "STATUS" message from
1182# the guest.
1183#
1184# Note: this event is rate-limited.
1185#
1186# Since: 8.2
1187#
1188# Example:
1189#
1190#     <- { "event": "HV_BALLOON_STATUS_REPORT",
1191#          "data": { "committed": 816640000, "available": 3333054464 },
1192#          "timestamp": { "seconds": 1600295492, "microseconds": 661044 } }
1193#
1194##
1195{ 'event': 'HV_BALLOON_STATUS_REPORT',
1196  'data': 'HvBalloonInfo' }
1197
1198##
1199# @MemoryInfo:
1200#
1201# Actual memory information in bytes.
1202#
1203# @base-memory: size of "base" memory specified with command line
1204#     option -m.
1205#
1206# @plugged-memory: size of memory that can be hot-unplugged.  This
1207#     field is omitted if target doesn't support memory hotplug (i.e.
1208#     CONFIG_MEM_DEVICE not defined at build time).
1209#
1210# Since: 2.11
1211##
1212{ 'struct': 'MemoryInfo',
1213  'data'  : { 'base-memory': 'size', '*plugged-memory': 'size' } }
1214
1215##
1216# @query-memory-size-summary:
1217#
1218# Return the amount of initially allocated and present hotpluggable
1219# (if enabled) memory in bytes.
1220#
1221# Example:
1222#
1223#     -> { "execute": "query-memory-size-summary" }
1224#     <- { "return": { "base-memory": 4294967296, "plugged-memory": 0 } }
1225#
1226# Since: 2.11
1227##
1228{ 'command': 'query-memory-size-summary', 'returns': 'MemoryInfo' }
1229
1230##
1231# @PCDIMMDeviceInfo:
1232#
1233# PCDIMMDevice state information
1234#
1235# @id: device's ID
1236#
1237# @addr: physical address, where device is mapped
1238#
1239# @size: size of memory that the device provides
1240#
1241# @slot: slot number at which device is plugged in
1242#
1243# @node: NUMA node number where device is plugged in
1244#
1245# @memdev: memory backend linked with device
1246#
1247# @hotplugged: true if device was hotplugged
1248#
1249# @hotpluggable: true if device if could be added/removed while
1250#     machine is running
1251#
1252# Since: 2.1
1253##
1254{ 'struct': 'PCDIMMDeviceInfo',
1255  'data': { '*id': 'str',
1256            'addr': 'int',
1257            'size': 'int',
1258            'slot': 'int',
1259            'node': 'int',
1260            'memdev': 'str',
1261            'hotplugged': 'bool',
1262            'hotpluggable': 'bool'
1263          }
1264}
1265
1266##
1267# @VirtioPMEMDeviceInfo:
1268#
1269# VirtioPMEM state information
1270#
1271# @id: device's ID
1272#
1273# @memaddr: physical address in memory, where device is mapped
1274#
1275# @size: size of memory that the device provides
1276#
1277# @memdev: memory backend linked with device
1278#
1279# Since: 4.1
1280##
1281{ 'struct': 'VirtioPMEMDeviceInfo',
1282  'data': { '*id': 'str',
1283            'memaddr': 'size',
1284            'size': 'size',
1285            'memdev': 'str'
1286          }
1287}
1288
1289##
1290# @VirtioMEMDeviceInfo:
1291#
1292# VirtioMEMDevice state information
1293#
1294# @id: device's ID
1295#
1296# @memaddr: physical address in memory, where device is mapped
1297#
1298# @requested-size: the user requested size of the device
1299#
1300# @size: the (current) size of memory that the device provides
1301#
1302# @max-size: the maximum size of memory that the device can provide
1303#
1304# @block-size: the block size of memory that the device provides
1305#
1306# @node: NUMA node number where device is assigned to
1307#
1308# @memdev: memory backend linked with the region
1309#
1310# Since: 5.1
1311##
1312{ 'struct': 'VirtioMEMDeviceInfo',
1313  'data': { '*id': 'str',
1314            'memaddr': 'size',
1315            'requested-size': 'size',
1316            'size': 'size',
1317            'max-size': 'size',
1318            'block-size': 'size',
1319            'node': 'int',
1320            'memdev': 'str'
1321          }
1322}
1323
1324##
1325# @SgxEPCDeviceInfo:
1326#
1327# Sgx EPC state information
1328#
1329# @id: device's ID
1330#
1331# @memaddr: physical address in memory, where device is mapped
1332#
1333# @size: size of memory that the device provides
1334#
1335# @memdev: memory backend linked with device
1336#
1337# @node: the numa node (Since: 7.0)
1338#
1339# Since: 6.2
1340##
1341{ 'struct': 'SgxEPCDeviceInfo',
1342  'data': { '*id': 'str',
1343            'memaddr': 'size',
1344            'size': 'size',
1345            'node': 'int',
1346            'memdev': 'str'
1347          }
1348}
1349
1350##
1351# @HvBalloonDeviceInfo:
1352#
1353# hv-balloon provided memory state information
1354#
1355# @id: device's ID
1356#
1357# @memaddr: physical address in memory, where device is mapped
1358#
1359# @max-size: the maximum size of memory that the device can provide
1360#
1361# @memdev: memory backend linked with device
1362#
1363# Since: 8.2
1364##
1365{ 'struct': 'HvBalloonDeviceInfo',
1366  'data': { '*id': 'str',
1367            '*memaddr': 'size',
1368            'max-size': 'size',
1369            '*memdev': 'str'
1370          }
1371}
1372
1373##
1374# @MemoryDeviceInfoKind:
1375#
1376# @nvdimm: since 2.12
1377#
1378# @virtio-pmem: since 4.1
1379#
1380# @virtio-mem: since 5.1
1381#
1382# @sgx-epc: since 6.2.
1383#
1384# @hv-balloon: since 8.2.
1385#
1386# Since: 2.1
1387##
1388{ 'enum': 'MemoryDeviceInfoKind',
1389  'data': [ 'dimm', 'nvdimm', 'virtio-pmem', 'virtio-mem', 'sgx-epc',
1390            'hv-balloon' ] }
1391
1392##
1393# @PCDIMMDeviceInfoWrapper:
1394#
1395# @data: PCDIMMDevice state information
1396#
1397# Since: 2.1
1398##
1399{ 'struct': 'PCDIMMDeviceInfoWrapper',
1400  'data': { 'data': 'PCDIMMDeviceInfo' } }
1401
1402##
1403# @VirtioPMEMDeviceInfoWrapper:
1404#
1405# @data: VirtioPMEM state information
1406#
1407# Since: 2.1
1408##
1409{ 'struct': 'VirtioPMEMDeviceInfoWrapper',
1410  'data': { 'data': 'VirtioPMEMDeviceInfo' } }
1411
1412##
1413# @VirtioMEMDeviceInfoWrapper:
1414#
1415# @data: VirtioMEMDevice state information
1416#
1417# Since: 2.1
1418##
1419{ 'struct': 'VirtioMEMDeviceInfoWrapper',
1420  'data': { 'data': 'VirtioMEMDeviceInfo' } }
1421
1422##
1423# @SgxEPCDeviceInfoWrapper:
1424#
1425# @data: Sgx EPC state information
1426#
1427# Since: 6.2
1428##
1429{ 'struct': 'SgxEPCDeviceInfoWrapper',
1430  'data': { 'data': 'SgxEPCDeviceInfo' } }
1431
1432##
1433# @HvBalloonDeviceInfoWrapper:
1434#
1435# @data: hv-balloon provided memory state information
1436#
1437# Since: 8.2
1438##
1439{ 'struct': 'HvBalloonDeviceInfoWrapper',
1440  'data': { 'data': 'HvBalloonDeviceInfo' } }
1441
1442##
1443# @MemoryDeviceInfo:
1444#
1445# Union containing information about a memory device
1446#
1447# @type: memory device type
1448#
1449# Since: 2.1
1450##
1451{ 'union': 'MemoryDeviceInfo',
1452  'base': { 'type': 'MemoryDeviceInfoKind' },
1453  'discriminator': 'type',
1454  'data': { 'dimm': 'PCDIMMDeviceInfoWrapper',
1455            'nvdimm': 'PCDIMMDeviceInfoWrapper',
1456            'virtio-pmem': 'VirtioPMEMDeviceInfoWrapper',
1457            'virtio-mem': 'VirtioMEMDeviceInfoWrapper',
1458            'sgx-epc': 'SgxEPCDeviceInfoWrapper',
1459            'hv-balloon': 'HvBalloonDeviceInfoWrapper'
1460          }
1461}
1462
1463##
1464# @SgxEPC:
1465#
1466# Sgx EPC cmdline information
1467#
1468# @memdev: memory backend linked with device
1469#
1470# @node: the numa node (Since: 7.0)
1471#
1472# Since: 6.2
1473##
1474{ 'struct': 'SgxEPC',
1475  'data': { 'memdev': 'str',
1476            'node': 'int'
1477          }
1478}
1479
1480##
1481# @SgxEPCProperties:
1482#
1483# SGX properties of machine types.
1484#
1485# @sgx-epc: list of ids of memory-backend-epc objects.
1486#
1487# Since: 6.2
1488##
1489{ 'struct': 'SgxEPCProperties',
1490  'data': { 'sgx-epc': ['SgxEPC'] }
1491}
1492
1493##
1494# @query-memory-devices:
1495#
1496# Lists available memory devices and their state
1497#
1498# Since: 2.1
1499#
1500# Example:
1501#
1502#     -> { "execute": "query-memory-devices" }
1503#     <- { "return": [ { "data":
1504#                           { "addr": 5368709120,
1505#                             "hotpluggable": true,
1506#                             "hotplugged": true,
1507#                             "id": "d1",
1508#                             "memdev": "/objects/memX",
1509#                             "node": 0,
1510#                             "size": 1073741824,
1511#                             "slot": 0},
1512#                        "type": "dimm"
1513#                      } ] }
1514##
1515{ 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
1516
1517##
1518# @MEMORY_DEVICE_SIZE_CHANGE:
1519#
1520# Emitted when the size of a memory device changes.  Only emitted for
1521# memory devices that can actually change the size (e.g., virtio-mem
1522# due to guest action).
1523#
1524# @id: device's ID
1525#
1526# @size: the new size of memory that the device provides
1527#
1528# @qom-path: path to the device object in the QOM tree (since 6.2)
1529#
1530# Note: this event is rate-limited.
1531#
1532# Since: 5.1
1533#
1534# Example:
1535#
1536#     <- { "event": "MEMORY_DEVICE_SIZE_CHANGE",
1537#          "data": { "id": "vm0", "size": 1073741824,
1538#                    "qom-path": "/machine/unattached/device[2]" },
1539#          "timestamp": { "seconds": 1588168529, "microseconds": 201316 } }
1540##
1541{ 'event': 'MEMORY_DEVICE_SIZE_CHANGE',
1542  'data': { '*id': 'str', 'size': 'size', 'qom-path' : 'str'} }
1543
1544##
1545# @MEM_UNPLUG_ERROR:
1546#
1547# Emitted when memory hot unplug error occurs.
1548#
1549# @device: device name
1550#
1551# @msg: Informative message
1552#
1553# Features:
1554#
1555# @deprecated: This event is deprecated.  Use
1556#     @DEVICE_UNPLUG_GUEST_ERROR instead.
1557#
1558# Since: 2.4
1559#
1560# Example:
1561#
1562#     <- { "event": "MEM_UNPLUG_ERROR",
1563#          "data": { "device": "dimm1",
1564#                    "msg": "acpi: device unplug for unsupported device"
1565#          },
1566#          "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
1567##
1568{ 'event': 'MEM_UNPLUG_ERROR',
1569  'data': { 'device': 'str', 'msg': 'str' },
1570  'features': ['deprecated'] }
1571
1572##
1573# @BootConfiguration:
1574#
1575# Schema for virtual machine boot configuration.
1576#
1577# @order: Boot order (a=floppy, c=hard disk, d=CD-ROM, n=network)
1578#
1579# @once: Boot order to apply on first boot
1580#
1581# @menu: Whether to show a boot menu
1582#
1583# @splash: The name of the file to be passed to the firmware as logo
1584#     picture, if @menu is true.
1585#
1586# @splash-time: How long to show the logo picture, in milliseconds
1587#
1588# @reboot-timeout: Timeout before guest reboots after boot fails
1589#
1590# @strict: Whether to attempt booting from devices not included in the
1591#     boot order
1592#
1593# Since: 7.1
1594##
1595{ 'struct': 'BootConfiguration', 'data': {
1596     '*order': 'str',
1597     '*once': 'str',
1598     '*menu': 'bool',
1599     '*splash': 'str',
1600     '*splash-time': 'int',
1601     '*reboot-timeout': 'int',
1602     '*strict': 'bool' } }
1603
1604##
1605# @SMPConfiguration:
1606#
1607# Schema for CPU topology configuration.  A missing value lets QEMU
1608# figure out a suitable value based on the ones that are provided.
1609#
1610# The members other than @cpus and @maxcpus define a topology of
1611# containers.
1612#
1613# The ordering from highest/coarsest to lowest/finest is:
1614# @drawers, @books, @sockets, @dies, @clusters, @cores, @threads.
1615#
1616# Different architectures support different subsets of topology
1617# containers.
1618#
1619# For example, s390x does not have clusters and dies, and the socket
1620# is the parent container of cores.
1621#
1622# @cpus: number of virtual CPUs in the virtual machine
1623#
1624# @maxcpus: maximum number of hotpluggable virtual CPUs in the virtual
1625#     machine
1626#
1627# @drawers: number of drawers in the CPU topology (since 8.2)
1628#
1629# @books: number of books in the CPU topology (since 8.2)
1630#
1631# @sockets: number of sockets per parent container
1632#
1633# @dies: number of dies per parent container
1634#
1635# @clusters: number of clusters per parent container (since 7.0)
1636#
1637# @cores: number of cores per parent container
1638#
1639# @threads: number of threads per core
1640#
1641# Since: 6.1
1642##
1643{ 'struct': 'SMPConfiguration', 'data': {
1644     '*cpus': 'int',
1645     '*drawers': 'int',
1646     '*books': 'int',
1647     '*sockets': 'int',
1648     '*dies': 'int',
1649     '*clusters': 'int',
1650     '*cores': 'int',
1651     '*threads': 'int',
1652     '*maxcpus': 'int' } }
1653
1654##
1655# @x-query-irq:
1656#
1657# Query interrupt statistics
1658#
1659# Features:
1660#
1661# @unstable: This command is meant for debugging.
1662#
1663# Returns: interrupt statistics
1664#
1665# Since: 6.2
1666##
1667{ 'command': 'x-query-irq',
1668  'returns': 'HumanReadableText',
1669  'features': [ 'unstable' ] }
1670
1671##
1672# @x-query-jit:
1673#
1674# Query TCG compiler statistics
1675#
1676# Features:
1677#
1678# @unstable: This command is meant for debugging.
1679#
1680# Returns: TCG compiler statistics
1681#
1682# Since: 6.2
1683##
1684{ 'command': 'x-query-jit',
1685  'returns': 'HumanReadableText',
1686  'if': 'CONFIG_TCG',
1687  'features': [ 'unstable' ] }
1688
1689##
1690# @x-query-numa:
1691#
1692# Query NUMA topology information
1693#
1694# Features:
1695#
1696# @unstable: This command is meant for debugging.
1697#
1698# Returns: topology information
1699#
1700# Since: 6.2
1701##
1702{ 'command': 'x-query-numa',
1703  'returns': 'HumanReadableText',
1704  'features': [ 'unstable' ] }
1705
1706##
1707# @x-query-opcount:
1708#
1709# Query TCG opcode counters
1710#
1711# Features:
1712#
1713# @unstable: This command is meant for debugging.
1714#
1715# Returns: TCG opcode counters
1716#
1717# Since: 6.2
1718##
1719{ 'command': 'x-query-opcount',
1720  'returns': 'HumanReadableText',
1721  'if': 'CONFIG_TCG',
1722  'features': [ 'unstable' ] }
1723
1724##
1725# @x-query-ramblock:
1726#
1727# Query system ramblock information
1728#
1729# Features:
1730#
1731# @unstable: This command is meant for debugging.
1732#
1733# Returns: system ramblock information
1734#
1735# Since: 6.2
1736##
1737{ 'command': 'x-query-ramblock',
1738  'returns': 'HumanReadableText',
1739  'features': [ 'unstable' ] }
1740
1741##
1742# @x-query-rdma:
1743#
1744# Query RDMA state
1745#
1746# Features:
1747#
1748# @unstable: This command is meant for debugging.
1749#
1750# Returns: RDMA state
1751#
1752# Since: 6.2
1753##
1754{ 'command': 'x-query-rdma',
1755  'returns': 'HumanReadableText',
1756  'features': [ 'unstable' ] }
1757
1758##
1759# @x-query-roms:
1760#
1761# Query information on the registered ROMS
1762#
1763# Features:
1764#
1765# @unstable: This command is meant for debugging.
1766#
1767# Returns: registered ROMs
1768#
1769# Since: 6.2
1770##
1771{ 'command': 'x-query-roms',
1772  'returns': 'HumanReadableText',
1773  'features': [ 'unstable' ] }
1774
1775##
1776# @x-query-usb:
1777#
1778# Query information on the USB devices
1779#
1780# Features:
1781#
1782# @unstable: This command is meant for debugging.
1783#
1784# Returns: USB device information
1785#
1786# Since: 6.2
1787##
1788{ 'command': 'x-query-usb',
1789  'returns': 'HumanReadableText',
1790  'features': [ 'unstable' ] }
1791
1792##
1793# @SmbiosEntryPointType:
1794#
1795# @32: SMBIOS version 2.1 (32-bit) Entry Point
1796#
1797# @64: SMBIOS version 3.0 (64-bit) Entry Point
1798#
1799# @auto: Either 2.x or 3.x SMBIOS version, 2.x if configuration can be
1800#     described by it and 3.x otherwise (since: 9.0)
1801#
1802# Since: 7.0
1803##
1804{ 'enum': 'SmbiosEntryPointType',
1805  'data': [ '32', '64', 'auto' ] }
1806
1807##
1808# @MemorySizeConfiguration:
1809#
1810# Schema for memory size configuration.
1811#
1812# @size: memory size in bytes
1813#
1814# @max-size: maximum hotpluggable memory size in bytes
1815#
1816# @slots: number of available memory slots for hotplug
1817#
1818# Since: 7.1
1819##
1820{ 'struct': 'MemorySizeConfiguration', 'data': {
1821     '*size': 'size',
1822     '*max-size': 'size',
1823     '*slots': 'uint64' } }
1824
1825##
1826# @dumpdtb:
1827#
1828# Save the FDT in dtb format.
1829#
1830# @filename: name of the dtb file to be created
1831#
1832# Since: 7.2
1833#
1834# Example:
1835#
1836#     -> { "execute": "dumpdtb" }
1837#          "arguments": { "filename": "fdt.dtb" } }
1838#     <- { "return": {} }
1839##
1840{ 'command': 'dumpdtb',
1841  'data': { 'filename': 'str' },
1842  'if': 'CONFIG_FDT' }
1843