#include "Logger.h"
#include <cstdlib>
#include <iostream>
#include <csignal>

Functions
static void	printInfo (std::string module, std::string msg, Flusher doFlush)
	Prints messages of loglevel INFO. More...

static void	printWarn (std::string module, std::string msg, Flusher doFlush)
	Prints messages of loglevel WARN. More...

static void	printError (std::string module, std::string msg, Flusher doFlush)
	Prints messages of loglevel ERROR. More...

static void	printFatalError (const std::string &module, const std::string &msg, Flusher doFlush)
	Prints messages of loglevel FATAL. More...

Variables
LL< Log::FATAL >	FATAL
	Definition of the different loglevels by its wrapper class LL. These are used as tags in template metaprogramming for the Logger class. More...

LL< Log::ERROR >	ERROR
	Error log level. More...

LL< Log::WARN >	WARN
	Warning log level. More...

LL< Log::INFO >	INFO
	Info log level. More...

LL< Log::DEFAULT >	DEFAULT
	Default log level. More...

LL< Log::VERBOSE >	VERBOSE
	Verbose information. More...

LL< Log::DEBUG >	DEBUG
	Debug information. More...

Logger< MERCURY_LOGLEVEL >	logger ("MercuryKernel")
	Definition of different loggers with certain modules. A user can define its own custom logger here. More...

Logger< CG_LOGLEVEL >	cgLogger ("MercuryCG")

LoggerOutput	loggerOutputDefaultImpl

LoggerOutput *	loggerOutput = &loggerOutputDefaultImpl
	Declaration of the output functions. More...

Function Documentation

◆ printError()

static void printError	(	std::string	module,
		std::string	msg,
		Flusher	doFlush
	)

static

Prints messages of loglevel ERROR.

Parameters

[in]	module	The module name of the current logger invocation.
[in]	msg	formatted message to be printed.
[in]	doFlush	Flusher enum class object to enable/disable flushing of the output.

 {
 #ifdef MERCURY_USE_MPI
     //Check if MPI is initialised
     initialiseMPI();
     MPIContainer& communicator = MPIContainer::Instance();
     std::cout << "\033[1;33mError " << module << ":\033[0m\n" << "[Processor: " << communicator.getProcessorID() << "]" << msg << std::endl;
 #else
     std::cout << "\033[1;31mAn error has occured"
               << "\n\033[1;31mModule  :" << module
               << "\n\033[1;31mMessage :" << msg << std::endl;
 #endif
 #ifdef MERCURY_STACKTRACE_SHOW
     std::cerr << "\n-----------------[Stack Trace]-----------------\n";
     
     void* stackBuffer[64]; //This should be enough for all purposes..
     //First, we retrieve the addresses of the entire stack...
     int nStackFrames = backtrace(stackBuffer, 64);
 #ifndef MERCURY_STACKTRACE_DEMANGLE
     //We don't have the demangling infra, so just use backtrace_symbols.
     char** functionNames = backtrace_symbols(stackBuffer, nStackFrames);
     for( int i = 0; i < nStackFrames; i++ )
     {   
         std::cerr << '\t' << functionNames[i] << '\n';
     }
     std::cerr << "Exiting.\n" << std::endl;
  
     //DO NOT USE DELETE HERE. THIS SHOULD BE free()'d!
     // -- dducks
     free(functionNames);
 #else
     //We request the symbol information ourselves, in order to be able to demangle it.
     //And request the function names using dladdr.
     Dl_info infoStruct;
     for (int i = 4; i < nStackFrames; i++)
     {
         if (dladdr(stackBuffer[i], &infoStruct))
         { // We succesfully loaded the address...
             int demangleStatus;
             char* fnDemangled = abi::__cxa_demangle(infoStruct.dli_sname, NULL, NULL, &demangleStatus);
             if (infoStruct.dli_sname == nullptr)
                 continue;
             
             //We even succesfully demangled the symbol...
             if (demangleStatus == 0)
             {
                 std::cerr << fnDemangled << " +" << (void*) ((char*) stackBuffer[i] - (char*) infoStruct.dli_saddr) << "\t(" << infoStruct.dli_fname << ")\n";
                 free(fnDemangled);
             }
             else
             { //Well, we tried. Lets output at least our raw symbol name.
                 std::cerr << infoStruct.dli_sname << " +" << (void*) ((char*) stackBuffer[i] - (char*) infoStruct.dli_saddr) << "\t(" << infoStruct.dli_fname << ")\n";
             }
         }
         else
         { //Name lookup failed.
             std::cerr << stackBuffer[i] << ": ?????" << std::endl;
         }
     }
 #endif
 #endif
     //send a signal first, in case a debugger can catch it
     std::raise(SIGTERM);
     //call exit() for the specific loglevel
     std::exit(static_cast<int>(Log::ERROR));
 }

References ERROR, MPIContainer::getProcessorID(), constants::i, initialiseMPI(), and MPIContainer::Instance().

◆ printFatalError()

static void printFatalError	(	const std::string &	module,
		const std::string &	msg,
		Flusher	doFlush
	)

static

Prints messages of loglevel FATAL.

Parameters

[in]	module	The module name of the current logger invocation.
[in]	msg	formatted message to be printed.
[in]	doFlush	Flusher enum class object to enable/disable flushing of the output.

 {
 #ifdef MERCURY_USE_MPI
     //Check if MPI is initialised
     initialiseMPI();
     MPIContainer& communicator = MPIContainer::Instance();
     std::cout << "\033[1;33mError " << module << ":\033[0m\n" << "[Processor: " << communicator.getProcessorID() << "]" << msg << std::endl;
 #else
     std::cout << "\033[1;31mA fatal error has occured"
               << "\n\033[1;31mModule  :" << module
               << "\n\033[1;31mMessage :" << msg << std::endl;
 #endif
 #ifdef MERCURY_STACKTRACE_SHOW
     std::cerr << "\n-----------------[Stack Trace]-----------------\n";
     
     void* stackBuffer[64]; //This should be enough for all purposes..
     //First, we retrieve the addresses of the entire stack...
     int nStackFrames = backtrace(stackBuffer, 64);
 #ifndef MERCURY_STACKTRACE_DEMANGLE
     //We don't have the demangling infra, so just use backtrace_symbols.
     char** functionNames = backtrace_symbols(stackBuffer, nStackFrames);
     for( int i = 0; i < nStackFrames; i++ )
     {
         std::cerr << '\t' << functionNames[i] << '\n';
     }
     std::cerr << "Exiting.\n" << std::endl;
  
     //DO NOT USE DELETE HERE. THIS SHOULD BE free()'d!
     // -- dducks
     free(functionNames);
 #else
     //We request the symbol information ourselves, in order to be able to demangle it.
     //And request the function names using dladdr.
     Dl_info infoStruct;
     for (int i = 4; i < nStackFrames; i++)
     {
         if (dladdr(stackBuffer[i], &infoStruct))
         { // We succesfully loaded the address...
             int demangleStatus;
             char* fnDemangled = abi::__cxa_demangle(infoStruct.dli_sname, NULL, NULL, &demangleStatus);
             if (infoStruct.dli_sname == nullptr)
                 continue;
             
             //We even succesfully demangled the symbol...
             if (demangleStatus == 0)
             {
                 std::cerr << fnDemangled << " +" << (void*) ((char*) stackBuffer[i] - (char*) infoStruct.dli_saddr) << "\t(" << infoStruct.dli_fname << ")\n";
                 free(fnDemangled);
             }
             else
             { //Well, we tried. Lets output at least our raw symbol name.
                 std::cerr << infoStruct.dli_sname << " +" << (void*) ((char*) stackBuffer[i] - (char*) infoStruct.dli_saddr) << "\t(" << infoStruct.dli_fname << ")\n";
             }
         }
         else
         { //Name lookup failed.
             std::cerr << stackBuffer[i] << ": ?????" << std::endl;
         }
     }
 #endif
 #endif
     //send a signal first, in case a debugger can catch it
     std::raise(SIGTERM);
     //call exit for the specific loglevel
     std::exit(static_cast<int>(Log::FATAL));
 }

References FATAL, MPIContainer::getProcessorID(), constants::i, initialiseMPI(), and MPIContainer::Instance().

◆ printInfo()

static void printInfo	(	std::string	module,
		std::string	msg,
		Flusher	doFlush
	)

static

Prints messages of loglevel INFO.

Parameters

[in]	module	The module name of the current logger invocation.
[in]	msg	formatted message to be printed.
[in]	doFlush	Flusher enum class object to enable/disable flushing of the output.

 {
 #ifdef MERCURY_USE_MPI
     //Check if MPI is initialised
     initialiseMPI();
     MPIContainer& communicator = MPIContainer::Instance();
     std::cout << "[Process: " << communicator.getProcessorID() << "]: " << msg;
     if (doFlush == Flusher::FLUSH)
     {
         std::cout << std::endl;
     }
 #else
     std::cout << msg;
     if (doFlush == Flusher::FLUSH)
     {
         std::cout << std::endl;
     }
 #endif
 }

References MPIContainer::getProcessorID(), initialiseMPI(), and MPIContainer::Instance().

◆ printWarn()

static void printWarn	(	std::string	module,
		std::string	msg,
		Flusher	doFlush
	)

static

Prints messages of loglevel WARN.

Parameters

[in]	module	The module name of the current logger invocation.
[in]	msg	formatted message to be printed.
[in]	doFlush	Flusher enum class object to enable/disable flushing of the output.

 {
 #ifdef MERCURY_USE_MPI
     //Check if MPI is initialised
     initialiseMPI();
     MPIContainer& communicator = MPIContainer::Instance();
     std::cout << "\033[1;33mModule " << module << ":\033[0m\n" << "[Processor: " << communicator.getProcessorID() << "]" << msg;
     if (doFlush == Flusher::FLUSH)
     {
         std::cout << std::endl;
     }
 #else
     std::cout << "\033[1;33mMessage " << module << ":\033[0m\n" << msg;
     if (doFlush == Flusher::FLUSH)
     {
         std::cout << std::endl;
     }
 #endif
 }

References MPIContainer::getProcessorID(), initialiseMPI(), and MPIContainer::Instance().

Variable Documentation

◆ cgLogger

Logger<CG_LOGLEVEL> cgLogger("MercuryCG")

Referenced by CGHandler::computeContactPoints(), CGHandler::evaluateDataFiles(), CGHandler::evaluateRestartFiles(), and CGHandler::restart().

◆ DEBUG

LL<Log::DEBUG> DEBUG

Debug information.

Only used for internal development. Can be very cryptic, as it is only meant for finding bugs / oddities by the internal development team.

Example: Collision found between Particle #38201 and Wall #5

Default behaviour: ignore.

Referenced by BaseHandler< T >::BaseHandler(), load(), main(), SmallMatrix< numberOfRows, numberOfColumns >::operator*(), operator*(), CGFields::OrientationField::OrientationField(), CGFields::OrientationField::setFields(), BaseHandler< T >::~BaseHandler(), MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::~MixedSpecies(), and Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::~Species().

◆ DEFAULT

LL<Log::DEFAULT> DEFAULT

Default log level.

Only useful for defining the loglevel of the logger itself. Should not actually be used.

◆ ERROR

LL<Log::ERROR> ERROR

Error log level.

Error, as in, the program has found a severe problem which it cannot resolve any further. It does not know how to recover in a sane way. The difference to FATAL is mainly that this type of failure is most often caused by human error.

Example: Negative time step, Infinite end time and no override of the continuation function.

Default behaviour: log to std::cerr, followed by std::exit().

◆ FATAL

LL<Log::FATAL> FATAL

Definition of the different loglevels by its wrapper class LL. These are used as tags in template metaprogramming for the Logger class.

Fatal log level.

Referenced by DrivenParticleClass::actionsAfterTimeStep(), BondedInteraction::BondedInteraction(), ChargedBondedInteraction::ChargedBondedInteraction(), compareParticles(), MPIContainer::directReceive(), MPIContainer::directSend(), main(), MPIContainer::MPIContainer(), Logger< L, ASSERTS >::operator()(), ParhamiMcMeekingSinterInteraction::ParhamiMcMeekingSinterInteraction(), printFatalError(), DPMBase::read(), MPIContainer::receive(), RegimeSinterInteraction::RegimeSinterInteraction(), MPIContainer::send(), Chute::setRoughBottomType(), Chute::setupInitialConditions(), and transformMercuryToVTK().

◆ INFO

LL<Log::INFO> INFO

Info log level.

Useful information, small oddities and statistics which should be of no real effect to the user, but still give useful information about the current state and progress of the program.

Example: Finished inserting 381 particles.

Default behaviour: log to std::cout, returns afterwards.

◆ logger

Logger<MERCURY_LOGLEVEL> logger("MercuryKernel")

Definition of different loggers with certain modules. A user can define its own custom logger here.

Default logger. Use this for general logging.

For very specific modules, define your own logger. If you want to make extensive use of Debug messages, please use a custom logger as well, to prevent polluting the output.

◆ loggerOutput

LoggerOutput* loggerOutput = &loggerOutputDefaultImpl

Declaration of the output functions.

If the output needs to be redirected, please swap the loggerOutput pointer to your preferred LoggerOutput instance, and make sure this exists until AFTER an std::exit() invocation. (e.g. clean up with std::atexit())

Referenced by Logger< L, ASSERTS >::if(), main(), and Logger< L, ASSERTS >::operator()().

◆ loggerOutputDefaultImpl

LoggerOutput loggerOutputDefaultImpl

Initial value:

= {printFatalError, 
                                        printError, 
                                        printWarn, 
                                        printInfo, 
                                        printInfo, 
                                        printInfo 
}

◆ VERBOSE

LL<Log::VERBOSE> VERBOSE

Verbose information.

Information which is not useful to anybody except those looking for weird behaviour. These should however still be clear in meaning.

Example: Finished creating a particle.

Default behaviour: ignore.

Referenced by BaseCluster::actionsAfterSolve(), BaseCluster::actionsAfterTimeStep(), BaseBoundary::actionsBeforeTimeLoop(), SmoothChute::actionsBeforeTimeStep(), PeriodicWallsWithSlidingFrictionUnitTest::actionsBeforeTimeStep(), BaseCluster::actionsOnRestart(), PossibleContactList::add_PossibleContact(), ConstantMassFlowMaserBoundary::addParticleToMaser(), SubcriticalMaserBoundary::addParticleToMaser(), HGridOptimiser::applyStep(), HGridOptimiser::calcDfDx(), BaseCluster::calculateTimeStep(), SubcriticalMaserBoundaryTEST::checkBoundaryAfterParticleMoved(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), InsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), HGridOptimiser::checkLimit(), MercuryBase::checkParticleForInteractionLocal(), SuperQuadricParticle::computeContactPoint(), BaseCluster::computeInternalStructure(), StressStrainControlBoundary::computeStrainRate(), Mercury3D::computeWallForces(), Logger< L, ASSERTS >::createMessage(), DPMBase::decompose(), PeriodicBoundaryHandler::findNewParticle(), DPMBase::findNextExistingDataFile(), Domain::flushParticlesFromList(), PolydisperseInsertionBoundary::generateParticle(), SuperQuadricParticle::getContactPointPlanB(), NurbsSurface::getDistance(), Mercury2D::hGridFindParticleContacts(), Mercury3D::hGridFindParticleContacts(), Mercury2D::hGridHasParticleContacts(), MercuryBase::hGridNeedsRebuilding(), MercuryBase::hGridRebuild(), BaseCluster::insertParticles(), ContactDetectionIntersectionOfWallsTest::introduceParticlesAtWall(), load(), main(), Logger< L, ASSERTS >::operator()(), BaseCluster::printTime(), PeriodicBoundaryHandler::processLocalGhostParticles(), PeriodicBoundaryHandler::processLocalInteractionData(), Domain::processReceivedBoundaryParticleData(), PeriodicBoundaryHandler::processReceivedGhostParticleData(), Domain::processReceivedInteractionData(), BaseHandler< T >::read(), InteractionHandler::read(), BoundaryHandler::readAndAddObject(), WallHandler::readAndCreateOldObject(), PossibleContactList::remove_ParticlePosibleContacts(), statistics_while_running< T >::run(), SilbertPeriodic::set_study(), Slide::set_Walls(), BaseCluster::setDomainLimits(), ChuteWithHopper::setHopper(), IntersectionOfWalls::setPointsAndLines(), BaseCluster::setSpecies(), SegregationPeriodic::setupInitialConditions(), SphericalIndenter::setupInitialConditions(), BaseCluster::setupInitialConditions(), DPMBase::updateGhostGrid(), PeriodicBoundaryHandler::updateMaserParticle(), Domain::updateParticles(), PeriodicBoundaryHandler::updateParticleStatus(), InsertionBoundary::write(), PolydisperseInsertionBoundary::write(), SuperQuadricParticle::writeDebugMessageMiddleOfLoop(), SuperQuadricParticle::writeDebugMessageStep1(), SuperQuadricParticle::writeDebugMessageStep2(), SuperQuadricParticle::writeDebugMessageStep3(), BaseInteractable::~BaseInteractable(), DropletBoundary::~DropletBoundary(), and HeaterBoundary::~HeaterBoundary().

◆ WARN

LL<Log::WARN> WARN

Warning log level.

Warning, as in, the program has detected a problem but does know a solution. The simulation can continue with this fix, but the user should look at fixing his / her simulation so this won't occur in the future.

Example: Setting a smaller Xmax than Xmin.

Default behaviour: log to std::cerr, returns afterwards.

Functions

Variables

Function Documentation

◆ printError()

◆ printFatalError()

◆ printInfo()

◆ printWarn()

Variable Documentation

◆ cgLogger

◆ DEBUG

◆ DEFAULT

◆ ERROR

◆ FATAL

◆ INFO

◆ logger

◆ loggerOutput

◆ loggerOutputDefaultImpl

◆ VERBOSE

◆ WARN