log.h

Go to the documentation of this file.

 
// Copyright (c) 2013-2015 OpenM++
// This code is licensed under the MIT license (see LICENSE.txt for details)
 
#ifndef OM_LOG_H
#define OM_LOG_H
 
#include <chrono>
#include <mutex>
#include <thread>
#include <iomanip>
#include <fstream>
#include <sstream>
#include <iostream>
#include <cstdarg>
using namespace std;
 
#include "libopenm/omLog.h"
#include "libopenm/omError.h"
#include "libopenm/common/omHelper.h"
#include "helper.h"
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable : 4250)
#endif  // _WIN32
 
namespace openm
{
    class LogBase : public virtual ILogBase
    {
    public:
        LogBase(
            bool i_logToConsole,
            const char * i_basePath,
            bool i_logToFile,
            bool i_useTimeStamp,
            bool i_usePidStamp,
            bool i_noMsgTime
            );
        ~LogBase(void) noexcept;
 
        const string timeStamp(void) noexcept override;
 
        const bool isEnabled(void) noexcept override { return isConsoleEnabled || isLastEnabled || isStampedEnabled; }
 
        void init(
            bool i_logToConsole,
            const char * i_basePath,
            bool i_logToFile,
            bool i_useTimeStamp = false,
            bool i_usePidStamp = false,
            bool i_noMsgTime = false
            ) noexcept;
 
        void setRank(int i_rank, int i_worldSize) noexcept override;
 
    protected:
        recursive_mutex theMutex;   // mutex to lock for log operations
        bool isConsoleEnabled;      // if true then log to console
        bool isLastEnabled;         // if true then last log enabled
        bool isLastCreated;         // if true then last log file created
        bool isStampedEnabled;      // if true then last log enabled
        bool isStampedCreated;      // if true then last log file created
        string tsPart;              // log file name timestamp part: 2012_08_17_16_04_59_148
        string pidPart;             // log file name pid part: 1234
        string lastPath;            // last log file path: /var/log/openm.log
        string stampedPath;         // stamped log file path: /var/log/openm.2012_08_17_16_04_59_148.1234.log
        bool isNoMsgTime;           // if true then not prefix messages with date-time
        string rankPrefix;          // process rank log prefix
        bool isMsgRank;             // if true then prefix messages with process rank
 
        static const size_t msgBufferSize = 32768;
        char msgBuffer[msgBufferSize + 1];          // buffer to format message
 
    protected:
 
        void doLogMsg(const char * i_msg, const char * i_extra) noexcept;
 
        // create log file or truncate existing, return false on error
        bool logFileCreate(const string & i_path) noexcept;
 
        // log to console
        virtual bool logToConsole(
            const chrono::system_clock::time_point & i_msgTime, const char * i_msg, const char * i_extra = nullptr
            ) noexcept = 0;
 
        // log to file, return false on error
        virtual bool logToFile(
            bool i_isToStamped, const chrono::system_clock::time_point & i_msgTime, const char * i_msg, const char * i_extra = nullptr
            ) noexcept = 0;
 
        // write date-time and message to output stream, return false on error
        void writeToLog(
            ostream & i_ost, const chrono::system_clock::time_point & i_msgTime, const char * i_msg, const char * i_extra = nullptr
            );
 
    private:
        LogBase(const LogBase & i_log) = delete;
        LogBase & operator=(const LogBase & i_log) = delete;
    };
 
    class Log : public LogBase, public ILog
    {
    public:
        Log(
            bool i_logToConsole = false,
            const char * i_basePath = "openm.log",
            bool i_logToFile = false,
            bool i_useTimeStamp = false,
            bool i_usePidStamp = false
            );
        ~Log(void) noexcept;
 
        void init(
            bool i_logToConsole,
            const char * i_basePath,
            bool i_logToFile,
            bool i_useTimeStamp = false,
            bool i_usePidStamp = false, 
            bool i_noMsgTime = false,
            bool i_isLogSql = false
            ) noexcept override;
 
        const string lastLogPath(void) noexcept override;
 
        const string stampedLogPath(void) noexcept override;
 
        const string getMessage(const char * i_sourceMsg) noexcept override;
 
        const list<string> getLanguages(void) noexcept override;
 
        const unordered_map<string, string> getLanguageMessages(void) noexcept override;
 
        void swapLanguageMessages(const list<string> & i_langLst, unordered_map<string, string> & io_msgMap) noexcept override;
 
        void logMsg(const char * i_msg, const char * i_extra = NULL) noexcept override;
 
        void logFormatted(const char * i_format, ...) noexcept override;
 
        void logErr(const exception & i_ex, const char * i_msg = nullptr) noexcept override;
 
        void logSql(const char * i_sql) noexcept override;
 
    private:
        bool isSqlLog;                          // if true then log sql queries into last log
        list<string> msgLangLst;                // list of languages, in order of user prefrences
        unordered_map<string, string> msgMap;   // language-specific messages
 
        // log to console and flush each line, return false on error
        bool logToConsole(
            const chrono::system_clock::time_point & i_msgTime, const char * i_msg, const char * i_extra = nullptr
            ) noexcept override;
 
        // log to file, return false on error
        bool logToFile(
            bool i_isToStamped, const chrono::system_clock::time_point & i_msgTime, const char * i_msg, const char * i_extra = nullptr
            ) noexcept override;
 
    private:
        Log(const Log & i_log) = delete;
        Log & operator=(const Log & i_log) = delete;
    };
 
    class TraceLog : public LogBase, public ITrace
    {
    public:
        TraceLog(
            bool i_logToConsole = false,
            const char * i_basePath = "",
            bool i_logToFile = false,
            bool i_useTimeStamp = false,
            bool i_usePidStamp = false,
            bool i_noMsgTime = false
            ) : LogBase(i_logToConsole, i_basePath, i_logToFile, i_useTimeStamp, i_usePidStamp, i_noMsgTime)
        { }
 
        ~TraceLog(void) noexcept;
 
        void init(
            bool i_logToConsole,
            const char * i_basePath,
            bool i_logToFile,
            bool i_useTimeStamp = false,
            bool i_usePidStamp = false,
            bool i_noMsgTime = false
            ) noexcept override;
 
        void logMsg(const char * i_msg, const char * i_extra = NULL) noexcept override;
 
        void logFormatted(const char * i_format, ...) noexcept override;
 
    private:
        ofstream lastSt;        // last log output stream
        ofstream stampedSt;     // stamped log output stream
 
        // log to console, return false on error
        bool logToConsole(
            const chrono::system_clock::time_point & i_msgTime, const char * i_msg, const char * i_extra = nullptr
        ) noexcept override;
 
        // log to file, return false on error
        bool logToFile(
            bool i_isToStamped, const chrono::system_clock::time_point & i_msgTime, const char * i_msg, const char * i_extra = nullptr
            ) noexcept override;
 
    private:
        TraceLog(const TraceLog & i_log) = delete;
        TraceLog & operator=(const TraceLog & i_log) = delete;
    };
}
 
#ifdef _WIN32
#pragma warning(pop)
#endif  // _WIN32
 
#endif  // OM_LOG_H