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 #include "qemu/rcu.h"
   7
   8 typedef struct QemuLogFile {
   9     struct rcu_head rcu;
  10     FILE *fd;
  11 } QemuLogFile;
  12
  13 /* Private global variable, don't use */
  14 extern QemuLogFile *qemu_logfile;
  15
  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     QemuLogFile *logfile;
  36     bool res = false;
  37
  38     rcu_read_lock();
  39     logfile = qatomic_rcu_read(&qemu_logfile);
  40     if (logfile && logfile->fd != stderr) {
  41         res = true;
  42     }
  43     rcu_read_unlock();
  44     return res;
  45 }
  46
  47 #define CPU_LOG_TB_OUT_ASM (1 << 0)
  48 #define CPU_LOG_TB_IN_ASM  (1 << 1)
  49 #define CPU_LOG_TB_OP      (1 << 2)
  50 #define CPU_LOG_TB_OP_OPT  (1 << 3)
  51 #define CPU_LOG_INT        (1 << 4)
  52 #define CPU_LOG_EXEC       (1 << 5)
  53 #define CPU_LOG_PCALL      (1 << 6)
  54 #define CPU_LOG_TB_CPU     (1 << 8)
  55 #define CPU_LOG_RESET      (1 << 9)
  56 #define LOG_UNIMP          (1 << 10)
  57 #define LOG_GUEST_ERROR    (1 << 11)
  58 #define CPU_LOG_MMU        (1 << 12)
  59 #define CPU_LOG_TB_NOCHAIN (1 << 13)
  60 #define CPU_LOG_PAGE       (1 << 14)
  61 /* LOG_TRACE (1 << 15) is defined in log-for-trace.h */
  62 #define CPU_LOG_TB_OP_IND  (1 << 16)
  63 #define CPU_LOG_TB_FPU     (1 << 17)
  64 #define CPU_LOG_PLUGIN     (1 << 18)
  65 /* LOG_STRACE is used for user-mode strace logging. */
  66 #define LOG_STRACE         (1 << 19)
  67
  68 /* Lock/unlock output. */
  69
  70 FILE *qemu_log_trylock(void) G_GNUC_WARN_UNUSED_RESULT;
  71 void qemu_log_unlock(FILE *fd);
  72
  73 /* Logging functions: */
  74
  75 /* log only if a bit is set on the current loglevel mask:
  76  * @mask: bit to check in the mask
  77  * @fmt: printf-style format string
  78  * @args: optional arguments for format string
  79  */
  80 #define qemu_log_mask(MASK, FMT, ...)                   \
  81     do {                                                \
  82         if (unlikely(qemu_loglevel_mask(MASK))) {       \
  83             qemu_log(FMT, ## __VA_ARGS__);              \
  84         }                                               \
  85     } while (0)
  86
  87 /* log only if a bit is set on the current loglevel mask
  88  * and we are in the address range we care about:
  89  * @mask: bit to check in the mask
  90  * @addr: address to check in dfilter
  91  * @fmt: printf-style format string
  92  * @args: optional arguments for format string
  93  */
  94 #define qemu_log_mask_and_addr(MASK, ADDR, FMT, ...)    \
  95     do {                                                \
  96         if (unlikely(qemu_loglevel_mask(MASK)) &&       \
  97                      qemu_log_in_addr_range(ADDR)) {    \
  98             qemu_log(FMT, ## __VA_ARGS__);              \
  99         }                                               \
 100     } while (0)
 101
 102 /* Maintenance: */
 103
 104 /* define log items */
 105 typedef struct QEMULogItem {
 106     int mask;
 107     const char *name;
 108     const char *help;
 109 } QEMULogItem;
 110
 111 extern const QEMULogItem qemu_log_items[];
 112
 113 bool qemu_set_log(int log_flags, Error **errp);
 114 bool qemu_set_log_filename(const char *filename, Error **errp);
 115 void qemu_set_dfilter_ranges(const char *ranges, Error **errp);
 116 bool qemu_log_in_addr_range(uint64_t addr);
 117 int qemu_str_to_log_mask(const char *str);
 118
 119 /* Print a usage message listing all the valid logging categories
 120  * to the specified FILE*.
 121  */
 122 void qemu_print_log_usage(FILE *f);
 123
 124 /* Close the log file */
 125 void qemu_log_close(void);
 126
 127 #endif