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