logging.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2018 The Bitcoin developers
// Copyright (c) 2018-2021 The Dash Core developers
// Copyright (c) 2015-2022 The PIVX Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef PIVX_LOGGING_H
#define PIVX_LOGGING_H
 
#include "fs.h"
#include "tinyformat.h"
 
#include <atomic>
#include <cstdint>
#include <list>
#include <mutex>
#include <vector>
 
 
static const bool DEFAULT_LOGTIMEMICROS = false;
static const bool DEFAULT_LOGIPS        = false;
static const bool DEFAULT_LOGTIMESTAMPS = true;
extern const char * const DEFAULT_DEBUGLOGFILE;
 
extern bool fLogIPs;
 
struct CLogCategoryActive
{
    std::string category;
    bool active;
};
 
namespace BCLog {
    enum LogFlags : uint32_t {
        NONE        = 0,
        NET         = (1 <<  0),
        TOR         = (1 <<  1),
        MEMPOOL     = (1 <<  2),
        HTTP        = (1 <<  3),
        BENCHMARK   = (1 <<  4),
        ZMQ         = (1 <<  5),
        DB          = (1 <<  6),
        RPC         = (1 <<  7),
        ESTIMATEFEE = (1 <<  8),
        ADDRMAN     = (1 <<  9),
        REINDEX     = (1 << 10),
        PROXY       = (1 << 11),
        MEMPOOLREJ  = (1 << 12),
        LIBEVENT    = (1 << 13),
        COINDB      = (1 << 14),
        QT          = (1 << 15),
        LEVELDB     = (1 << 16),
        STAKING     = (1 << 17),
        MASTERNODE  = (1 << 18),
        MNBUDGET    = (1 << 19),
        MNPING      = (1 << 20),
        LEGACYZC    = (1 << 21),
        SAPLING     = (1 << 22),
        SPORKS      = (1 << 23),
        VALIDATION  = (1 << 24),
        LLMQ        = (1 << 25),
        NET_MN      = (1 << 26),
        DKG         = (1 << 27),
        CHAINLOCKS  = (1 << 28),
        ALL         = ~(uint32_t)0,
    };
 
    class Logger
    {
    private:
        FILE* m_fileout = nullptr;
        std::mutex m_file_mutex;
        std::list<std::string> m_msgs_before_open;
 
        std::atomic_bool m_started_new_line{true};
 
        std::atomic<uint32_t> m_categories{0};
 
        std::string LogTimestampStr(const std::string& str);
 
    public:
        bool m_print_to_console = false;
        bool m_print_to_file = false;
 
        bool m_log_timestamps = DEFAULT_LOGTIMESTAMPS;
        bool m_log_time_micros = DEFAULT_LOGTIMEMICROS;
 
        fs::path m_file_path;
        std::atomic<bool> m_reopen_file{false};
 
        void LogPrintStr(const std::string &str);
 
        bool Enabled() const { return m_print_to_console || m_print_to_file; }
 
        bool OpenDebugLog();
        void ShrinkDebugFile();
 
        uint32_t GetCategoryMask() const { return m_categories.load(); }
 
        void EnableCategory(LogFlags flag);
        bool EnableCategory(const std::string& str);
        void DisableCategory(LogFlags flag);
        bool DisableCategory(const std::string& str);
 
        bool WillLogCategory(LogFlags category) const;
 
        bool DefaultShrinkDebugFile() const;
    };
 
} // namespace BCLog
 
extern BCLog::Logger* const g_logger;
 
static inline bool LogAcceptCategory(BCLog::LogFlags category)
{
    return g_logger->WillLogCategory(category);
}
 
std::string ListLogCategories();
 
std::vector<CLogCategoryActive> ListActiveLogCategories();
 
bool GetLogCategory(BCLog::LogFlags& flag, const std::string& str);
 
// Be conservative when using LogPrintf/error or other things which
// unconditionally log to debug.log! It should not be the case that an inbound
// peer can fill up a user's disk with debug.log entries.
 
template <typename... Args>
static inline void LogPrintf(const char* fmt, const Args&... args)
{
    if (g_logger->Enabled()) {
        std::string log_msg;
        try {
            log_msg = tfm::format(fmt, args...);
        } catch (tinyformat::format_error& fmterr) {
            /* Original format string will have newline so don't add one here */
            log_msg = "Error \"" + std::string(fmterr.what()) + "\" while formatting log message: " + fmt;
        }
        g_logger->LogPrintStr(log_msg);
    }
}
 
// Use a macro instead of a function for conditional logging to prevent
// evaluating arguments when logging for the category is not enabled.
#define LogPrint(category, ...) do {                                                \
    if (LogAcceptCategory((category))) {                                            \
        LogPrintf(__VA_ARGS__);                                                     \
    }                                                                               \
} while(0)
 
 
class CBatchedLogger
{
private:
    BCLog::Logger* logger;
    bool accept;
    std::string header;
    std::string msg;
public:
    CBatchedLogger(BCLog::Logger* _logger, BCLog::LogFlags _category, const std::string& _header);
    virtual ~CBatchedLogger();
    void Flush();
 
    template<typename... Args>
    void Batch(const std::string& fmt, const Args&... args)
    {
        if (!accept) {
            return;
        }
        msg += "    " + strprintf(fmt, args...) + "\n";
    }
};
 
#endif // PIVX_LOGGING_H