include/qemu/log.h

   1 #ifndef QEMU_LOG_H
   2 #define QEMU_LOG_H
   3
   4 /* A small part of this API is split into its own header */
   5 #include "qemu/log-for-trace.h"
   6
   7 /* Private global variable, don't use */
   8 extern FILE *qemu_logfile;
   9
  10 /*
  11  * The new API:
  12  *
  13  */
  14
  15 /* Log settings checking macros: */
  16
  17 /* Returns true if qemu_log() will really write somewhere
  18  */
  19 static inline bool qemu_log_enabled(void)
  20 {
  21     return qemu_logfile != NULL;
  22 }
  23
  24 /* Returns true if qemu_log() will write somewhere else than stderr
  25  */
  26 static inline bool qemu_log_separate(void)
  27 {
  28     return qemu_logfile != NULL && qemu_logfile != stderr;
  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_TB_CPU     (1 << 8)
  39 #define CPU_LOG_RESET      (1 << 9)
  40 #define LOG_UNIMP          (1 << 10)
  41 #define LOG_GUEST_ERROR    (1 << 11)
  42 #define CPU_LOG_MMU        (1 << 12)
  43 #define CPU_LOG_TB_NOCHAIN (1 << 13)
  44 #define CPU_LOG_PAGE       (1 << 14)
  45 /* LOG_TRACE (1 << 15) is defined in log-for-trace.h */
  46 #define CPU_LOG_TB_OP_IND  (1 << 16)
  47 #define CPU_LOG_TB_FPU     (1 << 17)
  48 #define CPU_LOG_PLUGIN     (1 << 18)
  49
  50 /* Lock output for a series of related logs.  Since this is not needed
  51  * for a single qemu_log / qemu_log_mask / qemu_log_mask_and_addr, we
  52  * assume that qemu_loglevel_mask has already been tested, and that
  53  * qemu_loglevel is never set when qemu_logfile is unset.
  54  */
  55
  56 static inline FILE *qemu_log_lock(void)
  57 {
  58     qemu_flockfile(qemu_logfile);
  59     return logfile->fd;
  60 }
  61
  62 static inline void qemu_log_unlock(FILE *fd)
  63 {
  64     if (fd) {
  65         qemu_funlockfile(fd);
  66     }
  67 }
  68
  69 /* Logging functions: */
  70
  71 /* vfprintf-like logging function
  72  */
  73 static inline void GCC_FMT_ATTR(1, 0)
  74 qemu_log_vprintf(const char *fmt, va_list va)
  75 {
  76     if (qemu_logfile) {
  77         vfprintf(qemu_logfile, fmt, va);
  78     }
  79 }
  80
  81 /* log only if a bit is set on the current loglevel mask:
  82  * @mask: bit to check in the mask
  83  * @fmt: printf-style format string
  84  * @args: optional arguments for format string
  85  */
  86 #define qemu_log_mask(MASK, FMT, ...)                   \
  87     do {                                                \
  88         if (unlikely(qemu_loglevel_mask(MASK))) {       \
  89             qemu_log(FMT, ## __VA_ARGS__);              \
  90         }                                               \
  91     } while (0)
  92
  93 /* log only if a bit is set on the current loglevel mask
  94  * and we are in the address range we care about:
  95  * @mask: bit to check in the mask
  96  * @addr: address to check in dfilter
  97  * @fmt: printf-style format string
  98  * @args: optional arguments for format string
  99  */
 100 #define qemu_log_mask_and_addr(MASK, ADDR, FMT, ...)    \
 101     do {                                                \
 102         if (unlikely(qemu_loglevel_mask(MASK)) &&       \
 103                      qemu_log_in_addr_range(ADDR)) {    \
 104             qemu_log(FMT, ## __VA_ARGS__);              \
 105         }                                               \
 106     } while (0)
 107
 108 /* Maintenance: */
 109
 110 /* define log items */
 111 typedef struct QEMULogItem {
 112     int mask;
 113     const char *name;
 114     const char *help;
 115 } QEMULogItem;
 116
 117 extern const QEMULogItem qemu_log_items[];
 118
 119 void qemu_set_log(int log_flags);
 120 void qemu_log_needs_buffers(void);
 121 void qemu_set_log_filename(const char *filename, Error **errp);
 122 void qemu_set_dfilter_ranges(const char *ranges, Error **errp);
 123 bool qemu_log_in_addr_range(uint64_t addr);
 124 int qemu_str_to_log_mask(const char *str);
 125
 126 /* Print a usage message listing all the valid logging categories
 127  * to the specified FILE*.
 128  */
 129 void qemu_print_log_usage(FILE *f);
 130
 131 /* fflush() the log file */
 132 void qemu_log_flush(void);
 133 /* Close the log file */
 134 void qemu_log_close(void);
 135
 136 #endif