include/qemu/log.h

   1 #ifndef QEMU_LOG_H
   2 #define QEMU_LOG_H
   3
   4
   5 /* Private global variables, don't use */
   6 extern FILE *qemu_logfile;
   7 extern int qemu_loglevel;
   8
   9 /*
  10  * The new API:
  11  *
  12  */
  13
  14 /* Log settings checking macros: */
  15
  16 /* Returns true if qemu_log() will really write somewhere
  17  */
  18 static inline bool qemu_log_enabled(void)
  19 {
  20     return qemu_logfile != NULL;
  21 }
  22
  23 /* Returns true if qemu_log() will write somewhere else than stderr
  24  */
  25 static inline bool qemu_log_separate(void)
  26 {
  27     return qemu_logfile != NULL && qemu_logfile != stderr;
  28 }
  29
  30 #define CPU_LOG_TB_OUT_ASM (1 << 0)
  31 #define CPU_LOG_TB_IN_ASM  (1 << 1)
  32 #define CPU_LOG_TB_OP      (1 << 2)
  33 #define CPU_LOG_TB_OP_OPT  (1 << 3)
  34 #define CPU_LOG_INT        (1 << 4)
  35 #define CPU_LOG_EXEC       (1 << 5)
  36 #define CPU_LOG_PCALL      (1 << 6)
  37 #define CPU_LOG_TB_CPU     (1 << 8)
  38 #define CPU_LOG_RESET      (1 << 9)
  39 #define LOG_UNIMP          (1 << 10)
  40 #define LOG_GUEST_ERROR    (1 << 11)
  41 #define CPU_LOG_MMU        (1 << 12)
  42 #define CPU_LOG_TB_NOCHAIN (1 << 13)
  43 #define CPU_LOG_PAGE       (1 << 14)
  44 #define LOG_TRACE          (1 << 15)
  45
  46 /* Returns true if a bit is set in the current loglevel mask
  47  */
  48 static inline bool qemu_loglevel_mask(int mask)
  49 {
  50     return (qemu_loglevel & mask) != 0;
  51 }
  52
  53 /* Logging functions: */
  54
  55 /* main logging function
  56  */
  57 void GCC_FMT_ATTR(1, 2) qemu_log(const char *fmt, ...);
  58
  59 /* vfprintf-like logging function
  60  */
  61 static inline void GCC_FMT_ATTR(1, 0)
  62 qemu_log_vprintf(const char *fmt, va_list va)
  63 {
  64     if (qemu_logfile) {
  65         vfprintf(qemu_logfile, fmt, va);
  66     }
  67 }
  68
  69 /* log only if a bit is set on the current loglevel mask:
  70  * @mask: bit to check in the mask
  71  * @fmt: printf-style format string
  72  * @args: optional arguments for format string
  73  */
  74 #define qemu_log_mask(MASK, FMT, ...)                   \
  75     do {                                                \
  76         if (unlikely(qemu_loglevel_mask(MASK))) {       \
  77             qemu_log(FMT, ## __VA_ARGS__);              \
  78         }                                               \
  79     } while (0)
  80
  81 /* log only if a bit is set on the current loglevel mask
  82  * and we are in the address range we care about:
  83  * @mask: bit to check in the mask
  84  * @addr: address to check in dfilter
  85  * @fmt: printf-style format string
  86  * @args: optional arguments for format string
  87  */
  88 #define qemu_log_mask_and_addr(MASK, ADDR, FMT, ...)    \
  89     do {                                                \
  90         if (unlikely(qemu_loglevel_mask(MASK)) &&       \
  91                      qemu_log_in_addr_range(ADDR)) {    \
  92             qemu_log(FMT, ## __VA_ARGS__);              \
  93         }                                               \
  94     } while (0)
  95
  96 /* Maintenance: */
  97
  98 /* define log items */
  99 typedef struct QEMULogItem {
 100     int mask;
 101     const char *name;
 102     const char *help;
 103 } QEMULogItem;
 104
 105 extern const QEMULogItem qemu_log_items[];
 106
 107 void qemu_set_log(int log_flags);
 108 void qemu_log_needs_buffers(void);
 109 void qemu_set_log_filename(const char *filename, Error **errp);
 110 void qemu_set_dfilter_ranges(const char *ranges, Error **errp);
 111 bool qemu_log_in_addr_range(uint64_t addr);
 112 int qemu_str_to_log_mask(const char *str);
 113
 114 /* Print a usage message listing all the valid logging categories
 115  * to the specified FILE*.
 116  */
 117 void qemu_print_log_usage(FILE *f);
 118
 119 /* fflush() the log file */
 120 void qemu_log_flush(void);
 121 /* Close the log file */
 122 void qemu_log_close(void);
 123
 124 #endif