mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-08-03 07:43:54 -06:00
Monitor patches for 2019-07-02
-----BEGIN PGP SIGNATURE----- iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAl0bQhUSHGFybWJydUBy ZWRoYXQuY29tAAoJEDhwtADrkYZTOgoP/3v1ZAg4ulTrUx/KO8C80sA3qqaPgkbP s8DFUwtjWcDrefGejIep4C0dxhY5vD1oNg9JeK+6O4IInijlg30kildBj85nPa5J Z55hZFIGWW1CSMzeSlOMWH1QdYdGPXkGRe8ApXPqRH4VpsdulC+vErQl1YrleNtv B8K8402hMOKL+TsheBpdnbM+1hXRj8zBGfobiY/9eLex30uaNDVOd3bIpx0M63fr kcwOOPKQeUTLPbUvI6mVQtTkNFCzk6Wmi5vMyT3bSe2ZMLNnEFQZXabcgSBverTK 9ar5MxTMHIplstWVQEceXN3BLVlIsmunUsuCSHqmX6tdX37EKiJXZImiz0i98bnq 5SFNAHntr3JDMdqqZJX+v1DvmGbPfv/H5poWk+wQfFBkjDykExEd77v9kuOc4aVZ HkEYNbAPVTjfm5xXxn8yXdY++tVsQKV4q2T4OX9WacMu5sJujDm9qIlVaE2A3Cdc ePM4tNrHJ0MNDHn2CG/wPEaLelfylLlL/Aai/WQe/YPVrVOHroT4zvwVv6+QJB2k MWqmRzGEOYDevPs8PizPetEHiirTHyrIufuleFJglBVSNi5V2LpG5d97Pal0Dn2k 1ZzSnonXGnhx7VoaqbxhAEj8vAI42gJJ3Q/f6VW2q2rBAv4/oc9jeQVx1SYGFKCu QbNALrVpyv+5 =jtpi -----END PGP SIGNATURE----- Merge remote-tracking branch 'remotes/armbru/tags/pull-monitor-2019-07-02-v2' into staging Monitor patches for 2019-07-02 # gpg: Signature made Tue 02 Jul 2019 12:37:57 BST # gpg: using RSA key 354BC8B3D7EB2A6B68674E5F3870B400EB918653 # gpg: issuer "armbru@redhat.com" # gpg: Good signature from "Markus Armbruster <armbru@redhat.com>" [full] # gpg: aka "Markus Armbruster <armbru@pond.sub.org>" [full] # Primary key fingerprint: 354B C8B3 D7EB 2A6B 6867 4E5F 3870 B400 EB91 8653 * remotes/armbru/tags/pull-monitor-2019-07-02-v2: dump: Move HMP command handlers to dump/ MAINTAINERS: Add Windows dump to section "Dump" dump: Move the code to dump/ qapi: Split dump.json off misc.json qapi: Rename target.json to misc-target.json qapi: Split machine-target.json off target.json and misc.json hw/core: Collect HMP command handlers in hw/core/ hw/core: Collect QMP command handlers in hw/core/ hw/core: Move numa.c to hw/core/ qapi: Split machine.json off misc.json MAINTAINERS: Merge sections CPU, NUMA into Machine core qom: Move HMP command handlers to qom/ qom: Move QMP command handlers to qom/ qapi: Split qom.json and qdev.json off misc.json hmp: Move hmp.h to include/monitor/ Makefile: Don't add monitor/ twice to common-obj-y MAINTAINERS: Make section "QOM" cover qdev as well MAINTAINERS: new maintainers for QOM Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
This commit is contained in:
Peter Maydell
commit
374f63f681
56 changed files with 2698 additions and 2553 deletions
|
|
@ -6,9 +6,10 @@ util-obj-y += qmp-event.o
|
|||
util-obj-y += qapi-util.o
|
||||
|
||||
QAPI_COMMON_MODULES = audio authz block-core block char common crypto
|
||||
QAPI_COMMON_MODULES += introspect job migration misc net rdma rocker
|
||||
QAPI_COMMON_MODULES += run-state sockets tpm trace transaction ui
|
||||
QAPI_TARGET_MODULES = target
|
||||
QAPI_COMMON_MODULES += dump introspect job machine migration misc net
|
||||
QAPI_COMMON_MODULES += qdev qom rdma rocker run-state sockets tpm
|
||||
QAPI_COMMON_MODULES += trace transaction ui
|
||||
QAPI_TARGET_MODULES = machine-target misc-target
|
||||
QAPI_MODULES = $(QAPI_COMMON_MODULES) $(QAPI_TARGET_MODULES)
|
||||
|
||||
util-obj-y += qapi-builtin-types.o
|
||||
|
|
|
|||
200
qapi/dump.json
Normal file
200
qapi/dump.json
Normal file
|
|
@ -0,0 +1,200 @@
|
|||
# -*- Mode: Python -*-
|
||||
#
|
||||
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
||||
# See the COPYING file in the top-level directory.
|
||||
|
||||
##
|
||||
# = Dump guest memory
|
||||
##
|
||||
|
||||
##
|
||||
# @DumpGuestMemoryFormat:
|
||||
#
|
||||
# An enumeration of guest-memory-dump's format.
|
||||
#
|
||||
# @elf: elf format
|
||||
#
|
||||
# @kdump-zlib: kdump-compressed format with zlib-compressed
|
||||
#
|
||||
# @kdump-lzo: kdump-compressed format with lzo-compressed
|
||||
#
|
||||
# @kdump-snappy: kdump-compressed format with snappy-compressed
|
||||
#
|
||||
# @win-dmp: Windows full crashdump format,
|
||||
# can be used instead of ELF converting (since 2.13)
|
||||
#
|
||||
# Since: 2.0
|
||||
##
|
||||
{ 'enum': 'DumpGuestMemoryFormat',
|
||||
'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy', 'win-dmp' ] }
|
||||
|
||||
##
|
||||
# @dump-guest-memory:
|
||||
#
|
||||
# Dump guest's memory to vmcore. It is a synchronous operation that can take
|
||||
# very long depending on the amount of guest memory.
|
||||
#
|
||||
# @paging: if true, do paging to get guest's memory mapping. This allows
|
||||
# using gdb to process the core file.
|
||||
#
|
||||
# IMPORTANT: this option can make QEMU allocate several gigabytes
|
||||
# of RAM. This can happen for a large guest, or a
|
||||
# malicious guest pretending to be large.
|
||||
#
|
||||
# Also, paging=true has the following limitations:
|
||||
#
|
||||
# 1. The guest may be in a catastrophic state or can have corrupted
|
||||
# memory, which cannot be trusted
|
||||
# 2. The guest can be in real-mode even if paging is enabled. For
|
||||
# example, the guest uses ACPI to sleep, and ACPI sleep state
|
||||
# goes in real-mode
|
||||
# 3. Currently only supported on i386 and x86_64.
|
||||
#
|
||||
# @protocol: the filename or file descriptor of the vmcore. The supported
|
||||
# protocols are:
|
||||
#
|
||||
# 1. file: the protocol starts with "file:", and the following
|
||||
# string is the file's path.
|
||||
# 2. fd: the protocol starts with "fd:", and the following string
|
||||
# is the fd's name.
|
||||
#
|
||||
# @detach: if true, QMP will return immediately rather than
|
||||
# waiting for the dump to finish. The user can track progress
|
||||
# using "query-dump". (since 2.6).
|
||||
#
|
||||
# @begin: if specified, the starting physical address.
|
||||
#
|
||||
# @length: if specified, the memory size, in bytes. If you don't
|
||||
# want to dump all guest's memory, please specify the start @begin
|
||||
# and @length
|
||||
#
|
||||
# @format: if specified, the format of guest memory dump. But non-elf
|
||||
# format is conflict with paging and filter, ie. @paging, @begin and
|
||||
# @length is not allowed to be specified with non-elf @format at the
|
||||
# same time (since 2.0)
|
||||
#
|
||||
# Note: All boolean arguments default to false
|
||||
#
|
||||
# Returns: nothing on success
|
||||
#
|
||||
# Since: 1.2
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "dump-guest-memory",
|
||||
# "arguments": { "protocol": "fd:dump" } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'dump-guest-memory',
|
||||
'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
|
||||
'*begin': 'int', '*length': 'int',
|
||||
'*format': 'DumpGuestMemoryFormat'} }
|
||||
|
||||
##
|
||||
# @DumpStatus:
|
||||
#
|
||||
# Describe the status of a long-running background guest memory dump.
|
||||
#
|
||||
# @none: no dump-guest-memory has started yet.
|
||||
#
|
||||
# @active: there is one dump running in background.
|
||||
#
|
||||
# @completed: the last dump has finished successfully.
|
||||
#
|
||||
# @failed: the last dump has failed.
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'enum': 'DumpStatus',
|
||||
'data': [ 'none', 'active', 'completed', 'failed' ] }
|
||||
|
||||
##
|
||||
# @DumpQueryResult:
|
||||
#
|
||||
# The result format for 'query-dump'.
|
||||
#
|
||||
# @status: enum of @DumpStatus, which shows current dump status
|
||||
#
|
||||
# @completed: bytes written in latest dump (uncompressed)
|
||||
#
|
||||
# @total: total bytes to be written in latest dump (uncompressed)
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'DumpQueryResult',
|
||||
'data': { 'status': 'DumpStatus',
|
||||
'completed': 'int',
|
||||
'total': 'int' } }
|
||||
|
||||
##
|
||||
# @query-dump:
|
||||
#
|
||||
# Query latest dump status.
|
||||
#
|
||||
# Returns: A @DumpStatus object showing the dump status.
|
||||
#
|
||||
# Since: 2.6
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-dump" }
|
||||
# <- { "return": { "status": "active", "completed": 1024000,
|
||||
# "total": 2048000 } }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-dump', 'returns': 'DumpQueryResult' }
|
||||
|
||||
##
|
||||
# @DUMP_COMPLETED:
|
||||
#
|
||||
# Emitted when background dump has completed
|
||||
#
|
||||
# @result: final dump status
|
||||
#
|
||||
# @error: human-readable error string that provides
|
||||
# hint on why dump failed. Only presents on failure. The
|
||||
# user should not try to interpret the error string.
|
||||
#
|
||||
# Since: 2.6
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# { "event": "DUMP_COMPLETED",
|
||||
# "data": {"result": {"total": 1090650112, "status": "completed",
|
||||
# "completed": 1090650112} } }
|
||||
#
|
||||
##
|
||||
{ 'event': 'DUMP_COMPLETED' ,
|
||||
'data': { 'result': 'DumpQueryResult', '*error': 'str' } }
|
||||
|
||||
##
|
||||
# @DumpGuestMemoryCapability:
|
||||
#
|
||||
# A list of the available formats for dump-guest-memory
|
||||
#
|
||||
# Since: 2.0
|
||||
##
|
||||
{ 'struct': 'DumpGuestMemoryCapability',
|
||||
'data': {
|
||||
'formats': ['DumpGuestMemoryFormat'] } }
|
||||
|
||||
##
|
||||
# @query-dump-guest-memory-capability:
|
||||
#
|
||||
# Returns the available formats for dump-guest-memory
|
||||
#
|
||||
# Returns: A @DumpGuestMemoryCapability object listing available formats for
|
||||
# dump-guest-memory
|
||||
#
|
||||
# Since: 2.0
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-dump-guest-memory-capability" }
|
||||
# <- { "return": { "formats":
|
||||
# ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-dump-guest-memory-capability',
|
||||
'returns': 'DumpGuestMemoryCapability' }
|
||||
|
|
@ -1,232 +1,81 @@
|
|||
# -*- Mode: Python -*-
|
||||
#
|
||||
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
||||
# See the COPYING file in the top-level directory.
|
||||
|
||||
##
|
||||
# = Target-specific commands & events
|
||||
# @CpuModelInfo:
|
||||
#
|
||||
# Virtual CPU model.
|
||||
#
|
||||
# A CPU model consists of the name of a CPU definition, to which
|
||||
# delta changes are applied (e.g. features added/removed). Most magic values
|
||||
# that an architecture might require should be hidden behind the name.
|
||||
# However, if required, architectures can expose relevant properties.
|
||||
#
|
||||
# @name: the name of the CPU definition the model is based on
|
||||
# @props: a dictionary of QOM properties to be applied
|
||||
#
|
||||
# Since: 2.8.0
|
||||
##
|
||||
|
||||
{ 'include': 'misc.json' }
|
||||
{ 'struct': 'CpuModelInfo',
|
||||
'data': { 'name': 'str',
|
||||
'*props': 'any' } }
|
||||
|
||||
##
|
||||
# @RTC_CHANGE:
|
||||
# @CpuModelExpansionType:
|
||||
#
|
||||
# Emitted when the guest changes the RTC time.
|
||||
# An enumeration of CPU model expansion types.
|
||||
#
|
||||
# @offset: offset between base RTC clock (as specified by -rtc base), and
|
||||
# new RTC clock value
|
||||
#
|
||||
# Note: This event is rate-limited.
|
||||
#
|
||||
# Since: 0.13.0
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# <- { "event": "RTC_CHANGE",
|
||||
# "data": { "offset": 78 },
|
||||
# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
|
||||
#
|
||||
##
|
||||
{ 'event': 'RTC_CHANGE',
|
||||
'data': { 'offset': 'int' },
|
||||
'if': 'defined(TARGET_ALPHA) || defined(TARGET_ARM) || defined(TARGET_HPPA) || defined(TARGET_I386) || defined(TARGET_MIPS) || defined(TARGET_MIPS64) || defined(TARGET_MOXIE) || defined(TARGET_PPC) || defined(TARGET_PPC64) || defined(TARGET_S390X) || defined(TARGET_SH4) || defined(TARGET_SPARC)' }
|
||||
# @static: Expand to a static CPU model, a combination of a static base
|
||||
# model name and property delta changes. As the static base model will
|
||||
# never change, the expanded CPU model will be the same, independent of
|
||||
# QEMU version, machine type, machine options, and accelerator options.
|
||||
# Therefore, the resulting model can be used by tooling without having
|
||||
# to specify a compatibility machine - e.g. when displaying the "host"
|
||||
# model. The @static CPU models are migration-safe.
|
||||
|
||||
# @full: Expand all properties. The produced model is not guaranteed to be
|
||||
# migration-safe, but allows tooling to get an insight and work with
|
||||
# model details.
|
||||
#
|
||||
# Note: When a non-migration-safe CPU model is expanded in static mode, some
|
||||
# features enabled by the CPU model may be omitted, because they can't be
|
||||
# implemented by a static CPU model definition (e.g. cache info passthrough and
|
||||
# PMU passthrough in x86). If you need an accurate representation of the
|
||||
# features enabled by a non-migration-safe CPU model, use @full. If you need a
|
||||
# static representation that will keep ABI compatibility even when changing QEMU
|
||||
# version or machine-type, use @static (but keep in mind that some features may
|
||||
# be omitted).
|
||||
#
|
||||
# Since: 2.8.0
|
||||
##
|
||||
# @rtc-reset-reinjection:
|
||||
#
|
||||
# This command will reset the RTC interrupt reinjection backlog.
|
||||
# Can be used if another mechanism to synchronize guest time
|
||||
# is in effect, for example QEMU guest agent's guest-set-time
|
||||
# command.
|
||||
#
|
||||
# Since: 2.1
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "rtc-reset-reinjection" }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'rtc-reset-reinjection',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
{ 'enum': 'CpuModelExpansionType',
|
||||
'data': [ 'static', 'full' ] }
|
||||
|
||||
|
||||
##
|
||||
# @SevState:
|
||||
# @CpuModelCompareResult:
|
||||
#
|
||||
# An enumeration of SEV state information used during @query-sev.
|
||||
# An enumeration of CPU model comparison results. The result is usually
|
||||
# calculated using e.g. CPU features or CPU generations.
|
||||
#
|
||||
# @uninit: The guest is uninitialized.
|
||||
# @incompatible: If model A is incompatible to model B, model A is not
|
||||
# guaranteed to run where model B runs and the other way around.
|
||||
#
|
||||
# @launch-update: The guest is currently being launched; plaintext data and
|
||||
# register state is being imported.
|
||||
# @identical: If model A is identical to model B, model A is guaranteed to run
|
||||
# where model B runs and the other way around.
|
||||
#
|
||||
# @launch-secret: The guest is currently being launched; ciphertext data
|
||||
# is being imported.
|
||||
# @superset: If model A is a superset of model B, model B is guaranteed to run
|
||||
# where model A runs. There are no guarantees about the other way.
|
||||
#
|
||||
# @running: The guest is fully launched or migrated in.
|
||||
# @subset: If model A is a subset of model B, model A is guaranteed to run
|
||||
# where model B runs. There are no guarantees about the other way.
|
||||
#
|
||||
# @send-update: The guest is currently being migrated out to another machine.
|
||||
#
|
||||
# @receive-update: The guest is currently being migrated from another machine.
|
||||
#
|
||||
# Since: 2.12
|
||||
# Since: 2.8.0
|
||||
##
|
||||
{ 'enum': 'SevState',
|
||||
'data': ['uninit', 'launch-update', 'launch-secret', 'running',
|
||||
'send-update', 'receive-update' ],
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @SevInfo:
|
||||
#
|
||||
# Information about Secure Encrypted Virtualization (SEV) support
|
||||
#
|
||||
# @enabled: true if SEV is active
|
||||
#
|
||||
# @api-major: SEV API major version
|
||||
#
|
||||
# @api-minor: SEV API minor version
|
||||
#
|
||||
# @build-id: SEV FW build id
|
||||
#
|
||||
# @policy: SEV policy value
|
||||
#
|
||||
# @state: SEV guest state
|
||||
#
|
||||
# @handle: SEV firmware handle
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'struct': 'SevInfo',
|
||||
'data': { 'enabled': 'bool',
|
||||
'api-major': 'uint8',
|
||||
'api-minor' : 'uint8',
|
||||
'build-id' : 'uint8',
|
||||
'policy' : 'uint32',
|
||||
'state' : 'SevState',
|
||||
'handle' : 'uint32'
|
||||
},
|
||||
'if': 'defined(TARGET_I386)'
|
||||
}
|
||||
|
||||
##
|
||||
# @query-sev:
|
||||
#
|
||||
# Returns information about SEV
|
||||
#
|
||||
# Returns: @SevInfo
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-sev" }
|
||||
# <- { "return": { "enabled": true, "api-major" : 0, "api-minor" : 0,
|
||||
# "build-id" : 0, "policy" : 0, "state" : "running",
|
||||
# "handle" : 1 } }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-sev', 'returns': 'SevInfo',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
|
||||
##
|
||||
# @SevLaunchMeasureInfo:
|
||||
#
|
||||
# SEV Guest Launch measurement information
|
||||
#
|
||||
# @data: the measurement value encoded in base64
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
##
|
||||
{ 'struct': 'SevLaunchMeasureInfo', 'data': {'data': 'str'},
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @query-sev-launch-measure:
|
||||
#
|
||||
# Query the SEV guest launch information.
|
||||
#
|
||||
# Returns: The @SevLaunchMeasureInfo for the guest
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-sev-launch-measure" }
|
||||
# <- { "return": { "data": "4l8LXeNlSPUDlXPJG5966/8%YZ" } }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-sev-launch-measure', 'returns': 'SevLaunchMeasureInfo',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
|
||||
##
|
||||
# @SevCapability:
|
||||
#
|
||||
# The struct describes capability for a Secure Encrypted Virtualization
|
||||
# feature.
|
||||
#
|
||||
# @pdh: Platform Diffie-Hellman key (base64 encoded)
|
||||
#
|
||||
# @cert-chain: PDH certificate chain (base64 encoded)
|
||||
#
|
||||
# @cbitpos: C-bit location in page table entry
|
||||
#
|
||||
# @reduced-phys-bits: Number of physical Address bit reduction when SEV is
|
||||
# enabled
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'struct': 'SevCapability',
|
||||
'data': { 'pdh': 'str',
|
||||
'cert-chain': 'str',
|
||||
'cbitpos': 'int',
|
||||
'reduced-phys-bits': 'int'},
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @query-sev-capabilities:
|
||||
#
|
||||
# This command is used to get the SEV capabilities, and is supported on AMD
|
||||
# X86 platforms only.
|
||||
#
|
||||
# Returns: SevCapability objects.
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-sev-capabilities" }
|
||||
# <- { "return": { "pdh": "8CCDD8DDD", "cert-chain": "888CCCDDDEE",
|
||||
# "cbitpos": 47, "reduced-phys-bits": 5}}
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-sev-capabilities', 'returns': 'SevCapability',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @dump-skeys:
|
||||
#
|
||||
# Dump guest's storage keys
|
||||
#
|
||||
# @filename: the path to the file to dump to
|
||||
#
|
||||
# This command is only supported on s390 architecture.
|
||||
#
|
||||
# Since: 2.5
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "dump-skeys",
|
||||
# "arguments": { "filename": "/tmp/skeys" } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'dump-skeys',
|
||||
'data': { 'filename': 'str' },
|
||||
'if': 'defined(TARGET_S390X)' }
|
||||
{ 'enum': 'CpuModelCompareResult',
|
||||
'data': [ 'incompatible', 'identical', 'superset', 'subset' ] }
|
||||
|
||||
##
|
||||
# @CpuModelBaselineInfo:
|
||||
|
|
@ -352,51 +201,6 @@
|
|||
'returns': 'CpuModelBaselineInfo',
|
||||
'if': 'defined(TARGET_S390X)' }
|
||||
|
||||
##
|
||||
# @GICCapability:
|
||||
#
|
||||
# The struct describes capability for a specific GIC (Generic
|
||||
# Interrupt Controller) version. These bits are not only decided by
|
||||
# QEMU/KVM software version, but also decided by the hardware that
|
||||
# the program is running upon.
|
||||
#
|
||||
# @version: version of GIC to be described. Currently, only 2 and 3
|
||||
# are supported.
|
||||
#
|
||||
# @emulated: whether current QEMU/hardware supports emulated GIC
|
||||
# device in user space.
|
||||
#
|
||||
# @kernel: whether current QEMU/hardware supports hardware
|
||||
# accelerated GIC device in kernel.
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'GICCapability',
|
||||
'data': { 'version': 'int',
|
||||
'emulated': 'bool',
|
||||
'kernel': 'bool' },
|
||||
'if': 'defined(TARGET_ARM)' }
|
||||
|
||||
##
|
||||
# @query-gic-capabilities:
|
||||
#
|
||||
# This command is ARM-only. It will return a list of GICCapability
|
||||
# objects that describe its capability bits.
|
||||
#
|
||||
# Returns: a list of GICCapability objects.
|
||||
#
|
||||
# Since: 2.6
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-gic-capabilities" }
|
||||
# <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
|
||||
# { "version": 3, "emulated": false, "kernel": true } ] }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-gic-capabilities', 'returns': ['GICCapability'],
|
||||
'if': 'defined(TARGET_ARM)' }
|
||||
|
||||
##
|
||||
# @CpuModelExpansionInfo:
|
||||
#
|
||||
697
qapi/machine.json
Normal file
697
qapi/machine.json
Normal file
|
|
@ -0,0 +1,697 @@
|
|||
# -*- Mode: Python -*-
|
||||
#
|
||||
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
||||
# See the COPYING file in the top-level directory.
|
||||
|
||||
##
|
||||
# = Machines
|
||||
##
|
||||
|
||||
{ 'include': 'common.json' }
|
||||
|
||||
##
|
||||
# @CpuInfoArch:
|
||||
#
|
||||
# An enumeration of cpu types that enable additional information during
|
||||
# @query-cpus and @query-cpus-fast.
|
||||
#
|
||||
# @s390: since 2.12
|
||||
#
|
||||
# @riscv: since 2.12
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'enum': 'CpuInfoArch',
|
||||
'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 's390', 'riscv', 'other' ] }
|
||||
|
||||
##
|
||||
# @CpuInfo:
|
||||
#
|
||||
# Information about a virtual CPU
|
||||
#
|
||||
# @CPU: the index of the virtual CPU
|
||||
#
|
||||
# @current: this only exists for backwards compatibility and should be ignored
|
||||
#
|
||||
# @halted: true if the virtual CPU is in the halt state. Halt usually refers
|
||||
# to a processor specific low power mode.
|
||||
#
|
||||
# @qom_path: path to the CPU object in the QOM tree (since 2.4)
|
||||
#
|
||||
# @thread_id: ID of the underlying host thread
|
||||
#
|
||||
# @props: properties describing to which node/socket/core/thread
|
||||
# virtual CPU belongs to, provided if supported by board (since 2.10)
|
||||
#
|
||||
# @arch: architecture of the cpu, which determines which additional fields
|
||||
# will be listed (since 2.6)
|
||||
#
|
||||
# Since: 0.14.0
|
||||
#
|
||||
# Notes: @halted is a transient state that changes frequently. By the time the
|
||||
# data is sent to the client, the guest may no longer be halted.
|
||||
##
|
||||
{ 'union': 'CpuInfo',
|
||||
'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
|
||||
'qom_path': 'str', 'thread_id': 'int',
|
||||
'*props': 'CpuInstanceProperties', 'arch': 'CpuInfoArch' },
|
||||
'discriminator': 'arch',
|
||||
'data': { 'x86': 'CpuInfoX86',
|
||||
'sparc': 'CpuInfoSPARC',
|
||||
'ppc': 'CpuInfoPPC',
|
||||
'mips': 'CpuInfoMIPS',
|
||||
'tricore': 'CpuInfoTricore',
|
||||
's390': 'CpuInfoS390',
|
||||
'riscv': 'CpuInfoRISCV' } }
|
||||
|
||||
##
|
||||
# @CpuInfoX86:
|
||||
#
|
||||
# Additional information about a virtual i386 or x86_64 CPU
|
||||
#
|
||||
# @pc: the 64-bit instruction pointer
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
|
||||
|
||||
##
|
||||
# @CpuInfoSPARC:
|
||||
#
|
||||
# Additional information about a virtual SPARC CPU
|
||||
#
|
||||
# @pc: the PC component of the instruction pointer
|
||||
#
|
||||
# @npc: the NPC component of the instruction pointer
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
|
||||
|
||||
##
|
||||
# @CpuInfoPPC:
|
||||
#
|
||||
# Additional information about a virtual PPC CPU
|
||||
#
|
||||
# @nip: the instruction pointer
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
|
||||
|
||||
##
|
||||
# @CpuInfoMIPS:
|
||||
#
|
||||
# Additional information about a virtual MIPS CPU
|
||||
#
|
||||
# @PC: the instruction pointer
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
|
||||
|
||||
##
|
||||
# @CpuInfoTricore:
|
||||
#
|
||||
# Additional information about a virtual Tricore CPU
|
||||
#
|
||||
# @PC: the instruction pointer
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
|
||||
|
||||
##
|
||||
# @CpuInfoRISCV:
|
||||
#
|
||||
# Additional information about a virtual RISCV CPU
|
||||
#
|
||||
# @pc: the instruction pointer
|
||||
#
|
||||
# Since 2.12
|
||||
##
|
||||
{ 'struct': 'CpuInfoRISCV', 'data': { 'pc': 'int' } }
|
||||
|
||||
##
|
||||
# @CpuS390State:
|
||||
#
|
||||
# An enumeration of cpu states that can be assumed by a virtual
|
||||
# S390 CPU
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'enum': 'CpuS390State',
|
||||
'prefix': 'S390_CPU_STATE',
|
||||
'data': [ 'uninitialized', 'stopped', 'check-stop', 'operating', 'load' ] }
|
||||
|
||||
##
|
||||
# @CpuInfoS390:
|
||||
#
|
||||
# Additional information about a virtual S390 CPU
|
||||
#
|
||||
# @cpu-state: the virtual CPU's state
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'struct': 'CpuInfoS390', 'data': { 'cpu-state': 'CpuS390State' } }
|
||||
|
||||
##
|
||||
# @query-cpus:
|
||||
#
|
||||
# Returns a list of information about each virtual CPU.
|
||||
#
|
||||
# This command causes vCPU threads to exit to userspace, which causes
|
||||
# a small interruption to guest CPU execution. This will have a negative
|
||||
# impact on realtime guests and other latency sensitive guest workloads.
|
||||
# It is recommended to use @query-cpus-fast instead of this command to
|
||||
# avoid the vCPU interruption.
|
||||
#
|
||||
# Returns: a list of @CpuInfo for each virtual CPU
|
||||
#
|
||||
# Since: 0.14.0
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-cpus" }
|
||||
# <- { "return": [
|
||||
# {
|
||||
# "CPU":0,
|
||||
# "current":true,
|
||||
# "halted":false,
|
||||
# "qom_path":"/machine/unattached/device[0]",
|
||||
# "arch":"x86",
|
||||
# "pc":3227107138,
|
||||
# "thread_id":3134
|
||||
# },
|
||||
# {
|
||||
# "CPU":1,
|
||||
# "current":false,
|
||||
# "halted":true,
|
||||
# "qom_path":"/machine/unattached/device[2]",
|
||||
# "arch":"x86",
|
||||
# "pc":7108165,
|
||||
# "thread_id":3135
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
#
|
||||
# Notes: This interface is deprecated (since 2.12.0), and it is strongly
|
||||
# recommended that you avoid using it. Use @query-cpus-fast to
|
||||
# obtain information about virtual CPUs.
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-cpus', 'returns': ['CpuInfo'] }
|
||||
|
||||
##
|
||||
# @CpuInfoFast:
|
||||
#
|
||||
# Information about a virtual CPU
|
||||
#
|
||||
# @cpu-index: index of the virtual CPU
|
||||
#
|
||||
# @qom-path: path to the CPU object in the QOM tree
|
||||
#
|
||||
# @thread-id: ID of the underlying host thread
|
||||
#
|
||||
# @props: properties describing to which node/socket/core/thread
|
||||
# virtual CPU belongs to, provided if supported by board
|
||||
#
|
||||
# @arch: base architecture of the cpu; deprecated since 3.0.0 in favor
|
||||
# of @target
|
||||
#
|
||||
# @target: the QEMU system emulation target, which determines which
|
||||
# additional fields will be listed (since 3.0)
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
##
|
||||
{ 'union' : 'CpuInfoFast',
|
||||
'base' : { 'cpu-index' : 'int',
|
||||
'qom-path' : 'str',
|
||||
'thread-id' : 'int',
|
||||
'*props' : 'CpuInstanceProperties',
|
||||
'arch' : 'CpuInfoArch',
|
||||
'target' : 'SysEmuTarget' },
|
||||
'discriminator' : 'target',
|
||||
'data' : { 's390x' : 'CpuInfoS390' } }
|
||||
|
||||
##
|
||||
# @query-cpus-fast:
|
||||
#
|
||||
# Returns information about all virtual CPUs. This command does not
|
||||
# incur a performance penalty and should be used in production
|
||||
# instead of query-cpus.
|
||||
#
|
||||
# Returns: list of @CpuInfoFast
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-cpus-fast" }
|
||||
# <- { "return": [
|
||||
# {
|
||||
# "thread-id": 25627,
|
||||
# "props": {
|
||||
# "core-id": 0,
|
||||
# "thread-id": 0,
|
||||
# "socket-id": 0
|
||||
# },
|
||||
# "qom-path": "/machine/unattached/device[0]",
|
||||
# "arch":"x86",
|
||||
# "target":"x86_64",
|
||||
# "cpu-index": 0
|
||||
# },
|
||||
# {
|
||||
# "thread-id": 25628,
|
||||
# "props": {
|
||||
# "core-id": 0,
|
||||
# "thread-id": 0,
|
||||
# "socket-id": 1
|
||||
# },
|
||||
# "qom-path": "/machine/unattached/device[2]",
|
||||
# "arch":"x86",
|
||||
# "target":"x86_64",
|
||||
# "cpu-index": 1
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
##
|
||||
{ 'command': 'query-cpus-fast', 'returns': [ 'CpuInfoFast' ] }
|
||||
|
||||
##
|
||||
# @cpu-add:
|
||||
#
|
||||
# Adds CPU with specified ID.
|
||||
#
|
||||
# @id: ID of CPU to be created, valid values [0..max_cpus)
|
||||
#
|
||||
# Returns: Nothing on success
|
||||
#
|
||||
# Since: 1.5
|
||||
#
|
||||
# Note: This command is deprecated. The `device_add` command should be
|
||||
# used instead. See the `query-hotpluggable-cpus` command for
|
||||
# details.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "cpu-add", "arguments": { "id": 2 } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'cpu-add', 'data': {'id': 'int'} }
|
||||
|
||||
##
|
||||
# @MachineInfo:
|
||||
#
|
||||
# Information describing a machine.
|
||||
#
|
||||
# @name: the name of the machine
|
||||
#
|
||||
# @alias: an alias for the machine name
|
||||
#
|
||||
# @is-default: whether the machine is default
|
||||
#
|
||||
# @cpu-max: maximum number of CPUs supported by the machine type
|
||||
# (since 1.5.0)
|
||||
#
|
||||
# @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0)
|
||||
#
|
||||
# Since: 1.2.0
|
||||
##
|
||||
{ 'struct': 'MachineInfo',
|
||||
'data': { 'name': 'str', '*alias': 'str',
|
||||
'*is-default': 'bool', 'cpu-max': 'int',
|
||||
'hotpluggable-cpus': 'bool'} }
|
||||
|
||||
##
|
||||
# @query-machines:
|
||||
#
|
||||
# Return a list of supported machines
|
||||
#
|
||||
# Returns: a list of MachineInfo
|
||||
#
|
||||
# Since: 1.2.0
|
||||
##
|
||||
{ 'command': 'query-machines', 'returns': ['MachineInfo'] }
|
||||
|
||||
##
|
||||
# @CurrentMachineParams:
|
||||
#
|
||||
# Information describing the running machine parameters.
|
||||
#
|
||||
# @wakeup-suspend-support: true if the machine supports wake up from
|
||||
# suspend
|
||||
#
|
||||
# Since: 4.0
|
||||
##
|
||||
{ 'struct': 'CurrentMachineParams',
|
||||
'data': { 'wakeup-suspend-support': 'bool'} }
|
||||
|
||||
##
|
||||
# @query-current-machine:
|
||||
#
|
||||
# Return information on the current virtual machine.
|
||||
#
|
||||
# Returns: CurrentMachineParams
|
||||
#
|
||||
# Since: 4.0
|
||||
##
|
||||
{ 'command': 'query-current-machine', 'returns': 'CurrentMachineParams' }
|
||||
|
||||
##
|
||||
# @NumaOptionsType:
|
||||
#
|
||||
# @node: NUMA nodes configuration
|
||||
#
|
||||
# @dist: NUMA distance configuration (since 2.10)
|
||||
#
|
||||
# @cpu: property based CPU(s) to node mapping (Since: 2.10)
|
||||
#
|
||||
# Since: 2.1
|
||||
##
|
||||
{ 'enum': 'NumaOptionsType',
|
||||
'data': [ 'node', 'dist', 'cpu' ] }
|
||||
|
||||
##
|
||||
# @NumaOptions:
|
||||
#
|
||||
# A discriminated record of NUMA options. (for OptsVisitor)
|
||||
#
|
||||
# Since: 2.1
|
||||
##
|
||||
{ 'union': 'NumaOptions',
|
||||
'base': { 'type': 'NumaOptionsType' },
|
||||
'discriminator': 'type',
|
||||
'data': {
|
||||
'node': 'NumaNodeOptions',
|
||||
'dist': 'NumaDistOptions',
|
||||
'cpu': 'NumaCpuOptions' }}
|
||||
|
||||
##
|
||||
# @NumaNodeOptions:
|
||||
#
|
||||
# Create a guest NUMA node. (for OptsVisitor)
|
||||
#
|
||||
# @nodeid: NUMA node ID (increase by 1 from 0 if omitted)
|
||||
#
|
||||
# @cpus: VCPUs belonging to this node (assign VCPUS round-robin
|
||||
# if omitted)
|
||||
#
|
||||
# @mem: memory size of this node; mutually exclusive with @memdev.
|
||||
# Equally divide total memory among nodes if both @mem and @memdev are
|
||||
# omitted.
|
||||
#
|
||||
# @memdev: memory backend object. If specified for one node,
|
||||
# it must be specified for all nodes.
|
||||
#
|
||||
# Since: 2.1
|
||||
##
|
||||
{ 'struct': 'NumaNodeOptions',
|
||||
'data': {
|
||||
'*nodeid': 'uint16',
|
||||
'*cpus': ['uint16'],
|
||||
'*mem': 'size',
|
||||
'*memdev': 'str' }}
|
||||
|
||||
##
|
||||
# @NumaDistOptions:
|
||||
#
|
||||
# Set the distance between 2 NUMA nodes.
|
||||
#
|
||||
# @src: source NUMA node.
|
||||
#
|
||||
# @dst: destination NUMA node.
|
||||
#
|
||||
# @val: NUMA distance from source node to destination node.
|
||||
# When a node is unreachable from another node, set the distance
|
||||
# between them to 255.
|
||||
#
|
||||
# Since: 2.10
|
||||
##
|
||||
{ 'struct': 'NumaDistOptions',
|
||||
'data': {
|
||||
'src': 'uint16',
|
||||
'dst': 'uint16',
|
||||
'val': 'uint8' }}
|
||||
|
||||
##
|
||||
# @X86CPURegister32:
|
||||
#
|
||||
# A X86 32-bit register
|
||||
#
|
||||
# Since: 1.5
|
||||
##
|
||||
{ 'enum': 'X86CPURegister32',
|
||||
'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
|
||||
|
||||
##
|
||||
# @X86CPUFeatureWordInfo:
|
||||
#
|
||||
# Information about a X86 CPU feature word
|
||||
#
|
||||
# @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
|
||||
#
|
||||
# @cpuid-input-ecx: Input ECX value for CPUID instruction for that
|
||||
# feature word
|
||||
#
|
||||
# @cpuid-register: Output register containing the feature bits
|
||||
#
|
||||
# @features: value of output register, containing the feature bits
|
||||
#
|
||||
# Since: 1.5
|
||||
##
|
||||
{ 'struct': 'X86CPUFeatureWordInfo',
|
||||
'data': { 'cpuid-input-eax': 'int',
|
||||
'*cpuid-input-ecx': 'int',
|
||||
'cpuid-register': 'X86CPURegister32',
|
||||
'features': 'int' } }
|
||||
|
||||
##
|
||||
# @DummyForceArrays:
|
||||
#
|
||||
# Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
|
||||
#
|
||||
# Since: 2.5
|
||||
##
|
||||
{ 'struct': 'DummyForceArrays',
|
||||
'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
|
||||
|
||||
##
|
||||
# @NumaCpuOptions:
|
||||
#
|
||||
# Option "-numa cpu" overrides default cpu to node mapping.
|
||||
# It accepts the same set of cpu properties as returned by
|
||||
# query-hotpluggable-cpus[].props, where node-id could be used to
|
||||
# override default node mapping.
|
||||
#
|
||||
# Since: 2.10
|
||||
##
|
||||
{ 'struct': 'NumaCpuOptions',
|
||||
'base': 'CpuInstanceProperties',
|
||||
'data' : {} }
|
||||
|
||||
##
|
||||
# @HostMemPolicy:
|
||||
#
|
||||
# Host memory policy types
|
||||
#
|
||||
# @default: restore default policy, remove any nondefault policy
|
||||
#
|
||||
# @preferred: set the preferred host nodes for allocation
|
||||
#
|
||||
# @bind: a strict policy that restricts memory allocation to the
|
||||
# host nodes specified
|
||||
#
|
||||
# @interleave: memory allocations are interleaved across the set
|
||||
# of host nodes specified
|
||||
#
|
||||
# Since: 2.1
|
||||
##
|
||||
{ 'enum': 'HostMemPolicy',
|
||||
'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
|
||||
|
||||
##
|
||||
# @Memdev:
|
||||
#
|
||||
# Information about memory backend
|
||||
#
|
||||
# @id: backend's ID if backend has 'id' property (since 2.9)
|
||||
#
|
||||
# @size: memory backend size
|
||||
#
|
||||
# @merge: enables or disables memory merge support
|
||||
#
|
||||
# @dump: includes memory backend's memory in a core dump or not
|
||||
#
|
||||
# @prealloc: enables or disables memory preallocation
|
||||
#
|
||||
# @host-nodes: host nodes for its memory policy
|
||||
#
|
||||
# @policy: memory policy of memory backend
|
||||
#
|
||||
# Since: 2.1
|
||||
##
|
||||
{ 'struct': 'Memdev',
|
||||
'data': {
|
||||
'*id': 'str',
|
||||
'size': 'size',
|
||||
'merge': 'bool',
|
||||
'dump': 'bool',
|
||||
'prealloc': 'bool',
|
||||
'host-nodes': ['uint16'],
|
||||
'policy': 'HostMemPolicy' }}
|
||||
|
||||
##
|
||||
# @query-memdev:
|
||||
#
|
||||
# Returns information for all memory backends.
|
||||
#
|
||||
# Returns: a list of @Memdev.
|
||||
#
|
||||
# Since: 2.1
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-memdev" }
|
||||
# <- { "return": [
|
||||
# {
|
||||
# "id": "mem1",
|
||||
# "size": 536870912,
|
||||
# "merge": false,
|
||||
# "dump": true,
|
||||
# "prealloc": false,
|
||||
# "host-nodes": [0, 1],
|
||||
# "policy": "bind"
|
||||
# },
|
||||
# {
|
||||
# "size": 536870912,
|
||||
# "merge": false,
|
||||
# "dump": true,
|
||||
# "prealloc": true,
|
||||
# "host-nodes": [2, 3],
|
||||
# "policy": "preferred"
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-memdev', 'returns': ['Memdev'], 'allow-preconfig': true }
|
||||
|
||||
##
|
||||
# @CpuInstanceProperties:
|
||||
#
|
||||
# List of properties to be used for hotplugging a CPU instance,
|
||||
# it should be passed by management with device_add command when
|
||||
# a CPU is being hotplugged.
|
||||
#
|
||||
# @node-id: NUMA node ID the CPU belongs to
|
||||
# @socket-id: socket number within node/board the CPU belongs to
|
||||
# @core-id: core number within socket the CPU belongs to
|
||||
# @thread-id: thread number within core the CPU belongs to
|
||||
#
|
||||
# Note: currently there are 4 properties that could be present
|
||||
# but management should be prepared to pass through other
|
||||
# properties with device_add command to allow for future
|
||||
# interface extension. This also requires the filed names to be kept in
|
||||
# sync with the properties passed to -device/device_add.
|
||||
#
|
||||
# Since: 2.7
|
||||
##
|
||||
{ 'struct': 'CpuInstanceProperties',
|
||||
'data': { '*node-id': 'int',
|
||||
'*socket-id': 'int',
|
||||
'*core-id': 'int',
|
||||
'*thread-id': 'int'
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# @HotpluggableCPU:
|
||||
#
|
||||
# @type: CPU object type for usage with device_add command
|
||||
# @props: list of properties to be used for hotplugging CPU
|
||||
# @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
|
||||
# @qom-path: link to existing CPU object if CPU is present or
|
||||
# omitted if CPU is not present.
|
||||
#
|
||||
# Since: 2.7
|
||||
##
|
||||
{ 'struct': 'HotpluggableCPU',
|
||||
'data': { 'type': 'str',
|
||||
'vcpus-count': 'int',
|
||||
'props': 'CpuInstanceProperties',
|
||||
'*qom-path': 'str'
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# @query-hotpluggable-cpus:
|
||||
#
|
||||
# TODO: Better documentation; currently there is none.
|
||||
#
|
||||
# Returns: a list of HotpluggableCPU objects.
|
||||
#
|
||||
# Since: 2.7
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8:
|
||||
#
|
||||
# -> { "execute": "query-hotpluggable-cpus" }
|
||||
# <- {"return": [
|
||||
# { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core",
|
||||
# "vcpus-count": 1 },
|
||||
# { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core",
|
||||
# "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
|
||||
# ]}'
|
||||
#
|
||||
# For pc machine type started with -smp 1,maxcpus=2:
|
||||
#
|
||||
# -> { "execute": "query-hotpluggable-cpus" }
|
||||
# <- {"return": [
|
||||
# {
|
||||
# "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
|
||||
# "props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
|
||||
# },
|
||||
# {
|
||||
# "qom-path": "/machine/unattached/device[0]",
|
||||
# "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
|
||||
# "props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
|
||||
# }
|
||||
# ]}
|
||||
#
|
||||
# For s390x-virtio-ccw machine type started with -smp 1,maxcpus=2 -cpu qemu
|
||||
# (Since: 2.11):
|
||||
#
|
||||
# -> { "execute": "query-hotpluggable-cpus" }
|
||||
# <- {"return": [
|
||||
# {
|
||||
# "type": "qemu-s390x-cpu", "vcpus-count": 1,
|
||||
# "props": { "core-id": 1 }
|
||||
# },
|
||||
# {
|
||||
# "qom-path": "/machine/unattached/device[0]",
|
||||
# "type": "qemu-s390x-cpu", "vcpus-count": 1,
|
||||
# "props": { "core-id": 0 }
|
||||
# }
|
||||
# ]}
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'],
|
||||
'allow-preconfig': true }
|
||||
|
||||
##
|
||||
# @set-numa-node:
|
||||
#
|
||||
# Runtime equivalent of '-numa' CLI option, available at
|
||||
# preconfigure stage to configure numa mapping before initializing
|
||||
# machine.
|
||||
#
|
||||
# Since 3.0
|
||||
##
|
||||
{ 'command': 'set-numa-node', 'boxed': true,
|
||||
'data': 'NumaOptions',
|
||||
'allow-preconfig': true
|
||||
}
|
||||
268
qapi/misc-target.json
Normal file
268
qapi/misc-target.json
Normal file
|
|
@ -0,0 +1,268 @@
|
|||
# -*- Mode: Python -*-
|
||||
#
|
||||
|
||||
##
|
||||
# @RTC_CHANGE:
|
||||
#
|
||||
# Emitted when the guest changes the RTC time.
|
||||
#
|
||||
# @offset: offset between base RTC clock (as specified by -rtc base), and
|
||||
# new RTC clock value
|
||||
#
|
||||
# Note: This event is rate-limited.
|
||||
#
|
||||
# Since: 0.13.0
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# <- { "event": "RTC_CHANGE",
|
||||
# "data": { "offset": 78 },
|
||||
# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
|
||||
#
|
||||
##
|
||||
{ 'event': 'RTC_CHANGE',
|
||||
'data': { 'offset': 'int' },
|
||||
'if': 'defined(TARGET_ALPHA) || defined(TARGET_ARM) || defined(TARGET_HPPA) || defined(TARGET_I386) || defined(TARGET_MIPS) || defined(TARGET_MIPS64) || defined(TARGET_MOXIE) || defined(TARGET_PPC) || defined(TARGET_PPC64) || defined(TARGET_S390X) || defined(TARGET_SH4) || defined(TARGET_SPARC)' }
|
||||
|
||||
##
|
||||
# @rtc-reset-reinjection:
|
||||
#
|
||||
# This command will reset the RTC interrupt reinjection backlog.
|
||||
# Can be used if another mechanism to synchronize guest time
|
||||
# is in effect, for example QEMU guest agent's guest-set-time
|
||||
# command.
|
||||
#
|
||||
# Since: 2.1
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "rtc-reset-reinjection" }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'rtc-reset-reinjection',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
|
||||
##
|
||||
# @SevState:
|
||||
#
|
||||
# An enumeration of SEV state information used during @query-sev.
|
||||
#
|
||||
# @uninit: The guest is uninitialized.
|
||||
#
|
||||
# @launch-update: The guest is currently being launched; plaintext data and
|
||||
# register state is being imported.
|
||||
#
|
||||
# @launch-secret: The guest is currently being launched; ciphertext data
|
||||
# is being imported.
|
||||
#
|
||||
# @running: The guest is fully launched or migrated in.
|
||||
#
|
||||
# @send-update: The guest is currently being migrated out to another machine.
|
||||
#
|
||||
# @receive-update: The guest is currently being migrated from another machine.
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'enum': 'SevState',
|
||||
'data': ['uninit', 'launch-update', 'launch-secret', 'running',
|
||||
'send-update', 'receive-update' ],
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @SevInfo:
|
||||
#
|
||||
# Information about Secure Encrypted Virtualization (SEV) support
|
||||
#
|
||||
# @enabled: true if SEV is active
|
||||
#
|
||||
# @api-major: SEV API major version
|
||||
#
|
||||
# @api-minor: SEV API minor version
|
||||
#
|
||||
# @build-id: SEV FW build id
|
||||
#
|
||||
# @policy: SEV policy value
|
||||
#
|
||||
# @state: SEV guest state
|
||||
#
|
||||
# @handle: SEV firmware handle
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'struct': 'SevInfo',
|
||||
'data': { 'enabled': 'bool',
|
||||
'api-major': 'uint8',
|
||||
'api-minor' : 'uint8',
|
||||
'build-id' : 'uint8',
|
||||
'policy' : 'uint32',
|
||||
'state' : 'SevState',
|
||||
'handle' : 'uint32'
|
||||
},
|
||||
'if': 'defined(TARGET_I386)'
|
||||
}
|
||||
|
||||
##
|
||||
# @query-sev:
|
||||
#
|
||||
# Returns information about SEV
|
||||
#
|
||||
# Returns: @SevInfo
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-sev" }
|
||||
# <- { "return": { "enabled": true, "api-major" : 0, "api-minor" : 0,
|
||||
# "build-id" : 0, "policy" : 0, "state" : "running",
|
||||
# "handle" : 1 } }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-sev', 'returns': 'SevInfo',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
|
||||
##
|
||||
# @SevLaunchMeasureInfo:
|
||||
#
|
||||
# SEV Guest Launch measurement information
|
||||
#
|
||||
# @data: the measurement value encoded in base64
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
##
|
||||
{ 'struct': 'SevLaunchMeasureInfo', 'data': {'data': 'str'},
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @query-sev-launch-measure:
|
||||
#
|
||||
# Query the SEV guest launch information.
|
||||
#
|
||||
# Returns: The @SevLaunchMeasureInfo for the guest
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-sev-launch-measure" }
|
||||
# <- { "return": { "data": "4l8LXeNlSPUDlXPJG5966/8%YZ" } }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-sev-launch-measure', 'returns': 'SevLaunchMeasureInfo',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
|
||||
##
|
||||
# @SevCapability:
|
||||
#
|
||||
# The struct describes capability for a Secure Encrypted Virtualization
|
||||
# feature.
|
||||
#
|
||||
# @pdh: Platform Diffie-Hellman key (base64 encoded)
|
||||
#
|
||||
# @cert-chain: PDH certificate chain (base64 encoded)
|
||||
#
|
||||
# @cbitpos: C-bit location in page table entry
|
||||
#
|
||||
# @reduced-phys-bits: Number of physical Address bit reduction when SEV is
|
||||
# enabled
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'struct': 'SevCapability',
|
||||
'data': { 'pdh': 'str',
|
||||
'cert-chain': 'str',
|
||||
'cbitpos': 'int',
|
||||
'reduced-phys-bits': 'int'},
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @query-sev-capabilities:
|
||||
#
|
||||
# This command is used to get the SEV capabilities, and is supported on AMD
|
||||
# X86 platforms only.
|
||||
#
|
||||
# Returns: SevCapability objects.
|
||||
#
|
||||
# Since: 2.12
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-sev-capabilities" }
|
||||
# <- { "return": { "pdh": "8CCDD8DDD", "cert-chain": "888CCCDDDEE",
|
||||
# "cbitpos": 47, "reduced-phys-bits": 5}}
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-sev-capabilities', 'returns': 'SevCapability',
|
||||
'if': 'defined(TARGET_I386)' }
|
||||
|
||||
##
|
||||
# @dump-skeys:
|
||||
#
|
||||
# Dump guest's storage keys
|
||||
#
|
||||
# @filename: the path to the file to dump to
|
||||
#
|
||||
# This command is only supported on s390 architecture.
|
||||
#
|
||||
# Since: 2.5
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "dump-skeys",
|
||||
# "arguments": { "filename": "/tmp/skeys" } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'dump-skeys',
|
||||
'data': { 'filename': 'str' },
|
||||
'if': 'defined(TARGET_S390X)' }
|
||||
|
||||
##
|
||||
# @GICCapability:
|
||||
#
|
||||
# The struct describes capability for a specific GIC (Generic
|
||||
# Interrupt Controller) version. These bits are not only decided by
|
||||
# QEMU/KVM software version, but also decided by the hardware that
|
||||
# the program is running upon.
|
||||
#
|
||||
# @version: version of GIC to be described. Currently, only 2 and 3
|
||||
# are supported.
|
||||
#
|
||||
# @emulated: whether current QEMU/hardware supports emulated GIC
|
||||
# device in user space.
|
||||
#
|
||||
# @kernel: whether current QEMU/hardware supports hardware
|
||||
# accelerated GIC device in kernel.
|
||||
#
|
||||
# Since: 2.6
|
||||
##
|
||||
{ 'struct': 'GICCapability',
|
||||
'data': { 'version': 'int',
|
||||
'emulated': 'bool',
|
||||
'kernel': 'bool' },
|
||||
'if': 'defined(TARGET_ARM)' }
|
||||
|
||||
##
|
||||
# @query-gic-capabilities:
|
||||
#
|
||||
# This command is ARM-only. It will return a list of GICCapability
|
||||
# objects that describe its capability bits.
|
||||
#
|
||||
# Returns: a list of GICCapability objects.
|
||||
#
|
||||
# Since: 2.6
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-gic-capabilities" }
|
||||
# <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
|
||||
# { "version": 3, "emulated": false, "kernel": true } ] }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-gic-capabilities', 'returns': ['GICCapability'],
|
||||
'if': 'defined(TARGET_ARM)' }
|
||||
1304
qapi/misc.json
1304
qapi/misc.json
File diff suppressed because it is too large
Load diff
|
|
@ -86,6 +86,7 @@
|
|||
{ 'include': 'crypto.json' }
|
||||
{ 'include': 'block.json' }
|
||||
{ 'include': 'char.json' }
|
||||
{ 'include': 'dump.json' }
|
||||
{ 'include': 'job.json' }
|
||||
{ 'include': 'net.json' }
|
||||
{ 'include': 'rdma.json' }
|
||||
|
|
@ -97,6 +98,10 @@
|
|||
{ 'include': 'transaction.json' }
|
||||
{ 'include': 'trace.json' }
|
||||
{ 'include': 'introspect.json' }
|
||||
{ 'include': 'qom.json' }
|
||||
{ 'include': 'qdev.json' }
|
||||
{ 'include': 'machine.json' }
|
||||
{ 'include': 'machine-target.json' }
|
||||
{ 'include': 'misc.json' }
|
||||
{ 'include': 'target.json' }
|
||||
{ 'include': 'misc-target.json' }
|
||||
{ 'include': 'audio.json' }
|
||||
|
|
|
|||
125
qapi/qdev.json
Normal file
125
qapi/qdev.json
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
# -*- Mode: Python -*-
|
||||
#
|
||||
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
||||
# See the COPYING file in the top-level directory.
|
||||
|
||||
##
|
||||
# = Device infrastructure (qdev)
|
||||
##
|
||||
|
||||
{ 'include': 'qom.json' }
|
||||
|
||||
##
|
||||
# @device-list-properties:
|
||||
#
|
||||
# List properties associated with a device.
|
||||
#
|
||||
# @typename: the type name of a device
|
||||
#
|
||||
# Returns: a list of ObjectPropertyInfo describing a devices properties
|
||||
#
|
||||
# Note: objects can create properties at runtime, for example to describe
|
||||
# links between different devices and/or objects. These properties
|
||||
# are not included in the output of this command.
|
||||
#
|
||||
# Since: 1.2
|
||||
##
|
||||
{ 'command': 'device-list-properties',
|
||||
'data': { 'typename': 'str'},
|
||||
'returns': [ 'ObjectPropertyInfo' ] }
|
||||
|
||||
##
|
||||
# @device_add:
|
||||
#
|
||||
# @driver: the name of the new device's driver
|
||||
#
|
||||
# @bus: the device's parent bus (device tree path)
|
||||
#
|
||||
# @id: the device's ID, must be unique
|
||||
#
|
||||
# Additional arguments depend on the type.
|
||||
#
|
||||
# Add a device.
|
||||
#
|
||||
# Notes:
|
||||
# 1. For detailed information about this command, please refer to the
|
||||
# 'docs/qdev-device-use.txt' file.
|
||||
#
|
||||
# 2. It's possible to list device properties by running QEMU with the
|
||||
# "-device DEVICE,help" command-line argument, where DEVICE is the
|
||||
# device's name
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "device_add",
|
||||
# "arguments": { "driver": "e1000", "id": "net1",
|
||||
# "bus": "pci.0",
|
||||
# "mac": "52:54:00:12:34:56" } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
# TODO: This command effectively bypasses QAPI completely due to its
|
||||
# "additional arguments" business. It shouldn't have been added to
|
||||
# the schema in this form. It should be qapified properly, or
|
||||
# replaced by a properly qapified command.
|
||||
#
|
||||
# Since: 0.13
|
||||
##
|
||||
{ 'command': 'device_add',
|
||||
'data': {'driver': 'str', '*bus': 'str', '*id': 'str'},
|
||||
'gen': false } # so we can get the additional arguments
|
||||
|
||||
##
|
||||
# @device_del:
|
||||
#
|
||||
# Remove a device from a guest
|
||||
#
|
||||
# @id: the device's ID or QOM path
|
||||
#
|
||||
# Returns: Nothing on success
|
||||
# If @id is not a valid device, DeviceNotFound
|
||||
#
|
||||
# Notes: When this command completes, the device may not be removed from the
|
||||
# guest. Hot removal is an operation that requires guest cooperation.
|
||||
# This command merely requests that the guest begin the hot removal
|
||||
# process. Completion of the device removal process is signaled with a
|
||||
# DEVICE_DELETED event. Guest reset will automatically complete removal
|
||||
# for all devices.
|
||||
#
|
||||
# Since: 0.14.0
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "device_del",
|
||||
# "arguments": { "id": "net1" } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
# -> { "execute": "device_del",
|
||||
# "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'device_del', 'data': {'id': 'str'} }
|
||||
|
||||
##
|
||||
# @DEVICE_DELETED:
|
||||
#
|
||||
# Emitted whenever the device removal completion is acknowledged by the guest.
|
||||
# At this point, it's safe to reuse the specified device ID. Device removal can
|
||||
# be initiated by the guest or by HMP/QMP commands.
|
||||
#
|
||||
# @device: device name
|
||||
#
|
||||
# @path: device path
|
||||
#
|
||||
# Since: 1.5
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# <- { "event": "DEVICE_DELETED",
|
||||
# "data": { "device": "virtio-net-pci-0",
|
||||
# "path": "/machine/peripheral/virtio-net-pci-0" },
|
||||
# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
|
||||
#
|
||||
##
|
||||
{ 'event': 'DEVICE_DELETED',
|
||||
'data': { '*device': 'str', 'path': 'str' } }
|
||||
244
qapi/qom.json
Normal file
244
qapi/qom.json
Normal file
|
|
@ -0,0 +1,244 @@
|
|||
# -*- Mode: Python -*-
|
||||
#
|
||||
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
||||
# See the COPYING file in the top-level directory.
|
||||
|
||||
##
|
||||
# = QEMU Object Model (QOM)
|
||||
##
|
||||
|
||||
##
|
||||
# @ObjectPropertyInfo:
|
||||
#
|
||||
# @name: the name of the property
|
||||
#
|
||||
# @type: the type of the property. This will typically come in one of four
|
||||
# forms:
|
||||
#
|
||||
# 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
|
||||
# These types are mapped to the appropriate JSON type.
|
||||
#
|
||||
# 2) A child type in the form 'child<subtype>' where subtype is a qdev
|
||||
# device type name. Child properties create the composition tree.
|
||||
#
|
||||
# 3) A link type in the form 'link<subtype>' where subtype is a qdev
|
||||
# device type name. Link properties form the device model graph.
|
||||
#
|
||||
# @description: if specified, the description of the property.
|
||||
#
|
||||
# Since: 1.2
|
||||
##
|
||||
{ 'struct': 'ObjectPropertyInfo',
|
||||
'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
|
||||
|
||||
##
|
||||
# @qom-list:
|
||||
#
|
||||
# This command will list any properties of a object given a path in the object
|
||||
# model.
|
||||
#
|
||||
# @path: the path within the object model. See @qom-get for a description of
|
||||
# this parameter.
|
||||
#
|
||||
# Returns: a list of @ObjectPropertyInfo that describe the properties of the
|
||||
# object.
|
||||
#
|
||||
# Since: 1.2
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "qom-list",
|
||||
# "arguments": { "path": "/chardevs" } }
|
||||
# <- { "return": [ { "name": "type", "type": "string" },
|
||||
# { "name": "parallel0", "type": "child<chardev-vc>" },
|
||||
# { "name": "serial0", "type": "child<chardev-vc>" },
|
||||
# { "name": "mon0", "type": "child<chardev-stdio>" } ] }
|
||||
#
|
||||
##
|
||||
{ 'command': 'qom-list',
|
||||
'data': { 'path': 'str' },
|
||||
'returns': [ 'ObjectPropertyInfo' ],
|
||||
'allow-preconfig': true }
|
||||
|
||||
##
|
||||
# @qom-get:
|
||||
#
|
||||
# This command will get a property from a object model path and return the
|
||||
# value.
|
||||
#
|
||||
# @path: The path within the object model. There are two forms of supported
|
||||
# paths--absolute and partial paths.
|
||||
#
|
||||
# Absolute paths are derived from the root object and can follow child<>
|
||||
# or link<> properties. Since they can follow link<> properties, they
|
||||
# can be arbitrarily long. Absolute paths look like absolute filenames
|
||||
# and are prefixed with a leading slash.
|
||||
#
|
||||
# Partial paths look like relative filenames. They do not begin
|
||||
# with a prefix. The matching rules for partial paths are subtle but
|
||||
# designed to make specifying objects easy. At each level of the
|
||||
# composition tree, the partial path is matched as an absolute path.
|
||||
# The first match is not returned. At least two matches are searched
|
||||
# for. A successful result is only returned if only one match is
|
||||
# found. If more than one match is found, a flag is return to
|
||||
# indicate that the match was ambiguous.
|
||||
#
|
||||
# @property: The property name to read
|
||||
#
|
||||
# Returns: The property value. The type depends on the property
|
||||
# type. child<> and link<> properties are returned as #str
|
||||
# pathnames. All integer property types (u8, u16, etc) are
|
||||
# returned as #int.
|
||||
#
|
||||
# Since: 1.2
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# 1. Use absolute path
|
||||
#
|
||||
# -> { "execute": "qom-get",
|
||||
# "arguments": { "path": "/machine/unattached/device[0]",
|
||||
# "property": "hotplugged" } }
|
||||
# <- { "return": false }
|
||||
#
|
||||
# 2. Use partial path
|
||||
#
|
||||
# -> { "execute": "qom-get",
|
||||
# "arguments": { "path": "unattached/sysbus",
|
||||
# "property": "type" } }
|
||||
# <- { "return": "System" }
|
||||
#
|
||||
##
|
||||
{ 'command': 'qom-get',
|
||||
'data': { 'path': 'str', 'property': 'str' },
|
||||
'returns': 'any',
|
||||
'allow-preconfig': true }
|
||||
|
||||
##
|
||||
# @qom-set:
|
||||
#
|
||||
# This command will set a property from a object model path.
|
||||
#
|
||||
# @path: see @qom-get for a description of this parameter
|
||||
#
|
||||
# @property: the property name to set
|
||||
#
|
||||
# @value: a value who's type is appropriate for the property type. See @qom-get
|
||||
# for a description of type mapping.
|
||||
#
|
||||
# Since: 1.2
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "qom-set",
|
||||
# "arguments": { "path": "/machine",
|
||||
# "property": "graphics",
|
||||
# "value": false } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'qom-set',
|
||||
'data': { 'path': 'str', 'property': 'str', 'value': 'any' },
|
||||
'allow-preconfig': true }
|
||||
|
||||
##
|
||||
# @ObjectTypeInfo:
|
||||
#
|
||||
# This structure describes a search result from @qom-list-types
|
||||
#
|
||||
# @name: the type name found in the search
|
||||
#
|
||||
# @abstract: the type is abstract and can't be directly instantiated.
|
||||
# Omitted if false. (since 2.10)
|
||||
#
|
||||
# @parent: Name of parent type, if any (since 2.10)
|
||||
#
|
||||
# Since: 1.1
|
||||
##
|
||||
{ 'struct': 'ObjectTypeInfo',
|
||||
'data': { 'name': 'str', '*abstract': 'bool', '*parent': 'str' } }
|
||||
|
||||
##
|
||||
# @qom-list-types:
|
||||
#
|
||||
# This command will return a list of types given search parameters
|
||||
#
|
||||
# @implements: if specified, only return types that implement this type name
|
||||
#
|
||||
# @abstract: if true, include abstract types in the results
|
||||
#
|
||||
# Returns: a list of @ObjectTypeInfo or an empty list if no results are found
|
||||
#
|
||||
# Since: 1.1
|
||||
##
|
||||
{ 'command': 'qom-list-types',
|
||||
'data': { '*implements': 'str', '*abstract': 'bool' },
|
||||
'returns': [ 'ObjectTypeInfo' ],
|
||||
'allow-preconfig': true }
|
||||
|
||||
##
|
||||
# @qom-list-properties:
|
||||
#
|
||||
# List properties associated with a QOM object.
|
||||
#
|
||||
# @typename: the type name of an object
|
||||
#
|
||||
# Note: objects can create properties at runtime, for example to describe
|
||||
# links between different devices and/or objects. These properties
|
||||
# are not included in the output of this command.
|
||||
#
|
||||
# Returns: a list of ObjectPropertyInfo describing object properties
|
||||
#
|
||||
# Since: 2.12
|
||||
##
|
||||
{ 'command': 'qom-list-properties',
|
||||
'data': { 'typename': 'str'},
|
||||
'returns': [ 'ObjectPropertyInfo' ],
|
||||
'allow-preconfig': true }
|
||||
|
||||
##
|
||||
# @object-add:
|
||||
#
|
||||
# Create a QOM object.
|
||||
#
|
||||
# @qom-type: the class name for the object to be created
|
||||
#
|
||||
# @id: the name of the new object
|
||||
#
|
||||
# @props: a dictionary of properties to be passed to the backend
|
||||
#
|
||||
# Returns: Nothing on success
|
||||
# Error if @qom-type is not a valid class name
|
||||
#
|
||||
# Since: 2.0
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "object-add",
|
||||
# "arguments": { "qom-type": "rng-random", "id": "rng1",
|
||||
# "props": { "filename": "/dev/hwrng" } } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'object-add',
|
||||
'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
|
||||
|
||||
##
|
||||
# @object-del:
|
||||
#
|
||||
# Remove a QOM object.
|
||||
#
|
||||
# @id: the name of the QOM object to remove
|
||||
#
|
||||
# Returns: Nothing on success
|
||||
# Error if @id is not a valid id for a QOM object
|
||||
#
|
||||
# Since: 2.0
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "object-del", "arguments": { "id": "rng1" } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'object-del', 'data': {'id': 'str'} }
|
||||
Loading…
Add table
Add a link
Reference in a new issue