PerfMonTest::ManyLeaksAlg Class Reference

#include <PerfMonTestManyLeaksAlg.h>

Inheritance diagram for PerfMonTest::ManyLeaksAlg:

Collaboration diagram for PerfMonTest::ManyLeaksAlg:

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) override
	Execute method.
	AthAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor:
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
bool	filterPassed (const EventContext &ctx) const
void	setFilterPassed (bool state, const EventContext &ctx) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
const EventContext &	getContext () const
	Deprecated methods (use the ones with EventContext).
bool	filterPassed () const
void	setFilterPassed (bool state) const

Protected Member Functions
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
long *	stillReachableFct (long **array)
long *	possibleLostFct (long **array)
	this one's possible lost
long *	indirectlyLostFct (long **array)
	this one's indirectly lost
long *	definitelyLostFct (long **array)
	this one's definitely lost
void	leakAll ()
	this one's definitely lost
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< int >	m_leakSize {this, "LeakSize", 10, "Number of longs to be leaked just once"}
	Property to setup the size of the leak.
Gaudi::Property< bool >	m_leakInInit {this, "LeakInInit", false, "Where it will leak: initialize or execute(default)"}
	Property to setup the location of the leak, in initialize (true) or execute (false).
long *	m_stillReachable {}
long *	m_possibleLost {}
long *	m_indirectlyLost {}
long *	m_definitelyLost {}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Static Private Attributes
static long **m_pointers	ATLAS_THREAD_SAFE

Detailed Description

Definition at line 26 of file PerfMonTestManyLeaksAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

AthAlgorithm()

AthAlgorithm::AthAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Constructor:

Definition at line 57 of file AthAlgorithm.cxx.

                                                       :
  ::AthCommonDataStore<AthCommonMsg<Algorithm>>   ( name, pSvcLocator )
{
  // default cardinality for non-reentrant algorithms
  setProperty( "Cardinality", 1 ).orThrow("Unable to set property 'Cardinality'", name);
 
  // Set up to run AthAlgorithmDHUpdate in sysInitialize before
  // merging dependency lists.  This extends the output dependency
  // list with any symlinks implied by inheritance relations.
  m_updateDataHandles =
    std::make_unique<AthenaBaseComps::AthAlgorithmDHUpdate>
    (m_extendedExtraObjects,
     std::move (m_updateDataHandles));
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

definitelyLostFct()

long * ManyLeaksAlg::definitelyLostFct ( long ** array )

private

this one's definitely lost

Definition at line 145 of file PerfMonTestManyLeaksAlg.cxx.

{
  if ( ! bool(m_definitelyLost) )
    {
      // this one's definitely lost
      m_definitelyLost = new long[m_leakSize];
      
      // do something with it ...
      
      // and (accidentially) invalidate pointer
      m_definitelyLost = NULL;
      // now, we cannot delete m_possibleLost, because it's pointer value is gone
      // there's no reference in memory, so we cannot even do :
      // delete [] m_possibleLost;
    }
  return m_definitelyLost;
}

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode ManyLeaksAlg::execute ( const EventContext & ctx )

overridevirtual

Execute method.

Provides access to the EventContext if needed but is non-const as opposed to AthReentrantAlgorithm.

Implements AthAlgorithm.

Definition at line 42 of file PerfMonTestManyLeaksAlg.cxx.

{
  ATH_MSG_DEBUG ( "Executing " << name() << "..." ) ;
  
  if ( 0 == m_leakSize ) {
    return StatusCode::SUCCESS;
  }
  
  if ( ! m_leakInInit )  leakAll();
  
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

filterPassed() [1/2]

bool AthAlgorithm::filterPassed ( ) const

inherited

Definition at line 94 of file AthAlgorithm.cxx.

                                      {
  return filterPassed( Gaudi::Hive::currentContext() );
}

filterPassed() [2/2]

bool AthAlgorithm::filterPassed ( const EventContext & ctx ) const

inherited

Definition at line 98 of file AthAlgorithm.cxx.

                                                             {
  return execState( ctx ).filterPassed();
}

getContext()

const EventContext & AthAlgorithm::getContext ( ) const

inherited

Deprecated methods (use the ones with EventContext).

Definition at line 90 of file AthAlgorithm.cxx.

                                                   {
  return Gaudi::Hive::currentContext();
}

indirectlyLostFct()

long * ManyLeaksAlg::indirectlyLostFct ( long ** array )

private

this one's indirectly lost

Definition at line 113 of file PerfMonTestManyLeaksAlg.cxx.

{
  if ( ! bool(m_indirectlyLost) )
    {      
      // this one's indirectly lost
      m_indirectlyLost = new long[m_leakSize];
      
      // move along
      m_indirectlyLost++;
      m_indirectlyLost++;
      m_indirectlyLost++;
      m_indirectlyLost++;
      m_indirectlyLost++;
      m_indirectlyLost++;
      m_indirectlyLost++;
      m_indirectlyLost++;
      
      // save pointer in array
      array[127] = m_indirectlyLost;
      
      // do something with it ...
      
      // and (accidentially) invalidate pointer
      m_indirectlyLost = NULL;
      
      // we don't need it any more, but we don't clean up and delete array
      // array goes out of scope and it's lost !
      // array still points to m_indirectlyLost which is now indirectly lost
    }
  return m_indirectlyLost;
}

initialize()

StatusCode ManyLeaksAlg::initialize ( )

overridevirtual

Definition at line 26 of file PerfMonTestManyLeaksAlg.cxx.

{
  ATH_MSG_INFO ( "Initializing " << name() << "..." ) ;
  
  // in m_pointers, we'll store the pointers to the allocated space
  // they need to exist beyond the lifetime of this algorithm
  // or the'll be gone and everything is labelled as 'definitly lost'
  
  if ( !bool(m_pointers) )
    m_pointers = new long* [4];
  
  if ( m_leakInInit )  leakAll();
  
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 111 of file AthAlgorithm.h.

{ return false; }

leakAll()

void ManyLeaksAlg::leakAll ( )

private

this one's definitely lost

Definition at line 55 of file PerfMonTestManyLeaksAlg.cxx.

{
  // 1024: if it's too small, they'll be classified as definitely lost
  // check Scott's wiki - will be created on the heap ?
  const unsigned int maxSize = 256;
  long **array = new long* [maxSize];
  for ( unsigned int i=0; i<maxSize; ++i )
    array[i] = NULL;
  
  // this one's definitely lost
  m_pointers[0] = this->definitelyLostFct(array);
  
  // this one's indirectly lost
  m_pointers[2] = this->indirectlyLostFct(array);
  
  // this one's possible lost
  m_pointers[1] = this->possibleLostFct(array);
  
  // we'll create a small 'mem leak', but it's still reachable
  m_pointers[0] = this->stillReachableFct(array);
  
  // don't delete m_pointers
}

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

possibleLostFct()

long * ManyLeaksAlg::possibleLostFct ( long ** array )

private

this one's possible lost

Definition at line 93 of file PerfMonTestManyLeaksAlg.cxx.

{
  if ( ! bool(m_possibleLost) )
    {
      // this one's possible lost
      m_possibleLost = new long[m_leakSize];
      // move along
      m_possibleLost++;
      m_possibleLost++;
      m_possibleLost++;
      m_possibleLost++;
      
      // do something with it ...
      
      // we don't really need it any more, but we never delete m_possibleLost
      // delete [] m_possibleLost (must point to original location !!!)
    }
  return m_possibleLost;
}

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed() [1/2]

void AthAlgorithm::setFilterPassed ( bool state ) const

inherited

Definition at line 102 of file AthAlgorithm.cxx.

                                                     {
  setFilterPassed( state, Gaudi::Hive::currentContext() );
}

setFilterPassed() [2/2]

void AthAlgorithm::setFilterPassed ( bool state, const EventContext & ctx ) const

inherited

Definition at line 106 of file AthAlgorithm.cxx.

                                                                              {
  execState( ctx ).setFilterPassed(state);
}

stillReachableFct()

long * ManyLeaksAlg::stillReachableFct ( long ** array )

private

Definition at line 79 of file PerfMonTestManyLeaksAlg.cxx.

{
  if ( ! bool(m_stillReachable) )
    {
      m_stillReachable = new long[m_leakSize];
      
      // do something with it ...
      
      // we don't really need it any more, but we never delete m_stillReachable
      // delete [] m_stillReachable;
    }
  return m_stillReachable;
}

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc.

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

ATLAS_THREAD_SAFE

long** m_pointers PerfMonTest::ManyLeaksAlg::ATLAS_THREAD_SAFE

staticprivate

Definition at line 74 of file PerfMonTestManyLeaksAlg.h.

m_definitelyLost

long* PerfMonTest::ManyLeaksAlg::m_definitelyLost {}

private

Definition at line 70 of file PerfMonTestManyLeaksAlg.h.

{};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 114 of file AthAlgorithm.h.

m_indirectlyLost

long* PerfMonTest::ManyLeaksAlg::m_indirectlyLost {}

private

Definition at line 67 of file PerfMonTestManyLeaksAlg.h.

{};

m_leakInInit

Gaudi::Property<bool> PerfMonTest::ManyLeaksAlg::m_leakInInit {this, "LeakInInit", false, "Where it will leak: initialize or execute(default)"}

private

Property to setup the location of the leak, in initialize (true) or execute (false).

Definition at line 56 of file PerfMonTestManyLeaksAlg.h.

{this, "LeakInInit", false, "Where it will leak: initialize or execute(default)"};

m_leakSize

Gaudi::Property<int> PerfMonTest::ManyLeaksAlg::m_leakSize {this, "LeakSize", 10, "Number of longs to be leaked just once"}

private

Property to setup the size of the leak.

Definition at line 53 of file PerfMonTestManyLeaksAlg.h.

{this, "LeakSize", 10, "Number of longs to be leaked just once"};

m_possibleLost

long* PerfMonTest::ManyLeaksAlg::m_possibleLost {}

private

Definition at line 64 of file PerfMonTestManyLeaksAlg.h.

{};

m_stillReachable

long* PerfMonTest::ManyLeaksAlg::m_stillReachable {}

private

Definition at line 61 of file PerfMonTestManyLeaksAlg.h.

{};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• PerfMonTestManyLeaksAlg.h
• PerfMonTestManyLeaksAlg.cxx