include/qemu/log.h

   1 #ifndef QEMU_LOG_H
   2 #define QEMU_LOG_H
   3
   4 #include <stdarg.h>
   5 #include <stdbool.h>
   6 #include <stdio.h>
   7 #include "qemu/compiler.h"
   8 #include "qom/cpu.h"
   9 #ifdef NEED_CPU_H
  10 #include "disas/disas.h"
  11 #endif
  12
  13 /* Private global variables, don't use */
  14 extern FILE *qemu_logfile;
  15 extern int qemu_loglevel;
  16
  17 /*
  18  * The new API:
  19  *
  20  */
  21
  22 /* Log settings checking macros: */
  23
  24 /* Returns true if qemu_log() will really write somewhere
  25  */
  26 static inline bool qemu_log_enabled(void)
  27 {
  28     return qemu_logfile != NULL;
  29 }
  30
  31 /* Returns true if qemu_log() will write somewhere else than stderr
  32  */
  33 static inline bool qemu_log_separate(void)
  34 {
  35     return qemu_logfile != NULL && qemu_logfile != stderr;
  36 }
  37
  38 #define CPU_LOG_TB_OUT_ASM (1 << 0)
  39 #define CPU_LOG_TB_IN_ASM  (1 << 1)
  40 #define CPU_LOG_TB_OP      (1 << 2)
  41 #define CPU_LOG_TB_OP_OPT  (1 << 3)
  42 #define CPU_LOG_INT        (1 << 4)
  43 #define CPU_LOG_EXEC       (1 << 5)
  44 #define CPU_LOG_PCALL      (1 << 6)
  45 #define CPU_LOG_TB_CPU     (1 << 8)
  46 #define CPU_LOG_RESET      (1 << 9)
  47 #define LOG_UNIMP          (1 << 10)
  48 #define LOG_GUEST_ERROR    (1 << 11)
  49 #define CPU_LOG_MMU        (1 << 12)
  50 #define CPU_LOG_TB_NOCHAIN (1 << 13)
  51 #define CPU_LOG_PAGE       (1 << 14)
  52
  53 /* Returns true if a bit is set in the current loglevel mask
  54  */
  55 static inline bool qemu_loglevel_mask(int mask)
  56 {
  57     return (qemu_loglevel & mask) != 0;
  58 }
  59
  60 /* Logging functions: */
  61
  62 /* main logging function
  63  */
  64 void GCC_FMT_ATTR(1, 2) qemu_log(const char *fmt, ...);
  65
  66 /* vfprintf-like logging function
  67  */
  68 static inline void GCC_FMT_ATTR(1, 0)
  69 qemu_log_vprintf(const char *fmt, va_list va)
  70 {
  71     if (qemu_logfile) {
  72         vfprintf(qemu_logfile, fmt, va);
  73     }
  74 }
  75
  76 /* log only if a bit is set on the current loglevel mask
  77  */
  78 void GCC_FMT_ATTR(2, 3) qemu_log_mask(int mask, const char *fmt, ...);
  79
  80
  81 /* Special cases: */
  82
  83 /* cpu_dump_state() logging functions: */
  84 /**
  85  * log_cpu_state:
  86  * @cpu: The CPU whose state is to be logged.
  87  * @flags: Flags what to log.
  88  *
  89  * Logs the output of cpu_dump_state().
  90  */
  91 static inline void log_cpu_state(CPUState *cpu, int flags)
  92 {
  93     if (qemu_log_enabled()) {
  94         cpu_dump_state(cpu, qemu_logfile, fprintf, flags);
  95     }
  96 }
  97
  98 /**
  99  * log_cpu_state_mask:
 100  * @mask: Mask when to log.
 101  * @cpu: The CPU whose state is to be logged.
 102  * @flags: Flags what to log.
 103  *
 104  * Logs the output of cpu_dump_state() if loglevel includes @mask.
 105  */
 106 static inline void log_cpu_state_mask(int mask, CPUState *cpu, int flags)
 107 {
 108     if (qemu_loglevel & mask) {
 109         log_cpu_state(cpu, flags);
 110     }
 111 }
 112
 113 #ifdef NEED_CPU_H
 114 /* disas() and target_disas() to qemu_logfile: */
 115 static inline void log_target_disas(CPUState *cpu, target_ulong start,
 116                                     target_ulong len, int flags)
 117 {
 118     target_disas(qemu_logfile, cpu, start, len, flags);
 119 }
 120
 121 static inline void log_disas(void *code, unsigned long size)
 122 {
 123     disas(qemu_logfile, code, size);
 124 }
 125
 126 #if defined(CONFIG_USER_ONLY)
 127 /* page_dump() output to the log file: */
 128 static inline void log_page_dump(void)
 129 {
 130     page_dump(qemu_logfile);
 131 }
 132 #endif
 133 #endif
 134
 135
 136 /* Maintenance: */
 137
 138 /* fflush() the log file */
 139 static inline void qemu_log_flush(void)
 140 {
 141     fflush(qemu_logfile);
 142 }
 143
 144 /* Close the log file */
 145 static inline void qemu_log_close(void)
 146 {
 147     if (qemu_logfile) {
 148         if (qemu_logfile != stderr) {
 149             fclose(qemu_logfile);
 150         }
 151         qemu_logfile = NULL;
 152     }
 153 }
 154
 155 /* Set up a new log file */
 156 static inline void qemu_log_set_file(FILE *f)
 157 {
 158     qemu_logfile = f;
 159 }
 160
 161 /* define log items */
 162 typedef struct QEMULogItem {
 163     int mask;
 164     const char *name;
 165     const char *help;
 166 } QEMULogItem;
 167
 168 extern const QEMULogItem qemu_log_items[];
 169
 170 /* This is the function that actually does the work of
 171  * changing the log level; it should only be accessed via
 172  * the qemu_set_log() wrapper.
 173  */
 174 void do_qemu_set_log(int log_flags, bool use_own_buffers);
 175
 176 static inline void qemu_set_log(int log_flags)
 177 {
 178 #ifdef CONFIG_USER_ONLY
 179     do_qemu_set_log(log_flags, true);
 180 #else
 181     do_qemu_set_log(log_flags, false);
 182 #endif
 183 }
 184
 185 void qemu_set_log_filename(const char *filename);
 186 int qemu_str_to_log_mask(const char *str);
 187
 188 /* Print a usage message listing all the valid logging categories
 189  * to the specified FILE*.
 190  */
 191 void qemu_print_log_usage(FILE *f);
 192
 193 #endif