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; 43*9f45a641SPaolo 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 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++; 71d01c05c9SLluís Vilanova if (events[i]->vcpu_id == TRACE_VCPU_EVENT_NONE) { 72d01c05c9SLluís Vilanova continue; 73d01c05c9SLluís Vilanova } 74d01c05c9SLluís Vilanova 75d01c05c9SLluís Vilanova if (likely(next_vcpu_id < CPU_TRACE_DSTATE_MAX_EVENTS)) { 76ca3fa0e8SDaniel P. Berrange events[i]->vcpu_id = next_vcpu_id++; 77d01c05c9SLluís Vilanova } else { 7855d527a9SAlistair Francis warn_report("too many vcpu trace events; dropping '%s'", 79d01c05c9SLluís Vilanova events[i]->name); 80ca3fa0e8SDaniel P. Berrange } 81ca3fa0e8SDaniel P. Berrange } 82fe4db84dSDaniel P. Berrange event_groups = g_renew(TraceEventGroup, event_groups, nevent_groups + 1); 83fe4db84dSDaniel P. Berrange event_groups[nevent_groups].events = events; 84fe4db84dSDaniel P. Berrange nevent_groups++; 85fe4db84dSDaniel P. Berrange } 86fe4db84dSDaniel P. Berrange 87fe4db84dSDaniel P. Berrange 88b1bae816SLluís Vilanova TraceEvent *trace_event_name(const char *name) 89b1bae816SLluís Vilanova { 90b1bae816SLluís Vilanova assert(name != NULL); 91b1bae816SLluís Vilanova 920d4e995cSDaniel P. Berrange TraceEventIter iter; 930d4e995cSDaniel P. Berrange TraceEvent *ev; 940d4e995cSDaniel P. Berrange trace_event_iter_init(&iter, NULL); 950d4e995cSDaniel P. Berrange while ((ev = trace_event_iter_next(&iter)) != NULL) { 96b1bae816SLluís Vilanova if (strcmp(trace_event_get_name(ev), name) == 0) { 97b1bae816SLluís Vilanova return ev; 98b1bae816SLluís Vilanova } 99b1bae816SLluís Vilanova } 100b1bae816SLluís Vilanova return NULL; 101b1bae816SLluís Vilanova } 102b1bae816SLluís Vilanova 1036a1b0f3aSDaniel P. Berrange void trace_event_iter_init(TraceEventIter *iter, const char *pattern) 1046a1b0f3aSDaniel P. Berrange { 1056a1b0f3aSDaniel P. Berrange iter->event = 0; 106fe4db84dSDaniel P. Berrange iter->group = 0; 1076a1b0f3aSDaniel P. Berrange iter->pattern = pattern; 1086a1b0f3aSDaniel P. Berrange } 1096a1b0f3aSDaniel P. Berrange 1106a1b0f3aSDaniel P. Berrange TraceEvent *trace_event_iter_next(TraceEventIter *iter) 1116a1b0f3aSDaniel P. Berrange { 112fe4db84dSDaniel P. Berrange while (iter->group < nevent_groups && 113fe4db84dSDaniel P. Berrange event_groups[iter->group].events[iter->event] != NULL) { 114fe4db84dSDaniel P. Berrange TraceEvent *ev = event_groups[iter->group].events[iter->event]; 1156a1b0f3aSDaniel P. Berrange iter->event++; 116fe4db84dSDaniel P. Berrange if (event_groups[iter->group].events[iter->event] == NULL) { 117fe4db84dSDaniel P. Berrange iter->event = 0; 118fe4db84dSDaniel P. Berrange iter->group++; 119fe4db84dSDaniel P. Berrange } 1206a1b0f3aSDaniel P. Berrange if (!iter->pattern || 121e66eae7aSAlex Bennée g_pattern_match_simple(iter->pattern, trace_event_get_name(ev))) { 1226a1b0f3aSDaniel P. Berrange return ev; 1236a1b0f3aSDaniel P. Berrange } 1246a1b0f3aSDaniel P. Berrange } 1256a1b0f3aSDaniel P. Berrange 1266a1b0f3aSDaniel P. Berrange return NULL; 1276a1b0f3aSDaniel P. Berrange } 1286a1b0f3aSDaniel P. Berrange 1296745c8a0SDoug Evans void trace_list_events(FILE *f) 130e9527dd3SPaolo Bonzini { 1310d4e995cSDaniel P. Berrange TraceEventIter iter; 1320d4e995cSDaniel P. Berrange TraceEvent *ev; 1330d4e995cSDaniel P. Berrange trace_event_iter_init(&iter, NULL); 1340d4e995cSDaniel P. Berrange while ((ev = trace_event_iter_next(&iter)) != NULL) { 1356745c8a0SDoug Evans fprintf(f, "%s\n", trace_event_get_name(ev)); 136e9527dd3SPaolo Bonzini } 1379f591a5dSPhilippe Mathieu-Daudé #ifdef CONFIG_TRACE_DTRACE 1386745c8a0SDoug Evans fprintf(f, "This list of names of trace points may be incomplete " 1399f591a5dSPhilippe Mathieu-Daudé "when using the DTrace/SystemTap backends.\n" 1409f591a5dSPhilippe Mathieu-Daudé "Run 'qemu-trace-stap list %s' to print the full list.\n", 1419f591a5dSPhilippe Mathieu-Daudé error_get_progname()); 1429f591a5dSPhilippe Mathieu-Daudé #endif 143e9527dd3SPaolo Bonzini } 144e9527dd3SPaolo Bonzini 145e9527dd3SPaolo Bonzini static void do_trace_enable_events(const char *line_buf) 14610578a25SPaolo Bonzini { 14710578a25SPaolo Bonzini const bool enable = ('-' != line_buf[0]); 14810578a25SPaolo Bonzini const char *line_ptr = enable ? line_buf : line_buf + 1; 1490d4e995cSDaniel P. Berrange TraceEventIter iter; 1500d4e995cSDaniel P. Berrange TraceEvent *ev; 1510d4e995cSDaniel P. Berrange bool is_pattern = trace_event_is_pattern(line_ptr); 15210578a25SPaolo Bonzini 1530d4e995cSDaniel P. Berrange trace_event_iter_init(&iter, line_ptr); 1540d4e995cSDaniel P. Berrange while ((ev = trace_event_iter_next(&iter)) != NULL) { 1550d4e995cSDaniel P. Berrange if (!trace_event_get_state_static(ev)) { 1560d4e995cSDaniel P. Berrange if (!is_pattern) { 1573dc6f869SAlistair Francis warn_report("trace event '%s' is not traceable", 15810578a25SPaolo Bonzini line_ptr); 1590d4e995cSDaniel P. Berrange return; 16010578a25SPaolo Bonzini } 1610d4e995cSDaniel P. Berrange continue; 1620d4e995cSDaniel P. Berrange } 1630d4e995cSDaniel P. Berrange 1640d4e995cSDaniel P. Berrange /* start tracing */ 1650d4e995cSDaniel P. Berrange trace_event_set_state_dynamic(ev, enable); 1660d4e995cSDaniel P. Berrange if (!is_pattern) { 1670d4e995cSDaniel P. Berrange return; 1680d4e995cSDaniel P. Berrange } 1690d4e995cSDaniel P. Berrange } 1700d4e995cSDaniel P. Berrange 1710d4e995cSDaniel P. Berrange if (!is_pattern) { 1723dc6f869SAlistair Francis warn_report("trace event '%s' does not exist", 1730d4e995cSDaniel P. Berrange line_ptr); 17410578a25SPaolo Bonzini } 17510578a25SPaolo Bonzini } 17610578a25SPaolo Bonzini 177e9527dd3SPaolo Bonzini void trace_enable_events(const char *line_buf) 178e9527dd3SPaolo Bonzini { 179e9527dd3SPaolo Bonzini if (is_help_option(line_buf)) { 1806745c8a0SDoug Evans trace_list_events(stdout); 181947e4744SKevin Wolf if (monitor_cur() == NULL) { 182e9527dd3SPaolo Bonzini exit(0); 183acc6809dSDenis V. Lunev } 184e9527dd3SPaolo Bonzini } else { 185e9527dd3SPaolo Bonzini do_trace_enable_events(line_buf); 186e9527dd3SPaolo Bonzini } 187e9527dd3SPaolo Bonzini } 188e9527dd3SPaolo Bonzini 189e9e0bb2aSDenis V. Lunev static void trace_init_events(const char *fname) 19023d15e86SLluís { 191a35d9be6SAlexey Kardashevskiy Location loc; 192a35d9be6SAlexey Kardashevskiy FILE *fp; 193a35d9be6SAlexey Kardashevskiy char line_buf[1024]; 194a35d9be6SAlexey Kardashevskiy size_t line_idx = 0; 195a35d9be6SAlexey Kardashevskiy 19623d15e86SLluís if (fname == NULL) { 19723d15e86SLluís return; 19823d15e86SLluís } 19923d15e86SLluís 200a35d9be6SAlexey Kardashevskiy loc_push_none(&loc); 201a35d9be6SAlexey Kardashevskiy loc_set_file(fname, 0); 202a35d9be6SAlexey Kardashevskiy fp = fopen(fname, "r"); 20323d15e86SLluís if (!fp) { 204a35d9be6SAlexey Kardashevskiy error_report("%s", strerror(errno)); 20523d15e86SLluís exit(1); 20623d15e86SLluís } 20723d15e86SLluís while (fgets(line_buf, sizeof(line_buf), fp)) { 208a35d9be6SAlexey Kardashevskiy loc_set_file(fname, ++line_idx); 20923d15e86SLluís size_t len = strlen(line_buf); 21023d15e86SLluís if (len > 1) { /* skip empty lines */ 21123d15e86SLluís line_buf[len - 1] = '\0'; 212794b1f96SAlexey Kardashevskiy if ('#' == line_buf[0]) { /* skip commented lines */ 213794b1f96SAlexey Kardashevskiy continue; 214794b1f96SAlexey Kardashevskiy } 21510578a25SPaolo Bonzini trace_enable_events(line_buf); 21623d15e86SLluís } 21782432638SAlexey Kardashevskiy } 21823d15e86SLluís if (fclose(fp) != 0) { 219a35d9be6SAlexey Kardashevskiy loc_set_file(fname, 0); 220a35d9be6SAlexey Kardashevskiy error_report("%s", strerror(errno)); 22123d15e86SLluís exit(1); 22223d15e86SLluís } 223a35d9be6SAlexey Kardashevskiy loc_pop(&loc); 22423d15e86SLluís } 2255b808275SLluís Vilanova 22692eecfffSPaolo Bonzini void trace_init_file(void) 2275b808275SLluís Vilanova { 2285b808275SLluís Vilanova #ifdef CONFIG_TRACE_SIMPLE 229*9f45a641SPaolo Bonzini st_set_trace_file(trace_opts_file); 230648b4823SJosh DuBois if (init_trace_on_startup) { 2311b7157beSJosh DuBois st_set_trace_file_enabled(true); 232648b4823SJosh DuBois } 233ed7f5f1dSPaolo Bonzini #elif defined CONFIG_TRACE_LOG 2343d88754eSAlex Bennée /* 2353d88754eSAlex Bennée * If both the simple and the log backends are enabled, "--trace file" 2363d88754eSAlex Bennée * only applies to the simple backend; use "-D" for the log 2373d88754eSAlex Bennée * backend. However we should only override -D if we actually have 2383d88754eSAlex Bennée * something to override it with. 239ed7f5f1dSPaolo Bonzini */ 240*9f45a641SPaolo Bonzini if (trace_opts_file) { 241*9f45a641SPaolo Bonzini qemu_set_log_filename(trace_opts_file, &error_fatal); 2423d88754eSAlex Bennée } 2435b808275SLluís Vilanova #else 244*9f45a641SPaolo Bonzini if (trace_opts_file) { 245db817b8cSYaowei Bai fprintf(stderr, "error: --trace file=...: " 2465b808275SLluís Vilanova "option not supported by the selected tracing backends\n"); 24741fc57e4SPaolo Bonzini exit(1); 24841fc57e4SPaolo Bonzini } 24941fc57e4SPaolo Bonzini #endif 25041fc57e4SPaolo Bonzini } 25141fc57e4SPaolo Bonzini 25282e95ec8SLluís Vilanova void trace_fini_vcpu(CPUState *vcpu) 25382e95ec8SLluís Vilanova { 25482e95ec8SLluís Vilanova TraceEventIter iter; 25582e95ec8SLluís Vilanova TraceEvent *ev; 25682e95ec8SLluís Vilanova 257a47e8715SLluís Vilanova trace_guest_cpu_exit(vcpu); 258a47e8715SLluís Vilanova 25982e95ec8SLluís Vilanova trace_event_iter_init(&iter, NULL); 26082e95ec8SLluís Vilanova while ((ev = trace_event_iter_next(&iter)) != NULL) { 26182e95ec8SLluís Vilanova if (trace_event_is_vcpu(ev) && 26282e95ec8SLluís Vilanova trace_event_get_state_static(ev) && 26382e95ec8SLluís Vilanova trace_event_get_vcpu_state_dynamic(vcpu, ev)) { 26482e95ec8SLluís Vilanova /* must disable to affect the global counter */ 26582e95ec8SLluís Vilanova trace_event_set_vcpu_state_dynamic(vcpu, ev, false); 26682e95ec8SLluís Vilanova } 26782e95ec8SLluís Vilanova } 26882e95ec8SLluís Vilanova } 26982e95ec8SLluís Vilanova 27041fc57e4SPaolo Bonzini bool trace_init_backends(void) 27141fc57e4SPaolo Bonzini { 27241fc57e4SPaolo Bonzini #ifdef CONFIG_TRACE_SIMPLE 27341fc57e4SPaolo Bonzini if (!st_init()) { 27441fc57e4SPaolo Bonzini fprintf(stderr, "failed to initialize simple tracing backend.\n"); 2755b808275SLluís Vilanova return false; 2765b808275SLluís Vilanova } 2775b808275SLluís Vilanova #endif 2785b808275SLluís Vilanova 2795b808275SLluís Vilanova #ifdef CONFIG_TRACE_FTRACE 2805b808275SLluís Vilanova if (!ftrace_init()) { 2815b808275SLluís Vilanova fprintf(stderr, "failed to initialize ftrace backend.\n"); 2825b808275SLluís Vilanova return false; 2835b808275SLluís Vilanova } 2845b808275SLluís Vilanova #endif 2855b808275SLluís Vilanova 2860a852417SPaul Durrant #ifdef CONFIG_TRACE_SYSLOG 2870a852417SPaul Durrant openlog(NULL, LOG_PID, LOG_DAEMON); 2880a852417SPaul Durrant #endif 2890a852417SPaul Durrant 2905b808275SLluís Vilanova return true; 2915b808275SLluís Vilanova } 292e9e0bb2aSDenis V. Lunev 29392eecfffSPaolo Bonzini void trace_opt_parse(const char *optarg) 294e9e0bb2aSDenis V. Lunev { 295e9e0bb2aSDenis V. Lunev QemuOpts *opts = qemu_opts_parse_noisily(qemu_find_opts("trace"), 296e9e0bb2aSDenis V. Lunev optarg, true); 297e9e0bb2aSDenis V. Lunev if (!opts) { 298e9e0bb2aSDenis V. Lunev exit(1); 299e9e0bb2aSDenis V. Lunev } 300e9e0bb2aSDenis V. Lunev if (qemu_opt_get(opts, "enable")) { 301e9e0bb2aSDenis V. Lunev trace_enable_events(qemu_opt_get(opts, "enable")); 302e9e0bb2aSDenis V. Lunev } 303e9e0bb2aSDenis V. Lunev trace_init_events(qemu_opt_get(opts, "events")); 304648b4823SJosh DuBois init_trace_on_startup = true; 305*9f45a641SPaolo Bonzini g_free(trace_opts_file); 306*9f45a641SPaolo Bonzini trace_opts_file = g_strdup(qemu_opt_get(opts, "file")); 307e9e0bb2aSDenis V. Lunev qemu_opts_del(opts); 308e9e0bb2aSDenis V. Lunev } 309b7d48952SDaniel P. Berrange 310b7d48952SDaniel P. Berrange uint32_t trace_get_vcpu_event_count(void) 311b7d48952SDaniel P. Berrange { 312ca3fa0e8SDaniel P. Berrange return next_vcpu_id; 313b7d48952SDaniel P. Berrange } 314