logging.cpp File Reference

#include <logging.h>
#include <util/fs.h>
#include <util/string.h>
#include <util/threadnames.h>
#include <util/time.h>
#include <array>
#include <map>
#include <unordered_map>

Include dependency graph for logging.cpp:

Go to the source code of this file.

Namespaces
namespace	BCLog

Functions
BCLog::Logger &	LogInstance ()
static int	FileWriteStr (const std::string &str, FILE *fp)
bool	GetLogCategory (BCLog::LogFlags &flag, const std::string &str)
	Return true if str parses as a log category and set the flag.
std::string	LogLevelToStr (BCLog::Level level)
std::string	LogCategoryToStr (BCLog::LogFlags category)
std::string	BCLog::LogEscapeMessage (const std::string &str)
	Belts and suspenders: make sure outgoing log messages don't contain potentially suspicious characters, such as terminal control codes.

Variables
bool	fLogIPs = DEFAULT_LOGIPS
const char *const	DEFAULT_DEBUGLOGFILE = "debug.log"
static const std::map< std::string, BCLog::LogFlags >	LOG_CATEGORIES_BY_STR
static const std::unordered_map< BCLog::LogFlags, std::string >	LOG_CATEGORIES_BY_FLAG

Function Documentation

FileWriteStr()

static int FileWriteStr ( const std::string &  str, FILE *  fp  )

static

Definition at line 41 of file logging.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetLogCategory()

bool GetLogCategory	(	BCLog::LogFlags &	flag,
		const std::string &	str
	)

Return true if str parses as a log category and set the flag.

Definition at line 158 of file logging.cpp.

Here is the caller graph for this function:

LogCategoryToStr()

std::string LogCategoryToStr

(

BCLog::LogFlags

category

)

Definition at line 187 of file logging.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

LogInstance()

BCLog::Logger & LogInstance

(

)

NOTE: the logger instance is leaked on exit. This is ugly, but will be cleaned up by the OS/libc. Defining a logger as a global object doesn't work since the order of destruction of static/global objects is undefined. Consider if the logger gets destroyed, and then some later destructor calls LogPrintf, maybe indirectly, and you get a core dump at shutdown trying to access the logger. When the shutdown sequence is fully audited and tested, explicit destruction of these objects can be implemented by changing this from a raw pointer to a std::unique_ptr. Since the ~Logger() destructor is never called, the Logger class and all its subclasses must have implicitly-defined destructors.

This method of initialization was originally introduced in ee3374234c60aba2cc4c5cd5cac1c0aefc2d817c.

Definition at line 21 of file logging.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

LogLevelToStr()

std::string LogLevelToStr

(

BCLog::Level

level

)

Definition at line 171 of file logging.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

DEFAULT_DEBUGLOGFILE

const char* const DEFAULT_DEBUGLOGFILE = "debug.log"

Definition at line 19 of file logging.cpp.

fLogIPs

bool fLogIPs = DEFAULT_LOGIPS

Definition at line 18 of file logging.cpp.

LOG_CATEGORIES_BY_FLAG

const std::unordered_map<BCLog::LogFlags, std::string> LOG_CATEGORIES_BY_FLAG

static

Initial value:

{
        
        [](const std::map<std::string, BCLog::LogFlags> &in) {
            std::unordered_map<BCLog::LogFlags, std::string> out;
            for (const auto &[k, v] : in) {
                switch (v) {
                    case BCLog::NONE:
                        out.emplace(BCLog::NONE, "");
                        break;
                    case BCLog::ALL:
                        out.emplace(BCLog::ALL, "all");
                        break;
                    default:
                        out.emplace(v, k);
                }
            }
            return out;
        }(LOG_CATEGORIES_BY_STR)}

Definition at line 139 of file logging.cpp.

LOG_CATEGORIES_BY_STR

const std::map<std::string, BCLog::LogFlags> LOG_CATEGORIES_BY_STR

static

Definition at line 100 of file logging.cpp.