4 * Copyright (c) 2003 Fabrice Bellard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
20 #include "qemu/osdep.h"
22 #include "qemu/range.h"
23 #include "qemu/error-report.h"
24 #include "qapi/error.h"
25 #include "qemu/cutils.h"
26 #include "trace/control.h"
27 #include "qemu/thread.h"
28 #include "qemu/lockable.h"
31 #include <sys/syscall.h>
35 typedef struct RCUCloseFILE {
40 /* Mutex covering the other global_* variables. */
41 static QemuMutex global_mutex;
42 static char *global_filename;
43 static FILE *global_file;
44 static __thread FILE *thread_file;
45 static __thread Notifier qemu_log_thread_cleanup_notifier;
48 static bool log_per_thread;
49 static GArray *debug_regions;
51 /* Returns true if qemu_log() will really write somewhere. */
52 bool qemu_log_enabled(void)
54 return log_per_thread || qatomic_read(&global_file) != NULL;
57 /* Returns true if qemu_log() will write somewhere other than stderr. */
58 bool qemu_log_separate(void)
63 FILE *logfile = qatomic_read(&global_file);
64 return logfile && logfile != stderr;
68 static int log_thread_id(void)
72 #elif defined(SYS_gettid)
73 return syscall(SYS_gettid);
76 return qatomic_fetch_inc(&counter);
80 static void qemu_log_thread_cleanup(Notifier *n, void *unused)
82 if (thread_file != stderr) {
88 /* Lock/unlock output. */
90 static FILE *qemu_log_trylock_with_err(Error **errp)
94 logfile = thread_file;
97 g_autofree char *filename
98 = g_strdup_printf(global_filename, log_thread_id());
99 logfile = fopen(filename, "w");
101 error_setg_errno(errp, errno,
102 "Error opening logfile %s for thread %d",
103 filename, log_thread_id());
106 thread_file = logfile;
107 qemu_log_thread_cleanup_notifier.notify = qemu_log_thread_cleanup;
108 qemu_thread_atexit_add(&qemu_log_thread_cleanup_notifier);
112 * FIXME: typeof_strip_qual, as used by qatomic_rcu_read,
113 * does not work with pointers to undefined structures,
114 * such as we have with struct _IO_FILE and musl libc.
115 * Since all we want is a read of a pointer, cast to void**,
116 * which does work with typeof_strip_qual.
118 logfile = qatomic_rcu_read((void **)&global_file);
126 qemu_flockfile(logfile);
130 FILE *qemu_log_trylock(void)
132 return qemu_log_trylock_with_err(NULL);
135 void qemu_log_unlock(FILE *logfile)
139 qemu_funlockfile(logfile);
140 if (!log_per_thread) {
146 void qemu_log(const char *fmt, ...)
148 FILE *f = qemu_log_trylock();
153 vfprintf(f, fmt, ap);
159 static void __attribute__((__constructor__)) startup(void)
161 qemu_mutex_init(&global_mutex);
164 static void rcu_close_file(RCUCloseFILE *r)
171 * valid_filename_template:
173 * Validate the filename template. Require %d if per_thread, allow it
174 * otherwise; require no other % within the template.
182 } ValidFilenameTemplateResult;
184 static ValidFilenameTemplateResult
185 valid_filename_template(const char *filename, bool per_thread, Error **errp)
188 char *pidstr = strstr(filename, "%");
191 /* We only accept one %d, no other format strings */
192 if (pidstr[1] != 'd' || strchr(pidstr + 2, '%')) {
193 error_setg(errp, "Bad logfile template: %s", filename);
196 return per_thread ? vft_strdup : vft_pid_printf;
200 error_setg(errp, "Filename template with '%%d' required for 'tid'");
203 return filename ? vft_strdup : vft_stderr;
206 /* enable or disable low levels log */
207 static bool qemu_set_log_internal(const char *filename, bool changed_name,
208 int log_flags, Error **errp)
210 bool need_to_open_file;
215 QEMU_LOCK_GUARD(&global_mutex);
216 logfile = global_file;
218 /* The per-thread flag is immutable. */
219 if (log_per_thread) {
220 log_flags |= LOG_PER_THREAD;
222 if (global_filename) {
223 log_flags &= ~LOG_PER_THREAD;
227 per_thread = log_flags & LOG_PER_THREAD;
230 char *newname = NULL;
233 * Once threads start opening their own log files, we have no
234 * easy mechanism to tell them all to close and re-open.
235 * There seems little cause to do so either -- this option
236 * will most often be used at user-only startup.
238 if (log_per_thread) {
239 error_setg(errp, "Cannot change log filename after setting 'tid'");
243 switch (valid_filename_template(filename, per_thread, errp)) {
249 newname = g_strdup(filename);
252 newname = g_strdup_printf(filename, getpid());
256 g_free(global_filename);
257 global_filename = newname;
260 filename = global_filename;
262 valid_filename_template(filename, true, errp) == vft_error) {
267 /* Once the per-thread flag is set, it cannot be unset. */
269 log_per_thread = true;
271 /* The flag itself is not relevant for need_to_open_file. */
272 log_flags &= ~LOG_PER_THREAD;
273 #ifdef CONFIG_TRACE_LOG
274 log_flags |= LOG_TRACE;
276 qemu_loglevel = log_flags;
278 daemonized = is_daemonized();
279 need_to_open_file = false;
282 * If not daemonized we only log if qemu_loglevel is set, either to
283 * stderr or to a file (if there is a filename).
284 * If per-thread, open the file for each thread in qemu_log_trylock().
286 need_to_open_file = qemu_loglevel && !log_per_thread;
289 * If we are daemonized, we will only log if there is a filename.
291 need_to_open_file = filename != NULL;
296 if (changed_name && logfile != stderr) {
297 RCUCloseFILE *r = g_new0(RCUCloseFILE, 1);
299 qatomic_rcu_set(&global_file, NULL);
300 call_rcu(r, rcu_close_file, rcu);
307 if (log_per_thread && daemonized) {
308 logfile = thread_file;
311 if (!logfile && need_to_open_file) {
313 if (log_per_thread) {
314 logfile = qemu_log_trylock_with_err(errp);
318 qemu_log_unlock(logfile);
320 logfile = fopen(filename, "w");
322 error_setg_errno(errp, errno, "Error opening logfile %s",
327 /* In case we are a daemon redirect stderr to logfile */
329 dup2(fileno(logfile), STDERR_FILENO);
332 * This will skip closing logfile in rcu_close_file()
333 * or qemu_log_thread_cleanup().
338 /* Default to stderr if no log file specified */
343 if (log_per_thread && daemonized) {
344 thread_file = logfile;
346 qatomic_rcu_set(&global_file, logfile);
352 bool qemu_set_log(int log_flags, Error **errp)
354 return qemu_set_log_internal(NULL, false, log_flags, errp);
357 bool qemu_set_log_filename(const char *filename, Error **errp)
359 return qemu_set_log_internal(filename, true, qemu_loglevel, errp);
362 bool qemu_set_log_filename_flags(const char *name, int flags, Error **errp)
364 return qemu_set_log_internal(name, true, flags, errp);
367 /* Returns true if addr is in our debug filter or no filter defined
369 bool qemu_log_in_addr_range(uint64_t addr)
373 for (i = 0; i < debug_regions->len; i++) {
374 Range *range = &g_array_index(debug_regions, Range, i);
375 if (range_contains(range, addr)) {
386 void qemu_set_dfilter_ranges(const char *filter_spec, Error **errp)
388 gchar **ranges = g_strsplit(filter_spec, ",", 0);
392 g_array_unref(debug_regions);
393 debug_regions = NULL;
396 debug_regions = g_array_sized_new(FALSE, FALSE,
397 sizeof(Range), g_strv_length(ranges));
398 for (i = 0; ranges[i]; i++) {
399 const char *r = ranges[i];
400 const char *range_op, *r2, *e;
401 uint64_t r1val, r2val, lob, upb;
404 range_op = strstr(r, "-");
405 r2 = range_op ? range_op + 1 : NULL;
407 range_op = strstr(r, "+");
408 r2 = range_op ? range_op + 1 : NULL;
411 range_op = strstr(r, "..");
412 r2 = range_op ? range_op + 2 : NULL;
415 error_setg(errp, "Bad range specifier");
419 if (qemu_strtou64(r, &e, 0, &r1val)
421 error_setg(errp, "Invalid number to the left of %.*s",
422 (int)(r2 - range_op), range_op);
425 if (qemu_strtou64(r2, NULL, 0, &r2val)) {
426 error_setg(errp, "Invalid number to the right of %.*s",
427 (int)(r2 - range_op), range_op);
434 upb = r1val + r2val - 1;
438 lob = r1val - (r2val - 1);
445 g_assert_not_reached();
448 error_setg(errp, "Invalid range");
451 range_set_bounds(&range, lob, upb);
452 g_array_append_val(debug_regions, range);
458 const QEMULogItem qemu_log_items[] = {
459 { CPU_LOG_TB_OUT_ASM, "out_asm",
460 "show generated host assembly code for each compiled TB" },
461 { CPU_LOG_TB_IN_ASM, "in_asm",
462 "show target assembly code for each compiled TB" },
463 { CPU_LOG_TB_OP, "op",
464 "show micro ops for each compiled TB" },
465 { CPU_LOG_TB_OP_OPT, "op_opt",
466 "show micro ops after optimization" },
467 { CPU_LOG_TB_OP_IND, "op_ind",
468 "show micro ops before indirect lowering" },
469 { CPU_LOG_INT, "int",
470 "show interrupts/exceptions in short format" },
471 { CPU_LOG_EXEC, "exec",
472 "show trace before each executed TB (lots of logs)" },
473 { CPU_LOG_TB_CPU, "cpu",
474 "show CPU registers before entering a TB (lots of logs)" },
475 { CPU_LOG_TB_FPU, "fpu",
476 "include FPU registers in the 'cpu' logging" },
477 { CPU_LOG_MMU, "mmu",
478 "log MMU-related activities" },
479 { CPU_LOG_PCALL, "pcall",
480 "x86 only: show protected mode far calls/returns/exceptions" },
481 { CPU_LOG_RESET, "cpu_reset",
482 "show CPU state before CPU resets" },
483 { LOG_UNIMP, "unimp",
484 "log unimplemented functionality" },
485 { LOG_GUEST_ERROR, "guest_errors",
486 "log when the guest OS does something invalid (eg accessing a\n"
487 "non-existent register)" },
488 { CPU_LOG_PAGE, "page",
489 "dump pages at beginning of user mode emulation" },
490 { CPU_LOG_TB_NOCHAIN, "nochain",
491 "do not chain compiled TBs so that \"exec\" and \"cpu\" show\n"
494 { CPU_LOG_PLUGIN, "plugin", "output from TCG plugins"},
496 { LOG_STRACE, "strace",
497 "log every user-mode syscall, its input, and its result" },
498 { LOG_PER_THREAD, "tid",
499 "open a separate log file per thread; filename must contain '%d'" },
500 { CPU_LOG_TB_VPU, "vpu",
501 "include VPU registers in the 'cpu' logging" },
505 /* takes a comma separated list of log masks. Return 0 if error. */
506 int qemu_str_to_log_mask(const char *str)
508 const QEMULogItem *item;
510 char **parts = g_strsplit(str, ",", 0);
513 for (tmp = parts; tmp && *tmp; tmp++) {
514 if (g_str_equal(*tmp, "all")) {
515 for (item = qemu_log_items; item->mask != 0; item++) {
518 #ifdef CONFIG_TRACE_LOG
519 } else if (g_str_has_prefix(*tmp, "trace:") && (*tmp)[6] != '\0') {
520 trace_enable_events((*tmp) + 6);
524 for (item = qemu_log_items; item->mask != 0; item++) {
525 if (g_str_equal(*tmp, item->name)) {
543 void qemu_print_log_usage(FILE *f)
545 const QEMULogItem *item;
546 fprintf(f, "Log items (comma separated):\n");
547 for (item = qemu_log_items; item->mask != 0; item++) {
548 fprintf(f, "%-15s %s\n", item->name, item->help);
550 #ifdef CONFIG_TRACE_LOG
551 fprintf(f, "trace:PATTERN enable trace events\n");
552 fprintf(f, "\nUse \"-d trace:help\" to get a list of trace events.\n\n");