qapi: Split qom.json and qdev.json off misc.json
Move commands object-add, object-del, qom-get, qom-list, qom-list-properties, qom-list-types, and qom-set with their types from misc.json to new qom.json. Move commands device-list-properties, device_add, device-del, and event DEVICE_DELETED from misc.json to new qdev.json. Add both new files to MAINTAINERS section QOM. Cc: Paolo Bonzini <pbonzini@redhat.com> Cc: "Daniel P. Berrange" <berrange@redhat.com> Cc: Eduardo Habkost <ehabkost@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20190619201050.19040-5-armbru@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> [Straightforwardly updated for "MAINTAINERS: Make section "QOM" cover qdev as well"]
This commit is contained in:
Markus Armbruster
parent
275307aaab
commit
c577ff624f
@ -2039,6 +2039,8 @@ F: include/hw/qdev*
|
||||
F: include/monitor/qdev.h
|
||||
F: include/qom/
|
||||
X: include/qom/cpu.h
|
||||
F: qapi/qom.json
|
||||
F: qapi/qdev.json
|
||||
F: qdev-monitor.c
|
||||
F: qom/
|
||||
X: qom/cpu.c
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
#include "qemu/option.h"
|
||||
#include "qapi/error.h"
|
||||
#include "qapi/qapi-commands-block-core.h"
|
||||
#include "qapi/qapi-commands-misc.h"
|
||||
#include "qapi/qapi-commands-qom.h"
|
||||
#include "qapi/qapi-visit-block-core.h"
|
||||
#include "qapi/qobject-input-visitor.h"
|
||||
#include "qapi/visitor.h"
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
#include "hw/qdev.h"
|
||||
#include "sysemu/sysemu.h"
|
||||
#include "qapi/error.h"
|
||||
#include "qapi/qapi-events-misc.h"
|
||||
#include "qapi/qapi-events-qdev.h"
|
||||
#include "qapi/qmp/qerror.h"
|
||||
#include "qapi/visitor.h"
|
||||
#include "qemu/error-report.h"
|
||||
|
||||
@ -34,6 +34,7 @@
|
||||
#include "qapi/qapi-commands-migration.h"
|
||||
#include "qapi/qapi-commands-misc.h"
|
||||
#include "qapi/qapi-commands-net.h"
|
||||
#include "qapi/qapi-commands-qdev.h"
|
||||
#include "qapi/qapi-commands-rocker.h"
|
||||
#include "qapi/qapi-commands-run-state.h"
|
||||
#include "qapi/qapi-commands-tpm.h"
|
||||
|
||||
@ -34,6 +34,7 @@
|
||||
#include "qapi/error.h"
|
||||
#include "qapi/qapi-commands-block-core.h"
|
||||
#include "qapi/qapi-commands-misc.h"
|
||||
#include "qapi/qapi-commands-qdev.h"
|
||||
#include "qapi/qapi-commands-ui.h"
|
||||
#include "qapi/qmp/qdict.h"
|
||||
#include "qapi/qmp/qerror.h"
|
||||
|
||||
@ -6,8 +6,9 @@ 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_COMMON_MODULES += introspect job migration misc net
|
||||
QAPI_COMMON_MODULES += qdev qom rdma rocker run-state sockets tpm
|
||||
QAPI_COMMON_MODULES += trace transaction ui
|
||||
QAPI_TARGET_MODULES = target
|
||||
QAPI_MODULES = $(QAPI_COMMON_MODULES) $(QAPI_TARGET_MODULES)
|
||||
|
||||
|
||||
351
qapi/misc.json
351
qapi/misc.json
@ -1342,140 +1342,6 @@
|
||||
'data': {'command-line': 'str', '*cpu-index': 'int'},
|
||||
'returns': 'str' }
|
||||
|
||||
##
|
||||
# @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 }
|
||||
|
||||
##
|
||||
# @change:
|
||||
#
|
||||
@ -1524,80 +1390,6 @@
|
||||
{ 'command': 'change',
|
||||
'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
|
||||
|
||||
##
|
||||
# @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 }
|
||||
|
||||
##
|
||||
# @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' ] }
|
||||
|
||||
##
|
||||
# @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 }
|
||||
|
||||
##
|
||||
# @xen-set-global-dirty-log:
|
||||
#
|
||||
@ -1618,102 +1410,6 @@
|
||||
##
|
||||
{ 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
|
||||
|
||||
##
|
||||
# @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' } }
|
||||
|
||||
##
|
||||
# @DumpGuestMemoryFormat:
|
||||
#
|
||||
@ -1906,53 +1602,6 @@
|
||||
{ 'command': 'query-dump-guest-memory-capability',
|
||||
'returns': 'DumpGuestMemoryCapability' }
|
||||
|
||||
##
|
||||
# @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'} }
|
||||
|
||||
##
|
||||
# @getfd:
|
||||
#
|
||||
|
||||
@ -97,6 +97,8 @@
|
||||
{ 'include': 'transaction.json' }
|
||||
{ 'include': 'trace.json' }
|
||||
{ 'include': 'introspect.json' }
|
||||
{ 'include': 'qom.json' }
|
||||
{ 'include': 'qdev.json' }
|
||||
{ 'include': 'misc.json' }
|
||||
{ 'include': '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'} }
|
||||
@ -24,7 +24,7 @@
|
||||
#include "monitor/qdev.h"
|
||||
#include "sysemu/arch_init.h"
|
||||
#include "qapi/error.h"
|
||||
#include "qapi/qapi-commands-misc.h"
|
||||
#include "qapi/qapi-commands-qdev.h"
|
||||
#include "qapi/qmp/qdict.h"
|
||||
#include "qapi/qmp/qerror.h"
|
||||
#include "qemu/config-file.h"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user