mirror of
https://github.com/qemu/qemu.git
synced 2024-12-14 06:53:43 +08:00
f5cf31c575
The generated QEMU QMP reference is now structured as follows:
1.1 Introduction
1.2 Stability Considerations
1.3 Common data types
1.4 Socket data types
1.5 VM run state
1.6 Cryptography
1.7 Block devices
1.7.1 Block core (VM unrelated)
1.7.2 QAPI block definitions (vm unrelated)
1.8 Character devices
1.9 Net devices
1.10 Rocker switch device
1.11 TPM (trusted platform module) devices
1.12 Remote desktop
1.12.1 Spice
1.12.2 VNC
1.13 Input
1.14 Migration
1.15 Transactions
1.16 Tracing
1.17 QMP introspection
1.18 Miscellanea
Section "1.18 Miscellanea" is still too big: it documents 134 symbols.
Section "1.7.1 Block core (VM unrelated)" is also rather big: 128
symbols. All the others are of reasonable size.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <1503602048-12268-17-git-send-email-armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
108 lines
2.8 KiB
Python
108 lines
2.8 KiB
Python
# -*- mode: python -*-
|
|
#
|
|
# Copyright (C) 2011-2016 Lluís Vilanova <vilanova@ac.upc.edu>
|
|
#
|
|
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
# See the COPYING file in the top-level directory.
|
|
|
|
##
|
|
# = Tracing
|
|
##
|
|
|
|
##
|
|
# @TraceEventState:
|
|
#
|
|
# State of a tracing event.
|
|
#
|
|
# @unavailable: The event is statically disabled.
|
|
#
|
|
# @disabled: The event is dynamically disabled.
|
|
#
|
|
# @enabled: The event is dynamically enabled.
|
|
#
|
|
# Since: 2.2
|
|
##
|
|
{ 'enum': 'TraceEventState',
|
|
'data': ['unavailable', 'disabled', 'enabled'] }
|
|
|
|
##
|
|
# @TraceEventInfo:
|
|
#
|
|
# Information of a tracing event.
|
|
#
|
|
# @name: Event name.
|
|
# @state: Tracing state.
|
|
# @vcpu: Whether this is a per-vCPU event (since 2.7).
|
|
#
|
|
# An event is per-vCPU if it has the "vcpu" property in the "trace-events"
|
|
# files.
|
|
#
|
|
# Since: 2.2
|
|
##
|
|
{ 'struct': 'TraceEventInfo',
|
|
'data': {'name': 'str', 'state': 'TraceEventState', 'vcpu': 'bool'} }
|
|
|
|
##
|
|
# @trace-event-get-state:
|
|
#
|
|
# Query the state of events.
|
|
#
|
|
# @name: Event name pattern (case-sensitive glob).
|
|
# @vcpu: The vCPU to query (any by default; since 2.7).
|
|
#
|
|
# Returns: a list of @TraceEventInfo for the matching events
|
|
#
|
|
# An event is returned if:
|
|
# - its name matches the @name pattern, and
|
|
# - if @vcpu is given, the event has the "vcpu" property.
|
|
#
|
|
# Therefore, if @vcpu is given, the operation will only match per-vCPU events,
|
|
# returning their state on the specified vCPU. Special case: if @name is an
|
|
# exact match, @vcpu is given and the event does not have the "vcpu" property,
|
|
# an error is returned.
|
|
#
|
|
# Since: 2.2
|
|
#
|
|
# Example:
|
|
#
|
|
# -> { "execute": "trace-event-get-state",
|
|
# "arguments": { "name": "qemu_memalign" } }
|
|
# <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
|
|
#
|
|
##
|
|
{ 'command': 'trace-event-get-state',
|
|
'data': {'name': 'str', '*vcpu': 'int'},
|
|
'returns': ['TraceEventInfo'] }
|
|
|
|
##
|
|
# @trace-event-set-state:
|
|
#
|
|
# Set the dynamic tracing state of events.
|
|
#
|
|
# @name: Event name pattern (case-sensitive glob).
|
|
# @enable: Whether to enable tracing.
|
|
# @ignore-unavailable: Do not match unavailable events with @name.
|
|
# @vcpu: The vCPU to act upon (all by default; since 2.7).
|
|
#
|
|
# An event's state is modified if:
|
|
# - its name matches the @name pattern, and
|
|
# - if @vcpu is given, the event has the "vcpu" property.
|
|
#
|
|
# Therefore, if @vcpu is given, the operation will only match per-vCPU events,
|
|
# setting their state on the specified vCPU. Special case: if @name is an exact
|
|
# match, @vcpu is given and the event does not have the "vcpu" property, an
|
|
# error is returned.
|
|
#
|
|
# Since: 2.2
|
|
#
|
|
# Example:
|
|
#
|
|
# -> { "execute": "trace-event-set-state",
|
|
# "arguments": { "name": "qemu_memalign", "enable": "true" } }
|
|
# <- { "return": {} }
|
|
#
|
|
##
|
|
{ 'command': 'trace-event-set-state',
|
|
'data': {'name': 'str', 'enable': 'bool', '*ignore-unavailable': 'bool',
|
|
'*vcpu': 'int'} }
|