Lluís | e485897 | 2011-08-31 20:31:03 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Interface for configuring and controlling the state of tracing events. |
| 3 | * |
Lluís Vilanova | 3d211d9 | 2016-02-25 17:43:38 +0100 | [diff] [blame] | 4 | * Copyright (C) 2011-2016 Lluís Vilanova <vilanova@ac.upc.edu> |
Lluís | e485897 | 2011-08-31 20:31:03 +0200 | [diff] [blame] | 5 | * |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 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. |
Lluís | e485897 | 2011-08-31 20:31:03 +0200 | [diff] [blame] | 8 | */ |
| 9 | |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 10 | #ifndef TRACE__CONTROL_H |
| 11 | #define TRACE__CONTROL_H |
Lluís | e485897 | 2011-08-31 20:31:03 +0200 | [diff] [blame] | 12 | |
Daniel P. Berrange | 3477018 | 2016-10-04 14:35:55 +0100 | [diff] [blame] | 13 | #include "event-internal.h" |
Lluís | fc76410 | 2011-08-31 20:31:18 +0200 | [diff] [blame] | 14 | |
Daniel P. Berrange | 6a1b0f3 | 2016-10-04 14:35:42 +0100 | [diff] [blame] | 15 | typedef struct TraceEventIter { |
| 16 | size_t event; |
Daniel P. Berrange | fe4db84 | 2016-10-04 14:35:52 +0100 | [diff] [blame] | 17 | size_t group; |
Daniel P. Berrange | 6a1b0f3 | 2016-10-04 14:35:42 +0100 | [diff] [blame] | 18 | const char *pattern; |
| 19 | } TraceEventIter; |
Lluís | fc76410 | 2011-08-31 20:31:18 +0200 | [diff] [blame] | 20 | |
Daniel P. Berrange | 6a1b0f3 | 2016-10-04 14:35:42 +0100 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * trace_event_iter_init: |
| 24 | * @iter: the event iterator struct |
| 25 | * @pattern: optional pattern to filter events on name |
| 26 | * |
| 27 | * Initialize the event iterator struct @iter, |
| 28 | * optionally using @pattern to filter out events |
| 29 | * with non-matching names. |
| 30 | */ |
| 31 | void trace_event_iter_init(TraceEventIter *iter, const char *pattern); |
| 32 | |
| 33 | /** |
| 34 | * trace_event_iter_next: |
| 35 | * @iter: the event iterator struct |
| 36 | * |
| 37 | * Get the next event, if any. When this returns NULL, |
| 38 | * the iterator should no longer be used. |
| 39 | * |
| 40 | * Returns: the next event, or NULL if no more events exist |
| 41 | */ |
| 42 | TraceEvent *trace_event_iter_next(TraceEventIter *iter); |
| 43 | |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * trace_event_name: |
| 47 | * @id: Event name. |
| 48 | * |
| 49 | * Search an event by its name. |
| 50 | * |
| 51 | * Returns: pointer to #TraceEvent or NULL if not found. |
| 52 | */ |
| 53 | TraceEvent *trace_event_name(const char *name); |
| 54 | |
| 55 | /** |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 56 | * trace_event_is_pattern: |
| 57 | * |
| 58 | * Whether the given string is an event name pattern. |
| 59 | */ |
| 60 | static bool trace_event_is_pattern(const char *str); |
| 61 | |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 62 | |
| 63 | /** |
| 64 | * trace_event_get_id: |
| 65 | * |
| 66 | * Get the identifier of an event. |
| 67 | */ |
Daniel P. Berrange | ef4c9fc | 2016-10-04 14:35:49 +0100 | [diff] [blame] | 68 | static uint32_t trace_event_get_id(TraceEvent *ev); |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 69 | |
| 70 | /** |
Lluís Vilanova | 17f7ac7 | 2016-07-11 12:53:24 +0200 | [diff] [blame] | 71 | * trace_event_get_vcpu_id: |
| 72 | * |
| 73 | * Get the per-vCPU identifier of an event. |
| 74 | * |
Daniel P. Berrange | ef4c9fc | 2016-10-04 14:35:49 +0100 | [diff] [blame] | 75 | * Special value #TRACE_VCPU_EVENT_NONE means the event is not vCPU-specific |
Lluís Vilanova | 17f7ac7 | 2016-07-11 12:53:24 +0200 | [diff] [blame] | 76 | * (does not have the "vcpu" property). |
| 77 | */ |
Daniel P. Berrange | ef4c9fc | 2016-10-04 14:35:49 +0100 | [diff] [blame] | 78 | static uint32_t trace_event_get_vcpu_id(TraceEvent *ev); |
Lluís Vilanova | 17f7ac7 | 2016-07-11 12:53:24 +0200 | [diff] [blame] | 79 | |
| 80 | /** |
| 81 | * trace_event_is_vcpu: |
| 82 | * |
| 83 | * Whether this is a per-vCPU event. |
| 84 | */ |
| 85 | static bool trace_event_is_vcpu(TraceEvent *ev); |
| 86 | |
| 87 | /** |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 88 | * trace_event_get_name: |
| 89 | * |
| 90 | * Get the name of an event. |
| 91 | */ |
| 92 | static const char * trace_event_get_name(TraceEvent *ev); |
| 93 | |
| 94 | /** |
| 95 | * trace_event_get_state: |
Daniel P. Berrange | ef4c9fc | 2016-10-04 14:35:49 +0100 | [diff] [blame] | 96 | * @id: Event identifier name. |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 97 | * |
Stefan Hajnoczi | d87aa13 | 2017-07-31 15:07:18 +0100 | [diff] [blame] | 98 | * Get the tracing state of an event, both static and the QEMU dynamic state. |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 99 | * |
| 100 | * If the event has the disabled property, the check will have no performance |
| 101 | * impact. |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 102 | */ |
| 103 | #define trace_event_get_state(id) \ |
Paolo Bonzini | 585ec72 | 2015-10-28 07:06:27 +0100 | [diff] [blame] | 104 | ((id ##_ENABLED) && trace_event_get_state_dynamic_by_id(id)) |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 105 | |
| 106 | /** |
Stefan Hajnoczi | d87aa13 | 2017-07-31 15:07:18 +0100 | [diff] [blame] | 107 | * trace_event_get_state_backends: |
| 108 | * @id: Event identifier name. |
| 109 | * |
| 110 | * Get the tracing state of an event, both static and dynamic state from all |
| 111 | * compiled-in backends. |
| 112 | * |
| 113 | * If the event has the disabled property, the check will have no performance |
| 114 | * impact. |
| 115 | * |
| 116 | * Returns: true if at least one backend has the event enabled and the event |
| 117 | * does not have the disabled property. |
| 118 | */ |
| 119 | #define trace_event_get_state_backends(id) \ |
| 120 | ((id ##_ENABLED) && id ##_BACKEND_DSTATE()) |
| 121 | |
| 122 | /** |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 123 | * trace_event_get_state_static: |
| 124 | * @id: Event identifier. |
| 125 | * |
| 126 | * Get the static tracing state of an event. |
| 127 | * |
| 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). |
| 130 | */ |
| 131 | static bool trace_event_get_state_static(TraceEvent *ev); |
| 132 | |
| 133 | /** |
| 134 | * trace_event_get_state_dynamic: |
| 135 | * |
| 136 | * Get the dynamic tracing state of an event. |
Lluís Vilanova | 4815185 | 2016-07-11 12:53:41 +0200 | [diff] [blame] | 137 | * |
| 138 | * If the event has the 'vcpu' property, gets the OR'ed state of all vCPUs. |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 139 | */ |
| 140 | static bool trace_event_get_state_dynamic(TraceEvent *ev); |
| 141 | |
| 142 | /** |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 143 | * trace_event_set_state_dynamic: |
| 144 | * |
| 145 | * Set the dynamic tracing state of an event. |
| 146 | * |
Lluís Vilanova | 4815185 | 2016-07-11 12:53:41 +0200 | [diff] [blame] | 147 | * If the event has the 'vcpu' property, sets the state on all vCPUs. |
| 148 | * |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 149 | * Pre-condition: trace_event_get_state_static(ev) == true |
| 150 | */ |
Lluís Vilanova | 4815185 | 2016-07-11 12:53:41 +0200 | [diff] [blame] | 151 | void trace_event_set_state_dynamic(TraceEvent *ev, bool state); |
| 152 | |
| 153 | /** |
| 154 | * trace_event_set_vcpu_state_dynamic: |
| 155 | * |
| 156 | * Set the dynamic tracing state of an event for the given vCPU. |
| 157 | * |
| 158 | * Pre-condition: trace_event_get_vcpu_state_static(ev) == true |
Lluís Vilanova | 61a67f7 | 2017-07-04 10:42:32 +0200 | [diff] [blame] | 159 | * |
| 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). |
Lluís Vilanova | 4815185 | 2016-07-11 12:53:41 +0200 | [diff] [blame] | 162 | */ |
| 163 | void trace_event_set_vcpu_state_dynamic(CPUState *vcpu, |
| 164 | TraceEvent *ev, bool state); |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 165 | |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 166 | |
| 167 | |
| 168 | /** |
Lluís Vilanova | 5b80827 | 2014-05-27 15:02:14 +0200 | [diff] [blame] | 169 | * trace_init_backends: |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 170 | * @file: Name of trace output file; may be NULL. |
Yaowei Bai | db817b8 | 2018-07-04 11:17:27 +0800 | [diff] [blame] | 171 | * Corresponds to commandline option "--trace file=...". |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 172 | * |
| 173 | * Initialize the tracing backend. |
| 174 | * |
Lluís Vilanova | 5b80827 | 2014-05-27 15:02:14 +0200 | [diff] [blame] | 175 | * Returns: Whether the backends could be successfully initialized. |
Lluís | e485897 | 2011-08-31 20:31:03 +0200 | [diff] [blame] | 176 | */ |
Paolo Bonzini | 41fc57e | 2016-01-07 16:55:24 +0300 | [diff] [blame] | 177 | bool trace_init_backends(void); |
Paolo Bonzini | 45bd0b4 | 2016-01-07 16:55:23 +0300 | [diff] [blame] | 178 | |
| 179 | /** |
Paolo Bonzini | 41fc57e | 2016-01-07 16:55:24 +0300 | [diff] [blame] | 180 | * trace_init_file: |
| 181 | * @file: Name of trace output file; may be NULL. |
Yaowei Bai | db817b8 | 2018-07-04 11:17:27 +0800 | [diff] [blame] | 182 | * Corresponds to commandline option "--trace file=...". |
Paolo Bonzini | 41fc57e | 2016-01-07 16:55:24 +0300 | [diff] [blame] | 183 | * |
| 184 | * Record the name of the output file for the tracing backend. |
| 185 | * Exits if no selected backend does not support specifying the |
| 186 | * output file, and a non-NULL file was passed. |
| 187 | */ |
| 188 | void trace_init_file(const char *file); |
| 189 | |
Paolo Bonzini | 10578a2 | 2016-01-07 16:55:26 +0300 | [diff] [blame] | 190 | /** |
Lluís Vilanova | 2bfe11c | 2016-09-19 14:55:07 +0200 | [diff] [blame] | 191 | * trace_init_vcpu: |
| 192 | * @vcpu: Added vCPU. |
| 193 | * |
| 194 | * Set initial dynamic event state for a hot-plugged vCPU. |
| 195 | */ |
| 196 | void trace_init_vcpu(CPUState *vcpu); |
| 197 | |
| 198 | /** |
Lluís Vilanova | 82e95ec | 2016-12-26 22:24:40 +0100 | [diff] [blame] | 199 | * trace_fini_vcpu: |
| 200 | * @vcpu: Removed vCPU. |
| 201 | * |
| 202 | * Disable dynamic event state for a hot-unplugged vCPU. |
| 203 | */ |
| 204 | void trace_fini_vcpu(CPUState *vcpu); |
| 205 | |
| 206 | /** |
Paolo Bonzini | e9527dd | 2016-01-07 16:55:27 +0300 | [diff] [blame] | 207 | * trace_list_events: |
| 208 | * |
| 209 | * List all available events. |
| 210 | */ |
| 211 | void trace_list_events(void); |
| 212 | |
| 213 | /** |
Paolo Bonzini | 10578a2 | 2016-01-07 16:55:26 +0300 | [diff] [blame] | 214 | * trace_enable_events: |
| 215 | * @line_buf: A string with a glob pattern of events to be enabled or, |
| 216 | * if the string starts with '-', disabled. |
| 217 | * |
| 218 | * Enable or disable matching events. |
| 219 | */ |
| 220 | void trace_enable_events(const char *line_buf); |
| 221 | |
Denis V. Lunev | e9e0bb2 | 2016-06-17 17:44:10 +0300 | [diff] [blame] | 222 | /** |
| 223 | * Definition of QEMU options describing trace subsystem configuration |
| 224 | */ |
| 225 | extern QemuOptsList qemu_trace_opts; |
| 226 | |
| 227 | /** |
| 228 | * trace_opt_parse: |
| 229 | * @optarg: A string argument of --trace command line argument |
| 230 | * |
| 231 | * Initialize tracing subsystem. |
| 232 | * |
| 233 | * Returns the filename to save trace to. It must be freed with g_free(). |
| 234 | */ |
| 235 | char *trace_opt_parse(const char *optarg); |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 236 | |
Daniel P. Berrange | b7d4895 | 2016-10-04 14:35:53 +0100 | [diff] [blame] | 237 | /** |
| 238 | * trace_get_vcpu_event_count: |
| 239 | * |
| 240 | * Return the number of known vcpu-specific events |
| 241 | */ |
| 242 | uint32_t trace_get_vcpu_event_count(void); |
| 243 | |
Lluís Vilanova | 4815185 | 2016-07-11 12:53:41 +0200 | [diff] [blame] | 244 | |
Michael S. Tsirkin | a322714 | 2018-05-03 22:50:28 +0300 | [diff] [blame] | 245 | #include "control-internal.h" |
Lluís Vilanova | b1bae81 | 2013-03-05 14:47:38 +0100 | [diff] [blame] | 246 | |
Markus Armbruster | 175de52 | 2016-06-29 15:29:06 +0200 | [diff] [blame] | 247 | #endif /* TRACE__CONTROL_H */ |