tarch::logging::ITACLogger Class Reference

Command Line Logger. More...

#include <ITACLogger.h>

Collaboration diagram for tarch::logging::ITACLogger:

Public Member Functions
	~ITACLogger ()
bool	getLogMachineName () const
	Is public as some analysis frameworks check explicitly whether these features are switched on.
bool	getLogThreadName () const
	Is public as some analysis frameworks check explicitly whether these features are switched on.
bool	getLogTrace () const
	Is public as some analysis frameworks check explicitly whether these features are switched on.
bool	getLogTimeStamp () const
	Is public as some analysis frameworks check explicitly whether these features are switched on.
void	debug (long int timestampNanoseconds, int rank, int threadId, const std::string &trace, const std::string &message)
void	info (long int timestampNanoseconds, int rank, int threadId, const std::string &trace, const std::string &message)
void	warning (long int timestampNanoseconds, int rank, int threadId, const std::string &trace, const std::string &message)
	Write Warning.
void	error (long int timestampNanoseconds, int rank, int threadId, const std::string &trace, const std::string &message)
	Write Error.
void	traceIn (long int timestampNanoseconds, int rank, int threadId, const std::string &trace, const std::string &message)
void	traceOut (long int timestampNanoseconds, int rank, int threadId, const std::string &trace, const std::string &message)
void	indent (bool indent, const std::string &trace)
	Tells the logger to increment/decrement the indent.
void	close ()
void	suspendTrace ()
void	continueTrace ()

Static Public Member Functions
static ITACLogger &	getInstance ()

Private Member Functions
ITACLogger &	operator= (const CommandLineLogger &)=delete
	Declared private since assignment does not make sense for an output class (output information mismatch).
	ITACLogger (const ITACLogger &)=delete
	Declared private since copying does not make sense for an output class (output information mismatch).
std::string	constructMessageString (std::string messageType, long int timestampNanoseconds, int rank, int threadId, const std::string &trace, const std::string &message)
	Construct message string.
	ITACLogger ()
	It's a singleton.
std::string	getTimeStampHumanReadable (long int timestampNanoseconds) const

Private Attributes
tarch::multicore::MultiReadSingleWriteSemaphore	_semaphore
std::map< std::string, int >	_itacHandles
bool	_firstTraceWritten

Static Private Attributes
static Log	_log
static ITACLogger	_singleton

Detailed Description

Command Line Logger.

Standard log output device. Implements the LogHandle. Usually there's only one instance of this class, as the Log type (which is implicitly used by all log and trace macros) forwards all data to a singleton.

Error and warnings

All error and warning messages are dumped to \texttt{cerr}. The logger automatically aborts the application if it encounters an error, once the error message is written and \texttt{cerr} is flushed.

Info and debugging

Debug information is piped to \texttt{cout}. The same happens with writes to the \texttt{info} log level.

Thread safety

All logs are protected by a semaphore to avoid race conditions.

Author

Tobias Weinzierl, Wolfgang Eckhardt

Definition at line 51 of file ITACLogger.h.

Constructor & Destructor Documentation

ITACLogger() [1/2]

tarch::logging::ITACLogger::ITACLogger ( const ITACLogger & )

privatedelete

Declared private since copying does not make sense for an output class (output information mismatch).

ITACLogger() [2/2]

tarch::logging::ITACLogger::ITACLogger ( )

private

It's a singleton.

According to Intel's documentation, ITAC is automatically initialised by MPI_Init(). However, if we have no MPI, then we have to initialise manually.

~ITACLogger()

tarch::logging::ITACLogger::~ITACLogger

(

)

Member Function Documentation

close()

void tarch::logging::ITACLogger::close

(

)

constructMessageString()

std::string tarch::logging::ITACLogger::constructMessageString ( std::string messageType, long int timestampNanoseconds, int rank, int threadId, const std::string & trace, const std::string & message )

private

Construct message string.

!!! Thread Safety

The message string relies on the global field _indent. This one might change throughout the execution of this method. However, I accept such a behavior: Changing _indent throughout the message execution makes the method add the wrong number of whitespaces in front of the message. That is a 'bug' we can accept.

To satisfy Intel Inspector et al at least slightly, I copy over _indent before I actually construct the message string. So the indent can't change while we add the spaces/tabs to the output.

continueTrace()

void tarch::logging::ITACLogger::continueTrace

(

)

debug()

void tarch::logging::ITACLogger::debug	(	long int	timestampNanoseconds,
		int	rank,
		int	threadId,
		const std::string &	trace,
		const std::string &	message )

error()

void tarch::logging::ITACLogger::error	(	long int	timestampNanoseconds,
		int	rank,
		int	threadId,
		const std::string &	trace,
		const std::string &	message )

Write Error.

In the implementation, I call a flush on cout before I write to cerr. Otherwise, the cerr messages might overtake cout. Before the operation returns, it does a flush on cerr, too. Otherwise, the message might not occur, i.e. the application might shut down before the message is flushed to the terminal.

getInstance()

static ITACLogger & tarch::logging::ITACLogger::getInstance ( )

static

getLogMachineName()

bool tarch::logging::ITACLogger::getLogMachineName

(

)

const

Is public as some analysis frameworks check explicitly whether these features are switched on.

getLogThreadName()

bool tarch::logging::ITACLogger::getLogThreadName

(

)

const

Is public as some analysis frameworks check explicitly whether these features are switched on.

getLogTimeStamp()

bool tarch::logging::ITACLogger::getLogTimeStamp

(

)

const

Is public as some analysis frameworks check explicitly whether these features are switched on.

getLogTrace()

bool tarch::logging::ITACLogger::getLogTrace

(

)

const

Is public as some analysis frameworks check explicitly whether these features are switched on.

getTimeStampHumanReadable()

std::string tarch::logging::ITACLogger::getTimeStampHumanReadable ( long int timestampNanoseconds ) const

private

indent()

void tarch::logging::ITACLogger::indent	(	bool	indent,
		const std::string &	trace )

Tells the logger to increment/decrement the indent.

For ITAC, we do not need any indentation. Consequently, we put the nop implementation into the header, so the compiler can inline the call and eventually remove it completely.

Definition at line 170 of file ITACLogger.h.

info()

void tarch::logging::ITACLogger::info	(	long int	timestampNanoseconds,
		int	rank,
		int	threadId,
		const std::string &	trace,
		const std::string &	message )

operator=()

ITACLogger & tarch::logging::ITACLogger::operator= ( const CommandLineLogger & )

privatedelete

Declared private since assignment does not make sense for an output class (output information mismatch).

suspendTrace()

void tarch::logging::ITACLogger::suspendTrace

(

)

traceIn()

void tarch::logging::ITACLogger::traceIn	(	long int	timestampNanoseconds,
		int	rank,
		int	threadId,
		const std::string &	trace,
		const std::string &	message )

traceOut()

void tarch::logging::ITACLogger::traceOut	(	long int	timestampNanoseconds,
		int	rank,
		int	threadId,
		const std::string &	trace,
		const std::string &	message )

warning()

void tarch::logging::ITACLogger::warning	(	long int	timestampNanoseconds,
		int	rank,
		int	threadId,
		const std::string &	trace,
		const std::string &	message )

Write Warning.

In the implementation, I call a flush on cout before I write to cerr. Otherwise, the cerr messages might overtake cout. Before the operation returns, it does a flush on cerr, too. Otherwise, the message might not occur, i.e. the application might shut down before the message is flushed to the terminal.

Field Documentation

_firstTraceWritten

bool tarch::logging::ITACLogger::_firstTraceWritten

private

Definition at line 61 of file ITACLogger.h.

_itacHandles

std::map< std::string, int > tarch::logging::ITACLogger::_itacHandles

private

Definition at line 59 of file ITACLogger.h.

_log

Log tarch::logging::ITACLogger::_log

staticprivate

Definition at line 53 of file ITACLogger.h.

_semaphore

tarch::multicore::MultiReadSingleWriteSemaphore tarch::logging::ITACLogger::_semaphore

private

Definition at line 57 of file ITACLogger.h.

_singleton

ITACLogger tarch::logging::ITACLogger::_singleton

staticprivate

Definition at line 55 of file ITACLogger.h.

---

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

• src/tarch/logging/ITACLogger.h