123d15e86SLluís /*
223d15e86SLluís * Interface for configuring and controlling the state of tracing events.
323d15e86SLluís *
448151859SLluís Vilanova * Copyright (C) 2011-2016 Lluís Vilanova <vilanova@ac.upc.edu>
523d15e86SLluís *
6b1bae816SLluís Vilanova * This work is licensed under the terms of the GNU GPL, version 2 or later.
7b1bae816SLluís Vilanova * See the COPYING file in the top-level directory.
823d15e86SLluís */
923d15e86SLluís
10d38ea87aSPeter Maydell #include "qemu/osdep.h"
1123d15e86SLluís #include "trace/control.h"
12f348b6d1SVeronia Bahaa #include "qemu/help_option.h"
13922a01a0SMarkus Armbruster #include "qemu/option.h"
145b808275SLluís Vilanova #ifdef CONFIG_TRACE_SIMPLE
155b808275SLluís Vilanova #include "trace/simple.h"
165b808275SLluís Vilanova #endif
175b808275SLluís Vilanova #ifdef CONFIG_TRACE_FTRACE
185b808275SLluís Vilanova #include "trace/ftrace.h"
195b808275SLluís Vilanova #endif
20ed7f5f1dSPaolo Bonzini #ifdef CONFIG_TRACE_LOG
21ed7f5f1dSPaolo Bonzini #include "qemu/log.h"
22ed7f5f1dSPaolo Bonzini #endif
230a852417SPaul Durrant #ifdef CONFIG_TRACE_SYSLOG
240a852417SPaul Durrant #include <syslog.h>
250a852417SPaul Durrant #endif
26daa76aa4SMarkus Armbruster #include "qapi/error.h"
27a35d9be6SAlexey Kardashevskiy #include "qemu/error-report.h"
28e9e0bb2aSDenis V. Lunev #include "qemu/config-file.h"
29acc6809dSDenis V. Lunev #include "monitor/monitor.h"
30243af022SPaolo Bonzini #include "trace/trace-root.h"
3123d15e86SLluís
3243b48cfcSPaolo Bonzini int trace_events_enabled_count;
3343b48cfcSPaolo Bonzini
34fe4db84dSDaniel P. Berrange typedef struct TraceEventGroup {
35fe4db84dSDaniel P. Berrange TraceEvent **events;
36fe4db84dSDaniel P. Berrange } TraceEventGroup;
37fe4db84dSDaniel P. Berrange
38fe4db84dSDaniel P. Berrange static TraceEventGroup *event_groups;
39fe4db84dSDaniel P. Berrange static size_t nevent_groups;
40ca3fa0e8SDaniel P. Berrange static uint32_t next_id;
41ca3fa0e8SDaniel P. Berrange static uint32_t next_vcpu_id;
42648b4823SJosh DuBois static bool init_trace_on_startup;
439f45a641SPaolo Bonzini static char *trace_opts_file;
44fe4db84dSDaniel P. Berrange
45e9e0bb2aSDenis V. Lunev QemuOptsList qemu_trace_opts = {
46e9e0bb2aSDenis V. Lunev .name = "trace",
47e9e0bb2aSDenis V. Lunev .implied_opt_name = "enable",
48e9e0bb2aSDenis V. Lunev .head = QTAILQ_HEAD_INITIALIZER(qemu_trace_opts.head),
49e9e0bb2aSDenis V. Lunev .desc = {
50e9e0bb2aSDenis V. Lunev {
51e9e0bb2aSDenis V. Lunev .name = "enable",
52e9e0bb2aSDenis V. Lunev .type = QEMU_OPT_STRING,
53e9e0bb2aSDenis V. Lunev },
54e9e0bb2aSDenis V. Lunev {
55e9e0bb2aSDenis V. Lunev .name = "events",
56e9e0bb2aSDenis V. Lunev .type = QEMU_OPT_STRING,
57e9e0bb2aSDenis V. Lunev },{
58e9e0bb2aSDenis V. Lunev .name = "file",
59e9e0bb2aSDenis V. Lunev .type = QEMU_OPT_STRING,
60e9e0bb2aSDenis V. Lunev },
61e9e0bb2aSDenis V. Lunev { /* end of list */ }
62e9e0bb2aSDenis V. Lunev },
63e9e0bb2aSDenis V. Lunev };
64e9e0bb2aSDenis V. Lunev
65e9e0bb2aSDenis V. Lunev
trace_event_register_group(TraceEvent ** events)66fe4db84dSDaniel P. Berrange void trace_event_register_group(TraceEvent **events)
67fe4db84dSDaniel P. Berrange {
68ca3fa0e8SDaniel P. Berrange size_t i;
69ca3fa0e8SDaniel P. Berrange for (i = 0; events[i] != NULL; i++) {
70ca3fa0e8SDaniel P. Berrange events[i]->id = next_id++;
71ca3fa0e8SDaniel P. Berrange }
72fe4db84dSDaniel P. Berrange event_groups = g_renew(TraceEventGroup, event_groups, nevent_groups + 1);
73fe4db84dSDaniel P. Berrange event_groups[nevent_groups].events = events;
74fe4db84dSDaniel P. Berrange nevent_groups++;
75263b6e96SGerd Hoffmann
76263b6e96SGerd Hoffmann #ifdef CONFIG_TRACE_SIMPLE
77263b6e96SGerd Hoffmann st_init_group(nevent_groups - 1);
78263b6e96SGerd Hoffmann #endif
79fe4db84dSDaniel P. Berrange }
80fe4db84dSDaniel P. Berrange
81fe4db84dSDaniel P. Berrange
trace_event_name(const char * name)82b1bae816SLluís Vilanova TraceEvent *trace_event_name(const char *name)
83b1bae816SLluís Vilanova {
84b1bae816SLluís Vilanova assert(name != NULL);
85b1bae816SLluís Vilanova
860d4e995cSDaniel P. Berrange TraceEventIter iter;
870d4e995cSDaniel P. Berrange TraceEvent *ev;
88117856c3SGerd Hoffmann trace_event_iter_init_all(&iter);
890d4e995cSDaniel P. Berrange while ((ev = trace_event_iter_next(&iter)) != NULL) {
90b1bae816SLluís Vilanova if (strcmp(trace_event_get_name(ev), name) == 0) {
91b1bae816SLluís Vilanova return ev;
92b1bae816SLluís Vilanova }
93b1bae816SLluís Vilanova }
94b1bae816SLluís Vilanova return NULL;
95b1bae816SLluís Vilanova }
96b1bae816SLluís Vilanova
trace_event_iter_init_all(TraceEventIter * iter)97117856c3SGerd Hoffmann void trace_event_iter_init_all(TraceEventIter *iter)
986a1b0f3aSDaniel P. Berrange {
996a1b0f3aSDaniel P. Berrange iter->event = 0;
100fe4db84dSDaniel P. Berrange iter->group = 0;
101c5cc58b1SGerd Hoffmann iter->group_id = -1;
102117856c3SGerd Hoffmann iter->pattern = NULL;
103117856c3SGerd Hoffmann }
104117856c3SGerd Hoffmann
trace_event_iter_init_pattern(TraceEventIter * iter,const char * pattern)105117856c3SGerd Hoffmann void trace_event_iter_init_pattern(TraceEventIter *iter, const char *pattern)
106117856c3SGerd Hoffmann {
107117856c3SGerd Hoffmann trace_event_iter_init_all(iter);
1086a1b0f3aSDaniel P. Berrange iter->pattern = pattern;
1096a1b0f3aSDaniel P. Berrange }
1106a1b0f3aSDaniel P. Berrange
trace_event_iter_init_group(TraceEventIter * iter,size_t group_id)111c5cc58b1SGerd Hoffmann void trace_event_iter_init_group(TraceEventIter *iter, size_t group_id)
112c5cc58b1SGerd Hoffmann {
113c5cc58b1SGerd Hoffmann trace_event_iter_init_all(iter);
114c5cc58b1SGerd Hoffmann iter->group_id = group_id;
115c5cc58b1SGerd Hoffmann }
116c5cc58b1SGerd Hoffmann
trace_event_iter_next(TraceEventIter * iter)1176a1b0f3aSDaniel P. Berrange TraceEvent *trace_event_iter_next(TraceEventIter *iter)
1186a1b0f3aSDaniel P. Berrange {
119fe4db84dSDaniel P. Berrange while (iter->group < nevent_groups &&
120fe4db84dSDaniel P. Berrange event_groups[iter->group].events[iter->event] != NULL) {
121fe4db84dSDaniel P. Berrange TraceEvent *ev = event_groups[iter->group].events[iter->event];
122c5cc58b1SGerd Hoffmann size_t group = iter->group;
1236a1b0f3aSDaniel P. Berrange iter->event++;
124fe4db84dSDaniel P. Berrange if (event_groups[iter->group].events[iter->event] == NULL) {
125fe4db84dSDaniel P. Berrange iter->event = 0;
126fe4db84dSDaniel P. Berrange iter->group++;
127fe4db84dSDaniel P. Berrange }
128c5cc58b1SGerd Hoffmann if (iter->pattern &&
129c5cc58b1SGerd Hoffmann !g_pattern_match_simple(iter->pattern, trace_event_get_name(ev))) {
130c5cc58b1SGerd Hoffmann continue;
1316a1b0f3aSDaniel P. Berrange }
132c5cc58b1SGerd Hoffmann if (iter->group_id != -1 &&
133c5cc58b1SGerd Hoffmann iter->group_id != group) {
134c5cc58b1SGerd Hoffmann continue;
135c5cc58b1SGerd Hoffmann }
136c5cc58b1SGerd Hoffmann return ev;
1376a1b0f3aSDaniel P. Berrange }
1386a1b0f3aSDaniel P. Berrange
1396a1b0f3aSDaniel P. Berrange return NULL;
1406a1b0f3aSDaniel P. Berrange }
1416a1b0f3aSDaniel P. Berrange
trace_list_events(FILE * f)1426745c8a0SDoug Evans void trace_list_events(FILE *f)
143e9527dd3SPaolo Bonzini {
1440d4e995cSDaniel P. Berrange TraceEventIter iter;
1450d4e995cSDaniel P. Berrange TraceEvent *ev;
146117856c3SGerd Hoffmann trace_event_iter_init_all(&iter);
1470d4e995cSDaniel P. Berrange while ((ev = trace_event_iter_next(&iter)) != NULL) {
1486745c8a0SDoug Evans fprintf(f, "%s\n", trace_event_get_name(ev));
149e9527dd3SPaolo Bonzini }
1509f591a5dSPhilippe Mathieu-Daudé #ifdef CONFIG_TRACE_DTRACE
1516745c8a0SDoug Evans fprintf(f, "This list of names of trace points may be incomplete "
1529f591a5dSPhilippe Mathieu-Daudé "when using the DTrace/SystemTap backends.\n"
1539f591a5dSPhilippe Mathieu-Daudé "Run 'qemu-trace-stap list %s' to print the full list.\n",
154336d354bSMarc-André Lureau g_get_prgname());
1559f591a5dSPhilippe Mathieu-Daudé #endif
156e9527dd3SPaolo Bonzini }
157e9527dd3SPaolo Bonzini
do_trace_enable_events(const char * line_buf)158e9527dd3SPaolo Bonzini static void do_trace_enable_events(const char *line_buf)
15910578a25SPaolo Bonzini {
16010578a25SPaolo Bonzini const bool enable = ('-' != line_buf[0]);
16110578a25SPaolo Bonzini const char *line_ptr = enable ? line_buf : line_buf + 1;
1620d4e995cSDaniel P. Berrange TraceEventIter iter;
1630d4e995cSDaniel P. Berrange TraceEvent *ev;
1640d4e995cSDaniel P. Berrange bool is_pattern = trace_event_is_pattern(line_ptr);
16510578a25SPaolo Bonzini
166117856c3SGerd Hoffmann trace_event_iter_init_pattern(&iter, line_ptr);
1670d4e995cSDaniel P. Berrange while ((ev = trace_event_iter_next(&iter)) != NULL) {
1680d4e995cSDaniel P. Berrange if (!trace_event_get_state_static(ev)) {
1690d4e995cSDaniel P. Berrange if (!is_pattern) {
1703dc6f869SAlistair Francis warn_report("trace event '%s' is not traceable",
17110578a25SPaolo Bonzini line_ptr);
1720d4e995cSDaniel P. Berrange return;
17310578a25SPaolo Bonzini }
1740d4e995cSDaniel P. Berrange continue;
1750d4e995cSDaniel P. Berrange }
1760d4e995cSDaniel P. Berrange
1770d4e995cSDaniel P. Berrange /* start tracing */
1780d4e995cSDaniel P. Berrange trace_event_set_state_dynamic(ev, enable);
1790d4e995cSDaniel P. Berrange if (!is_pattern) {
1800d4e995cSDaniel P. Berrange return;
1810d4e995cSDaniel P. Berrange }
1820d4e995cSDaniel P. Berrange }
1830d4e995cSDaniel P. Berrange
1840d4e995cSDaniel P. Berrange if (!is_pattern) {
1853dc6f869SAlistair Francis warn_report("trace event '%s' does not exist",
1860d4e995cSDaniel P. Berrange line_ptr);
18710578a25SPaolo Bonzini }
18810578a25SPaolo Bonzini }
18910578a25SPaolo Bonzini
trace_enable_events(const char * line_buf)190e9527dd3SPaolo Bonzini void trace_enable_events(const char *line_buf)
191e9527dd3SPaolo Bonzini {
192e9527dd3SPaolo Bonzini if (is_help_option(line_buf)) {
1936745c8a0SDoug Evans trace_list_events(stdout);
194947e4744SKevin Wolf if (monitor_cur() == NULL) {
195e9527dd3SPaolo Bonzini exit(0);
196acc6809dSDenis V. Lunev }
197e9527dd3SPaolo Bonzini } else {
198e9527dd3SPaolo Bonzini do_trace_enable_events(line_buf);
199e9527dd3SPaolo Bonzini }
200e9527dd3SPaolo Bonzini }
201e9527dd3SPaolo Bonzini
trace_init_events(const char * fname)202e9e0bb2aSDenis V. Lunev static void trace_init_events(const char *fname)
20323d15e86SLluís {
204a35d9be6SAlexey Kardashevskiy Location loc;
205a35d9be6SAlexey Kardashevskiy FILE *fp;
206a35d9be6SAlexey Kardashevskiy char line_buf[1024];
207a35d9be6SAlexey Kardashevskiy size_t line_idx = 0;
208a35d9be6SAlexey Kardashevskiy
20923d15e86SLluís if (fname == NULL) {
21023d15e86SLluís return;
21123d15e86SLluís }
21223d15e86SLluís
213a35d9be6SAlexey Kardashevskiy loc_push_none(&loc);
214a35d9be6SAlexey Kardashevskiy loc_set_file(fname, 0);
215a35d9be6SAlexey Kardashevskiy fp = fopen(fname, "r");
21623d15e86SLluís if (!fp) {
217a35d9be6SAlexey Kardashevskiy error_report("%s", strerror(errno));
21823d15e86SLluís exit(1);
21923d15e86SLluís }
22023d15e86SLluís while (fgets(line_buf, sizeof(line_buf), fp)) {
221a35d9be6SAlexey Kardashevskiy loc_set_file(fname, ++line_idx);
22223d15e86SLluís size_t len = strlen(line_buf);
22323d15e86SLluís if (len > 1) { /* skip empty lines */
22423d15e86SLluís line_buf[len - 1] = '\0';
225794b1f96SAlexey Kardashevskiy if ('#' == line_buf[0]) { /* skip commented lines */
226794b1f96SAlexey Kardashevskiy continue;
227794b1f96SAlexey Kardashevskiy }
22810578a25SPaolo Bonzini trace_enable_events(line_buf);
22923d15e86SLluís }
23082432638SAlexey Kardashevskiy }
23123d15e86SLluís if (fclose(fp) != 0) {
232a35d9be6SAlexey Kardashevskiy loc_set_file(fname, 0);
233a35d9be6SAlexey Kardashevskiy error_report("%s", strerror(errno));
23423d15e86SLluís exit(1);
23523d15e86SLluís }
236a35d9be6SAlexey Kardashevskiy loc_pop(&loc);
23723d15e86SLluís }
2385b808275SLluís Vilanova
trace_init_file(void)23992eecfffSPaolo Bonzini void trace_init_file(void)
2405b808275SLluís Vilanova {
2415b808275SLluís Vilanova #ifdef CONFIG_TRACE_SIMPLE
2429f45a641SPaolo Bonzini st_set_trace_file(trace_opts_file);
243648b4823SJosh DuBois if (init_trace_on_startup) {
2441b7157beSJosh DuBois st_set_trace_file_enabled(true);
245648b4823SJosh DuBois }
246ed7f5f1dSPaolo Bonzini #elif defined CONFIG_TRACE_LOG
2473d88754eSAlex Bennée /*
2483d88754eSAlex Bennée * If both the simple and the log backends are enabled, "--trace file"
2493d88754eSAlex Bennée * only applies to the simple backend; use "-D" for the log
2503d88754eSAlex Bennée * backend. However we should only override -D if we actually have
2513d88754eSAlex Bennée * something to override it with.
252ed7f5f1dSPaolo Bonzini */
2539f45a641SPaolo Bonzini if (trace_opts_file) {
2549f45a641SPaolo Bonzini qemu_set_log_filename(trace_opts_file, &error_fatal);
2553d88754eSAlex Bennée }
2565b808275SLluís Vilanova #else
2579f45a641SPaolo Bonzini if (trace_opts_file) {
258db817b8cSYaowei Bai fprintf(stderr, "error: --trace file=...: "
2595b808275SLluís Vilanova "option not supported by the selected tracing backends\n");
26041fc57e4SPaolo Bonzini exit(1);
26141fc57e4SPaolo Bonzini }
26241fc57e4SPaolo Bonzini #endif
26341fc57e4SPaolo Bonzini }
26441fc57e4SPaolo Bonzini
trace_init_backends(void)26541fc57e4SPaolo Bonzini bool trace_init_backends(void)
26641fc57e4SPaolo Bonzini {
26741fc57e4SPaolo Bonzini #ifdef CONFIG_TRACE_SIMPLE
26841fc57e4SPaolo Bonzini if (!st_init()) {
26941fc57e4SPaolo Bonzini fprintf(stderr, "failed to initialize simple tracing backend.\n");
2705b808275SLluís Vilanova return false;
2715b808275SLluís Vilanova }
2725b808275SLluís Vilanova #endif
2735b808275SLluís Vilanova
2745b808275SLluís Vilanova #ifdef CONFIG_TRACE_FTRACE
2755b808275SLluís Vilanova if (!ftrace_init()) {
2765b808275SLluís Vilanova fprintf(stderr, "failed to initialize ftrace backend.\n");
2775b808275SLluís Vilanova return false;
2785b808275SLluís Vilanova }
2795b808275SLluís Vilanova #endif
2805b808275SLluís Vilanova
2810a852417SPaul Durrant #ifdef CONFIG_TRACE_SYSLOG
2820a852417SPaul Durrant openlog(NULL, LOG_PID, LOG_DAEMON);
2830a852417SPaul Durrant #endif
2840a852417SPaul Durrant
2855b808275SLluís Vilanova return true;
2865b808275SLluís Vilanova }
287e9e0bb2aSDenis V. Lunev
trace_opt_parse(const char * optstr)288*8b7b9c5cSPhilippe Mathieu-Daudé void trace_opt_parse(const char *optstr)
289e9e0bb2aSDenis V. Lunev {
290e9e0bb2aSDenis V. Lunev QemuOpts *opts = qemu_opts_parse_noisily(qemu_find_opts("trace"),
291*8b7b9c5cSPhilippe Mathieu-Daudé optstr, true);
292e9e0bb2aSDenis V. Lunev if (!opts) {
293e9e0bb2aSDenis V. Lunev exit(1);
294e9e0bb2aSDenis V. Lunev }
295e9e0bb2aSDenis V. Lunev if (qemu_opt_get(opts, "enable")) {
296e9e0bb2aSDenis V. Lunev trace_enable_events(qemu_opt_get(opts, "enable"));
297e9e0bb2aSDenis V. Lunev }
298e9e0bb2aSDenis V. Lunev trace_init_events(qemu_opt_get(opts, "events"));
299648b4823SJosh DuBois init_trace_on_startup = true;
3009f45a641SPaolo Bonzini g_free(trace_opts_file);
3019f45a641SPaolo Bonzini trace_opts_file = g_strdup(qemu_opt_get(opts, "file"));
302e9e0bb2aSDenis V. Lunev qemu_opts_del(opts);
303e9e0bb2aSDenis V. Lunev }
304b7d48952SDaniel P. Berrange
trace_get_vcpu_event_count(void)305b7d48952SDaniel P. Berrange uint32_t trace_get_vcpu_event_count(void)
306b7d48952SDaniel P. Berrange {
307ca3fa0e8SDaniel P. Berrange return next_vcpu_id;
308b7d48952SDaniel P. Berrange }
309