KaliVeda
Toolkit for HIC analysis
KVClassMonitor Class Reference

Detailed Description

Simple tool to track which classes instance count increases over time.

Created by KVClassFactory on Thu Jun 17 14:19:50 2010 Author: John Frankland,,,

Every time the Check() method is called we compare the instance count of every class derived from TObject to the previous Check(). We print a warning message for every class whose instance count has increased.

YOU MUST ACTIVATE ROOT OBJECT TRACKING FOR THIS TO WORK!

In your .rootrc file, add/change this variable:

Root.ObjectStat: 1

Note that, as the instance counts are stored in a TEnv, any time new classes are instanciated, some class instances increase due to the TEnv itself changing.

Typical output in this case is:

Info in <KVClassMonitor::Check>: Checking class instance statistics
Warning in <KVClassMonitor::Check>: TList increase from 4060 --> 4065
Warning in <KVClassMonitor::Check>: TEnvRec increase from 3032 --> 3038
Warning in <KVClassMonitor::Check>: TClass increase from 70 --> 71
Warning in <KVClassMonitor::Check>: TObjArray increase from 90 --> 92
Simple tool to track which classes instance count increases over time.

Usage

This is a singleton class: only one instance can exist at a time. A pointer to the current instance can be retrieved with static method KVClassMonitor::GetInstance().

Typical use:

while( [some treatment loop] ){
[lots of memory-leaking activity]
cmon->Check();-//- print infos on memory usage
}
static KVClassMonitor * GetInstance()
Return pointer to unique instance of class monitor class.

Definition at line 56 of file KVClassMonitor.h.

#include <KVClassMonitor.h>

Inheritance diagram for KVClassMonitor:

Public Member Functions

virtual ~KVClassMonitor ()
 Destructor. More...
 
void Check ()
 
void CompareToInit ()
 
std::map< std::string, int > & GetListOfChanges () const
 
void SetInitStatistics ()
 
- Public Member Functions inherited from KVBase
 KVBase ()
 Default constructor. More...
 
 KVBase (const Char_t *name, const Char_t *title="")
 Ctor for object with given name and type. More...
 
 KVBase (const KVBase &)
 copy ctor More...
 
virtual ~ KVBase ()
 
virtual void Clear (Option_t *opt="")
 Clear object properties : name, type/title, number, label. More...
 
virtual void Copy (TObject &) const
 Make a copy of this object. More...
 
const Char_t * GetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObject * GetObject () const
 
virtual const Char_t * GetType () const
 
Bool_t HasLabel () const
 
virtual Bool_t IsCalled (const Char_t *name) const
 
Bool_t IsLabelled (const Char_t *l) const
 
virtual Bool_t IsType (const Char_t *typ) const
 
virtual void List ()
 
KVBaseoperator= (const KVBase &)
 copy assignment operator More...
 
virtual void Print (Option_t *option="") const
 
Double_t ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const
 
void SetLabel (const Char_t *lab)
 
virtual void SetNumber (UInt_t num)
 
virtual void SetType (const Char_t *str)
 

Static Public Member Functions

static void DisableChecking ()
 Disable static DoCheck method. More...
 
static void DoCheck (const TString &method, const TString &message)
 Print statistics of global singleton if it exists. More...
 
static void EnableChecking ()
 Re-enable static DoCheck method. More...
 
static KVClassMonitorGetInstance ()
 Return pointer to unique instance of class monitor class. More...
 
- Static Public Member Functions inherited from KVBase
static Bool_t AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
 Comparison between two 64-bit floating-point values. More...
 
static void BackupFileWithDate (const Char_t *path)
 
static void CombineFiles (const Char_t *file1, const Char_t *file2, const Char_t *newfilename, Bool_t keep=kTRUE)
 
static void Deprecated (const char *method, const char *advice)
 
static Bool_t FindClassSourceFiles (const Char_t *class_name, KVString &imp_file, KVString &dec_file, const Char_t *dir_name=".")
 
static Bool_t FindExecutable (TString &exec, const Char_t *path="$(PATH)")
 
static const Char_t * FindFile (const Char_t *search, TString &wfil)
 
static const Char_t * GetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetDATABASEFilePath ()
 
static const Char_t * GetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_t * GetDataSetEnv (const Char_t *dataset, const Char_t *type, const Char_t *defval)
 
static Double_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Double_t defval)
 
static const Char_t * GetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...
 
static const Char_t * GetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_t * GetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_t * GetKVBuildTime ()
 Returns KaliVeda build time. More...
 
static const Char_t * GetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_t * GetKVBuildUser ()
 Returns username of person who performed build. More...
 
static const Char_t * GetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_t * GetKVVersion ()
 Returns KaliVeda version string. More...
 
static const Char_t * GetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetListOfPlugins (const Char_t *base)
 
static const Char_t * GetListOfPluginURIs (const Char_t *base)
 
static const Char_t * GetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_t * GetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_t * gitBranch ()
 Returns git branch of sources. More...
 
static const Char_t * gitCommit ()
 Returns last git commit of sources. More...
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandler * LoadPlugin (const Char_t *base, const Char_t *uri="0")
 
static Bool_t OpenContextMenu (const char *method, TObject *obj, const char *alt_method_name="")
 
static void OpenTempFile (TString &base, std::ofstream &fp)
 
static void PrintSplashScreen ()
 Prints welcome message and infos on version etc. More...
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, KVSQLite::database &dbfile, const Char_t *kvsubdir="")
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ifstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ofstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchKVFile (const Char_t *name, TString &fullpath, const Char_t *kvsubdir="")
 
static const Char_t * WorkingDirectory ()
 

Private Member Functions

 KVClassMonitor ()
 

Private Attributes

std::map< std::string, int > fChanges
 list of classes whose number changed in last Check() More...
 
TEnv fClassStats
 store class instance statistics More...
 
TEnv fClassStatsInit
 intitial class instance statistics More...
 

Static Private Attributes

static Bool_t fDisableCheck = kFALSE
 disable static DoCheck() method More...
 
static KVClassMonitorfgClassMonitor = nullptr
 singleton More...
 

Additional Inherited Members

- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 

Constructor & Destructor Documentation

◆ KVClassMonitor()

KVClassMonitor::KVClassMonitor ( )
private

Default constructor fill fClassStats with all current instance counts Store current class instance statistics as 'initial' values used for global comparison by CompareToInit()

Definition at line 22 of file KVClassMonitor.cpp.

◆ ~KVClassMonitor()

KVClassMonitor::~KVClassMonitor ( )
virtual

Destructor.

Definition at line 90 of file KVClassMonitor.cpp.

Member Function Documentation

◆ Check()

void KVClassMonitor::Check ( )

update class instance statistics print warning for every class whose number has increased

Definition at line 102 of file KVClassMonitor.cpp.

◆ CompareToInit()

void KVClassMonitor::CompareToInit ( )

compare class instance statistics to initial values print warning for every class whose number has increased

Definition at line 129 of file KVClassMonitor.cpp.

◆ DisableChecking()

static void KVClassMonitor::DisableChecking ( )
inlinestatic

Disable static DoCheck method.

Definition at line 85 of file KVClassMonitor.h.

◆ DoCheck()

static void KVClassMonitor::DoCheck ( const TString &  method,
const TString &  message 
)
inlinestatic

Print statistics of global singleton if it exists.

Definition at line 76 of file KVClassMonitor.h.

◆ EnableChecking()

static void KVClassMonitor::EnableChecking ( )
inlinestatic

Re-enable static DoCheck method.

Definition at line 90 of file KVClassMonitor.h.

◆ GetInstance()

KVClassMonitor * KVClassMonitor::GetInstance ( )
static

Return pointer to unique instance of class monitor class.

Definition at line 78 of file KVClassMonitor.cpp.

◆ GetListOfChanges()

std::map< std::string, int > & KVClassMonitor::GetListOfChanges ( ) const

Return list of classes whose count changed in last call to Check() Each parameter (classname) has a value corresponding to the change (+ or -)

Definition at line 65 of file KVClassMonitor.cpp.

◆ SetInitStatistics()

void KVClassMonitor::SetInitStatistics ( )

Store current class instance statistics as 'initial' values used for global comparison by CompareToInit()

Definition at line 45 of file KVClassMonitor.cpp.

Member Data Documentation

◆ fChanges

std::map<std::string, int> KVClassMonitor::fChanges
mutableprivate

list of classes whose number changed in last Check()

Definition at line 62 of file KVClassMonitor.h.

◆ fClassStats

TEnv KVClassMonitor::fClassStats
private

store class instance statistics

Definition at line 59 of file KVClassMonitor.h.

◆ fClassStatsInit

TEnv KVClassMonitor::fClassStatsInit
private

intitial class instance statistics

Definition at line 60 of file KVClassMonitor.h.

◆ fDisableCheck

Bool_t KVClassMonitor::fDisableCheck = kFALSE
staticprivate

disable static DoCheck() method

Definition at line 61 of file KVClassMonitor.h.

◆ fgClassMonitor

KVClassMonitor * KVClassMonitor::fgClassMonitor = nullptr
staticprivate

singleton

Definition at line 58 of file KVClassMonitor.h.