Bitcoin Core  24.99.0
P2P Digital Currency
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
BCLog::Logger Class Reference

#include <logging.h>

Collaboration diagram for BCLog::Logger:
[legend]

Public Member Functions

void LogPrintStr (const std::string &str, const std::string &logging_function, const std::string &source_file, int source_line, BCLog::LogFlags category, BCLog::Level level)
 Send a string to the log output. More...
 
bool Enabled () const
 Returns whether logs will be written to any output. More...
 
std::list< std::function< void(const std::string &)> >::iterator PushBackCallback (std::function< void(const std::string &)> fun)
 Connect a slot to the print signal and return the connection. More...
 
void DeleteCallback (std::list< std::function< void(const std::string &)>>::iterator it)
 Delete a connection. More...
 
bool StartLogging ()
 Start logging (and flush all buffered messages) More...
 
void DisconnectTestLogger ()
 Only for testing. More...
 
void ShrinkDebugFile ()
 
std::unordered_map< LogFlags, LevelCategoryLevels () const
 
void SetCategoryLogLevel (const std::unordered_map< LogFlags, Level > &levels)
 
bool SetCategoryLogLevel (const std::string &category_str, const std::string &level_str)
 
Level LogLevel () const
 
void SetLogLevel (Level level)
 
bool SetLogLevel (const std::string &level)
 
uint32_t GetCategoryMask () const
 
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 WillLogCategoryLevel (LogFlags category, Level level) const
 
std::vector< LogCategoryLogCategoriesList () const
 Returns a vector of the log categories in alphabetical order. More...
 
std::string LogCategoriesString () const
 Returns a string with the log categories in alphabetical order. More...
 
std::string LogLevelsString () const
 Returns a string with all user-selectable log levels. More...
 
std::string LogLevelToStr (BCLog::Level level) const
 Returns the string representation of a log level. More...
 
bool DefaultShrinkDebugFile () const
 

Public Attributes

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
 
bool m_log_threadnames = DEFAULT_LOGTHREADNAMES
 
bool m_log_sourcelocations = DEFAULT_LOGSOURCELOCATIONS
 
fs::path m_file_path
 
std::atomic< bool > m_reopen_file {false}
 

Private Member Functions

FILE *m_fileout GUARDED_BY (m_cs)
 
std::list< std::string > m_msgs_before_open GUARDED_BY (m_cs)
 
bool m_buffering GUARDED_BY (m_cs)
 Buffer messages before logging can be started. More...
 
std::unordered_map< LogFlags, Level > m_category_log_levels GUARDED_BY (m_cs)
 Category-specific log level. Overrides m_log_level. More...
 
std::string LogTimestampStr (const std::string &str)
 
std::list< std::function< void(const std::string &)> > m_print_callbacks GUARDED_BY (m_cs)
 Slots that connect to the print signal. More...
 

Private Attributes

StdMutex m_cs
 
std::atomic_bool m_started_new_line {true}
 m_started_new_line is a state variable that will suppress printing of the timestamp when multiple calls are made that don't end in a newline. More...
 
std::atomic< Levelm_log_level {DEFAULT_LOG_LEVEL}
 If there is no category-specific log level, all logs with a severity level lower than m_log_level will be ignored. More...
 
std::atomic< uint32_t > m_categories {0}
 Log categories bitfield. More...
 

Detailed Description

Definition at line 83 of file logging.h.

Member Function Documentation

◆ CategoryLevels()

std::unordered_map<LogFlags, Level> BCLog::Logger::CategoryLevels ( ) const
inline

Definition at line 158 of file logging.h.

Here is the caller graph for this function:

◆ DefaultShrinkDebugFile()

bool BCLog::Logger::DefaultShrinkDebugFile ( ) const

Definition at line 140 of file logging.cpp.

◆ DeleteCallback()

void BCLog::Logger::DeleteCallback ( std::list< std::function< void(const std::string &)>>::iterator  it)
inline

Delete a connection.

Definition at line 145 of file logging.h.

Here is the caller graph for this function:

◆ DisableCategory() [1/2]

bool BCLog::Logger::DisableCategory ( const std::string &  str)

Definition at line 114 of file logging.cpp.

Here is the call graph for this function:

◆ DisableCategory() [2/2]

void BCLog::Logger::DisableCategory ( BCLog::LogFlags  flag)

Definition at line 109 of file logging.cpp.

Here is the caller graph for this function:

◆ DisconnectTestLogger()

void BCLog::Logger::DisconnectTestLogger ( )

Only for testing.

Definition at line 87 of file logging.cpp.

Here is the caller graph for this function:

◆ EnableCategory() [1/2]

bool BCLog::Logger::EnableCategory ( const std::string &  str)

Definition at line 101 of file logging.cpp.

Here is the call graph for this function:

◆ EnableCategory() [2/2]

void BCLog::Logger::EnableCategory ( BCLog::LogFlags  flag)

Definition at line 96 of file logging.cpp.

Here is the caller graph for this function:

◆ Enabled()

bool BCLog::Logger::Enabled ( ) const
inline

Returns whether logs will be written to any output.

Definition at line 130 of file logging.h.

◆ GetCategoryMask()

uint32_t BCLog::Logger::GetCategoryMask ( ) const
inline

Definition at line 174 of file logging.h.

Here is the caller graph for this function:

◆ GUARDED_BY() [1/5]

FILE* m_fileout BCLog::Logger::GUARDED_BY ( m_cs  )
private

◆ GUARDED_BY() [2/5]

std::list<std::string> m_msgs_before_open BCLog::Logger::GUARDED_BY ( m_cs  )
private

◆ GUARDED_BY() [3/5]

bool m_buffering BCLog::Logger::GUARDED_BY ( m_cs  )
private

Buffer messages before logging can be started.

◆ GUARDED_BY() [4/5]

std::unordered_map<LogFlags, Level> m_category_log_levels BCLog::Logger::GUARDED_BY ( m_cs  )
private

Category-specific log level. Overrides m_log_level.

◆ GUARDED_BY() [5/5]

std::list<std::function<void(const std::string&)> > m_print_callbacks BCLog::Logger::GUARDED_BY ( m_cs  )
inlineprivate

Slots that connect to the print signal.

Definition at line 112 of file logging.h.

◆ LogCategoriesList()

std::vector< LogCategory > BCLog::Logger::LogCategoriesList ( ) const

Returns a vector of the log categories in alphabetical order.

Definition at line 314 of file logging.cpp.

Here is the caller graph for this function:

◆ LogCategoriesString()

std::string BCLog::Logger::LogCategoriesString ( ) const
inline

Returns a string with the log categories in alphabetical order.

Definition at line 187 of file logging.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LogLevel()

Level BCLog::Logger::LogLevel ( ) const
inline

Definition at line 170 of file logging.h.

Here is the caller graph for this function:

◆ LogLevelsString()

std::string BCLog::Logger::LogLevelsString ( ) const

Returns a string with all user-selectable log levels.

Definition at line 338 of file logging.cpp.

Here is the call graph for this function:

◆ LogLevelToStr()

std::string BCLog::Logger::LogLevelToStr ( BCLog::Level  level) const

Returns the string representation of a log level.

Definition at line 204 of file logging.cpp.

Here is the call graph for this function:

◆ LogPrintStr()

void BCLog::Logger::LogPrintStr ( const std::string &  str,
const std::string &  logging_function,
const std::string &  source_file,
int  source_line,
BCLog::LogFlags  category,
BCLog::Level  level 
)

Send a string to the log output.

Definition at line 391 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LogTimestampStr()

std::string BCLog::Logger::LogTimestampStr ( const std::string &  str)
private

Definition at line 344 of file logging.cpp.

Here is the call graph for this function:

◆ PushBackCallback()

std::list<std::function<void(const std::string&)> >::iterator BCLog::Logger::PushBackCallback ( std::function< void(const std::string &)>  fun)
inline

Connect a slot to the print signal and return the connection.

Definition at line 137 of file logging.h.

Here is the caller graph for this function:

◆ SetCategoryLogLevel() [1/2]

bool BCLog::Logger::SetCategoryLogLevel ( const std::string &  category_str,
const std::string &  level_str 
)

Definition at line 509 of file logging.cpp.

Here is the call graph for this function:

◆ SetCategoryLogLevel() [2/2]

void BCLog::Logger::SetCategoryLogLevel ( const std::unordered_map< LogFlags, Level > &  levels)
inline

Definition at line 163 of file logging.h.

Here is the caller graph for this function:

◆ SetLogLevel() [1/2]

bool BCLog::Logger::SetLogLevel ( const std::string &  level)

Definition at line 501 of file logging.cpp.

Here is the call graph for this function:

◆ SetLogLevel() [2/2]

void BCLog::Logger::SetLogLevel ( Level  level)
inline

Definition at line 171 of file logging.h.

Here is the caller graph for this function:

◆ ShrinkDebugFile()

void BCLog::Logger::ShrinkDebugFile ( )

Definition at line 460 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StartLogging()

bool BCLog::Logger::StartLogging ( )

Start logging (and flush all buffered messages)

Definition at line 48 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WillLogCategory()

bool BCLog::Logger::WillLogCategory ( BCLog::LogFlags  category) const

Definition at line 122 of file logging.cpp.

◆ WillLogCategoryLevel()

bool BCLog::Logger::WillLogCategoryLevel ( BCLog::LogFlags  category,
BCLog::Level  level 
) const

Definition at line 127 of file logging.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ m_categories

std::atomic<uint32_t> BCLog::Logger::m_categories {0}
private

Log categories bitfield.

Definition at line 107 of file logging.h.

◆ m_cs

StdMutex BCLog::Logger::m_cs
mutableprivate

Definition at line 86 of file logging.h.

◆ m_file_path

fs::path BCLog::Logger::m_file_path

Definition at line 123 of file logging.h.

◆ m_log_level

std::atomic<Level> BCLog::Logger::m_log_level {DEFAULT_LOG_LEVEL}
private

If there is no category-specific log level, all logs with a severity level lower than m_log_level will be ignored.

Definition at line 104 of file logging.h.

◆ m_log_sourcelocations

bool BCLog::Logger::m_log_sourcelocations = DEFAULT_LOGSOURCELOCATIONS

Definition at line 121 of file logging.h.

◆ m_log_threadnames

bool BCLog::Logger::m_log_threadnames = DEFAULT_LOGTHREADNAMES

Definition at line 120 of file logging.h.

◆ m_log_time_micros

bool BCLog::Logger::m_log_time_micros = DEFAULT_LOGTIMEMICROS

Definition at line 119 of file logging.h.

◆ m_log_timestamps

bool BCLog::Logger::m_log_timestamps = DEFAULT_LOGTIMESTAMPS

Definition at line 118 of file logging.h.

◆ m_print_to_console

bool BCLog::Logger::m_print_to_console = false

Definition at line 115 of file logging.h.

◆ m_print_to_file

bool BCLog::Logger::m_print_to_file = false

Definition at line 116 of file logging.h.

◆ m_reopen_file

std::atomic<bool> BCLog::Logger::m_reopen_file {false}

Definition at line 124 of file logging.h.

◆ m_started_new_line

std::atomic_bool BCLog::Logger::m_started_new_line {true}
private

m_started_new_line is a state variable that will suppress printing of the timestamp when multiple calls are made that don't end in a newline.

Definition at line 97 of file logging.h.


The documentation for this class was generated from the following files: