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