#include <Log.h>

Classes
struct	Category
class	Channel

Public Types
using	MaskType = uint64_t
	The underlying type of all log channel enums.

Public Member Functions
	Log (Channel &channel)
	~Log ()=default
void	PutCString (const char *cstr)
void	PutString (llvm::StringRef str)
template<typename... Args>
void	Format (llvm::StringRef file, llvm::StringRef function, const char *format, Args &&... args)
template<typename... Args>
void	FormatError (llvm::Error error, llvm::StringRef file, llvm::StringRef function, const char *format, Args &&... args)
void	Formatf (llvm::StringRef file, llvm::StringRef function, const char *format,...) __attribute__((format(printf
void void	Printf (const char *format,...) __attribute__((format(printf
	Prefer using LLDB_LOGF whenever possible.
void void void	Verbose (const char *fmt,...) __attribute__((format(printf
void void void const Flags	GetOptions () const
MaskType	GetMask () const
bool	GetVerbose () const
void	VAPrintf (const char *format, va_list args)
void	VAFormatf (llvm::StringRef file, llvm::StringRef function, const char *format, va_list args)
void	Enable (const std::shared_ptr< LogHandler > &handler_sp, std::optional< MaskType > flags=std::nullopt, uint32_t options=0)
void	Disable (std::optional< MaskType > flags=std::nullopt)

Static Public Member Functions
static void	Register (llvm::StringRef name, Channel &channel)
static void	Unregister (llvm::StringRef name)
static bool	EnableLogChannel (const std::shared_ptr< LogHandler > &log_handler_sp, uint32_t log_options, llvm::StringRef channel, llvm::ArrayRef< const char * > categories, llvm::raw_ostream &error_stream)
static bool	DisableLogChannel (llvm::StringRef channel, llvm::ArrayRef< const char * > categories, llvm::raw_ostream &error_stream)
static bool	DumpLogChannel (llvm::StringRef channel, llvm::raw_ostream &output_stream, llvm::raw_ostream &error_stream)
static bool	ListChannelCategories (llvm::StringRef channel, llvm::raw_ostream &stream)
static std::vector< llvm::StringRef >	ListChannels ()
	Returns the list of log channels.
static void	ForEachChannelCategory (llvm::StringRef channel, llvm::function_ref< void(llvm::StringRef, llvm::StringRef)> lambda)
	Calls the given lambda for every category in the given channel.
static void	DisableAllLogChannels ()
static void	ListAllLogChannels (llvm::raw_ostream &stream)

Static Public Attributes
template<MaskType Bit>
static constexpr MaskType	ChannelFlag = MaskType(1) << Bit

Private Types
typedef llvm::StringMap< Log >	ChannelMap

Private Member Functions
void	WriteHeader (llvm::raw_ostream &OS, llvm::StringRef file, llvm::StringRef function)
void	WriteMessage (llvm::StringRef message)
void	Format (llvm::StringRef file, llvm::StringRef function, const llvm::formatv_object_base &payload)
std::shared_ptr< LogHandler >	GetHandler ()
bool	Dump (llvm::raw_ostream &stream)
	Log (const Log &)=delete
void	operator= (const Log &)=delete

Static Private Member Functions
static void	ForEachCategory (const Log::ChannelMap::value_type &entry, llvm::function_ref< void(llvm::StringRef, llvm::StringRef)> lambda)
static void	ListCategories (llvm::raw_ostream &stream, const ChannelMap::value_type &entry)
static Log::MaskType	GetFlags (llvm::raw_ostream &stream, const ChannelMap::value_type &entry, llvm::ArrayRef< const char * > categories)

Private Attributes
Channel &	m_channel
llvm::sys::RWMutex	m_mutex
std::shared_ptr< LogHandler >	m_handler
std::atomic< uint32_t >	m_options {0}
std::atomic< MaskType >	m_mask {0}

Static Private Attributes
static llvm::ManagedStatic< ChannelMap >	g_channel_map

Detailed Description

Definition at line 132 of file Log.h.

Member Typedef Documentation

◆ ChannelMap

typedef llvm::StringMap<Log> lldb_private::Log::ChannelMap

private

Definition at line 303 of file Log.h.

◆ MaskType

using lldb_private::Log::MaskType = uint64_t

The underlying type of all log channel enums.

Declare them as: enum class MyLog : MaskType { Channel0 = Log::ChannelFlag<0>, Channel1 = Log::ChannelFlag<1>, ..., LLVM_MARK_AS_BITMASK_ENUM(LastChannel), };

Definition at line 141 of file Log.h.

Constructor & Destructor Documentation

◆ Log() [1/2]

lldb_private::Log::Log ( Channel & channel )

inline

Definition at line 231 of file Log.h.

References m_channel.

Referenced by Log(), and operator=().

◆ ~Log()

lldb_private::Log::~Log ( )

default

◆ Log() [2/2]

lldb_private::Log::Log ( const Log & )

privatedelete

References Log().

Member Function Documentation

◆ Disable()

void Log::Disable ( std::optional< MaskType > flags = std::nullopt )

Definition at line 114 of file Log.cpp.

References m_channel, m_handler, m_mask, and m_mutex.

◆ DisableAllLogChannels()

void Log::DisableAllLogChannels ( )

static

Definition at line 268 of file Log.cpp.

References g_channel_map.

Referenced by CommandObjectLogDisable::DoExecute(), and lldb_private::SystemInitializerCommon::Terminate().

◆ DisableLogChannel()

bool Log::DisableLogChannel	(	llvm::StringRef	channel,
		llvm::ArrayRef< const char * >	categories,
		llvm::raw_ostream &	error_stream )

static

Definition at line 225 of file Log.cpp.

References g_channel_map, and GetFlags().

Referenced by CommandObjectLogDisable::DoExecute().

◆ Dump()

bool Log::Dump ( llvm::raw_ostream & stream )

private

Definition at line 127 of file Log.cpp.

References m_handler, and m_mutex.

◆ DumpLogChannel()

bool Log::DumpLogChannel	(	llvm::StringRef	channel,
		llvm::raw_ostream &	output_stream,
		llvm::raw_ostream &	error_stream )

static

Definition at line 241 of file Log.cpp.

References g_channel_map.

Referenced by CommandObjectLogDump::DoExecute().

◆ Enable()

void Log::Enable	(	const std::shared_ptr< LogHandler > &	handler_sp,
		std::optional< MaskType >	flags = std::nullopt,
		uint32_t	options = 0 )

Definition at line 99 of file Log.cpp.

References m_channel, m_handler, m_mask, m_mutex, and m_options.

◆ EnableLogChannel()

bool Log::EnableLogChannel	(	const std::shared_ptr< LogHandler > &	log_handler_sp,
		uint32_t	log_options,
		llvm::StringRef	channel,
		llvm::ArrayRef< const char * >	categories,
		llvm::raw_ostream &	error_stream )