log.h

Go to the documentation of this file.

/*
 * /phoenix/include/log.h
 *
 * This file is a part of Phoenix operating system.
 * Copyright (c) 2011-2012, Artyom Lebedev <artyom.lebedev@gmail.com>
 * All rights reserved.
 * See COPYING file for copyright details.
 */

#ifndef LOG_H_
#define LOG_H_

#ifdef UNITTEST

void __ut_trace(const char *file, int line, const char *msg, ...);

#define TRACE_FMT(...) __ut_trace(__FILE__, __LINE__, __VA_ARGS__)

#elif defined(KERNEL)

namespace log {

class DbgSerialPort;
extern DbgSerialPort *dbgSerialPort;
extern text_stream::OTextStream<DbgSerialPort> *dbgStream;

} /* namespace log */

#define TRACE_FMT(...) log::dbgStream->Format(__VA_ARGS__)

#elif defined(EFI_APP)

#define TRACE_FMT(...)

#endif

#ifdef DEBUG
#define TRACE(msg, ...) \
    TRACE_FMT("[TRACE] %s:%d <%s>: " msg "\n", __FILE__, __LINE__, __func__, ## __VA_ARGS__)
#else /* DEBUG */
#define TRACE(msg, ...)
#endif /* DEBUG */

namespace log {

class SysLogBase : public text_stream::OTextStream<SysLogBase> {
public:
    enum Level {
        LOG_ALERT, 
        LOG_CRITICAL, 
        LOG_ERROR, 
        LOG_WARNING, 
        LOG_NOTICE, 
        LOG_INFO, 
        LOG_DEBUG 
    };

    inline SysLogBase() : text_stream::OTextStream<SysLogBase>(this) {
        _curLevel = LOG_DEBUG;
#ifdef DEBUG
        _maxLevel = LOG_DEBUG;
#else /* DEBUG */
        _maxLevel = LOG_NOTICE;
#endif /* DEBUG */
    }

    virtual SysLogBase &operator <<(log::SysLogBase::Level level) = 0;

    template <typename T>
    inline SysLogBase &operator <<(T value) {
        if (UNLIKELY(_curLevel <= _maxLevel)) {
            text_stream::OTextStream<SysLogBase>::operator <<(value);
        }
        return *this;
    }

    template <typename... Args>
    inline SysLogBase &Format(const char *fmt, Args... args) {
        if (UNLIKELY(_curLevel <= _maxLevel)) {
            text_stream::OTextStream<SysLogBase>::Format(fmt, args...);
        }
        return *this;
    }

    inline SysLogBase &Format(const char *fmt) {
        if (UNLIKELY(_curLevel <= _maxLevel)) {
            text_stream::OTextStream<SysLogBase>::Format(fmt);
        }
        return *this;
    }

    inline SysLogBase &FormatV(const char *fmt, va_list args) {
        if (UNLIKELY(_curLevel <= _maxLevel)) {
            text_stream::OTextStream<SysLogBase>::FormatV(fmt, args);
        }
        return *this;
    }

    template <typename... Args>
    SysLogBase &Alert(const char *fmt, Args... args)
    {
        *this << LOG_ALERT;
        Format(fmt, args...);
        return *this;
    }

    template <typename... Args>
    SysLogBase &Critical(const char *fmt, Args... args)
    {
        *this << LOG_CRITICAL;
        Format(fmt, args...);
        return *this;
    }

    template <typename... Args>
    SysLogBase &Error(const char *fmt, Args... args)
    {
        *this << LOG_ERROR;
        Format(fmt, args...);
        return *this;
    }

    template <typename... Args>
    SysLogBase &Warning(const char *fmt, Args... args)
    {
        *this << LOG_WARNING;
        Format(fmt, args...);
        return *this;
    }

    template <typename... Args>
    SysLogBase &Notice(const char *fmt, Args... args)
    {
        *this << LOG_NOTICE;
        Format(fmt, args...);
        return *this;
    }

    template <typename... Args>
    SysLogBase &Info(const char *fmt, Args... args)
    {
        *this << LOG_INFO;
        Format(fmt, args...);
        return *this;
    }

    template <typename... Args>
    SysLogBase &Debug(const char *fmt, Args... args)
    {
        *this << LOG_DEBUG;
        Format(fmt, args...);
        return *this;
    }

    virtual bool Putc(char c, void *arg) = 0;
protected:
    Level _curLevel;
    Level _maxLevel;
};

#ifdef KERNEL

class KSysLog : public SysLogBase {
public:
    KSysLog();

    virtual SysLogBase &operator <<(log::SysLogBase::Level level);

    virtual bool Putc(char c, void *arg = 0);
private:
    bool lastNewLine;
};

typedef KSysLog SysLog;

extern SysLog *sysLog;

#define LOG     (*log::sysLog)

#elif defined(EFI_APP) /* KERNEL */

/* Stub for EFI environment. */
typedef void *SysLog;

#else /* EFI_APP */

// XXX user space log

#endif /* KERNEL/EFI_APP */

void InitLog();

#define LL(level) __CONCAT(log::SysLogBase::LOG_, level)

} /* namespace log */

#endif /* LOG_H_ */