A versatile "profiler" that logs the time spent within each pair of calls to enter(X)-leave(X), among other stats.
The results can be dumped to cout or to Visual Studio's output panel. Recursive methods are supported with no problems, that is, calling "enter(X)
enter(X) ... leave(X) leave(X)". enter()
/leave()
are thread-safe.
This class can be also used to monitorize min/mean/max/total stats of any user-provided parameters via the method CTimeLogger::registerUserMeasure()
Cost of the profiler itself (measured on MSVC2015, Windows 10, Intel i5-2310 2.9GHz):
Definition at line 43 of file system/CTimeLogger.h.
#include <mrpt/system/CTimeLogger.h>
Classes | |
struct | TCallData |
Data of all the calls: More... | |
struct | TCallStats |
Data of each call section: # of calls, minimum, maximum, average and overall execution time (in seconds) More... | |
Public Member Functions | |
CTimeLogger (bool enabled=true, const std::string &name="") | |
virtual | ~CTimeLogger () |
Default constructor. More... | |
CTimeLogger (const CTimeLogger &o) | |
CTimeLogger & | operator= (const CTimeLogger &o) |
CTimeLogger (CTimeLogger &&o) | |
CTimeLogger & | operator= (CTimeLogger &&o) |
std::string | getStatsAsText (const size_t column_width=80) const |
Dump all stats to a multi-line text string. More... | |
void | getStats (std::map< std::string, TCallStats > &out_stats) const |
Returns all the current stats as a map: section_name => stats. More... | |
void | dumpAllStats (const size_t column_width=80) const |
Dump all stats through the COutputLogger interface. More... | |
void | clear (bool deep_clear=false) |
Resets all stats. More... | |
void | enable (bool enabled=true) |
void | disable () |
bool | isEnabled () const |
void | saveToCSVFile (const std::string &csv_file) const |
Dump all stats to a Comma Separated Values (CSV) file. More... | |
void | registerUserMeasure (const char *event_name, const double value) |
void | setName (const std::string &name) |
void | enter (const char *func_name) |
Start of a named section. More... | |
double | leave (const char *func_name) |
End of a named section. More... | |
double | getMeanTime (const std::string &name) const |
Return the mean execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name. More... | |
double | getLastTime (const std::string &name) const |
Return the last execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name. More... | |
Static Public Attributes | |
static mrpt::system::TConsoleColor | logging_levels_to_colors [NUMBER_OF_VERBOSITY_LEVELS] |
Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor. More... | |
static std::string | logging_levels_to_names [NUMBER_OF_VERBOSITY_LEVELS] |
Map from VerbosityLevels to their corresponding names. More... | |
Protected Types | |
using | TDataMap = mrpt::containers::ts_hash_map< std::string, TCallData, 1, 10 > |
Protected Member Functions | |
void | do_enter (const char *func_name) |
double | do_leave (const char *func_name) |
Protected Attributes | |
TDataMap | m_data |
VerbosityLevel | m_min_verbosity_level |
Provided messages with VerbosityLevel smaller than this value shall be ignored. More... | |
Private Member Functions | |
std::string | generateStringFromFormat (const char *fmt, va_list argp) const |
Helper method for generating a std::string instance from printf-like arguments. More... | |
Private Attributes | |
CTicTac | m_tictac |
bool | m_enabled |
std::string | m_name |
std::string | m_logger_name |
std::deque< TMsg > | m_history |
std::deque< output_logger_callback_t > | m_listCallbacks |
Logging methods | |
void | logStr (const VerbosityLevel level, const std::string &msg_str) const |
Main method to add the specified message string to the logger. More... | |
void | logFmt (const VerbosityLevel level, const char *fmt,...) const MRPT_printf_format_check(3 |
Alternative logging method, which mimics the printf behavior. More... | |
void void | logCond (const VerbosityLevel level, bool cond, const std::string &msg_str) const |
Log the given message only if the condition is satisfied. More... | |
void | setLoggerName (const std::string &name) |
Set the name of the COutputLogger instance. More... | |
std::string | getLoggerName () const |
Return the name of the COutputLogger instance. More... | |
void | setMinLoggingLevel (const VerbosityLevel level) |
Set the minimum logging level for which the incoming logs are going to be taken into account. More... | |
void | setVerbosityLevel (const VerbosityLevel level) |
alias of setMinLoggingLevel() More... | |
VerbosityLevel | getMinLoggingLevel () const |
bool | isLoggingLevelVisible (VerbosityLevel level) const |
void | getLogAsString (std::string &log_contents) const |
Fill the provided string with the contents of the logger's history in std::string representation. More... | |
std::string | getLogAsString () const |
Get the history of COutputLogger instance in a string representation. More... | |
void | writeLogToFile (const std::string *fname_in=NULL) const |
Write the contents of the COutputLogger instance to an external file. More... | |
void | dumpLogToConsole () const |
Dump the current contents of the COutputLogger instance in the terminal window. More... | |
std::string | getLoggerLastMsg () const |
Return the last Tmsg instance registered in the logger history. More... | |
void | getLoggerLastMsg (std::string &msg_str) const |
Fill inputtted string with the contents of the last message in history. More... | |
void | loggerReset () |
Reset the contents of the logger instance. More... | |
void | logRegisterCallback (output_logger_callback_t userFunc) |
bool | logDeregisterCallback (output_logger_callback_t userFunc) |
bool | logging_enable_console_output |
[Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically. More... | |
bool | logging_enable_keep_record |
[Default=false] Enables storing all messages into an internal list. More... | |
|
protected |
Definition at line 65 of file system/CTimeLogger.h.
CTimeLogger::CTimeLogger | ( | bool | enabled = true , |
const std::string & | name = "" |
||
) |
Definition at line 54 of file CTimeLogger.cpp.
References m_tictac, and mrpt::system::CTicTac::Tic().
|
virtual |
Default constructor.
Destructor
Definition at line 61 of file CTimeLogger.cpp.
References dumpAllStats(), and m_data.
CTimeLogger::CTimeLogger | ( | const CTimeLogger & | o | ) |
Definition at line 68 of file CTimeLogger.cpp.
CTimeLogger::CTimeLogger | ( | CTimeLogger && | o | ) |
Definition at line 83 of file CTimeLogger.cpp.
void CTimeLogger::clear | ( | bool | deep_clear = false | ) |
Resets all stats.
By default (deep_clear=false), all section names are remembered (not freed) so the cost of creating upon the first next call is avoided.
Definition at line 99 of file CTimeLogger.cpp.
References m_data.
|
inline |
Definition at line 107 of file system/CTimeLogger.h.
References m_enabled.
Referenced by mrpt::vision::computeHistogramOfOrientations(), mrpt::vision::computeMultiOrientations(), mrpt::vision::computeMultiResolutionDescriptors(), mrpt::vision::interpolateHistEntry(), and mrpt::vision::matchMultiResolutionFeatures().
|
protected |
Definition at line 212 of file CTimeLogger.cpp.
References m_data, m_tictac, mrpt::system::CTimeLogger::TCallData::n_calls, mrpt::system::CTimeLogger::TCallData::open_calls, and mrpt::system::CTicTac::Tac().
Referenced by enter().
|
protected |
Definition at line 222 of file CTimeLogger.cpp.
References mrpt::keep_max(), mrpt::keep_min(), mrpt::system::CTimeLogger::TCallData::last_t, m_data, m_tictac, mrpt::system::CTimeLogger::TCallData::max_t, mrpt::system::CTimeLogger::TCallData::mean_t, mrpt::system::CTimeLogger::TCallData::min_t, mrpt::system::CTimeLogger::TCallData::n_calls, mrpt::system::CTimeLogger::TCallData::open_calls, and mrpt::system::CTicTac::Tac().
Referenced by leave().
void CTimeLogger::dumpAllStats | ( | const size_t | column_width = 80 | ) | const |
Dump all stats through the COutputLogger interface.
Definition at line 207 of file CTimeLogger.cpp.
References getStatsAsText(), and MRPT_LOG_INFO_STREAM.
Referenced by ~CTimeLogger().
|
inherited |
Dump the current contents of the COutputLogger instance in the terminal window.
Definition at line 179 of file COutputLogger.cpp.
|
inline |
Definition at line 106 of file system/CTimeLogger.h.
References m_enabled.
Referenced by mrpt::detectors::CFaceDetection::CFaceDetection(), mrpt::nav::CAbstractPTGBasedReactive::enableTimeLog(), mrpt::vision::CGenericFeatureTracker::enableTimeLogger(), and mrpt::graphs::ScalarFactorGraph::updateEstimation().
|
inline |
Start of a named section.
Definition at line 116 of file system/CTimeLogger.h.
References do_enter(), and m_enabled.
Referenced by mrpt::bayes::detail::addNewLandmarks(), mrpt::vision::bundle_adj_full(), mrpt::detectors::CFaceDetection::checkIfDiagonalSurface(), mrpt::detectors::CFaceDetection::checkIfDiagonalSurface2(), mrpt::detectors::CFaceDetection::checkIfFacePlaneCov(), mrpt::detectors::CFaceDetection::checkIfFaceRegions(), mrpt::system::CTimeLoggerEntry::CTimeLoggerEntry(), mrpt::detectors::CFaceDetection::detectObjects_Impl(), mrpt::system::global_profiler_enter(), mrpt::nav::CReactiveNavigationSystem3D::implementSenseObstacles(), mrpt::opengl::CTexturedObject::loadTextureInOpenGL(), mrpt::graphslam::optimize_graph_spa_levmarq(), mrpt::nav::CAbstractPTGBasedReactive::STEP8_GenerateLogRecord(), TestEigenvector(), mrpt::graphs::ScalarFactorGraph::updateEstimation(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::updateState().
|
privateinherited |
Helper method for generating a std::string instance from printf-like arguments.
Definition at line 99 of file COutputLogger.cpp.
References mrpt::system::os::vsnprintf().
double CTimeLogger::getLastTime | ( | const std::string & | name | ) | const |
Return the last execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name.
Definition at line 287 of file CTimeLogger.cpp.
References m_data.
Referenced by mrpt::nav::CAbstractPTGBasedReactive::performNavigationStep(), and mrpt::nav::CAbstractPTGBasedReactive::STEP8_GenerateLogRecord().
|
inherited |
Get the history of COutputLogger instance in a string representation.
Definition at line 148 of file COutputLogger.cpp.
Referenced by mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::getDescriptiveReport().
|
inherited |
Fill the provided string with the contents of the logger's history in std::string representation.
Definition at line 143 of file COutputLogger.cpp.
|
inherited |
Return the last Tmsg instance registered in the logger history.
Definition at line 184 of file COutputLogger.cpp.
References mrpt::system::COutputLogger::TMsg::getAsString().
|
inherited |
Fill inputtted string with the contents of the last message in history.
Definition at line 190 of file COutputLogger.cpp.
|
inherited |
Return the name of the COutputLogger instance.
Definition at line 132 of file COutputLogger.cpp.
Referenced by mrpt::system::COutputLogger::TMsg::TMsg().
double CTimeLogger::getMeanTime | ( | const std::string & | name | ) | const |
Return the mean execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name.
Definition at line 279 of file CTimeLogger.cpp.
References m_data.
|
inlineinherited |
Definition at line 200 of file system/COutputLogger.h.
References mrpt::system::COutputLogger::m_min_verbosity_level.
Referenced by mrpt::maps::CRandomFieldGridMap2D::isEnabledVerbose(), and mrpt::slam::CMetricMapBuilderRBPF::processActionObservation().
void CTimeLogger::getStats | ( | std::map< std::string, TCallStats > & | out_stats | ) | const |
Returns all the current stats as a map: section_name => stats.
Definition at line 121 of file CTimeLogger.cpp.
References mrpt::system::CTimeLogger::TCallStats::last_t, m_data, mrpt::system::CTimeLogger::TCallStats::max_t, mrpt::system::CTimeLogger::TCallStats::mean_t, mrpt::system::CTimeLogger::TCallStats::min_t, mrpt::system::CTimeLogger::TCallStats::n_calls, and mrpt::system::CTimeLogger::TCallStats::total_t.
std::string CTimeLogger::getStatsAsText | ( | const size_t | column_width = 80 | ) | const |
Dump all stats to a multi-line text string.
Definition at line 136 of file CTimeLogger.cpp.
References aux_format_string_multilines(), mrpt::format(), m_data, m_name, and mrpt::system::unitsFormat().
Referenced by dumpAllStats(), mrpt::detectors::CFaceDetection::experimental_showMeasurements(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::getDescriptiveReport().
|
inline |
Definition at line 108 of file system/CTimeLogger.h.
References m_enabled.
Referenced by mrpt::nav::CAbstractPTGBasedReactive::build_movement_candidate().
|
inlineinherited |
Definition at line 201 of file system/COutputLogger.h.
References mrpt::system::COutputLogger::m_min_verbosity_level.
Referenced by mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), and mrpt::system::COutputLoggerStreamWrapper::~COutputLoggerStreamWrapper().
|
inline |
End of a named section.
Definition at line 122 of file system/CTimeLogger.h.
References do_leave(), and m_enabled.
Referenced by mrpt::vision::bundle_adj_full(), mrpt::detectors::CFaceDetection::checkIfDiagonalSurface(), mrpt::detectors::CFaceDetection::checkIfDiagonalSurface2(), mrpt::detectors::CFaceDetection::checkIfFacePlaneCov(), mrpt::detectors::CFaceDetection::checkIfFaceRegions(), mrpt::detectors::CFaceDetection::detectObjects_Impl(), mrpt::system::global_profiler_leave(), mrpt::nav::CReactiveNavigationSystem3D::implementSenseObstacles(), mrpt::opengl::CTexturedObject::loadTextureInOpenGL(), mrpt::graphslam::optimize_graph_spa_levmarq(), mrpt::nav::CAbstractPTGBasedReactive::STEP8_GenerateLogRecord(), TestEigenvector(), mrpt::graphs::ScalarFactorGraph::updateEstimation(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::updateState(), and mrpt::system::CTimeLoggerEntry::~CTimeLoggerEntry().
|
inherited |
Log the given message only if the condition is satisfied.
Definition at line 120 of file COutputLogger.cpp.
|
inherited |
Definition at line 287 of file COutputLogger.cpp.
References getAddress().
|
inherited |
Alternative logging method, which mimics the printf behavior.
Handy for not having to first use mrpt::format to pass a std::string message to logStr
Definition at line 80 of file COutputLogger.cpp.
Referenced by mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::CICPCriteriaNRD(), mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), CGraphSlamHandler< GRAPH_T >::execute(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), CGraphSlamHandler< GRAPH_T >::initOutputDir(), CGraphSlamHandler< GRAPH_T >::initVisualization(), mrpt::nav::CNavigatorManualSequence::navigationStep(), mrpt::nav::CAbstractNavigator::performNavigationStepNavigating(), CGraphSlamHandler< GRAPH_T >::readConfigFname(), CGraphSlamHandler< GRAPH_T >::saveResults(), CGraphSlamHandler< GRAPH_T >::setResultsDirName(), mrpt::nav::CReactiveNavigationSystem::STEP1_InitPTGs(), and CGraphSlamHandler< GRAPH_T >::~CGraphSlamHandler().
|
inherited |
Reset the contents of the logger instance.
Called upon construction.
Definition at line 195 of file COutputLogger.cpp.
References mrpt::system::LVL_INFO.
|
inherited |
Definition at line 274 of file COutputLogger.cpp.
|
inherited |
Main method to add the specified message string to the logger.
Definition at line 61 of file COutputLogger.cpp.
References mrpt::system::COutputLogger::TMsg::body, mrpt::system::COutputLogger::TMsg::dumpToConsole(), mrpt::system::COutputLogger::TMsg::level, mrpt::system::COutputLogger::TMsg::name, and mrpt::system::COutputLogger::TMsg::timestamp.
Referenced by mrpt::slam::PF_implementation< mrpt::math::TPose3D, CMonteCarloLocalization3D, mrpt::bayes::particle_storage_mode::VALUE >::PF_SLAM_implementation_pfAuxiliaryPFStandardAndOptimal(), mrpt::nav::CReactiveNavigationSystem::STEP1_InitPTGs(), and mrpt::system::COutputLoggerStreamWrapper::~COutputLoggerStreamWrapper().
CTimeLogger & CTimeLogger::operator= | ( | const CTimeLogger & | o | ) |
Definition at line 75 of file CTimeLogger.cpp.
CTimeLogger & CTimeLogger::operator= | ( | CTimeLogger && | o | ) |
Definition at line 90 of file CTimeLogger.cpp.
void CTimeLogger::registerUserMeasure | ( | const char * | event_name, |
const double | value | ||
) |
Definition at line 252 of file CTimeLogger.cpp.
References mrpt::system::CTimeLogger::TCallData::has_time_units, mrpt::keep_max(), mrpt::keep_min(), mrpt::system::CTimeLogger::TCallData::last_t, m_data, m_enabled, mrpt::system::CTimeLogger::TCallData::max_t, mrpt::system::CTimeLogger::TCallData::mean_t, mrpt::system::CTimeLogger::TCallData::min_t, and mrpt::system::CTimeLogger::TCallData::n_calls.
Referenced by mrpt::nav::CAbstractPTGBasedReactive::build_movement_candidate().
void CTimeLogger::saveToCSVFile | ( | const std::string & | csv_file | ) | const |
Dump all stats to a Comma Separated Values (CSV) file.
Definition at line 191 of file CTimeLogger.cpp.
References mrpt::format(), and m_data.
|
inherited |
Set the name of the COutputLogger instance.
Definition at line 127 of file COutputLogger.cpp.
Referenced by mrpt::slam::CMetricMapBuilderICP::CMetricMapBuilderICP(), mrpt::slam::CMetricMapBuilderRBPF::CMetricMapBuilderRBPF(), mrpt::slam::CMonteCarloLocalization2D::CMonteCarloLocalization2D(), mrpt::slam::CMonteCarloLocalization3D::CMonteCarloLocalization3D(), and mrpt::graphslam::CWindowManager::initCWindowManager().
|
inherited |
Set the minimum logging level for which the incoming logs are going to be taken into account.
String messages with specified VerbosityLevel smaller than the min, will not be outputted to the screen and neither will a record of them be stored in by the COutputLogger instance
Definition at line 133 of file COutputLogger.cpp.
Referenced by mrpt::maps::CRandomFieldGridMap2D::enableVerbose(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), mrpt::hwdrivers::CHokuyoURG::initialize(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::loadParams().
|
inline |
Definition at line 114 of file system/CTimeLogger.h.
References m_name.
|
inherited |
alias of setMinLoggingLevel()
Definition at line 138 of file COutputLogger.cpp.
Referenced by mrpt::nav::CAbstractNavigator::CAbstractNavigator(), mrpt::slam::CMetricMapBuilderRBPF::CMetricMapBuilderRBPF(), mrpt::comms::CServerTCPSocket::CServerTCPSocket(), mrpt::slam::CMetricMapBuilderRBPF::processActionObservation(), and mrpt::math::ransac_detect_2D_lines().
|
inherited |
Write the contents of the COutputLogger instance to an external file.
Upon call to this method, COutputLogger dumps the contents of all the logged commands so far to the specified external file. By default the filename is set to ${LOGGERNAME}.log except if the fname parameter is provided
Definition at line 154 of file COutputLogger.cpp.
References ASSERTMSG_, and mrpt::format().
|
inherited |
[Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically.
Definition at line 239 of file system/COutputLogger.h.
|
inherited |
[Default=false] Enables storing all messages into an internal list.
Definition at line 242 of file system/COutputLogger.h.
|
staticinherited |
Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor.
Implementation file for the COutputLogger header class.
Handy for coloring the input based on the verbosity of the message
Definition at line 124 of file system/COutputLogger.h.
Referenced by mrpt::system::COutputLogger::TMsg::dumpToConsole().
|
staticinherited |
Map from VerbosityLevels to their corresponding names.
Handy for printing the current message VerbosityLevel along with the actual content
Definition at line 129 of file system/COutputLogger.h.
Referenced by mrpt::system::COutputLogger::TMsg::getAsString().
|
protected |
Definition at line 66 of file system/CTimeLogger.h.
Referenced by clear(), do_enter(), do_leave(), getLastTime(), getMeanTime(), getStats(), getStatsAsText(), operator=(), registerUserMeasure(), saveToCSVFile(), and ~CTimeLogger().
|
private |
Definition at line 47 of file system/CTimeLogger.h.
Referenced by disable(), enable(), enter(), isEnabled(), leave(), operator=(), and registerUserMeasure().
|
mutableprivateinherited |
Definition at line 312 of file system/COutputLogger.h.
|
privateinherited |
Definition at line 314 of file system/COutputLogger.h.
|
privateinherited |
Definition at line 310 of file system/COutputLogger.h.
|
protectedinherited |
Provided messages with VerbosityLevel smaller than this value shall be ignored.
Definition at line 252 of file system/COutputLogger.h.
Referenced by mrpt::system::COutputLogger::getMinLoggingLevel(), and mrpt::system::COutputLogger::isLoggingLevelVisible().
|
private |
Definition at line 48 of file system/CTimeLogger.h.
Referenced by getStatsAsText(), operator=(), and setName().
|
private |
Definition at line 46 of file system/CTimeLogger.h.
Referenced by CTimeLogger(), do_enter(), and do_leave().
Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at miƩ 12 jul 2023 10:03:34 CEST |