| 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 | # ******** |
| 9 | # Machines |
| 10 | # ******** |
| 11 | ## |
| 12 | |
| 13 | { 'include': 'common.json' } |
| 14 | { 'include': 'machine-common.json' } |
| 15 | |
| 16 | ## |
| 17 | # @SysEmuTarget: |
| 18 | # |
| 19 | # The comprehensive enumeration of QEMU system emulation ("softmmu") |
| 20 | # targets. Run "./configure --help" in the project root directory, |
| 21 | # and look for the \*-softmmu targets near the "--target-list" option. |
| 22 | # The individual target constants are not documented here, for the |
| 23 | # time being. |
| 24 | # |
| 25 | # @rx: since 5.0 |
| 26 | # |
| 27 | # @avr: since 5.1 |
| 28 | # |
| 29 | # @loongarch64: since 7.1 |
| 30 | # |
| 31 | # @hexagon: since 11.0 |
| 32 | # |
| 33 | # .. note:: The resulting QMP strings can be appended to the |
| 34 | # "qemu-system-" prefix to produce the corresponding QEMU |
| 35 | # executable name. This is true even for "qemu-system-x86_64". |
| 36 | # |
| 37 | # Since: 3.0 |
| 38 | ## |
| 39 | { 'enum' : 'SysEmuTarget', |
| 40 | 'data' : [ 'aarch64', 'alpha', 'arm', 'avr', 'hexagon', 'hppa', 'i386', |
| 41 | 'loongarch64', 'm68k', 'microblaze', 'mips', 'mips64', |
| 42 | 'mips64el', 'mipsel', 'or1k', 'ppc', |
| 43 | 'ppc64', 'riscv32', 'riscv64', 'rx', 's390x', 'sh4', |
| 44 | 'sh4eb', 'sparc', 'sparc64', 'tricore', |
| 45 | 'x86_64', 'xtensa', 'xtensaeb' ] } |
| 46 | |
| 47 | ## |
| 48 | # @S390CpuState: |
| 49 | # |
| 50 | # An enumeration of cpu states that can be assumed by a virtual S390 |
| 51 | # CPU |
| 52 | # |
| 53 | # Since: 2.12 |
| 54 | ## |
| 55 | { 'enum': 'S390CpuState', |
| 56 | 'data': [ 'uninitialized', 'stopped', 'check-stop', 'operating', 'load' ] } |
| 57 | |
| 58 | ## |
| 59 | # @CpuInfoS390: |
| 60 | # |
| 61 | # Additional information about a virtual S390 CPU |
| 62 | # |
| 63 | # @cpu-state: the virtual CPU's state |
| 64 | # |
| 65 | # @dedicated: the virtual CPU's dedication (since 8.2) |
| 66 | # |
| 67 | # @entitlement: the virtual CPU's entitlement (since 8.2) |
| 68 | # |
| 69 | # Since: 2.12 |
| 70 | ## |
| 71 | { 'struct': 'CpuInfoS390', |
| 72 | 'data': { 'cpu-state': 'S390CpuState', |
| 73 | '*dedicated': 'bool', |
| 74 | '*entitlement': 'S390CpuEntitlement' } } |
| 75 | |
| 76 | ## |
| 77 | # @CpuInfoFast: |
| 78 | # |
| 79 | # Information about a virtual CPU |
| 80 | # |
| 81 | # @cpu-index: index of the virtual CPU |
| 82 | # |
| 83 | # @qom-type: QOM type name of the CPU (since 10.1) |
| 84 | # |
| 85 | # @qom-path: path to the CPU object in the QOM tree |
| 86 | # |
| 87 | # @thread-id: ID of the underlying host thread |
| 88 | # |
| 89 | # @props: properties associated with a virtual CPU, e.g. the socket id |
| 90 | # |
| 91 | # @target: the QEMU system emulation target, which determines which |
| 92 | # additional fields will be listed (since 3.0) |
| 93 | # |
| 94 | # Since: 2.12 |
| 95 | ## |
| 96 | { 'union' : 'CpuInfoFast', |
| 97 | 'base' : { 'cpu-index' : 'int', |
| 98 | 'qom-type' : 'str', |
| 99 | 'qom-path' : 'str', |
| 100 | 'thread-id' : 'int', |
| 101 | '*props' : 'CpuInstanceProperties', |
| 102 | 'target' : 'SysEmuTarget' }, |
| 103 | 'discriminator' : 'target', |
| 104 | 'data' : { 's390x' : 'CpuInfoS390' } } |
| 105 | |
| 106 | ## |
| 107 | # @query-cpus-fast: |
| 108 | # |
| 109 | # Return information about all virtual CPUs. |
| 110 | # |
| 111 | # Since: 2.12 |
| 112 | # |
| 113 | # .. qmp-example:: |
| 114 | # |
| 115 | # -> { "execute": "query-cpus-fast" } |
| 116 | # <- { "return": [ |
| 117 | # { |
| 118 | # "thread-id": 25627, |
| 119 | # "props": { |
| 120 | # "core-id": 0, |
| 121 | # "thread-id": 0, |
| 122 | # "socket-id": 0 |
| 123 | # }, |
| 124 | # "qom-path": "/machine/unattached/device[0]", |
| 125 | # "target":"x86_64", |
| 126 | # "cpu-index": 0 |
| 127 | # }, |
| 128 | # { |
| 129 | # "thread-id": 25628, |
| 130 | # "props": { |
| 131 | # "core-id": 0, |
| 132 | # "thread-id": 0, |
| 133 | # "socket-id": 1 |
| 134 | # }, |
| 135 | # "qom-path": "/machine/unattached/device[2]", |
| 136 | # "target":"x86_64", |
| 137 | # "cpu-index": 1 |
| 138 | # } |
| 139 | # ] |
| 140 | # } |
| 141 | ## |
| 142 | { 'command': 'query-cpus-fast', 'returns': [ 'CpuInfoFast' ] } |
| 143 | |
| 144 | ## |
| 145 | # @CompatProperty: |
| 146 | # |
| 147 | # Property default values specific to a machine type, for use by |
| 148 | # scripts/compare-machine-types. |
| 149 | # |
| 150 | # @qom-type: name of the QOM type to which the default applies |
| 151 | # |
| 152 | # @property: name of its property to which the default applies |
| 153 | # |
| 154 | # @value: the default value (machine-specific default can overwrite |
| 155 | # the "default" default, to avoid this use -machine none) |
| 156 | # |
| 157 | # Since: 9.1 |
| 158 | ## |
| 159 | { 'struct': 'CompatProperty', |
| 160 | 'data': { 'qom-type': 'str', |
| 161 | 'property': 'str', |
| 162 | 'value': 'str' } } |
| 163 | |
| 164 | ## |
| 165 | # @MachineInfo: |
| 166 | # |
| 167 | # Information describing a machine. |
| 168 | # |
| 169 | # @name: the name of the machine |
| 170 | # |
| 171 | # @alias: an alias for the machine name |
| 172 | # |
| 173 | # @is-default: whether the machine is default |
| 174 | # |
| 175 | # @cpu-max: maximum number of CPUs supported by the machine type |
| 176 | # (since 1.5) |
| 177 | # |
| 178 | # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7) |
| 179 | # |
| 180 | # @numa-mem-supported: true if '-numa node,mem' option is supported by |
| 181 | # the machine type and false otherwise (since 4.1) |
| 182 | # |
| 183 | # @deprecated: if true, the machine type is deprecated and may be |
| 184 | # removed in future versions of QEMU according to the QEMU |
| 185 | # deprecation policy (since 4.1) |
| 186 | # |
| 187 | # @default-cpu-type: default CPU model typename if none is requested |
| 188 | # via the -cpu argument. (since 4.2) |
| 189 | # |
| 190 | # @default-ram-id: the default ID of initial RAM memory backend |
| 191 | # (since 5.2) |
| 192 | # |
| 193 | # @acpi: machine type supports ACPI (since 8.0) |
| 194 | # |
| 195 | # @compat-props: The machine type's compatibility properties. Only |
| 196 | # present when `query-machines` argument @compat-props is true. |
| 197 | # (since 9.1) |
| 198 | # |
| 199 | # Features: |
| 200 | # |
| 201 | # @unstable: Member @compat-props is experimental. |
| 202 | # |
| 203 | # Since: 1.2 |
| 204 | ## |
| 205 | { 'struct': 'MachineInfo', |
| 206 | 'data': { 'name': 'str', '*alias': 'str', |
| 207 | '*is-default': 'bool', 'cpu-max': 'int', |
| 208 | 'hotpluggable-cpus': 'bool', 'numa-mem-supported': 'bool', |
| 209 | 'deprecated': 'bool', '*default-cpu-type': 'str', |
| 210 | '*default-ram-id': 'str', 'acpi': 'bool', |
| 211 | '*compat-props': { 'type': ['CompatProperty'], |
| 212 | 'features': ['unstable'] } } } |
| 213 | |
| 214 | ## |
| 215 | # @query-machines: |
| 216 | # |
| 217 | # Return a list of supported machines |
| 218 | # |
| 219 | # @compat-props: if true, also return compatibility properties. |
| 220 | # (default: false) (since 9.1) |
| 221 | # |
| 222 | # Features: |
| 223 | # |
| 224 | # @unstable: Argument @compat-props is experimental. |
| 225 | # |
| 226 | # Since: 1.2 |
| 227 | # |
| 228 | # .. qmp-example:: |
| 229 | # |
| 230 | # -> { "execute": "query-machines", "arguments": { "compat-props": true } } |
| 231 | # <- { "return": [ |
| 232 | # { |
| 233 | # "hotpluggable-cpus": true, |
| 234 | # "name": "pc-q35-6.2", |
| 235 | # "compat-props": [ |
| 236 | # { |
| 237 | # "qom-type": "virtio-mem", |
| 238 | # "property": "unplugged-inaccessible", |
| 239 | # "value": "off" |
| 240 | # } |
| 241 | # ], |
| 242 | # "numa-mem-supported": false, |
| 243 | # "default-cpu-type": "qemu64-x86_64-cpu", |
| 244 | # "cpu-max": 288, |
| 245 | # "deprecated": false, |
| 246 | # "default-ram-id": "pc.ram" |
| 247 | # }, |
| 248 | # ... |
| 249 | # } |
| 250 | ## |
| 251 | { 'command': 'query-machines', |
| 252 | 'data': { '*compat-props': { 'type': 'bool', |
| 253 | 'features': [ 'unstable' ] } }, |
| 254 | 'returns': ['MachineInfo'] } |
| 255 | |
| 256 | ## |
| 257 | # @CurrentMachineParams: |
| 258 | # |
| 259 | # Information describing the running machine parameters. |
| 260 | # |
| 261 | # @wakeup-suspend-support: true if the machine supports wake up from |
| 262 | # suspend |
| 263 | # |
| 264 | # Since: 4.0 |
| 265 | ## |
| 266 | { 'struct': 'CurrentMachineParams', |
| 267 | 'data': { 'wakeup-suspend-support': 'bool'} } |
| 268 | |
| 269 | ## |
| 270 | # @query-current-machine: |
| 271 | # |
| 272 | # Return information on the current virtual machine. |
| 273 | # |
| 274 | # Since: 4.0 |
| 275 | ## |
| 276 | { 'command': 'query-current-machine', 'returns': 'CurrentMachineParams' } |
| 277 | |
| 278 | ## |
| 279 | # @QemuTargetInfo: |
| 280 | # |
| 281 | # Information on the target configuration built into the QEMU binary. |
| 282 | # |
| 283 | # @arch: the target architecture |
| 284 | # |
| 285 | # Since: 1.2 |
| 286 | ## |
| 287 | { 'struct': 'QemuTargetInfo', |
| 288 | 'data': { 'arch': 'SysEmuTarget' } } |
| 289 | |
| 290 | ## |
| 291 | # @query-target: |
| 292 | # |
| 293 | # Return information about the target for this QEMU |
| 294 | # |
| 295 | # Since: 1.2 |
| 296 | ## |
| 297 | { 'command': 'query-target', 'returns': 'QemuTargetInfo' } |
| 298 | |
| 299 | ## |
| 300 | # @UuidInfo: |
| 301 | # |
| 302 | # Guest UUID information (Universally Unique Identifier). |
| 303 | # |
| 304 | # @UUID: the UUID of the guest |
| 305 | # |
| 306 | # Since: 0.14 |
| 307 | # |
| 308 | # .. note:: If no UUID was specified for the guest, the nil UUID (all |
| 309 | # zeroes) is returned. |
| 310 | ## |
| 311 | { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} } |
| 312 | |
| 313 | ## |
| 314 | # @query-uuid: |
| 315 | # |
| 316 | # Query the guest UUID information. |
| 317 | # |
| 318 | # Since: 0.14 |
| 319 | # |
| 320 | # .. qmp-example:: |
| 321 | # |
| 322 | # -> { "execute": "query-uuid" } |
| 323 | # <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } } |
| 324 | ## |
| 325 | { 'command': 'query-uuid', 'returns': 'UuidInfo', 'allow-preconfig': true } |
| 326 | |
| 327 | ## |
| 328 | # @GuidInfo: |
| 329 | # |
| 330 | # GUID information. |
| 331 | # |
| 332 | # @guid: the globally unique identifier |
| 333 | # |
| 334 | # Since: 2.9 |
| 335 | ## |
| 336 | { 'struct': 'GuidInfo', 'data': {'guid': 'str'} } |
| 337 | |
| 338 | ## |
| 339 | # @query-vm-generation-id: |
| 340 | # |
| 341 | # Show Virtual Machine Generation ID |
| 342 | # |
| 343 | # Since: 2.9 |
| 344 | ## |
| 345 | { 'command': 'query-vm-generation-id', 'returns': 'GuidInfo' } |
| 346 | |
| 347 | ## |
| 348 | # @system_reset: |
| 349 | # |
| 350 | # Performs a hard reset of a guest. |
| 351 | # |
| 352 | # Since: 0.14 |
| 353 | # |
| 354 | # .. qmp-example:: |
| 355 | # |
| 356 | # -> { "execute": "system_reset" } |
| 357 | # <- { "return": {} } |
| 358 | ## |
| 359 | { 'command': 'system_reset' } |
| 360 | |
| 361 | ## |
| 362 | # @system_powerdown: |
| 363 | # |
| 364 | # Requests that a guest perform a powerdown operation. |
| 365 | # |
| 366 | # Since: 0.14 |
| 367 | # |
| 368 | # .. note:: A guest may or may not respond to this command. This |
| 369 | # command returning does not indicate that a guest has accepted the |
| 370 | # request or that it has shut down. Many guests will respond to |
| 371 | # this command by prompting the user in some way. |
| 372 | # |
| 373 | # .. qmp-example:: |
| 374 | # |
| 375 | # -> { "execute": "system_powerdown" } |
| 376 | # <- { "return": {} } |
| 377 | ## |
| 378 | { 'command': 'system_powerdown' } |
| 379 | |
| 380 | ## |
| 381 | # @system_wakeup: |
| 382 | # |
| 383 | # Wake up guest from suspend. If the guest has wake-up from suspend |
| 384 | # support enabled (wakeup-suspend-support flag from |
| 385 | # `query-current-machine`), wake-up guest from suspend if the guest is |
| 386 | # in SUSPENDED state. Return an error otherwise. |
| 387 | # |
| 388 | # Since: 1.1 |
| 389 | # |
| 390 | # .. note:: Prior to 4.0, this command does nothing in case the guest |
| 391 | # isn't suspended. |
| 392 | # |
| 393 | # .. qmp-example:: |
| 394 | # |
| 395 | # -> { "execute": "system_wakeup" } |
| 396 | # <- { "return": {} } |
| 397 | ## |
| 398 | { 'command': 'system_wakeup' } |
| 399 | |
| 400 | ## |
| 401 | # @LostTickPolicy: |
| 402 | # |
| 403 | # Policy for handling lost ticks in timer devices. Ticks end up |
| 404 | # getting lost when, for example, the guest is paused. |
| 405 | # |
| 406 | # @discard: throw away the missed ticks and continue with future |
| 407 | # injection normally. The guest OS will see the timer jump ahead |
| 408 | # by a potentially quite significant amount all at once, as if the |
| 409 | # intervening chunk of time had simply not existed; needless to |
| 410 | # say, such a sudden jump can easily confuse a guest OS which is |
| 411 | # not specifically prepared to deal with it. Assuming the guest |
| 412 | # OS can deal correctly with the time jump, the time in the guest |
| 413 | # and in the host should now match. |
| 414 | # |
| 415 | # @delay: continue to deliver ticks at the normal rate. The guest OS |
| 416 | # will not notice anything is amiss, as from its point of view |
| 417 | # time will have continued to flow normally. The time in the |
| 418 | # guest should now be behind the time in the host by exactly the |
| 419 | # amount of time during which ticks have been missed. |
| 420 | # |
| 421 | # @slew: deliver ticks at a higher rate to catch up with the missed |
| 422 | # ticks. The guest OS will not notice anything is amiss, as from |
| 423 | # its point of view time will have continued to flow normally. |
| 424 | # Once the timer has managed to catch up with all the missing |
| 425 | # ticks, the time in the guest and in the host should match. |
| 426 | # |
| 427 | # Since: 2.0 |
| 428 | ## |
| 429 | { 'enum': 'LostTickPolicy', |
| 430 | 'data': ['discard', 'delay', 'slew' ] } |
| 431 | |
| 432 | ## |
| 433 | # @inject-nmi: |
| 434 | # |
| 435 | # Injects a Non-Maskable Interrupt (machine specific: for example on |
| 436 | # s390x CCW only the first vCPU receives the NMI, but on x86 machines |
| 437 | # all vCPUs receive it). The command fails when the guest doesn't |
| 438 | # support injecting. |
| 439 | # |
| 440 | # Since: 0.14 |
| 441 | # |
| 442 | # .. note:: Prior to 2.1, this command was only supported for x86 and |
| 443 | # s390 VMs. |
| 444 | # |
| 445 | # .. qmp-example:: |
| 446 | # |
| 447 | # -> { "execute": "inject-nmi" } |
| 448 | # <- { "return": {} } |
| 449 | ## |
| 450 | { 'command': 'inject-nmi' } |
| 451 | |
| 452 | ## |
| 453 | # @NumaOptionsType: |
| 454 | # |
| 455 | # @node: NUMA nodes configuration |
| 456 | # |
| 457 | # @dist: NUMA distance configuration (since 2.10) |
| 458 | # |
| 459 | # @cpu: property based CPU(s) to node mapping (Since: 2.10) |
| 460 | # |
| 461 | # @hmat-lb: memory latency and bandwidth information (Since: 5.0) |
| 462 | # |
| 463 | # @hmat-cache: memory side cache information (Since: 5.0) |
| 464 | # |
| 465 | # Since: 2.1 |
| 466 | ## |
| 467 | { 'enum': 'NumaOptionsType', |
| 468 | 'data': [ 'node', 'dist', 'cpu', 'hmat-lb', 'hmat-cache' ] } |
| 469 | |
| 470 | ## |
| 471 | # @NumaOptions: |
| 472 | # |
| 473 | # A discriminated record of NUMA options. (for OptsVisitor) |
| 474 | # |
| 475 | # @type: NUMA option type |
| 476 | # |
| 477 | # Since: 2.1 |
| 478 | ## |
| 479 | { 'union': 'NumaOptions', |
| 480 | 'base': { 'type': 'NumaOptionsType' }, |
| 481 | 'discriminator': 'type', |
| 482 | 'data': { |
| 483 | 'node': 'NumaNodeOptions', |
| 484 | 'dist': 'NumaDistOptions', |
| 485 | 'cpu': 'NumaCpuOptions', |
| 486 | 'hmat-lb': 'NumaHmatLBOptions', |
| 487 | 'hmat-cache': 'NumaHmatCacheOptions' }} |
| 488 | |
| 489 | ## |
| 490 | # @NumaNodeOptions: |
| 491 | # |
| 492 | # Create a guest NUMA node. (for OptsVisitor) |
| 493 | # |
| 494 | # @nodeid: NUMA node ID (increase by 1 from 0 if omitted) |
| 495 | # |
| 496 | # @cpus: VCPUs belonging to this node (assign VCPUS round-robin if |
| 497 | # omitted) |
| 498 | # |
| 499 | # @mem: memory size of this node; mutually exclusive with @memdev. |
| 500 | # Equally divide total memory among nodes if both @mem and @memdev |
| 501 | # are omitted. |
| 502 | # |
| 503 | # @memdev: memory backend object. If specified for one node, it must |
| 504 | # be specified for all nodes. |
| 505 | # |
| 506 | # @initiator: defined in ACPI 6.3 Chapter 5.2.27.3 Table 5-145, points |
| 507 | # to the nodeid which has the memory controller responsible for |
| 508 | # this NUMA node. This field provides additional information as |
| 509 | # to the initiator node that is closest (as in directly attached) |
| 510 | # to this node, and therefore has the best performance (since 5.0) |
| 511 | # |
| 512 | # Since: 2.1 |
| 513 | ## |
| 514 | { 'struct': 'NumaNodeOptions', |
| 515 | 'data': { |
| 516 | '*nodeid': 'uint16', |
| 517 | '*cpus': ['uint16'], |
| 518 | '*mem': 'size', |
| 519 | '*memdev': 'str', |
| 520 | '*initiator': 'uint16' }} |
| 521 | |
| 522 | ## |
| 523 | # @NumaDistOptions: |
| 524 | # |
| 525 | # Set the distance between 2 NUMA nodes. |
| 526 | # |
| 527 | # @src: source NUMA node. |
| 528 | # |
| 529 | # @dst: destination NUMA node. |
| 530 | # |
| 531 | # @val: NUMA distance from source node to destination node. When a |
| 532 | # node is unreachable from another node, set the distance between |
| 533 | # them to 255. |
| 534 | # |
| 535 | # Since: 2.10 |
| 536 | ## |
| 537 | { 'struct': 'NumaDistOptions', |
| 538 | 'data': { |
| 539 | 'src': 'uint16', |
| 540 | 'dst': 'uint16', |
| 541 | 'val': 'uint8' }} |
| 542 | |
| 543 | ## |
| 544 | # @CXLFixedMemoryWindowOptions: |
| 545 | # |
| 546 | # Create a CXL Fixed Memory Window |
| 547 | # |
| 548 | # @size: Size of the Fixed Memory Window in bytes. Must be a multiple |
| 549 | # of 256MiB. |
| 550 | # |
| 551 | # @interleave-granularity: Number of contiguous bytes for which |
| 552 | # accesses will go to a given interleave target. Accepted values |
| 553 | # [256, 512, 1k, 2k, 4k, 8k, 16k] |
| 554 | # |
| 555 | # @targets: Target root bridge IDs from -device ...,id=<ID> for each |
| 556 | # root bridge. |
| 557 | # |
| 558 | # Since: 7.1 |
| 559 | ## |
| 560 | { 'struct': 'CXLFixedMemoryWindowOptions', |
| 561 | 'data': { |
| 562 | 'size': 'size', |
| 563 | '*interleave-granularity': 'size', |
| 564 | 'targets': ['str'] }} |
| 565 | |
| 566 | ## |
| 567 | # @CXLFMWProperties: |
| 568 | # |
| 569 | # List of CXL Fixed Memory Windows. |
| 570 | # |
| 571 | # @cxl-fmw: List of `CXLFixedMemoryWindowOptions` |
| 572 | # |
| 573 | # Since: 7.1 |
| 574 | ## |
| 575 | { 'struct' : 'CXLFMWProperties', |
| 576 | 'data': { 'cxl-fmw': ['CXLFixedMemoryWindowOptions'] } |
| 577 | } |
| 578 | |
| 579 | ## |
| 580 | # @X86CPURegister32: |
| 581 | # |
| 582 | # A X86 32-bit register |
| 583 | # |
| 584 | # Since: 1.5 |
| 585 | ## |
| 586 | { 'enum': 'X86CPURegister32', |
| 587 | 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] } |
| 588 | |
| 589 | ## |
| 590 | # @X86CPUFeatureWordInfo: |
| 591 | # |
| 592 | # Information about a X86 CPU feature word |
| 593 | # |
| 594 | # @cpuid-input-eax: Input EAX value for CPUID instruction for that |
| 595 | # feature word |
| 596 | # |
| 597 | # @cpuid-input-ecx: Input ECX value for CPUID instruction for that |
| 598 | # feature word |
| 599 | # |
| 600 | # @cpuid-register: Output register containing the feature bits |
| 601 | # |
| 602 | # @features: value of output register, containing the feature bits |
| 603 | # |
| 604 | # Since: 1.5 |
| 605 | ## |
| 606 | { 'struct': 'X86CPUFeatureWordInfo', |
| 607 | 'data': { 'cpuid-input-eax': 'int', |
| 608 | '*cpuid-input-ecx': 'int', |
| 609 | 'cpuid-register': 'X86CPURegister32', |
| 610 | 'features': 'int' } } |
| 611 | |
| 612 | ## |
| 613 | # @DummyForceArrays: |
| 614 | # |
| 615 | # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList |
| 616 | # internally |
| 617 | # |
| 618 | # Since: 2.5 |
| 619 | ## |
| 620 | { 'struct': 'DummyForceArrays', |
| 621 | 'data': { 'unused': ['X86CPUFeatureWordInfo'] } } |
| 622 | |
| 623 | ## |
| 624 | # @NumaCpuOptions: |
| 625 | # |
| 626 | # Option "-numa cpu" overrides default cpu to node mapping. It |
| 627 | # accepts the same set of cpu properties as returned by |
| 628 | # `query-hotpluggable-cpus[].props <query-hotpluggable-cpus>`, where |
| 629 | # node-id could be used to override default node mapping. |
| 630 | # |
| 631 | # Since: 2.10 |
| 632 | ## |
| 633 | { 'struct': 'NumaCpuOptions', |
| 634 | 'base': 'CpuInstanceProperties', |
| 635 | 'data' : {} } |
| 636 | |
| 637 | ## |
| 638 | # @HmatLBMemoryHierarchy: |
| 639 | # |
| 640 | # The memory hierarchy in the System Locality Latency and Bandwidth |
| 641 | # Information Structure of HMAT (Heterogeneous Memory Attribute Table) |
| 642 | # |
| 643 | # For more information about `HmatLBMemoryHierarchy`, see chapter |
| 644 | # 5.2.27.4: Table 5-146: Field "Flags" of ACPI 6.3 spec. |
| 645 | # |
| 646 | # @memory: the structure represents the memory performance |
| 647 | # |
| 648 | # @first-level: first level of memory side cache |
| 649 | # |
| 650 | # @second-level: second level of memory side cache |
| 651 | # |
| 652 | # @third-level: third level of memory side cache |
| 653 | # |
| 654 | # Since: 5.0 |
| 655 | ## |
| 656 | { 'enum': 'HmatLBMemoryHierarchy', |
| 657 | 'data': [ 'memory', 'first-level', 'second-level', 'third-level' ] } |
| 658 | |
| 659 | ## |
| 660 | # @HmatLBDataType: |
| 661 | # |
| 662 | # Data type in the System Locality Latency and Bandwidth Information |
| 663 | # Structure of HMAT (Heterogeneous Memory Attribute Table) |
| 664 | # |
| 665 | # For more information about `HmatLBDataType`, see chapter 5.2.27.4: |
| 666 | # Table 5-146: Field "Data Type" of ACPI 6.3 spec. |
| 667 | # |
| 668 | # @access-latency: access latency (nanoseconds) |
| 669 | # |
| 670 | # @read-latency: read latency (nanoseconds) |
| 671 | # |
| 672 | # @write-latency: write latency (nanoseconds) |
| 673 | # |
| 674 | # @access-bandwidth: access bandwidth (Bytes per second) |
| 675 | # |
| 676 | # @read-bandwidth: read bandwidth (Bytes per second) |
| 677 | # |
| 678 | # @write-bandwidth: write bandwidth (Bytes per second) |
| 679 | # |
| 680 | # Since: 5.0 |
| 681 | ## |
| 682 | { 'enum': 'HmatLBDataType', |
| 683 | 'data': [ 'access-latency', 'read-latency', 'write-latency', |
| 684 | 'access-bandwidth', 'read-bandwidth', 'write-bandwidth' ] } |
| 685 | |
| 686 | ## |
| 687 | # @NumaHmatLBOptions: |
| 688 | # |
| 689 | # Set the system locality latency and bandwidth information between |
| 690 | # Initiator and Target proximity Domains. |
| 691 | # |
| 692 | # For more information about `NumaHmatLBOptions`, see chapter |
| 693 | # 5.2.27.4: Table 5-146 of ACPI 6.3 spec. |
| 694 | # |
| 695 | # @initiator: the Initiator Proximity Domain. |
| 696 | # |
| 697 | # @target: the Target Proximity Domain. |
| 698 | # |
| 699 | # @hierarchy: the Memory Hierarchy. Indicates the performance of |
| 700 | # memory or side cache. |
| 701 | # |
| 702 | # @data-type: presents the type of data, access/read/write latency or |
| 703 | # hit latency. |
| 704 | # |
| 705 | # @latency: the value of latency from @initiator to @target proximity |
| 706 | # domain, the latency unit is "ns(nanosecond)". |
| 707 | # |
| 708 | # @bandwidth: the value of bandwidth between @initiator and @target |
| 709 | # proximity domain, the bandwidth unit is "Bytes per second". |
| 710 | # |
| 711 | # Since: 5.0 |
| 712 | ## |
| 713 | { 'struct': 'NumaHmatLBOptions', |
| 714 | 'data': { |
| 715 | 'initiator': 'uint16', |
| 716 | 'target': 'uint16', |
| 717 | 'hierarchy': 'HmatLBMemoryHierarchy', |
| 718 | 'data-type': 'HmatLBDataType', |
| 719 | '*latency': 'uint64', |
| 720 | '*bandwidth': 'size' }} |
| 721 | |
| 722 | ## |
| 723 | # @HmatCacheAssociativity: |
| 724 | # |
| 725 | # Cache associativity in the Memory Side Cache Information Structure |
| 726 | # of HMAT |
| 727 | # |
| 728 | # For more information of `HmatCacheAssociativity`, see chapter |
| 729 | # 5.2.27.5: Table 5-147 of ACPI 6.3 spec. |
| 730 | # |
| 731 | # @none: None (no memory side cache in this proximity domain, or cache |
| 732 | # associativity unknown) |
| 733 | # |
| 734 | # @direct: Direct Mapped |
| 735 | # |
| 736 | # @complex: Complex Cache Indexing (implementation specific) |
| 737 | # |
| 738 | # Since: 5.0 |
| 739 | ## |
| 740 | { 'enum': 'HmatCacheAssociativity', |
| 741 | 'data': [ 'none', 'direct', 'complex' ] } |
| 742 | |
| 743 | ## |
| 744 | # @HmatCacheWritePolicy: |
| 745 | # |
| 746 | # Cache write policy in the Memory Side Cache Information Structure of |
| 747 | # HMAT |
| 748 | # |
| 749 | # For more information of `HmatCacheWritePolicy`, see chapter |
| 750 | # 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec. |
| 751 | # |
| 752 | # @none: None (no memory side cache in this proximity domain, or cache |
| 753 | # write policy unknown) |
| 754 | # |
| 755 | # @write-back: Write Back (WB) |
| 756 | # |
| 757 | # @write-through: Write Through (WT) |
| 758 | # |
| 759 | # Since: 5.0 |
| 760 | ## |
| 761 | { 'enum': 'HmatCacheWritePolicy', |
| 762 | 'data': [ 'none', 'write-back', 'write-through' ] } |
| 763 | |
| 764 | ## |
| 765 | # @NumaHmatCacheOptions: |
| 766 | # |
| 767 | # Set the memory side cache information for a given memory domain. |
| 768 | # |
| 769 | # For more information of `NumaHmatCacheOptions`, see chapter |
| 770 | # 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec. |
| 771 | # |
| 772 | # @node-id: the memory proximity domain to which the memory belongs. |
| 773 | # |
| 774 | # @size: the size of memory side cache in bytes. |
| 775 | # |
| 776 | # @level: the cache level described in this structure. |
| 777 | # |
| 778 | # @associativity: the cache associativity, |
| 779 | # none/direct-mapped/complex(complex cache indexing). |
| 780 | # |
| 781 | # @policy: the write policy, none/write-back/write-through. |
| 782 | # |
| 783 | # @line: the cache line size in bytes. |
| 784 | # |
| 785 | # Since: 5.0 |
| 786 | ## |
| 787 | { 'struct': 'NumaHmatCacheOptions', |
| 788 | 'data': { |
| 789 | 'node-id': 'uint32', |
| 790 | 'size': 'size', |
| 791 | 'level': 'uint8', |
| 792 | 'associativity': 'HmatCacheAssociativity', |
| 793 | 'policy': 'HmatCacheWritePolicy', |
| 794 | 'line': 'uint16' }} |
| 795 | |
| 796 | ## |
| 797 | # @memsave: |
| 798 | # |
| 799 | # Save a portion of guest memory to a file. |
| 800 | # |
| 801 | # @val: the virtual address of the guest to start from |
| 802 | # |
| 803 | # @size: the size of memory region to save |
| 804 | # |
| 805 | # @filename: the file to save the memory to as binary data |
| 806 | # |
| 807 | # @cpu-index: the index of the virtual CPU to use for translating the |
| 808 | # virtual address (defaults to CPU 0) |
| 809 | # |
| 810 | # Since: 0.14 |
| 811 | # |
| 812 | # .. caution:: Errors were not reliably returned until 1.1. |
| 813 | # |
| 814 | # .. qmp-example:: |
| 815 | # |
| 816 | # -> { "execute": "memsave", |
| 817 | # "arguments": { "val": 10, |
| 818 | # "size": 100, |
| 819 | # "filename": "/tmp/virtual-mem-dump" } } |
| 820 | # <- { "return": {} } |
| 821 | ## |
| 822 | { 'command': 'memsave', |
| 823 | 'data': { |
| 824 | 'val': 'uint64', |
| 825 | 'size': 'size', |
| 826 | 'filename': 'str', |
| 827 | '*cpu-index': 'int' } } |
| 828 | |
| 829 | ## |
| 830 | # @pmemsave: |
| 831 | # |
| 832 | # Save a portion of guest physical memory to a file. |
| 833 | # |
| 834 | # @val: the physical address of the guest to start from |
| 835 | # |
| 836 | # @size: the size of memory region to save |
| 837 | # |
| 838 | # @filename: the file to save the memory to as binary data |
| 839 | # |
| 840 | # Since: 0.14 |
| 841 | # |
| 842 | # .. caution:: Errors were not reliably returned until 1.1. |
| 843 | # |
| 844 | # .. qmp-example:: |
| 845 | # |
| 846 | # -> { "execute": "pmemsave", |
| 847 | # "arguments": { "val": 10, |
| 848 | # "size": 100, |
| 849 | # "filename": "/tmp/physical-mem-dump" } } |
| 850 | # <- { "return": {} } |
| 851 | ## |
| 852 | { 'command': 'pmemsave', |
| 853 | 'data': { |
| 854 | 'val': 'uint64', |
| 855 | 'size': 'size', |
| 856 | 'filename': 'str' } } |
| 857 | |
| 858 | ## |
| 859 | # @Memdev: |
| 860 | # |
| 861 | # Information about memory backend |
| 862 | # |
| 863 | # @id: backend's ID if backend has 'id' property (since 2.9) |
| 864 | # |
| 865 | # @size: memory backend size |
| 866 | # |
| 867 | # @merge: whether memory merge support is enabled |
| 868 | # |
| 869 | # @dump: whether memory backend's memory is included in a core dump |
| 870 | # |
| 871 | # @prealloc: whether memory was preallocated |
| 872 | # |
| 873 | # @share: whether memory is private to QEMU or shared (since 6.1) |
| 874 | # |
| 875 | # @reserve: whether swap space (or huge pages) was reserved if |
| 876 | # applicable. This corresponds to the user configuration and not |
| 877 | # the actual behavior implemented in the OS to perform the |
| 878 | # reservation. For example, Linux will never reserve swap space |
| 879 | # for shared file mappings. (since 6.1) |
| 880 | # |
| 881 | # @host-nodes: host nodes for its memory policy |
| 882 | # |
| 883 | # @policy: memory policy of memory backend |
| 884 | # |
| 885 | # Since: 2.1 |
| 886 | ## |
| 887 | { 'struct': 'Memdev', |
| 888 | 'data': { |
| 889 | '*id': 'str', |
| 890 | 'size': 'size', |
| 891 | 'merge': 'bool', |
| 892 | 'dump': 'bool', |
| 893 | 'prealloc': 'bool', |
| 894 | 'share': 'bool', |
| 895 | '*reserve': 'bool', |
| 896 | 'host-nodes': ['uint16'], |
| 897 | 'policy': 'HostMemPolicy' }} |
| 898 | |
| 899 | ## |
| 900 | # @query-memdev: |
| 901 | # |
| 902 | # Return information for all memory backends. |
| 903 | # |
| 904 | # Since: 2.1 |
| 905 | # |
| 906 | # .. qmp-example:: |
| 907 | # |
| 908 | # -> { "execute": "query-memdev" } |
| 909 | # <- { "return": [ |
| 910 | # { |
| 911 | # "id": "mem1", |
| 912 | # "size": 536870912, |
| 913 | # "merge": false, |
| 914 | # "dump": true, |
| 915 | # "prealloc": false, |
| 916 | # "share": false, |
| 917 | # "host-nodes": [0, 1], |
| 918 | # "policy": "bind" |
| 919 | # }, |
| 920 | # { |
| 921 | # "size": 536870912, |
| 922 | # "merge": false, |
| 923 | # "dump": true, |
| 924 | # "prealloc": true, |
| 925 | # "share": false, |
| 926 | # "host-nodes": [2, 3], |
| 927 | # "policy": "preferred" |
| 928 | # } |
| 929 | # ] |
| 930 | # } |
| 931 | ## |
| 932 | { 'command': 'query-memdev', 'returns': ['Memdev'], 'allow-preconfig': true } |
| 933 | |
| 934 | ## |
| 935 | # @CpuInstanceProperties: |
| 936 | # |
| 937 | # Properties identifying a CPU. |
| 938 | # |
| 939 | # Which members are optional and which mandatory depends on the |
| 940 | # architecture and board. |
| 941 | # |
| 942 | # For s390x see :ref:`cpu-topology-s390x`. |
| 943 | # |
| 944 | # The ids other than the node-id specify the position of the CPU |
| 945 | # within the CPU topology (as defined by the machine property "smp", |
| 946 | # thus see also type `SMPConfiguration`) |
| 947 | # |
| 948 | # @node-id: NUMA node ID the CPU belongs to |
| 949 | # |
| 950 | # @drawer-id: drawer number within CPU topology the CPU belongs to |
| 951 | # (since 8.2) |
| 952 | # |
| 953 | # @book-id: book number within parent container the CPU belongs to |
| 954 | # (since 8.2) |
| 955 | # |
| 956 | # @socket-id: socket number within parent container the CPU belongs to |
| 957 | # |
| 958 | # @die-id: die number within the parent container the CPU belongs to |
| 959 | # (since 4.1) |
| 960 | # |
| 961 | # @cluster-id: cluster number within the parent container the CPU |
| 962 | # belongs to (since 7.1) |
| 963 | # |
| 964 | # @module-id: module number within the parent container the CPU |
| 965 | # belongs to (since 9.1) |
| 966 | # |
| 967 | # @core-id: core number within the parent container the CPU belongs to |
| 968 | # |
| 969 | # @thread-id: thread number within the core the CPU belongs to |
| 970 | # |
| 971 | # Since: 2.7 |
| 972 | ## |
| 973 | { 'struct': 'CpuInstanceProperties', |
| 974 | # Keep these in sync with the properties `device_add` accepts |
| 975 | 'data': { '*node-id': 'int', |
| 976 | '*drawer-id': 'int', |
| 977 | '*book-id': 'int', |
| 978 | '*socket-id': 'int', |
| 979 | '*die-id': 'int', |
| 980 | '*cluster-id': 'int', |
| 981 | '*module-id': 'int', |
| 982 | '*core-id': 'int', |
| 983 | '*thread-id': 'int' |
| 984 | } |
| 985 | } |
| 986 | |
| 987 | ## |
| 988 | # @HotpluggableCPU: |
| 989 | # |
| 990 | # @type: CPU object type for usage with `device_add` command |
| 991 | # |
| 992 | # @props: list of properties to pass for hotplugging a CPU with |
| 993 | # `device_add` |
| 994 | # |
| 995 | # @vcpus-count: number of logical VCPU threads `HotpluggableCPU` |
| 996 | # provides |
| 997 | # |
| 998 | # @qom-path: link to existing CPU object if CPU is present or omitted |
| 999 | # if CPU is not present. |
| 1000 | # |
| 1001 | # .. note:: Management should be prepared to pass through additional |
| 1002 | # properties with `device_add`. |
| 1003 | # |
| 1004 | # Since: 2.7 |
| 1005 | ## |
| 1006 | { 'struct': 'HotpluggableCPU', |
| 1007 | 'data': { 'type': 'str', |
| 1008 | 'vcpus-count': 'int', |
| 1009 | 'props': 'CpuInstanceProperties', |
| 1010 | '*qom-path': 'str' |
| 1011 | } |
| 1012 | } |
| 1013 | |
| 1014 | ## |
| 1015 | # @query-hotpluggable-cpus: |
| 1016 | # |
| 1017 | # TODO: Better documentation; currently there is none. |
| 1018 | # |
| 1019 | # Since: 2.7 |
| 1020 | # |
| 1021 | # .. qmp-example:: |
| 1022 | # :annotated: |
| 1023 | # |
| 1024 | # For pseries machine type started with |
| 1025 | # ``-smp 2,cores=2,maxcpus=4 -cpu POWER8``:: |
| 1026 | # |
| 1027 | # -> { "execute": "query-hotpluggable-cpus" } |
| 1028 | # <- {"return": [ |
| 1029 | # { "props": { "core-id": 8 }, "type": "POWER8-spapr-cpu-core", |
| 1030 | # "vcpus-count": 1 }, |
| 1031 | # { "props": { "core-id": 0 }, "type": "POWER8-spapr-cpu-core", |
| 1032 | # "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"} |
| 1033 | # ]} |
| 1034 | # |
| 1035 | # .. qmp-example:: |
| 1036 | # :annotated: |
| 1037 | # |
| 1038 | # For pc machine type started with ``-smp 1,maxcpus=2``:: |
| 1039 | # |
| 1040 | # -> { "execute": "query-hotpluggable-cpus" } |
| 1041 | # <- {"return": [ |
| 1042 | # { |
| 1043 | # "type": "qemu64-x86_64-cpu", "vcpus-count": 1, |
| 1044 | # "props": {"core-id": 0, "socket-id": 1, "thread-id": 0} |
| 1045 | # }, |
| 1046 | # { |
| 1047 | # "qom-path": "/machine/unattached/device[0]", |
| 1048 | # "type": "qemu64-x86_64-cpu", "vcpus-count": 1, |
| 1049 | # "props": {"core-id": 0, "socket-id": 0, "thread-id": 0} |
| 1050 | # } |
| 1051 | # ]} |
| 1052 | # |
| 1053 | # .. qmp-example:: |
| 1054 | # :annotated: |
| 1055 | # |
| 1056 | # For s390x-virtio-ccw machine type started with |
| 1057 | # ``-smp 1,maxcpus=2 -cpu qemu``:: |
| 1058 | # |
| 1059 | # -> { "execute": "query-hotpluggable-cpus" } |
| 1060 | # <- {"return": [ |
| 1061 | # { |
| 1062 | # "type": "qemu-s390x-cpu", "vcpus-count": 1, |
| 1063 | # "props": { "core-id": 1 } |
| 1064 | # }, |
| 1065 | # { |
| 1066 | # "qom-path": "/machine/unattached/device[0]", |
| 1067 | # "type": "qemu-s390x-cpu", "vcpus-count": 1, |
| 1068 | # "props": { "core-id": 0 } |
| 1069 | # } |
| 1070 | # ]} |
| 1071 | ## |
| 1072 | { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'], |
| 1073 | 'allow-preconfig': true } |
| 1074 | |
| 1075 | ## |
| 1076 | # @set-numa-node: |
| 1077 | # |
| 1078 | # Runtime equivalent of '-numa' CLI option, available at preconfigure |
| 1079 | # stage to configure numa mapping before initializing machine. |
| 1080 | # |
| 1081 | # Since: 3.0 |
| 1082 | ## |
| 1083 | { 'command': 'set-numa-node', 'boxed': true, |
| 1084 | 'data': 'NumaOptions', |
| 1085 | 'allow-preconfig': true |
| 1086 | } |
| 1087 | |
| 1088 | ## |
| 1089 | # @balloon: |
| 1090 | # |
| 1091 | # Request the balloon driver to change its balloon size. |
| 1092 | # |
| 1093 | # @value: the target logical size of the VM in bytes. We can deduce |
| 1094 | # the size of the balloon using this formula: |
| 1095 | # |
| 1096 | # logical_vm_size = vm_ram_size - balloon_size |
| 1097 | # |
| 1098 | # From it we have: balloon_size = vm_ram_size - @value |
| 1099 | # |
| 1100 | # Errors: |
| 1101 | # - If the balloon driver is enabled but not functional because |
| 1102 | # the KVM kernel module cannot support it, KVMMissingCap |
| 1103 | # - If no balloon device is present, DeviceNotActive |
| 1104 | # |
| 1105 | # .. note:: This command just issues a request to the guest. When it |
| 1106 | # returns, the balloon size may not have changed. A guest can |
| 1107 | # change the balloon size independent of this command. |
| 1108 | # |
| 1109 | # Since: 0.14 |
| 1110 | # |
| 1111 | # .. qmp-example:: |
| 1112 | # :annotated: |
| 1113 | # |
| 1114 | # :: |
| 1115 | # |
| 1116 | # -> { "execute": "balloon", "arguments": { "value": 536870912 } } |
| 1117 | # <- { "return": {} } |
| 1118 | # |
| 1119 | # With a 2.5GiB guest this command inflated the ballon to 3GiB. |
| 1120 | ## |
| 1121 | { 'command': 'balloon', 'data': {'value': 'int'} } |
| 1122 | |
| 1123 | ## |
| 1124 | # @BalloonInfo: |
| 1125 | # |
| 1126 | # Information about the guest balloon device. |
| 1127 | # |
| 1128 | # @actual: the logical size of the VM in bytes. Formula used: |
| 1129 | # logical_vm_size = vm_ram_size - balloon_size |
| 1130 | # |
| 1131 | # Since: 0.14 |
| 1132 | ## |
| 1133 | { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } } |
| 1134 | |
| 1135 | ## |
| 1136 | # @query-balloon: |
| 1137 | # |
| 1138 | # Return information about the balloon device. |
| 1139 | # |
| 1140 | # Errors: |
| 1141 | # - If the balloon driver is enabled but not functional because |
| 1142 | # the KVM kernel module cannot support it, KVMMissingCap |
| 1143 | # - If no balloon device is present, DeviceNotActive |
| 1144 | # |
| 1145 | # Since: 0.14 |
| 1146 | # |
| 1147 | # .. qmp-example:: |
| 1148 | # |
| 1149 | # -> { "execute": "query-balloon" } |
| 1150 | # <- { "return": { |
| 1151 | # "actual": 1073741824 |
| 1152 | # } |
| 1153 | # } |
| 1154 | ## |
| 1155 | { 'command': 'query-balloon', 'returns': 'BalloonInfo' } |
| 1156 | |
| 1157 | ## |
| 1158 | # @BALLOON_CHANGE: |
| 1159 | # |
| 1160 | # Emitted when the guest changes the actual BALLOON level. This value |
| 1161 | # is equivalent to the @actual field return by the `query-balloon` |
| 1162 | # command |
| 1163 | # |
| 1164 | # @actual: the logical size of the VM in bytes. Formula used: |
| 1165 | # logical_vm_size = vm_ram_size - balloon_size |
| 1166 | # |
| 1167 | # .. note:: This event is rate-limited. |
| 1168 | # |
| 1169 | # Since: 1.2 |
| 1170 | # |
| 1171 | # .. qmp-example:: |
| 1172 | # |
| 1173 | # <- { "event": "BALLOON_CHANGE", |
| 1174 | # "data": { "actual": 944766976 }, |
| 1175 | # "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } |
| 1176 | ## |
| 1177 | { 'event': 'BALLOON_CHANGE', |
| 1178 | 'data': { 'actual': 'int' } } |
| 1179 | |
| 1180 | ## |
| 1181 | # @HvBalloonInfo: |
| 1182 | # |
| 1183 | # hv-balloon guest-provided memory status information. |
| 1184 | # |
| 1185 | # @committed: the amount of memory in use inside the guest plus the |
| 1186 | # amount of the memory unusable inside the guest (ballooned out, |
| 1187 | # offline, etc.) |
| 1188 | # |
| 1189 | # @available: the amount of the memory inside the guest available for |
| 1190 | # new allocations ("free") |
| 1191 | # |
| 1192 | # Since: 8.2 |
| 1193 | ## |
| 1194 | { 'struct': 'HvBalloonInfo', |
| 1195 | 'data': { 'committed': 'size', 'available': 'size' } } |
| 1196 | |
| 1197 | ## |
| 1198 | # @query-hv-balloon-status-report: |
| 1199 | # |
| 1200 | # Return the hv-balloon driver data contained in the last received |
| 1201 | # "STATUS" message from the guest. |
| 1202 | # |
| 1203 | # Errors: |
| 1204 | # - If no hv-balloon device is present, guest memory status |
| 1205 | # reporting is not enabled or no guest memory status report |
| 1206 | # received yet, GenericError |
| 1207 | # |
| 1208 | # Since: 8.2 |
| 1209 | # |
| 1210 | # .. qmp-example:: |
| 1211 | # |
| 1212 | # -> { "execute": "query-hv-balloon-status-report" } |
| 1213 | # <- { "return": { |
| 1214 | # "committed": 816640000, |
| 1215 | # "available": 3333054464 |
| 1216 | # } |
| 1217 | # } |
| 1218 | ## |
| 1219 | { 'command': 'query-hv-balloon-status-report', 'returns': 'HvBalloonInfo' } |
| 1220 | |
| 1221 | ## |
| 1222 | # @HV_BALLOON_STATUS_REPORT: |
| 1223 | # |
| 1224 | # Emitted when the hv-balloon driver receives a "STATUS" message from |
| 1225 | # the guest. |
| 1226 | # |
| 1227 | # .. note:: This event is rate-limited. |
| 1228 | # |
| 1229 | # Since: 8.2 |
| 1230 | # |
| 1231 | # .. qmp-example:: |
| 1232 | # |
| 1233 | # <- { "event": "HV_BALLOON_STATUS_REPORT", |
| 1234 | # "data": { "committed": 816640000, "available": 3333054464 }, |
| 1235 | # "timestamp": { "seconds": 1600295492, "microseconds": 661044 } } |
| 1236 | ## |
| 1237 | { 'event': 'HV_BALLOON_STATUS_REPORT', |
| 1238 | 'data': 'HvBalloonInfo' } |
| 1239 | |
| 1240 | ## |
| 1241 | # @MemoryInfo: |
| 1242 | # |
| 1243 | # Actual memory information in bytes. |
| 1244 | # |
| 1245 | # @base-memory: size of "base" memory specified with command line |
| 1246 | # option -m. |
| 1247 | # |
| 1248 | # @plugged-memory: size of memory that can be hot-unplugged. This |
| 1249 | # field is omitted if target doesn't support memory hotplug (i.e. |
| 1250 | # CONFIG_MEM_DEVICE not defined at build time). |
| 1251 | # |
| 1252 | # Since: 2.11 |
| 1253 | ## |
| 1254 | { 'struct': 'MemoryInfo', |
| 1255 | 'data' : { 'base-memory': 'size', '*plugged-memory': 'size' } } |
| 1256 | |
| 1257 | ## |
| 1258 | # @query-memory-size-summary: |
| 1259 | # |
| 1260 | # Return the amount of initially allocated and present hotpluggable |
| 1261 | # (if enabled) memory in bytes. |
| 1262 | # |
| 1263 | # TODO: This line is a hack to separate the example from the body |
| 1264 | # |
| 1265 | # .. qmp-example:: |
| 1266 | # |
| 1267 | # -> { "execute": "query-memory-size-summary" } |
| 1268 | # <- { "return": { "base-memory": 4294967296, "plugged-memory": 0 } } |
| 1269 | # |
| 1270 | # Since: 2.11 |
| 1271 | ## |
| 1272 | { 'command': 'query-memory-size-summary', 'returns': 'MemoryInfo' } |
| 1273 | |
| 1274 | ## |
| 1275 | # @PCDIMMDeviceInfo: |
| 1276 | # |
| 1277 | # PCDIMMDevice state information |
| 1278 | # |
| 1279 | # @id: device's ID |
| 1280 | # |
| 1281 | # @addr: physical address, where device is mapped |
| 1282 | # |
| 1283 | # @size: size of memory that the device provides |
| 1284 | # |
| 1285 | # @slot: slot number at which device is plugged in |
| 1286 | # |
| 1287 | # @node: NUMA node number where device is plugged in |
| 1288 | # |
| 1289 | # @memdev: memory backend linked with device |
| 1290 | # |
| 1291 | # @hotplugged: true if device was hotplugged |
| 1292 | # |
| 1293 | # @hotpluggable: true if device if could be added/removed while |
| 1294 | # machine is running |
| 1295 | # |
| 1296 | # Since: 2.1 |
| 1297 | ## |
| 1298 | { 'struct': 'PCDIMMDeviceInfo', |
| 1299 | 'data': { '*id': 'str', |
| 1300 | 'addr': 'int', |
| 1301 | 'size': 'int', |
| 1302 | 'slot': 'int', |
| 1303 | 'node': 'int', |
| 1304 | 'memdev': 'str', |
| 1305 | 'hotplugged': 'bool', |
| 1306 | 'hotpluggable': 'bool' |
| 1307 | } |
| 1308 | } |
| 1309 | |
| 1310 | ## |
| 1311 | # @VirtioPMEMDeviceInfo: |
| 1312 | # |
| 1313 | # VirtioPMEM state information |
| 1314 | # |
| 1315 | # @id: device's ID |
| 1316 | # |
| 1317 | # @memaddr: physical address in memory, where device is mapped |
| 1318 | # |
| 1319 | # @size: size of memory that the device provides |
| 1320 | # |
| 1321 | # @memdev: memory backend linked with device |
| 1322 | # |
| 1323 | # Since: 4.1 |
| 1324 | ## |
| 1325 | { 'struct': 'VirtioPMEMDeviceInfo', |
| 1326 | 'data': { '*id': 'str', |
| 1327 | 'memaddr': 'size', |
| 1328 | 'size': 'size', |
| 1329 | 'memdev': 'str' |
| 1330 | } |
| 1331 | } |
| 1332 | |
| 1333 | ## |
| 1334 | # @VirtioMEMDeviceInfo: |
| 1335 | # |
| 1336 | # VirtioMEMDevice state information |
| 1337 | # |
| 1338 | # @id: device's ID |
| 1339 | # |
| 1340 | # @memaddr: physical address in memory, where device is mapped |
| 1341 | # |
| 1342 | # @requested-size: the user requested size of the device |
| 1343 | # |
| 1344 | # @size: the (current) size of memory that the device provides |
| 1345 | # |
| 1346 | # @max-size: the maximum size of memory that the device can provide |
| 1347 | # |
| 1348 | # @block-size: the block size of memory that the device provides |
| 1349 | # |
| 1350 | # @node: NUMA node number where device is assigned to |
| 1351 | # |
| 1352 | # @memdev: memory backend linked with the region |
| 1353 | # |
| 1354 | # Since: 5.1 |
| 1355 | ## |
| 1356 | { 'struct': 'VirtioMEMDeviceInfo', |
| 1357 | 'data': { '*id': 'str', |
| 1358 | 'memaddr': 'size', |
| 1359 | 'requested-size': 'size', |
| 1360 | 'size': 'size', |
| 1361 | 'max-size': 'size', |
| 1362 | 'block-size': 'size', |
| 1363 | 'node': 'int', |
| 1364 | 'memdev': 'str' |
| 1365 | } |
| 1366 | } |
| 1367 | |
| 1368 | ## |
| 1369 | # @SgxEPCDeviceInfo: |
| 1370 | # |
| 1371 | # Sgx EPC state information |
| 1372 | # |
| 1373 | # @id: device's ID |
| 1374 | # |
| 1375 | # @memaddr: physical address in memory, where device is mapped |
| 1376 | # |
| 1377 | # @size: size of memory that the device provides |
| 1378 | # |
| 1379 | # @memdev: memory backend linked with device |
| 1380 | # |
| 1381 | # @node: the numa node (Since: 7.0) |
| 1382 | # |
| 1383 | # Since: 6.2 |
| 1384 | ## |
| 1385 | { 'struct': 'SgxEPCDeviceInfo', |
| 1386 | 'data': { '*id': 'str', |
| 1387 | 'memaddr': 'size', |
| 1388 | 'size': 'size', |
| 1389 | 'node': 'int', |
| 1390 | 'memdev': 'str' |
| 1391 | } |
| 1392 | } |
| 1393 | |
| 1394 | ## |
| 1395 | # @HvBalloonDeviceInfo: |
| 1396 | # |
| 1397 | # hv-balloon provided memory state information |
| 1398 | # |
| 1399 | # @id: device's ID |
| 1400 | # |
| 1401 | # @memaddr: physical address in memory, where device is mapped |
| 1402 | # |
| 1403 | # @max-size: the maximum size of memory that the device can provide |
| 1404 | # |
| 1405 | # @memdev: memory backend linked with device |
| 1406 | # |
| 1407 | # Since: 8.2 |
| 1408 | ## |
| 1409 | { 'struct': 'HvBalloonDeviceInfo', |
| 1410 | 'data': { '*id': 'str', |
| 1411 | '*memaddr': 'size', |
| 1412 | 'max-size': 'size', |
| 1413 | '*memdev': 'str' |
| 1414 | } |
| 1415 | } |
| 1416 | |
| 1417 | ## |
| 1418 | # @SpMemDeviceInfo: |
| 1419 | # |
| 1420 | # sp-mem device state information |
| 1421 | # |
| 1422 | # @id: device's ID |
| 1423 | # |
| 1424 | # @addr: physical address, where device is mapped |
| 1425 | # |
| 1426 | # @size: size of memory that the device provides, in bytes |
| 1427 | # |
| 1428 | # @node: NUMA proximity domain to which the device is assigned |
| 1429 | # |
| 1430 | # @memdev: memory backend linked with device |
| 1431 | # |
| 1432 | # Since: 11.1 |
| 1433 | ## |
| 1434 | { 'struct': 'SpMemDeviceInfo', |
| 1435 | 'data': { '*id': 'str', |
| 1436 | 'addr': 'size', |
| 1437 | 'size': 'size', |
| 1438 | 'node': 'int', |
| 1439 | 'memdev': 'str' |
| 1440 | } |
| 1441 | } |
| 1442 | |
| 1443 | ## |
| 1444 | # @MemoryDeviceInfoKind: |
| 1445 | # |
| 1446 | # @nvdimm: since 2.12 |
| 1447 | # |
| 1448 | # @virtio-pmem: since 4.1 |
| 1449 | # |
| 1450 | # @virtio-mem: since 5.1 |
| 1451 | # |
| 1452 | # @sgx-epc: since 6.2. |
| 1453 | # |
| 1454 | # @hv-balloon: since 8.2. |
| 1455 | # |
| 1456 | # @sp-mem: since 11.1. |
| 1457 | # |
| 1458 | # Since: 2.1 |
| 1459 | ## |
| 1460 | { 'enum': 'MemoryDeviceInfoKind', |
| 1461 | 'data': [ 'dimm', 'nvdimm', 'virtio-pmem', 'virtio-mem', 'sgx-epc', |
| 1462 | 'hv-balloon', 'sp-mem' ] } |
| 1463 | |
| 1464 | ## |
| 1465 | # @PCDIMMDeviceInfoWrapper: |
| 1466 | # |
| 1467 | # @data: PCDIMMDevice state information |
| 1468 | # |
| 1469 | # Since: 2.1 |
| 1470 | ## |
| 1471 | { 'struct': 'PCDIMMDeviceInfoWrapper', |
| 1472 | 'data': { 'data': 'PCDIMMDeviceInfo' } } |
| 1473 | |
| 1474 | ## |
| 1475 | # @VirtioPMEMDeviceInfoWrapper: |
| 1476 | # |
| 1477 | # @data: VirtioPMEM state information |
| 1478 | # |
| 1479 | # Since: 2.1 |
| 1480 | ## |
| 1481 | { 'struct': 'VirtioPMEMDeviceInfoWrapper', |
| 1482 | 'data': { 'data': 'VirtioPMEMDeviceInfo' } } |
| 1483 | |
| 1484 | ## |
| 1485 | # @VirtioMEMDeviceInfoWrapper: |
| 1486 | # |
| 1487 | # @data: VirtioMEMDevice state information |
| 1488 | # |
| 1489 | # Since: 2.1 |
| 1490 | ## |
| 1491 | { 'struct': 'VirtioMEMDeviceInfoWrapper', |
| 1492 | 'data': { 'data': 'VirtioMEMDeviceInfo' } } |
| 1493 | |
| 1494 | ## |
| 1495 | # @SgxEPCDeviceInfoWrapper: |
| 1496 | # |
| 1497 | # @data: Sgx EPC state information |
| 1498 | # |
| 1499 | # Since: 6.2 |
| 1500 | ## |
| 1501 | { 'struct': 'SgxEPCDeviceInfoWrapper', |
| 1502 | 'data': { 'data': 'SgxEPCDeviceInfo' } } |
| 1503 | |
| 1504 | ## |
| 1505 | # @HvBalloonDeviceInfoWrapper: |
| 1506 | # |
| 1507 | # @data: hv-balloon provided memory state information |
| 1508 | # |
| 1509 | # Since: 8.2 |
| 1510 | ## |
| 1511 | { 'struct': 'HvBalloonDeviceInfoWrapper', |
| 1512 | 'data': { 'data': 'HvBalloonDeviceInfo' } } |
| 1513 | |
| 1514 | ## |
| 1515 | # @SpMemDeviceInfoWrapper: |
| 1516 | # |
| 1517 | # @data: sp-mem device state information |
| 1518 | # |
| 1519 | # Since: 11.1 |
| 1520 | ## |
| 1521 | { 'struct': 'SpMemDeviceInfoWrapper', |
| 1522 | 'data': { 'data': 'SpMemDeviceInfo' } } |
| 1523 | |
| 1524 | ## |
| 1525 | # @MemoryDeviceInfo: |
| 1526 | # |
| 1527 | # Union containing information about a memory device |
| 1528 | # |
| 1529 | # @type: memory device type |
| 1530 | # |
| 1531 | # Since: 2.1 |
| 1532 | ## |
| 1533 | { 'union': 'MemoryDeviceInfo', |
| 1534 | 'base': { 'type': 'MemoryDeviceInfoKind' }, |
| 1535 | 'discriminator': 'type', |
| 1536 | 'data': { 'dimm': 'PCDIMMDeviceInfoWrapper', |
| 1537 | 'nvdimm': 'PCDIMMDeviceInfoWrapper', |
| 1538 | 'virtio-pmem': 'VirtioPMEMDeviceInfoWrapper', |
| 1539 | 'virtio-mem': 'VirtioMEMDeviceInfoWrapper', |
| 1540 | 'sgx-epc': 'SgxEPCDeviceInfoWrapper', |
| 1541 | 'hv-balloon': 'HvBalloonDeviceInfoWrapper', |
| 1542 | 'sp-mem': 'SpMemDeviceInfoWrapper' |
| 1543 | } |
| 1544 | } |
| 1545 | |
| 1546 | ## |
| 1547 | # @SgxEPC: |
| 1548 | # |
| 1549 | # Sgx EPC cmdline information |
| 1550 | # |
| 1551 | # @memdev: memory backend linked with device |
| 1552 | # |
| 1553 | # @node: the numa node (Since: 7.0) |
| 1554 | # |
| 1555 | # Since: 6.2 |
| 1556 | ## |
| 1557 | { 'struct': 'SgxEPC', |
| 1558 | 'data': { 'memdev': 'str', |
| 1559 | 'node': 'int' |
| 1560 | } |
| 1561 | } |
| 1562 | |
| 1563 | ## |
| 1564 | # @SgxEPCProperties: |
| 1565 | # |
| 1566 | # SGX properties of machine types. |
| 1567 | # |
| 1568 | # @sgx-epc: list of ids of memory-backend-epc objects. |
| 1569 | # |
| 1570 | # Since: 6.2 |
| 1571 | ## |
| 1572 | { 'struct': 'SgxEPCProperties', |
| 1573 | 'data': { 'sgx-epc': ['SgxEPC'] } |
| 1574 | } |
| 1575 | |
| 1576 | ## |
| 1577 | # @query-memory-devices: |
| 1578 | # |
| 1579 | # Lists available memory devices and their state |
| 1580 | # |
| 1581 | # Since: 2.1 |
| 1582 | # |
| 1583 | # .. qmp-example:: |
| 1584 | # |
| 1585 | # -> { "execute": "query-memory-devices" } |
| 1586 | # <- { "return": [ { "data": |
| 1587 | # { "addr": 5368709120, |
| 1588 | # "hotpluggable": true, |
| 1589 | # "hotplugged": true, |
| 1590 | # "id": "d1", |
| 1591 | # "memdev": "/objects/memX", |
| 1592 | # "node": 0, |
| 1593 | # "size": 1073741824, |
| 1594 | # "slot": 0}, |
| 1595 | # "type": "dimm" |
| 1596 | # } ] } |
| 1597 | ## |
| 1598 | { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] } |
| 1599 | |
| 1600 | ## |
| 1601 | # @MEMORY_DEVICE_SIZE_CHANGE: |
| 1602 | # |
| 1603 | # Emitted when the size of a memory device changes. Only emitted for |
| 1604 | # memory devices that can actually change the size (e.g., virtio-mem |
| 1605 | # due to guest action). |
| 1606 | # |
| 1607 | # @id: device's ID |
| 1608 | # |
| 1609 | # @size: the new size of memory that the device provides |
| 1610 | # |
| 1611 | # @qom-path: path to the device object in the QOM tree (since 6.2) |
| 1612 | # |
| 1613 | # .. note:: This event is rate-limited. |
| 1614 | # |
| 1615 | # Since: 5.1 |
| 1616 | # |
| 1617 | # .. qmp-example:: |
| 1618 | # |
| 1619 | # <- { "event": "MEMORY_DEVICE_SIZE_CHANGE", |
| 1620 | # "data": { "id": "vm0", "size": 1073741824, |
| 1621 | # "qom-path": "/machine/unattached/device[2]" }, |
| 1622 | # "timestamp": { "seconds": 1588168529, "microseconds": 201316 } } |
| 1623 | ## |
| 1624 | { 'event': 'MEMORY_DEVICE_SIZE_CHANGE', |
| 1625 | 'data': { '*id': 'str', 'size': 'size', 'qom-path' : 'str'} } |
| 1626 | |
| 1627 | ## |
| 1628 | # @BootConfiguration: |
| 1629 | # |
| 1630 | # Schema for virtual machine boot configuration. |
| 1631 | # |
| 1632 | # @order: Boot order (a=floppy, c=hard disk, d=CD-ROM, n=network) |
| 1633 | # |
| 1634 | # @once: Boot order to apply on first boot |
| 1635 | # |
| 1636 | # @menu: Whether to show a boot menu |
| 1637 | # |
| 1638 | # @splash: The name of the file to be passed to the firmware as logo |
| 1639 | # picture, if @menu is true. |
| 1640 | # |
| 1641 | # @splash-time: How long to show the logo picture, in milliseconds |
| 1642 | # |
| 1643 | # @reboot-timeout: Timeout before guest reboots after boot fails |
| 1644 | # |
| 1645 | # @strict: Whether to attempt booting from devices not included in the |
| 1646 | # boot order |
| 1647 | # |
| 1648 | # Since: 7.1 |
| 1649 | ## |
| 1650 | { 'struct': 'BootConfiguration', 'data': { |
| 1651 | '*order': 'str', |
| 1652 | '*once': 'str', |
| 1653 | '*menu': 'bool', |
| 1654 | '*splash': 'str', |
| 1655 | '*splash-time': 'int', |
| 1656 | '*reboot-timeout': 'int', |
| 1657 | '*strict': 'bool' } } |
| 1658 | |
| 1659 | ## |
| 1660 | # @SMPConfiguration: |
| 1661 | # |
| 1662 | # Schema for CPU topology configuration. A missing value lets QEMU |
| 1663 | # figure out a suitable value based on the ones that are provided. |
| 1664 | # |
| 1665 | # The members other than @cpus and @maxcpus define a topology of |
| 1666 | # containers. |
| 1667 | # |
| 1668 | # The ordering from highest/coarsest to lowest/finest is: @drawers, |
| 1669 | # @books, @sockets, @dies, @clusters, @cores, @threads. |
| 1670 | # |
| 1671 | # Different architectures support different subsets of topology |
| 1672 | # containers. |
| 1673 | # |
| 1674 | # For example, s390x does not have clusters and dies, and the socket |
| 1675 | # is the parent container of cores. |
| 1676 | # |
| 1677 | # @cpus: number of virtual CPUs in the virtual machine |
| 1678 | # |
| 1679 | # @maxcpus: maximum number of hotpluggable virtual CPUs in the virtual |
| 1680 | # machine |
| 1681 | # |
| 1682 | # @drawers: number of drawers in the CPU topology (since 8.2) |
| 1683 | # |
| 1684 | # @books: number of books in the CPU topology (since 8.2) |
| 1685 | # |
| 1686 | # @sockets: number of sockets per parent container |
| 1687 | # |
| 1688 | # @dies: number of dies per parent container |
| 1689 | # |
| 1690 | # @clusters: number of clusters per parent container (since 7.0) |
| 1691 | # |
| 1692 | # @modules: number of modules per parent container (since 9.1) |
| 1693 | # |
| 1694 | # @cores: number of cores per parent container |
| 1695 | # |
| 1696 | # @threads: number of threads per core |
| 1697 | # |
| 1698 | # Since: 6.1 |
| 1699 | ## |
| 1700 | { 'struct': 'SMPConfiguration', 'data': { |
| 1701 | '*cpus': 'int', |
| 1702 | '*drawers': 'int', |
| 1703 | '*books': 'int', |
| 1704 | '*sockets': 'int', |
| 1705 | '*dies': 'int', |
| 1706 | '*clusters': 'int', |
| 1707 | '*modules': 'int', |
| 1708 | '*cores': 'int', |
| 1709 | '*threads': 'int', |
| 1710 | '*maxcpus': 'int' } } |
| 1711 | |
| 1712 | ## |
| 1713 | # @x-query-irq: |
| 1714 | # |
| 1715 | # Query interrupt statistics |
| 1716 | # |
| 1717 | # Features: |
| 1718 | # |
| 1719 | # @unstable: This command is meant for debugging. |
| 1720 | # |
| 1721 | # Returns: interrupt statistics |
| 1722 | # |
| 1723 | # Since: 6.2 |
| 1724 | ## |
| 1725 | { 'command': 'x-query-irq', |
| 1726 | 'returns': 'HumanReadableText', |
| 1727 | 'features': [ 'unstable' ] } |
| 1728 | |
| 1729 | ## |
| 1730 | # @x-query-jit: |
| 1731 | # |
| 1732 | # Query TCG compiler statistics |
| 1733 | # |
| 1734 | # Features: |
| 1735 | # |
| 1736 | # @unstable: This command is meant for debugging. |
| 1737 | # |
| 1738 | # Returns: TCG compiler statistics |
| 1739 | # |
| 1740 | # Since: 6.2 |
| 1741 | ## |
| 1742 | { 'command': 'x-query-jit', |
| 1743 | 'returns': 'HumanReadableText', |
| 1744 | 'if': 'CONFIG_TCG', |
| 1745 | 'features': [ 'unstable' ] } |
| 1746 | |
| 1747 | ## |
| 1748 | # @x-query-numa: |
| 1749 | # |
| 1750 | # Query NUMA topology information |
| 1751 | # |
| 1752 | # Features: |
| 1753 | # |
| 1754 | # @unstable: This command is meant for debugging. |
| 1755 | # |
| 1756 | # Returns: topology information |
| 1757 | # |
| 1758 | # Since: 6.2 |
| 1759 | ## |
| 1760 | { 'command': 'x-query-numa', |
| 1761 | 'returns': 'HumanReadableText', |
| 1762 | 'features': [ 'unstable' ] } |
| 1763 | |
| 1764 | ## |
| 1765 | # @x-query-ramblock: |
| 1766 | # |
| 1767 | # Query system ramblock information |
| 1768 | # |
| 1769 | # Features: |
| 1770 | # |
| 1771 | # @unstable: This command is meant for debugging. |
| 1772 | # |
| 1773 | # Returns: system ramblock information |
| 1774 | # |
| 1775 | # Since: 6.2 |
| 1776 | ## |
| 1777 | { 'command': 'x-query-ramblock', |
| 1778 | 'returns': 'HumanReadableText', |
| 1779 | 'features': [ 'unstable' ] } |
| 1780 | |
| 1781 | ## |
| 1782 | # @x-query-roms: |
| 1783 | # |
| 1784 | # Query information on the registered ROMS |
| 1785 | # |
| 1786 | # Features: |
| 1787 | # |
| 1788 | # @unstable: This command is meant for debugging. |
| 1789 | # |
| 1790 | # Returns: registered ROMs |
| 1791 | # |
| 1792 | # Since: 6.2 |
| 1793 | ## |
| 1794 | { 'command': 'x-query-roms', |
| 1795 | 'returns': 'HumanReadableText', |
| 1796 | 'features': [ 'unstable' ] } |
| 1797 | |
| 1798 | ## |
| 1799 | # @x-query-usb: |
| 1800 | # |
| 1801 | # Query information on the USB devices |
| 1802 | # |
| 1803 | # Features: |
| 1804 | # |
| 1805 | # @unstable: This command is meant for debugging. |
| 1806 | # |
| 1807 | # Returns: USB device information |
| 1808 | # |
| 1809 | # Since: 6.2 |
| 1810 | ## |
| 1811 | { 'command': 'x-query-usb', |
| 1812 | 'returns': 'HumanReadableText', |
| 1813 | 'features': [ 'unstable' ] } |
| 1814 | |
| 1815 | ## |
| 1816 | # @SmbiosEntryPointType: |
| 1817 | # |
| 1818 | # @32: SMBIOS version 2.1 (32-bit) Entry Point |
| 1819 | # |
| 1820 | # @64: SMBIOS version 3.0 (64-bit) Entry Point |
| 1821 | # |
| 1822 | # @auto: Either 2.x or 3.x SMBIOS version, 2.x if configuration can be |
| 1823 | # described by it and 3.x otherwise (since: 9.0) |
| 1824 | # |
| 1825 | # Since: 7.0 |
| 1826 | ## |
| 1827 | { 'enum': 'SmbiosEntryPointType', |
| 1828 | 'data': [ '32', '64', 'auto' ] } |
| 1829 | |
| 1830 | ## |
| 1831 | # @MemorySizeConfiguration: |
| 1832 | # |
| 1833 | # Schema for memory size configuration. |
| 1834 | # |
| 1835 | # @size: memory size in bytes |
| 1836 | # |
| 1837 | # @max-size: maximum hotpluggable memory size in bytes |
| 1838 | # |
| 1839 | # @slots: number of available memory slots for hotplug |
| 1840 | # |
| 1841 | # Since: 7.1 |
| 1842 | ## |
| 1843 | { 'struct': 'MemorySizeConfiguration', 'data': { |
| 1844 | '*size': 'size', |
| 1845 | '*max-size': 'size', |
| 1846 | '*slots': 'uint64' } } |
| 1847 | |
| 1848 | ## |
| 1849 | # @dumpdtb: |
| 1850 | # |
| 1851 | # Save the FDT in dtb format. |
| 1852 | # |
| 1853 | # @filename: name of the dtb file to be created |
| 1854 | # |
| 1855 | # Since: 7.2 |
| 1856 | # |
| 1857 | # .. qmp-example:: |
| 1858 | # |
| 1859 | # -> { "execute": "dumpdtb" } |
| 1860 | # "arguments": { "filename": "fdt.dtb" } } |
| 1861 | # <- { "return": {} } |
| 1862 | ## |
| 1863 | { 'command': 'dumpdtb', |
| 1864 | 'data': { 'filename': 'str' }, |
| 1865 | 'if': 'CONFIG_FDT' } |
| 1866 | |
| 1867 | ## |
| 1868 | # @x-query-interrupt-controllers: |
| 1869 | # |
| 1870 | # Query information on interrupt controller devices |
| 1871 | # |
| 1872 | # Features: |
| 1873 | # |
| 1874 | # @unstable: This command is meant for debugging. |
| 1875 | # |
| 1876 | # Returns: Interrupt controller devices information |
| 1877 | # |
| 1878 | # Since: 9.1 |
| 1879 | ## |
| 1880 | { 'command': 'x-query-interrupt-controllers', |
| 1881 | 'returns': 'HumanReadableText', |
| 1882 | 'features': [ 'unstable' ]} |
| 1883 | |
| 1884 | ## |
| 1885 | # @FirmwareLog: |
| 1886 | # |
| 1887 | # @version: Firmware version. |
| 1888 | # |
| 1889 | # @log: Firmware debug log, in base64 encoding. First and last log |
| 1890 | # line might be incomplete. |
| 1891 | # |
| 1892 | # Since: 10.2 |
| 1893 | ## |
| 1894 | { 'struct': 'FirmwareLog', |
| 1895 | 'data': { '*version': 'str', |
| 1896 | 'log': 'str' } } |
| 1897 | |
| 1898 | ## |
| 1899 | # @query-firmware-log: |
| 1900 | # |
| 1901 | # Find firmware memory log buffer in guest memory, return content. |
| 1902 | # |
| 1903 | # @max-size: limit the amount of log data returned. Up to 1 MiB of |
| 1904 | # log data is allowed. In case the amount of log data is larger |
| 1905 | # than @max-size the tail of the log is returned. |
| 1906 | # |
| 1907 | # Since: 10.2 |
| 1908 | ## |
| 1909 | { 'command': 'query-firmware-log', |
| 1910 | 'data': { '*max-size': 'size' }, |
| 1911 | 'returns': 'FirmwareLog' } |
| 1912 | |
| 1913 | ## |
| 1914 | # @dump-skeys: |
| 1915 | # |
| 1916 | # Dump the storage keys for an s390x guest |
| 1917 | # |
| 1918 | # @filename: the path to the file to dump to |
| 1919 | # |
| 1920 | # Since: 2.5 |
| 1921 | # |
| 1922 | # .. qmp-example:: |
| 1923 | # |
| 1924 | # -> { "execute": "dump-skeys", |
| 1925 | # "arguments": { "filename": "/tmp/skeys" } } |
| 1926 | # <- { "return": {} } |
| 1927 | ## |
| 1928 | { 'command': 'dump-skeys', |
| 1929 | 'data': { 'filename': 'str' } } |
| 1930 | |
| 1931 | ## |
| 1932 | # @CpuModelInfo: |
| 1933 | # |
| 1934 | # Virtual CPU model. |
| 1935 | # |
| 1936 | # A CPU model consists of the name of a CPU definition, to which delta |
| 1937 | # changes are applied (e.g. features added/removed). Most magic |
| 1938 | # values that an architecture might require should be hidden behind |
| 1939 | # the name. However, if required, architectures can expose relevant |
| 1940 | # properties. |
| 1941 | # |
| 1942 | # @name: the name of the CPU definition the model is based on |
| 1943 | # |
| 1944 | # @props: a dictionary of QOM properties to be applied |
| 1945 | # |
| 1946 | # Since: 2.8 |
| 1947 | ## |
| 1948 | { 'struct': 'CpuModelInfo', |
| 1949 | 'data': { 'name': 'str', |
| 1950 | '*props': 'any' } } |
| 1951 | |
| 1952 | ## |
| 1953 | # @CpuModelExpansionType: |
| 1954 | # |
| 1955 | # An enumeration of CPU model expansion types. |
| 1956 | # |
| 1957 | # @static: Expand to a static CPU model, a combination of a static |
| 1958 | # base model name and property delta changes. As the static base |
| 1959 | # model will never change, the expanded CPU model will be the |
| 1960 | # same, independent of QEMU version, machine type, machine |
| 1961 | # options, and accelerator options. Therefore, the resulting |
| 1962 | # model can be used by tooling without having to specify a |
| 1963 | # compatibility machine - e.g. when displaying the "host" model. |
| 1964 | # The @static CPU models are migration-safe. |
| 1965 | # |
| 1966 | # @full: Expand all properties. The produced model is not guaranteed |
| 1967 | # to be migration-safe, but allows tooling to get an insight and |
| 1968 | # work with model details. |
| 1969 | # |
| 1970 | # .. note:: When a non-migration-safe CPU model is expanded in static |
| 1971 | # mode, some features enabled by the CPU model may be omitted, |
| 1972 | # because they can't be implemented by a static CPU model |
| 1973 | # definition (e.g. cache info passthrough and PMU passthrough in |
| 1974 | # x86). If you need an accurate representation of the features |
| 1975 | # enabled by a non-migration-safe CPU model, use @full. If you |
| 1976 | # need a static representation that will keep ABI compatibility |
| 1977 | # even when changing QEMU version or machine-type, use @static (but |
| 1978 | # keep in mind that some features may be omitted). |
| 1979 | # |
| 1980 | # Since: 2.8 |
| 1981 | ## |
| 1982 | { 'enum': 'CpuModelExpansionType', |
| 1983 | 'data': [ 'static', 'full' ] } |
| 1984 | |
| 1985 | ## |
| 1986 | # @CpuModelCompareResult: |
| 1987 | # |
| 1988 | # An enumeration of CPU model comparison results. The result is |
| 1989 | # usually calculated using e.g. CPU features or CPU generations. |
| 1990 | # |
| 1991 | # @incompatible: If model A is incompatible to model B, model A is not |
| 1992 | # guaranteed to run where model B runs and the other way around. |
| 1993 | # |
| 1994 | # @identical: If model A is identical to model B, model A is |
| 1995 | # guaranteed to run where model B runs and the other way around. |
| 1996 | # |
| 1997 | # @superset: If model A is a superset of model B, model B is |
| 1998 | # guaranteed to run where model A runs. There are no guarantees |
| 1999 | # about the other way. |
| 2000 | # |
| 2001 | # @subset: If model A is a subset of model B, model A is guaranteed to |
| 2002 | # run where model B runs. There are no guarantees about the other |
| 2003 | # way. |
| 2004 | # |
| 2005 | # Since: 2.8 |
| 2006 | ## |
| 2007 | { 'enum': 'CpuModelCompareResult', |
| 2008 | 'data': [ 'incompatible', 'identical', 'superset', 'subset' ] } |
| 2009 | |
| 2010 | ## |
| 2011 | # @CpuModelBaselineInfo: |
| 2012 | # |
| 2013 | # The result of a CPU model baseline. |
| 2014 | # |
| 2015 | # @model: the baselined `CpuModelInfo`. |
| 2016 | # |
| 2017 | # Since: 2.8 |
| 2018 | ## |
| 2019 | { 'struct': 'CpuModelBaselineInfo', |
| 2020 | 'data': { 'model': 'CpuModelInfo' } } |
| 2021 | |
| 2022 | ## |
| 2023 | # @CpuModelCompareInfo: |
| 2024 | # |
| 2025 | # The result of a CPU model comparison. |
| 2026 | # |
| 2027 | # @result: The result of the compare operation. |
| 2028 | # |
| 2029 | # @responsible-properties: List of properties that led to the |
| 2030 | # comparison result not being identical. |
| 2031 | # |
| 2032 | # @responsible-properties is a list of QOM property names that led to |
| 2033 | # both CPUs not being detected as identical. For identical models, |
| 2034 | # this list is empty. If a QOM property is read-only, that means |
| 2035 | # there's no known way to make the CPU models identical. If the |
| 2036 | # special property name "type" is included, the models are by |
| 2037 | # definition not identical and cannot be made identical. |
| 2038 | # |
| 2039 | # Since: 2.8 |
| 2040 | ## |
| 2041 | { 'struct': 'CpuModelCompareInfo', |
| 2042 | 'data': { 'result': 'CpuModelCompareResult', |
| 2043 | 'responsible-properties': ['str'] } } |
| 2044 | |
| 2045 | ## |
| 2046 | # @query-cpu-model-comparison: |
| 2047 | # |
| 2048 | # Compares two CPU models, @modela and @modelb, returning how they |
| 2049 | # compare in a specific configuration. The results indicates how both |
| 2050 | # models compare regarding runnability. This result can be used by |
| 2051 | # tooling to make decisions if a certain CPU model will run in a |
| 2052 | # certain configuration or if a compatible CPU model has to be created |
| 2053 | # by baselining. |
| 2054 | # |
| 2055 | # Usually, a CPU model is compared against the maximum possible CPU |
| 2056 | # model of a certain configuration (e.g. the "host" model for KVM). |
| 2057 | # If that CPU model is identical or a subset, it will run in that |
| 2058 | # configuration. |
| 2059 | # |
| 2060 | # The result returned by this command may be affected by: |
| 2061 | # |
| 2062 | # * QEMU version: CPU models may look different depending on the QEMU |
| 2063 | # version. (Except for CPU models reported as "static" in |
| 2064 | # `query-cpu-definitions`.) |
| 2065 | # * machine-type: CPU model may look different depending on the |
| 2066 | # machine-type. (Except for CPU models reported as "static" in |
| 2067 | # `query-cpu-definitions`.) |
| 2068 | # * machine options (including accelerator): in some architectures, |
| 2069 | # CPU models may look different depending on machine and accelerator |
| 2070 | # options. (Except for CPU models reported as "static" in |
| 2071 | # `query-cpu-definitions`.) |
| 2072 | # * "-cpu" arguments and global properties: arguments to the -cpu |
| 2073 | # option and global properties may affect expansion of CPU models. |
| 2074 | # Using `query-cpu-model-expansion` while using these is not |
| 2075 | # advised. |
| 2076 | # |
| 2077 | # Some architectures may not support comparing CPU models. s390x |
| 2078 | # supports comparing CPU models. |
| 2079 | # |
| 2080 | # @modela: description of the first CPU model to compare, referred to |
| 2081 | # as "model A" in `CpuModelCompareResult` |
| 2082 | # |
| 2083 | # @modelb: description of the second CPU model to compare, referred to |
| 2084 | # as "model B" in `CpuModelCompareResult` |
| 2085 | # |
| 2086 | # Returns: a `CpuModelCompareInfo` describing how both CPU models |
| 2087 | # compare |
| 2088 | # |
| 2089 | # Errors: |
| 2090 | # - if comparing CPU models is not supported by the target |
| 2091 | # - if a model cannot be used |
| 2092 | # - if a model contains an unknown cpu definition name, unknown |
| 2093 | # properties or properties with wrong types. |
| 2094 | # |
| 2095 | # Since: 2.8 |
| 2096 | ## |
| 2097 | { 'command': 'query-cpu-model-comparison', |
| 2098 | 'data': { 'modela': 'CpuModelInfo', 'modelb': 'CpuModelInfo' }, |
| 2099 | 'returns': 'CpuModelCompareInfo' } |
| 2100 | |
| 2101 | ## |
| 2102 | # @query-cpu-model-baseline: |
| 2103 | # |
| 2104 | # Baseline two CPU models, @modela and @modelb, creating a compatible |
| 2105 | # third model. The created model will always be a static, |
| 2106 | # migration-safe CPU model (see "static" CPU model expansion for |
| 2107 | # details). |
| 2108 | # |
| 2109 | # This interface can be used by tooling to create a compatible CPU |
| 2110 | # model out two CPU models. The created CPU model will be identical |
| 2111 | # to or a subset of both CPU models when comparing them. Therefore, |
| 2112 | # the created CPU model is guaranteed to run where the given CPU |
| 2113 | # models run. |
| 2114 | # |
| 2115 | # The result returned by this command may be affected by: |
| 2116 | # |
| 2117 | # * QEMU version: CPU models may look different depending on the QEMU |
| 2118 | # version. (Except for CPU models reported as "static" in |
| 2119 | # `query-cpu-definitions`.) |
| 2120 | # * machine-type: CPU model may look different depending on the |
| 2121 | # machine-type. (Except for CPU models reported as "static" in |
| 2122 | # `query-cpu-definitions`.) |
| 2123 | # * machine options (including accelerator): in some architectures, |
| 2124 | # CPU models may look different depending on machine and accelerator |
| 2125 | # options. (Except for CPU models reported as "static" in |
| 2126 | # `query-cpu-definitions`.) |
| 2127 | # * "-cpu" arguments and global properties: arguments to the -cpu |
| 2128 | # option and global properties may affect expansion of CPU models. |
| 2129 | # Using `query-cpu-model-expansion` while using these is not |
| 2130 | # advised. |
| 2131 | # |
| 2132 | # Some architectures may not support baselining CPU models. s390x |
| 2133 | # supports baselining CPU models. |
| 2134 | # |
| 2135 | # @modela: description of the first CPU model to baseline |
| 2136 | # |
| 2137 | # @modelb: description of the second CPU model to baseline |
| 2138 | # |
| 2139 | # Returns: a `CpuModelBaselineInfo` describing the baselined CPU model |
| 2140 | # |
| 2141 | # Errors: |
| 2142 | # - if baselining CPU models is not supported by the target |
| 2143 | # - if a model cannot be used |
| 2144 | # - if a model contains an unknown cpu definition name, unknown |
| 2145 | # properties or properties with wrong types. |
| 2146 | # |
| 2147 | # Since: 2.8 |
| 2148 | ## |
| 2149 | { 'command': 'query-cpu-model-baseline', |
| 2150 | 'data': { 'modela': 'CpuModelInfo', |
| 2151 | 'modelb': 'CpuModelInfo' }, |
| 2152 | 'returns': 'CpuModelBaselineInfo' } |
| 2153 | |
| 2154 | ## |
| 2155 | # @CpuModelExpansionInfo: |
| 2156 | # |
| 2157 | # The result of a cpu model expansion. |
| 2158 | # |
| 2159 | # @model: the expanded `CpuModelInfo`. |
| 2160 | # |
| 2161 | # @deprecated-props: an optional list of properties that are flagged |
| 2162 | # as deprecated by the CPU vendor. The list depends on the |
| 2163 | # `CpuModelExpansionType`: "static" properties are a subset of the |
| 2164 | # enabled-properties for the expanded model; "full" properties are |
| 2165 | # a set of properties that are deprecated across all models for |
| 2166 | # the architecture. (since: 10.1 -- since 9.1 on s390x --). |
| 2167 | # |
| 2168 | # Since: 2.8 |
| 2169 | ## |
| 2170 | { 'struct': 'CpuModelExpansionInfo', |
| 2171 | 'data': { 'model': 'CpuModelInfo', |
| 2172 | '*deprecated-props' : ['str'] } } |
| 2173 | |
| 2174 | ## |
| 2175 | # @query-cpu-model-expansion: |
| 2176 | # |
| 2177 | # Expands a given CPU model, @model, (or a combination of CPU model + |
| 2178 | # additional options) to different granularities, specified by @type, |
| 2179 | # allowing tooling to get an understanding what a specific CPU model |
| 2180 | # looks like in QEMU under a certain configuration. |
| 2181 | # |
| 2182 | # This interface can be used to query the "host" CPU model. |
| 2183 | # |
| 2184 | # The data returned by this command may be affected by: |
| 2185 | # |
| 2186 | # * QEMU version: CPU models may look different depending on the QEMU |
| 2187 | # version. (Except for CPU models reported as "static" in |
| 2188 | # `query-cpu-definitions`.) |
| 2189 | # * machine-type: CPU model may look different depending on the |
| 2190 | # machine-type. (Except for CPU models reported as "static" in |
| 2191 | # `query-cpu-definitions`.) |
| 2192 | # * machine options (including accelerator): in some architectures, |
| 2193 | # CPU models may look different depending on machine and accelerator |
| 2194 | # options. (Except for CPU models reported as "static" in |
| 2195 | # `query-cpu-definitions`.) |
| 2196 | # * "-cpu" arguments and global properties: arguments to the -cpu |
| 2197 | # option and global properties may affect expansion of CPU models. |
| 2198 | # Using `query-cpu-model-expansion` while using these is not |
| 2199 | # advised. |
| 2200 | # |
| 2201 | # Some architectures may not support all expansion types. s390x |
| 2202 | # supports "full" and "static". Arm only supports "full". |
| 2203 | # |
| 2204 | # @model: description of the CPU model to expand |
| 2205 | # |
| 2206 | # @type: expansion type, specifying how to expand the CPU model |
| 2207 | # |
| 2208 | # Returns: a `CpuModelExpansionInfo` describing the expanded CPU model |
| 2209 | # |
| 2210 | # Errors: |
| 2211 | # - if expanding CPU models is not supported |
| 2212 | # - if the model cannot be expanded |
| 2213 | # - if the model contains an unknown CPU definition name, unknown |
| 2214 | # properties or properties with a wrong type |
| 2215 | # - if an expansion type is not supported |
| 2216 | # |
| 2217 | # Since: 2.8 |
| 2218 | ## |
| 2219 | { 'command': 'query-cpu-model-expansion', |
| 2220 | 'data': { 'type': 'CpuModelExpansionType', |
| 2221 | 'model': 'CpuModelInfo' }, |
| 2222 | 'returns': 'CpuModelExpansionInfo' } |
| 2223 | |
| 2224 | ## |
| 2225 | # @CpuDefinitionInfo: |
| 2226 | # |
| 2227 | # Virtual CPU definition. |
| 2228 | # |
| 2229 | # @name: the name of the CPU definition |
| 2230 | # |
| 2231 | # @migration-safe: whether a CPU definition can be safely used for |
| 2232 | # migration in combination with a QEMU compatibility machine when |
| 2233 | # migrating between different QEMU versions and between hosts with |
| 2234 | # different sets of (hardware or software) capabilities. If not |
| 2235 | # provided, information is not available and callers should not |
| 2236 | # assume the CPU definition to be migration-safe. (since 2.8) |
| 2237 | # |
| 2238 | # @static: whether a CPU definition is static and will not change |
| 2239 | # depending on QEMU version, machine type, machine options and |
| 2240 | # accelerator options. A static model is always migration-safe. |
| 2241 | # (since 2.8) |
| 2242 | # |
| 2243 | # @unavailable-features: List of properties that prevent the CPU model |
| 2244 | # from running in the current host. (since 2.8) |
| 2245 | # |
| 2246 | # @typename: Type name that can be used as argument to |
| 2247 | # `device-list-properties`, to introspect properties configurable |
| 2248 | # using -cpu or -global. (since 2.9) |
| 2249 | # |
| 2250 | # @alias-of: Name of CPU model this model is an alias for. The target |
| 2251 | # of the CPU model alias may change depending on the machine type. |
| 2252 | # Management software is supposed to translate CPU model aliases |
| 2253 | # in the VM configuration, because aliases may stop being |
| 2254 | # migration-safe in the future (since 4.1) |
| 2255 | # |
| 2256 | # @deprecated: If true, this CPU model is deprecated and may be |
| 2257 | # removed in some future version of QEMU according to the QEMU |
| 2258 | # deprecation policy. (since 5.2) |
| 2259 | # |
| 2260 | # @unavailable-features is a list of QOM property names that represent |
| 2261 | # CPU model attributes that prevent the CPU from running. If the QOM |
| 2262 | # property is read-only, that means there's no known way to make the |
| 2263 | # CPU model run in the current host. Implementations that choose not |
| 2264 | # to provide specific information return the property name "type". If |
| 2265 | # the property is read-write, it means that it MAY be possible to run |
| 2266 | # the CPU model in the current host if that property is changed. |
| 2267 | # Management software can use it as hints to suggest or choose an |
| 2268 | # alternative for the user, or just to generate meaningful error |
| 2269 | # messages explaining why the CPU model can't be used. If |
| 2270 | # @unavailable-features is an empty list, the CPU model is runnable |
| 2271 | # using the current host and machine-type. If @unavailable-features |
| 2272 | # is not present, runnability information for the CPU is not |
| 2273 | # available. |
| 2274 | # |
| 2275 | # Since: 1.2 |
| 2276 | ## |
| 2277 | { 'struct': 'CpuDefinitionInfo', |
| 2278 | 'data': { 'name': 'str', |
| 2279 | '*migration-safe': 'bool', |
| 2280 | 'static': 'bool', |
| 2281 | '*unavailable-features': [ 'str' ], |
| 2282 | 'typename': 'str', |
| 2283 | '*alias-of' : 'str', |
| 2284 | 'deprecated' : 'bool' } } |
| 2285 | |
| 2286 | ## |
| 2287 | # @query-cpu-definitions: |
| 2288 | # |
| 2289 | # Return a list of supported virtual CPU definitions |
| 2290 | # |
| 2291 | # Since: 1.2 |
| 2292 | ## |
| 2293 | { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] } |