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