blob: 2ffe0008184869823fa5baf8ee43455dd3798900 [file] [log] [blame]
Lluís23d15e82011-08-31 20:31:31 +02001/*
2 * Interface for configuring and controlling the state of tracing events.
3 *
Lluís Vilanova48151852016-07-11 12:53:41 +02004 * Copyright (C) 2011-2016 Lluís Vilanova <vilanova@ac.upc.edu>
Lluís23d15e82011-08-31 20:31:31 +02005 *
Lluís Vilanovab1bae812013-03-05 14:47:38 +01006 * 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ís23d15e82011-08-31 20:31:31 +02008 */
9
Peter Maydelld38ea872016-01-29 17:50:05 +000010#include "qemu/osdep.h"
Lluís23d15e82011-08-31 20:31:31 +020011#include "trace/control.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020012#include "qemu/help_option.h"
Markus Armbruster922a01a2018-02-01 12:18:46 +010013#include "qemu/option.h"
Lluís Vilanova5b808272014-05-27 15:02:14 +020014#ifdef CONFIG_TRACE_SIMPLE
15#include "trace/simple.h"
16#endif
17#ifdef CONFIG_TRACE_FTRACE
18#include "trace/ftrace.h"
19#endif
Paolo Bonzinied7f5f12016-01-07 16:55:30 +030020#ifdef CONFIG_TRACE_LOG
21#include "qemu/log.h"
22#endif
Paul Durrant0a852412016-08-04 14:44:14 +010023#ifdef CONFIG_TRACE_SYSLOG
24#include <syslog.h>
25#endif
Markus Armbrusterdaa76aa2016-06-15 19:27:16 +020026#include "qapi/error.h"
Alexey Kardashevskiya35d9be2014-06-02 16:34:10 +100027#include "qemu/error-report.h"
Denis V. Luneve9e0bb22016-06-17 17:44:10 +030028#include "qemu/config-file.h"
Denis V. Lunevacc68092016-03-16 14:36:51 +030029#include "monitor/monitor.h"
Daniel P. Berrange0ab8ed12017-01-25 16:14:15 +000030#include "trace-root.h"
Lluís23d15e82011-08-31 20:31:31 +020031
Paolo Bonzini43b48cf2015-10-28 07:06:26 +010032int trace_events_enabled_count;
33
Daniel P. Berrangefe4db842016-10-04 14:35:52 +010034typedef struct TraceEventGroup {
35 TraceEvent **events;
36} TraceEventGroup;
37
38static TraceEventGroup *event_groups;
39static size_t nevent_groups;
Daniel P. Berrangeca3fa0e2016-10-04 14:35:54 +010040static uint32_t next_id;
41static uint32_t next_vcpu_id;
Daniel P. Berrangefe4db842016-10-04 14:35:52 +010042
Denis V. Luneve9e0bb22016-06-17 17:44:10 +030043QemuOptsList qemu_trace_opts = {
44 .name = "trace",
45 .implied_opt_name = "enable",
46 .head = QTAILQ_HEAD_INITIALIZER(qemu_trace_opts.head),
47 .desc = {
48 {
49 .name = "enable",
50 .type = QEMU_OPT_STRING,
51 },
52 {
53 .name = "events",
54 .type = QEMU_OPT_STRING,
55 },{
56 .name = "file",
57 .type = QEMU_OPT_STRING,
58 },
59 { /* end of list */ }
60 },
61};
62
63
Daniel P. Berrangefe4db842016-10-04 14:35:52 +010064void trace_event_register_group(TraceEvent **events)
65{
Daniel P. Berrangeca3fa0e2016-10-04 14:35:54 +010066 size_t i;
67 for (i = 0; events[i] != NULL; i++) {
68 events[i]->id = next_id++;
Lluís Vilanovad01c05c2017-07-04 10:34:19 +020069 if (events[i]->vcpu_id == TRACE_VCPU_EVENT_NONE) {
70 continue;
71 }
72
73 if (likely(next_vcpu_id < CPU_TRACE_DSTATE_MAX_EVENTS)) {
Daniel P. Berrangeca3fa0e2016-10-04 14:35:54 +010074 events[i]->vcpu_id = next_vcpu_id++;
Lluís Vilanovad01c05c2017-07-04 10:34:19 +020075 } else {
Alistair Francis55d527a2017-09-11 12:52:46 -070076 warn_report("too many vcpu trace events; dropping '%s'",
77 events[i]->name);
Daniel P. Berrangeca3fa0e2016-10-04 14:35:54 +010078 }
79 }
Daniel P. Berrangefe4db842016-10-04 14:35:52 +010080 event_groups = g_renew(TraceEventGroup, event_groups, nevent_groups + 1);
81 event_groups[nevent_groups].events = events;
82 nevent_groups++;
83}
84
85
Lluís Vilanovab1bae812013-03-05 14:47:38 +010086TraceEvent *trace_event_name(const char *name)
87{
88 assert(name != NULL);
89
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +010090 TraceEventIter iter;
91 TraceEvent *ev;
92 trace_event_iter_init(&iter, NULL);
93 while ((ev = trace_event_iter_next(&iter)) != NULL) {
Lluís Vilanovab1bae812013-03-05 14:47:38 +010094 if (strcmp(trace_event_get_name(ev), name) == 0) {
95 return ev;
96 }
97 }
98 return NULL;
99}
100
Daniel P. Berrange6a1b0f32016-10-04 14:35:42 +0100101void trace_event_iter_init(TraceEventIter *iter, const char *pattern)
102{
103 iter->event = 0;
Daniel P. Berrangefe4db842016-10-04 14:35:52 +0100104 iter->group = 0;
Daniel P. Berrange6a1b0f32016-10-04 14:35:42 +0100105 iter->pattern = pattern;
106}
107
108TraceEvent *trace_event_iter_next(TraceEventIter *iter)
109{
Daniel P. Berrangefe4db842016-10-04 14:35:52 +0100110 while (iter->group < nevent_groups &&
111 event_groups[iter->group].events[iter->event] != NULL) {
112 TraceEvent *ev = event_groups[iter->group].events[iter->event];
Daniel P. Berrange6a1b0f32016-10-04 14:35:42 +0100113 iter->event++;
Daniel P. Berrangefe4db842016-10-04 14:35:52 +0100114 if (event_groups[iter->group].events[iter->event] == NULL) {
115 iter->event = 0;
116 iter->group++;
117 }
Daniel P. Berrange6a1b0f32016-10-04 14:35:42 +0100118 if (!iter->pattern ||
Alex Bennéee66eae72019-12-05 12:25:17 +0000119 g_pattern_match_simple(iter->pattern, trace_event_get_name(ev))) {
Daniel P. Berrange6a1b0f32016-10-04 14:35:42 +0100120 return ev;
121 }
122 }
123
124 return NULL;
125}
126
Paolo Bonzinie9527dd2016-01-07 16:55:27 +0300127void trace_list_events(void)
128{
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100129 TraceEventIter iter;
130 TraceEvent *ev;
131 trace_event_iter_init(&iter, NULL);
132 while ((ev = trace_event_iter_next(&iter)) != NULL) {
133 fprintf(stderr, "%s\n", trace_event_get_name(ev));
Paolo Bonzinie9527dd2016-01-07 16:55:27 +0300134 }
Philippe Mathieu-Daudé9f591a52019-08-23 16:22:03 +0200135#ifdef CONFIG_TRACE_DTRACE
136 fprintf(stderr, "This list of names of trace points may be incomplete "
137 "when using the DTrace/SystemTap backends.\n"
138 "Run 'qemu-trace-stap list %s' to print the full list.\n",
139 error_get_progname());
140#endif
Paolo Bonzinie9527dd2016-01-07 16:55:27 +0300141}
142
143static void do_trace_enable_events(const char *line_buf)
Paolo Bonzini10578a22016-01-07 16:55:26 +0300144{
145 const bool enable = ('-' != line_buf[0]);
146 const char *line_ptr = enable ? line_buf : line_buf + 1;
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100147 TraceEventIter iter;
148 TraceEvent *ev;
149 bool is_pattern = trace_event_is_pattern(line_ptr);
Paolo Bonzini10578a22016-01-07 16:55:26 +0300150
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100151 trace_event_iter_init(&iter, line_ptr);
152 while ((ev = trace_event_iter_next(&iter)) != NULL) {
153 if (!trace_event_get_state_static(ev)) {
154 if (!is_pattern) {
Alistair Francis3dc6f862017-07-12 06:57:41 -0700155 warn_report("trace event '%s' is not traceable",
156 line_ptr);
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100157 return;
Paolo Bonzini10578a22016-01-07 16:55:26 +0300158 }
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100159 continue;
Paolo Bonzini10578a22016-01-07 16:55:26 +0300160 }
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100161
162 /* start tracing */
163 trace_event_set_state_dynamic(ev, enable);
164 if (!is_pattern) {
165 return;
Paolo Bonzini10578a22016-01-07 16:55:26 +0300166 }
167 }
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100168
169 if (!is_pattern) {
Alistair Francis3dc6f862017-07-12 06:57:41 -0700170 warn_report("trace event '%s' does not exist",
171 line_ptr);
Daniel P. Berrange0d4e9952016-10-04 14:35:43 +0100172 }
Paolo Bonzini10578a22016-01-07 16:55:26 +0300173}
174
Paolo Bonzinie9527dd2016-01-07 16:55:27 +0300175void trace_enable_events(const char *line_buf)
176{
177 if (is_help_option(line_buf)) {
178 trace_list_events();
Denis V. Lunevacc68092016-03-16 14:36:51 +0300179 if (cur_mon == NULL) {
180 exit(0);
181 }
Paolo Bonzinie9527dd2016-01-07 16:55:27 +0300182 } else {
183 do_trace_enable_events(line_buf);
184 }
185}
186
Denis V. Luneve9e0bb22016-06-17 17:44:10 +0300187static void trace_init_events(const char *fname)
Lluís23d15e82011-08-31 20:31:31 +0200188{
Alexey Kardashevskiya35d9be2014-06-02 16:34:10 +1000189 Location loc;
190 FILE *fp;
191 char line_buf[1024];
192 size_t line_idx = 0;
193
Lluís23d15e82011-08-31 20:31:31 +0200194 if (fname == NULL) {
195 return;
196 }
197
Alexey Kardashevskiya35d9be2014-06-02 16:34:10 +1000198 loc_push_none(&loc);
199 loc_set_file(fname, 0);
200 fp = fopen(fname, "r");
Lluís23d15e82011-08-31 20:31:31 +0200201 if (!fp) {
Alexey Kardashevskiya35d9be2014-06-02 16:34:10 +1000202 error_report("%s", strerror(errno));
Lluís23d15e82011-08-31 20:31:31 +0200203 exit(1);
204 }
Lluís23d15e82011-08-31 20:31:31 +0200205 while (fgets(line_buf, sizeof(line_buf), fp)) {
Alexey Kardashevskiya35d9be2014-06-02 16:34:10 +1000206 loc_set_file(fname, ++line_idx);
Lluís23d15e82011-08-31 20:31:31 +0200207 size_t len = strlen(line_buf);
208 if (len > 1) { /* skip empty lines */
209 line_buf[len - 1] = '\0';
Alexey Kardashevskiy794b1f92012-06-14 14:41:40 +1000210 if ('#' == line_buf[0]) { /* skip commented lines */
211 continue;
212 }
Paolo Bonzini10578a22016-01-07 16:55:26 +0300213 trace_enable_events(line_buf);
Lluís23d15e82011-08-31 20:31:31 +0200214 }
215 }
216 if (fclose(fp) != 0) {
Alexey Kardashevskiya35d9be2014-06-02 16:34:10 +1000217 loc_set_file(fname, 0);
218 error_report("%s", strerror(errno));
Lluís23d15e82011-08-31 20:31:31 +0200219 exit(1);
220 }
Alexey Kardashevskiya35d9be2014-06-02 16:34:10 +1000221 loc_pop(&loc);
Lluís23d15e82011-08-31 20:31:31 +0200222}
Lluís Vilanova5b808272014-05-27 15:02:14 +0200223
Paolo Bonzini41fc57e2016-01-07 16:55:24 +0300224void trace_init_file(const char *file)
Lluís Vilanova5b808272014-05-27 15:02:14 +0200225{
226#ifdef CONFIG_TRACE_SIMPLE
Paolo Bonzini41fc57e2016-01-07 16:55:24 +0300227 st_set_trace_file(file);
Paolo Bonzinied7f5f12016-01-07 16:55:30 +0300228#elif defined CONFIG_TRACE_LOG
Alex Bennée3d887542020-02-25 12:47:00 +0000229 /*
230 * If both the simple and the log backends are enabled, "--trace file"
231 * only applies to the simple backend; use "-D" for the log
232 * backend. However we should only override -D if we actually have
233 * something to override it with.
Paolo Bonzinied7f5f12016-01-07 16:55:30 +0300234 */
Alex Bennée3d887542020-02-25 12:47:00 +0000235 if (file) {
236 qemu_set_log_filename(file, &error_fatal);
237 }
Lluís Vilanova5b808272014-05-27 15:02:14 +0200238#else
239 if (file) {
Yaowei Baidb817b82018-07-04 11:17:27 +0800240 fprintf(stderr, "error: --trace file=...: "
Lluís Vilanova5b808272014-05-27 15:02:14 +0200241 "option not supported by the selected tracing backends\n");
Paolo Bonzini41fc57e2016-01-07 16:55:24 +0300242 exit(1);
243 }
244#endif
245}
246
Lluís Vilanova82e95ec2016-12-26 22:24:40 +0100247void trace_fini_vcpu(CPUState *vcpu)
248{
249 TraceEventIter iter;
250 TraceEvent *ev;
251
Lluís Vilanovaa47e8712016-12-26 22:24:46 +0100252 trace_guest_cpu_exit(vcpu);
253
Lluís Vilanova82e95ec2016-12-26 22:24:40 +0100254 trace_event_iter_init(&iter, NULL);
255 while ((ev = trace_event_iter_next(&iter)) != NULL) {
256 if (trace_event_is_vcpu(ev) &&
257 trace_event_get_state_static(ev) &&
258 trace_event_get_vcpu_state_dynamic(vcpu, ev)) {
259 /* must disable to affect the global counter */
260 trace_event_set_vcpu_state_dynamic(vcpu, ev, false);
261 }
262 }
263}
264
Paolo Bonzini41fc57e2016-01-07 16:55:24 +0300265bool trace_init_backends(void)
266{
267#ifdef CONFIG_TRACE_SIMPLE
268 if (!st_init()) {
269 fprintf(stderr, "failed to initialize simple tracing backend.\n");
Lluís Vilanova5b808272014-05-27 15:02:14 +0200270 return false;
271 }
272#endif
273
274#ifdef CONFIG_TRACE_FTRACE
275 if (!ftrace_init()) {
276 fprintf(stderr, "failed to initialize ftrace backend.\n");
277 return false;
278 }
279#endif
280
Paul Durrant0a852412016-08-04 14:44:14 +0100281#ifdef CONFIG_TRACE_SYSLOG
282 openlog(NULL, LOG_PID, LOG_DAEMON);
283#endif
284
Lluís Vilanova5b808272014-05-27 15:02:14 +0200285 return true;
286}
Denis V. Luneve9e0bb22016-06-17 17:44:10 +0300287
288char *trace_opt_parse(const char *optarg)
289{
290 char *trace_file;
291 QemuOpts *opts = qemu_opts_parse_noisily(qemu_find_opts("trace"),
292 optarg, true);
293 if (!opts) {
294 exit(1);
295 }
296 if (qemu_opt_get(opts, "enable")) {
297 trace_enable_events(qemu_opt_get(opts, "enable"));
298 }
299 trace_init_events(qemu_opt_get(opts, "events"));
300 trace_file = g_strdup(qemu_opt_get(opts, "file"));
301 qemu_opts_del(opts);
302
303 return trace_file;
304}
Daniel P. Berrangeb7d48952016-10-04 14:35:53 +0100305
306uint32_t trace_get_vcpu_event_count(void)
307{
Daniel P. Berrangeca3fa0e2016-10-04 14:35:54 +0100308 return next_vcpu_id;
Daniel P. Berrangeb7d48952016-10-04 14:35:53 +0100309}