LeaLeakChecker.cxx

Go to the documentation of this file.

// $Id: LeaLeakChecker.cxx,v 1.8 2005/02/01 18:55:04 tagg Exp $
//
// LeaLeakChecker
//
// Package: Lea (Leak Checker).

// Begin_Html<img src="../../pedestrians.gif" align=center>
// <a href="../source_warning.html">Warning for beginners</a>.<br>
// Also see <a href="../../root_crib/index.html">The ROOT Crib</a> and
// <a href="../index.html">The MINOS Class User Guide</a>End_Html
//
// N. West 06/00
//
//   
// Purpose: 
//
//

#include <string>

#include "LeakChecker/LeaClassMonitor.h"
#include "LeakChecker/LeaLeakChecker.h"
#include "MessageService/MsgService.h"

std::ostream& operator<<(std::ostream& os, LeaLeakChecker* l) 
                                                 {return l->Print(os);}

ClassImp(LeaLeakChecker)

//   Definition of static data members
//   *********************************

CVSID("$Id: LeaLeakChecker.cxx,v 1.8 2005/02/01 18:55:04 tagg Exp $");

LeaLeakChecker* LeaLeakChecker::fgInstance = 0;


// Definition of member functions (alphabetical order)
// ***************************************************

//.....................................................................

Bool_t LeaLeakChecker::Add(const Char_t* name, const void* addr) {


//  Purpose:  Add named object to class monitor.

//  Arguments: 
//    name         in    String containing class name (can be file name).
//    addr         in    Address of object.

//  Return:    kTRUE always (reserved for future use).

//  Contact:   N. West

//  Specification:-
//  =============

//  o Get monitor for class and record object creation.

//  Program Notes:-
//  =============

//  None.

  return GetMonitor(name)->Add(addr);

}


//.....................................................................

LeaClassMonitor* LeaLeakChecker::GetExistingMonitor(const Char_t* name
                                                    ) const {


//  Purpose:  Return monitor for this existing class.

//  Arguments: 
//    name         in    class name.

//  Return:    Class Monitor addr, or 0 if none.

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Return the LeaClassMonitor for this class if any.

//  Program Notes:-
//  =============

//  None.


  std::string className = name;

//  Locate the associated class monitor.
  MapConstItr element = fMonitors.find(className);
  return ( element != fMonitors.end() ) ? (*element).second : 0;

}
//.....................................................................

LeaClassMonitor* LeaLeakChecker::GetMonitor(const Char_t* name) {


//  Purpose:  Return monitor for this class, creating if necessary

//  Arguments: 
//    name         in    class name or file name.

//  Return:    Class Monitor add.

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Determine the class name if necessary from the file name.

//  o  Return, creating if necessary and required, the LeaClassMonitor
//     for this class.

//  Program Notes:-
//  =============

//  None.

//  Determine the class name from the file name by removing 
//  leading directory and any trailing extension.

  std::string className = name;
  if ( className.find(".") < className.size() ) {
    UInt_t locSlash = className.rfind("/");
    if ( locSlash < className.size() ) className.erase(0,locSlash+1);
    className.erase(className.find("."),className.size());
  }


//  Locate the associated class monitor and set its name if new.
  LeaClassMonitor* mon = fMonitors[className];
  if ( ! mon ) {
    mon = new LeaClassMonitor;
    fMonitors[className] = mon;
    mon->SetName(className.c_str());
  }

  MSG("Lea", Msg::kDebug) << "ClassMonitor: "
                         << className.c_str() << " found at "
                         << reinterpret_cast<void*> (mon)
                         << " set size " << fMonitors.size() << endl;
   
  return mon;
   

}

//.....................................................................

UInt_t LeaLeakChecker::GetNumActive(const Char_t* name) const{


//  Purpose:  Return the number of active objects of one or all
//            classes.

//  Arguments: 
//    name         in    Class name string or 0 (default) all classes.

//  Return:   Return the number of active objects of one or all
//            classes. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Return the number of active objects of one or all classes.

//  Program Notes:-
//  =============

//  None.

//  If name supplied, just use, but don't create, it.

  if ( name ) {
    LeaClassMonitor* mon = GetExistingMonitor(name);
    return mon ? mon->GetNumActive() : 0;
  }

//  No name supplied, use all classs

  UInt_t num = 0;
  for ( MapConstItr itr = fMonitors.begin();
        itr != fMonitors.end();
        itr++) num += (*itr).second->GetNumActive();
  return num;

}
//.....................................................................

UInt_t LeaLeakChecker::GetNumCreated(const Char_t* name) const {


//  Purpose:  Return the number of created objects of one or all
//            classes.

//  Arguments: 
//    name         in    Class name string or 0 (default) all classes.

//  Return:   Return the number of created objects of one or all
//            classes. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Return the number of created objects of one or all classes.

//  Program Notes:-
//  =============

//  None.

//  If name supplied, just use, but don't create, it.

  if ( name ) {
    LeaClassMonitor* mon = GetExistingMonitor(name);
    return mon ? mon->GetNumCreated() : 0;
  }

//  No name supplied, use all classs

  UInt_t num = 0;
  for ( MapConstItr itr = fMonitors.begin();
        itr != fMonitors.end();
        itr++)  num += (*itr).second->GetNumCreated();
  return num;

}
//.....................................................................

LeaLeakChecker* LeaLeakChecker::Instance() {


//  Purpose:  Return a pointer to the sole instance of the LeaLeakChecker. 

//  Arguments: 
//   None

//  Return:  A pointer to the LeaLeakChecker. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o Return a pointer to the sole instance of the LeaLeakChecker. 

//  Program Notes:-
//  =============

//  None.

  if ( ! fgInstance ) {

//  Helper class to handle delete
    static LeaLeakChecker::Cleaner c;
    c.ClassIsUsed();

    fgInstance = new LeaLeakChecker();

    MSG("Lea",Msg::kWarning) << "\n\n\n"
     << " WARNING:  The LeakChecker package has been activated.\n"
     << " *******   This can seriously degrade performance and should\n"
     << "           only be used for development and never production !!!\n\n\n";

  }

  return fgInstance;

}
//.....................................................................

LeaLeakChecker::LeaLeakChecker() {


//  Purpose:  Default constructor.

//  Arguments: 
//    None.

//  Return:   n/a

//  Contact:   N. West

//  Specification:-
//  =============

//  o Create LeaLeakChecker.

//  Program Notes:-
//  =============

//  None.

   MSG("Lea", Msg::kDebug) << "Creating LeaLeakChecker at "
                          << reinterpret_cast<void*>(this) << endl;

}
//.....................................................................

LeaLeakChecker::~LeaLeakChecker() {


//  Purpose:  Destructor.

//  Arguments: 
//    None.

//  Return:   n/a

//  Contact:   N. West

//  Specification:-
//  =============

//  o Destroy LeaLeakChecker.

//  Program Notes:-
//  =============

//  None.

  cout << "LeakChecker shutting down ..." << endl;
   for ( MapItr itr = fMonitors.begin();
         itr != fMonitors.end();
         itr++) {
     LeaClassMonitor* mon = (*itr).second;
     delete mon;
   }
  cout << "LeakChecker shutdown complete." << endl;
  LeaLeakChecker::fgInstance = 0;
   
}

//.....................................................................

ostream& LeaLeakChecker::Print(ostream& os) {


//  Purpose: Display current status of Leak Checker on ostream. 

//  Arguments: 
//    os           in    ostream to display on.

//  Return:  Update ostream.

//  Contact:   N. West

//  Specification:-
//  =============

//  o Display current status of Leak Checker on ostream.

//  Program Notes:-
//  =============

//  None.

  os << "Currently " << fMonitors.size() 
     << " classes are being monitored. " << endl
     << "There are "
     << GetNumActive() << " active objects of a total "
     << GetNumCreated() << " created." << endl
     << "Breakdown by class:-" << endl;

   for ( MapItr itr = fMonitors.begin();
         itr != fMonitors.end();
         itr++) {
     LeaClassMonitor* mon = (*itr).second;
     mon->Print(os);
   }

  return os;

}
//.....................................................................

void LeaLeakChecker::Reset(const Char_t* name) {


//  Purpose:  Clear the number of objects of one or all classes.

//  Arguments: 
//    name         in    Class name string or 0 (default) all classes.

//  Return:   None. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Reseet the number of objects of one or all classes.

//  Program Notes:-
//  =============

//  None.

//  If name supplied, just use, but don't create, it.

  if ( name ) {
    LeaClassMonitor* mon = GetExistingMonitor(name);
    if ( mon ) mon->Reset();
  }

//  No name supplied, use all classs

  for ( MapConstItr itr = fMonitors.begin();
        itr != fMonitors.end();
        itr++) (*itr).second->Reset();

}

//.....................................................................

Bool_t LeaLeakChecker::Remove(const Char_t* name, const void* addr) {


//  Purpose:  Remove named object to class monitor.

//  Arguments: 
//    name         in    String containing class name (can be file name).
//    addr         in    Address of object.

//  Return:    kTRUE always (reserved for future use).

//  Contact:   N. West

//  Specification:-
//  =============

//  o Get monitor for class and record object destruction.

//  Program Notes:-
//  =============

//  None.

  return GetMonitor(name)->Remove(addr);

}

//.....................................................................


/*    Template for New Member Function

//.....................................................................

LeaLeakChecker:: {


//  Purpose:  

//  Arguments: 
//    xxxxx        in    xxxxxxxxxxxxxxxxxx

//  Return:   

//  Contact:   N. West

//  Specification:-
//  =============

//  o 

//  Program Notes:-
//  =============

//  None.


}

*/

---