LXR qemu/include/qemu/log.h

   1#ifndef QEMU_LOG_H
   2#define QEMU_LOG_H
   3
   4
   5/* Private global variables, don't use */
   6extern FILE *qemu_logfile;
   7extern 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 */
  18static 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 */
  25static 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#define CPU_LOG_TB_OP_IND  (1 << 16)
  46
  47/* device entries */
  48#define DEV_LOG_NET_DEV    (1 << 18)
  49#define DEV_LOG_NAND       (1 << 19)
  50#define DEV_LOG_NANDC      (1 << 20)
  51#define DEV_LOG_SD         (1 << 21)
  52#define DEV_LOG_SDHCI      (1 << 22)
  53#define DEV_LOG_SPI        (1 << 23)
  54#define DEV_LOG_SPI_DEV    (1 << 24)
  55#define LOG_FDT            (1 << 25)
  56#define LOG_PM             (1 << 26)
  57
  58/* Returns true if a bit is set in the current loglevel mask
  59 */
  60static inline bool qemu_loglevel_mask(int mask)
  61{
  62    return (qemu_loglevel & mask) != 0;
  63}
  64
  65/* Lock output for a series of related logs.  Since this is not needed
  66 * for a single qemu_log / qemu_log_mask / qemu_log_mask_and_addr, we
  67 * assume that qemu_loglevel_mask has already been tested, and that
  68 * qemu_loglevel is never set when qemu_logfile is unset.
  69 */
  70
  71static inline void qemu_log_lock(void)
  72{
  73    qemu_flockfile(qemu_logfile);
  74}
  75
  76static inline void qemu_log_unlock(void)
  77{
  78    qemu_funlockfile(qemu_logfile);
  79}
  80
  81/* Logging functions: */
  82
  83/* main logging function
  84 */
  85int GCC_FMT_ATTR(1, 2) qemu_log(const char *fmt, ...);
  86
  87/* vfprintf-like logging function
  88 */
  89static inline void GCC_FMT_ATTR(1, 0)
  90qemu_log_vprintf(const char *fmt, va_list va)
  91{
  92    if (qemu_logfile) {
  93        vfprintf(qemu_logfile, fmt, va);
  94    }
  95}
  96
  97/* log only if a bit is set on the current loglevel mask:
  98 * @mask: bit to check in the mask
  99 * @fmt: printf-style format string
 100 * @args: optional arguments for format string
 101 */
 102#define qemu_log_mask(MASK, FMT, ...)                   \
 103    do {                                                \
 104        if (unlikely(qemu_loglevel_mask(MASK))) {       \
 105            qemu_log(FMT, ## __VA_ARGS__);              \
 106        }                                               \
 107    } while (0)
 108
 109/* log only if a bit is set on the current loglevel mask
 110 * and we are in the address range we care about:
 111 * @mask: bit to check in the mask
 112 * @addr: address to check in dfilter
 113 * @fmt: printf-style format string
 114 * @args: optional arguments for format string
 115 */
 116#define qemu_log_mask_and_addr(MASK, ADDR, FMT, ...)    \
 117    do {                                                \
 118        if (unlikely(qemu_loglevel_mask(MASK)) &&       \
 119                     qemu_log_in_addr_range(ADDR)) {    \
 120            qemu_log(FMT, ## __VA_ARGS__);              \
 121        }                                               \
 122    } while (0)
 123
 124/* Maintenance: */
 125
 126/* define log items */
 127typedef struct QEMULogItem {
 128    int mask;
 129    const char *name;
 130    const char *help;
 131} QEMULogItem;
 132
 133extern const QEMULogItem qemu_log_items[];
 134
 135void qemu_set_log(int log_flags);
 136void qemu_log_needs_buffers(void);
 137void qemu_set_log_filename(const char *filename, Error **errp);
 138void qemu_set_dfilter_ranges(const char *ranges, Error **errp);
 139bool qemu_log_in_addr_range(uint64_t addr);
 140int qemu_str_to_log_mask(const char *str);
 141
 142/* Print a usage message listing all the valid logging categories
 143 * to the specified FILE*.
 144 */
 145void qemu_print_log_usage(FILE *f);
 146
 147/* fflush() the log file */
 148void qemu_log_flush(void);
 149/* Close the log file */
 150void qemu_log_close(void);
 151
 152#endif
 153