xref: /openbmc/qemu/qapi/trace.json (revision d2dfe0b5) 
1# -*- mode: python -*-
2# vim: filetype=python
3#
4# Copyright (C) 2011-2016 Lluís Vilanova <vilanova@ac.upc.edu>
5#
6# This work is licensed under the terms of the GNU GPL, version 2 or later.
7# See the COPYING file in the top-level directory.
8
9##
10# = Tracing
11##
12
13##
14# @TraceEventState:
15#
16# State of a tracing event.
17#
18# @unavailable: The event is statically disabled.
19#
20# @disabled: The event is dynamically disabled.
21#
22# @enabled: The event is dynamically enabled.
23#
24# Since: 2.2
25##
26{ 'enum': 'TraceEventState',
27  'data': ['unavailable', 'disabled', 'enabled'] }
28
29##
30# @TraceEventInfo:
31#
32# Information of a tracing event.
33#
34# @name: Event name.
35#
36# @state: Tracing state.
37#
38# @vcpu: Whether this is a per-vCPU event (since 2.7).
39#
40# Features:
41# @deprecated: Member @vcpu is deprecated, and always ignored.
42#
43# Since: 2.2
44##
45{ 'struct': 'TraceEventInfo',
46  'data': {'name': 'str', 'state': 'TraceEventState',
47           'vcpu': { 'type': 'bool', 'features': ['deprecated'] } } }
48
49##
50# @trace-event-get-state:
51#
52# Query the state of events.
53#
54# @name: Event name pattern (case-sensitive glob).
55#
56# @vcpu: The vCPU to query (since 2.7).
57#
58# Features:
59# @deprecated: Member @vcpu is deprecated, and always ignored.
60#
61# Returns: a list of @TraceEventInfo for the matching events
62#
63# An event is returned if its name matches the @name pattern
64# (There are no longer any per-vCPU events).
65#
66# Since: 2.2
67#
68# Example:
69#
70# -> { "execute": "trace-event-get-state",
71#      "arguments": { "name": "qemu_memalign" } }
72# <- { "return": [ { "name": "qemu_memalign", "state": "disabled", "vcpu": false } ] }
73##
74{ 'command': 'trace-event-get-state',
75  'data': {'name': 'str',
76           '*vcpu': {'type': 'int', 'features': ['deprecated'] } },
77  'returns': ['TraceEventInfo'] }
78
79##
80# @trace-event-set-state:
81#
82# Set the dynamic tracing state of events.
83#
84# @name: Event name pattern (case-sensitive glob).
85#
86# @enable: Whether to enable tracing.
87#
88# @ignore-unavailable: Do not match unavailable events with @name.
89#
90# @vcpu: The vCPU to act upon (all by default; since 2.7).
91#
92# Features:
93# @deprecated: Member @vcpu is deprecated, and always ignored.
94#
95# An event is enabled if its name matches the @name pattern
96# (There are no longer any per-vCPU events).
97#
98# Since: 2.2
99#
100# Example:
101#
102# -> { "execute": "trace-event-set-state",
103#      "arguments": { "name": "qemu_memalign", "enable": true } }
104# <- { "return": {} }
105##
106{ 'command': 'trace-event-set-state',
107  'data': {'name': 'str', 'enable': 'bool', '*ignore-unavailable': 'bool',
108           '*vcpu': {'type': 'int', 'features': ['deprecated'] } } }
109