2 * Interface for configuring and controlling the state of tracing events.
4 * Copyright (C) 2011-2016 LluĂs Vilanova <vilanova@ac.upc.edu>
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.
10 #ifndef TRACE__CONTROL_H
11 #define TRACE__CONTROL_H
13 #include "event-internal.h"
15 typedef struct TraceEventIter
{
23 * trace_event_iter_init:
24 * @iter: the event iterator struct
25 * @pattern: optional pattern to filter events on name
27 * Initialize the event iterator struct @iter,
28 * optionally using @pattern to filter out events
29 * with non-matching names.
31 void trace_event_iter_init(TraceEventIter
*iter
, const char *pattern
);
34 * trace_event_iter_next:
35 * @iter: the event iterator struct
37 * Get the next event, if any. When this returns NULL,
38 * the iterator should no longer be used.
40 * Returns: the next event, or NULL if no more events exist
42 TraceEvent
*trace_event_iter_next(TraceEventIter
*iter
);
49 * Search an event by its name.
51 * Returns: pointer to #TraceEvent or NULL if not found.
53 TraceEvent
*trace_event_name(const char *name
);
56 * trace_event_is_pattern:
58 * Whether the given string is an event name pattern.
60 static bool trace_event_is_pattern(const char *str
);
66 * Get the identifier of an event.
68 static uint32_t trace_event_get_id(TraceEvent
*ev
);
71 * trace_event_get_vcpu_id:
73 * Get the per-vCPU identifier of an event.
75 * Special value #TRACE_VCPU_EVENT_NONE means the event is not vCPU-specific
76 * (does not have the "vcpu" property).
78 static uint32_t trace_event_get_vcpu_id(TraceEvent
*ev
);
81 * trace_event_is_vcpu:
83 * Whether this is a per-vCPU event.
85 static bool trace_event_is_vcpu(TraceEvent
*ev
);
88 * trace_event_get_name:
90 * Get the name of an event.
92 static const char * trace_event_get_name(TraceEvent
*ev
);
95 * trace_event_get_state:
96 * @id: Event identifier name.
98 * Get the tracing state of an event, both static and the QEMU dynamic state.
100 * If the event has the disabled property, the check will have no performance
103 #define trace_event_get_state(id) \
104 ((id ##_ENABLED) && trace_event_get_state_dynamic_by_id(id))
107 * trace_event_get_state_backends:
108 * @id: Event identifier name.
110 * Get the tracing state of an event, both static and dynamic state from all
111 * compiled-in backends.
113 * If the event has the disabled property, the check will have no performance
116 * Returns: true if at least one backend has the event enabled and the event
117 * does not have the disabled property.
119 #define trace_event_get_state_backends(id) \
120 ((id ##_ENABLED) && id ##_BACKEND_DSTATE())
123 * trace_event_get_state_static:
124 * @id: Event identifier.
126 * Get the static tracing state of an event.
128 * Use the define 'TRACE_${EVENT_NAME}_ENABLED' for compile-time checks (it will
129 * be set to 1 or 0 according to the presence of the disabled property).
131 static bool trace_event_get_state_static(TraceEvent
*ev
);
134 * trace_event_get_state_dynamic:
136 * Get the dynamic tracing state of an event.
138 * If the event has the 'vcpu' property, gets the OR'ed state of all vCPUs.
140 static bool trace_event_get_state_dynamic(TraceEvent
*ev
);
143 * trace_event_set_state_dynamic:
145 * Set the dynamic tracing state of an event.
147 * If the event has the 'vcpu' property, sets the state on all vCPUs.
149 * Pre-condition: trace_event_get_state_static(ev) == true
151 void trace_event_set_state_dynamic(TraceEvent
*ev
, bool state
);
154 * trace_event_set_vcpu_state_dynamic:
156 * Set the dynamic tracing state of an event for the given vCPU.
158 * Pre-condition: trace_event_get_vcpu_state_static(ev) == true
160 * Note: Changes for execution-time events with the 'tcg' property will not be
161 * propagated until the next TB is executed (iff executing in TCG mode).
163 void trace_event_set_vcpu_state_dynamic(CPUState
*vcpu
,
164 TraceEvent
*ev
, bool state
);
169 * trace_init_backends:
171 * Initialize the tracing backend.
173 * Returns: Whether the backends could be successfully initialized.
175 bool trace_init_backends(void);
180 * Record the name of the output file for the tracing backend.
181 * Exits if no selected backend does not support specifying the
182 * output file, and a file was specified with "-trace file=...".
184 void trace_init_file(void);
190 * Set initial dynamic event state for a hot-plugged vCPU.
192 void trace_init_vcpu(CPUState
*vcpu
);
196 * @vcpu: Removed vCPU.
198 * Disable dynamic event state for a hot-unplugged vCPU.
200 void trace_fini_vcpu(CPUState
*vcpu
);
205 * List all available events.
207 void trace_list_events(void);
210 * trace_enable_events:
211 * @line_buf: A string with a glob pattern of events to be enabled or,
212 * if the string starts with '-', disabled.
214 * Enable or disable matching events.
216 void trace_enable_events(const char *line_buf
);
219 * Definition of QEMU options describing trace subsystem configuration
221 extern QemuOptsList qemu_trace_opts
;
225 * @optarg: A string argument of --trace command line argument
227 * Initialize tracing subsystem.
229 void trace_opt_parse(const char *optarg
);
232 * trace_get_vcpu_event_count:
234 * Return the number of known vcpu-specific events
236 uint32_t trace_get_vcpu_event_count(void);
239 #include "control-internal.h"
241 #endif /* TRACE__CONTROL_H */