#include <ValgrindSvc.h>

Inheritance diagram for ValgrindSvc:

Collaboration diagram for ValgrindSvc:

Public Member Functions
	ValgrindSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters: More...

virtual	~ValgrindSvc ()
	Destructor: More...

StatusCode	initialize ()
	Gaudi Service Implementation. More...

StatusCode	finalize ()

virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)

void	handle (const Incident &incident)
	incident service handle for Begin/EndEvent More...

virtual void	callgrindStartInstrumentation ()
	Start callgrind instrumentation. More...

virtual void	callgrindStopInstrumentation ()
	Stop callgrind instrumentation. More...

virtual void	callgrindDumpStats (std::ostream &out)
	Dump callgrind profiling stats. More...

virtual void	callgrindToggleCollect ()
	Toggle callgrind event collection. More...

virtual void	valgrindDoLeakCheck ()
	Do a leak check now. More...

virtual unsigned int	profileCount ()
	Number of created callgrind profiles. More...

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	I/O operators. More...

Private Member Functions
StatusCode	makeAuditor (const std::string &audName, IAuditorSvc *audSvc)
	helper method to create auditors More...

	ValgrindSvc ()
	Default constructor: More...

Private Attributes
std::vector< std::string >	m_algs
	List of algorithms to profile If list is empty, profile between begin/end event. More...

std::vector< std::string >	m_intervals
	List of auditor intervals to profile Syntax: "MessageSvc.initialize:MessageSvc.finalize". More...

bool	m_dumpAfterEachEvent
	Dump separate profile after each event. More...

bool	m_dumpAfterEachInterval
	Dump separate profile after each interval. More...

unsigned int	m_ignoreFirstNEvents
	Don't profile on the first N events. More...

std::vector< std::string >	m_dumpAfterIncident
	List of incidents on which to create a profile dump. More...

unsigned int	m_eventCounter
	Internal event counter for BeginEvent incident. More...

unsigned int	m_profileCounter
	Counter of created profiles. More...

Friends
class	SvcFactory< ValgrindSvc >

Detailed Description

Definition at line 31 of file ValgrindSvc.h.

Constructor & Destructor Documentation

◆ ValgrindSvc() [1/2]

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

Constructor with parameters:

Definition at line 35 of file ValgrindSvc.cxx.

                                          : 
   AthService(name, pSvcLocator),
   m_eventCounter(0),
   m_profileCounter(0)
 {
   //
   // Property declaration
   // 
   declareProperty( "ProfiledAlgs", m_algs,
                    "List of profiled algorithms" );
  
   declareProperty( "ProfiledIntervals", m_intervals,
                    "Intervals to profile (e.g. 'MyAlg.initialize:MyAlg.finalize'" );
    
   declareProperty( "DumpAfterEachEvent", m_dumpAfterEachEvent = false,
                    "Dump separate profile after each event" );
  
   declareProperty( "DumpAfterEachInterval", m_dumpAfterEachInterval = true,
                    "Dump separate profile after each interval in ProfiledIntervals" );
      
   declareProperty( "DumpAfterIncident", m_dumpAfterIncident,
                    "List of incidents on which to dump a profile");
   
   declareProperty( "IgnoreFirstNEvents", m_ignoreFirstNEvents = 0,
                    "Do not profile the first N events");
  
   // for SvcHandle ? someday ?
   //declareInterface<IValgrindSvc>(this);
 }

◆ ~ValgrindSvc()

ValgrindSvc::~ValgrindSvc ( )

virtual

Destructor:

Definition at line 68 of file ValgrindSvc.cxx.

69 {}

◆ ValgrindSvc() [2/2]

ValgrindSvc::ValgrindSvc ( )

private

Default constructor:

Member Function Documentation

◆ callgrindDumpStats()

void ValgrindSvc::callgrindDumpStats ( std::ostream & out )

virtual

Dump callgrind profiling stats.

Implements IValgrindSvc.

Definition at line 210 of file ValgrindSvc.cxx.

 {
   CALLGRIND_DUMP_STATS;
   m_profileCounter++;
 }

◆ callgrindStartInstrumentation()

void ValgrindSvc::callgrindStartInstrumentation ( )

virtual

Start callgrind instrumentation.

Implements IValgrindSvc.

Definition at line 195 of file ValgrindSvc.cxx.

 {
   CALLGRIND_START_INSTRUMENTATION;
 }

◆ callgrindStopInstrumentation()

void ValgrindSvc::callgrindStopInstrumentation ( )

virtual

Stop callgrind instrumentation.

Implements IValgrindSvc.

Definition at line 200 of file ValgrindSvc.cxx.

 {
   CALLGRIND_STOP_INSTRUMENTATION;
 }

◆ callgrindToggleCollect()

void ValgrindSvc::callgrindToggleCollect ( )

virtual

Toggle callgrind event collection.

Implements IValgrindSvc.

Definition at line 205 of file ValgrindSvc.cxx.

 {
   CALLGRIND_TOGGLE_COLLECT;
 }

◆ finalize()

StatusCode ValgrindSvc::finalize ( )

Definition at line 117 of file ValgrindSvc.cxx.

 {
   ATH_MSG_INFO ("Finalizing " << name() << "...");
   return StatusCode::SUCCESS;
 }

◆ handle()

void ValgrindSvc::handle ( const Incident & incident )

incident service handle for Begin/EndEvent

Definition at line 144 of file ValgrindSvc.cxx.

 {
   // Only use Begin/EndEvent incident if no profiled algorithm or interval is set
   bool useEventIncident = m_intervals.empty() && m_algs.empty();
  
   // BeginEvent
   if ( inc.type() == IncidentType::BeginEvent ) {
     m_eventCounter++;
     if ( useEventIncident && m_eventCounter > m_ignoreFirstNEvents) {
       ATH_MSG_DEBUG ("[BeginEvent] Callgrind instrumentation ON.");
       callgrindStartInstrumentation();
     }
   }
  
   // EndEvent
   if ( inc.type() == IncidentType::EndEvent && (m_eventCounter > m_ignoreFirstNEvents) ) {    
     if ( useEventIncident ) {
       callgrindStopInstrumentation();
       ATH_MSG_DEBUG ("[EndEvent] Callgrind instrumentation OFF.");
     }
     if ( !m_algs.empty() && m_dumpAfterEachEvent ) {
       callgrindDumpStats(msg().stream());
       ATH_MSG_INFO ("Creating callgrind profile #" << profileCount()
                     << " for event #" << m_eventCounter);
     }    
   }
  
   // Optional additional dumps for user specified incidents
   if ( std::find(m_dumpAfterIncident.begin(),
                  m_dumpAfterIncident.end(),
                  inc.type()) != m_dumpAfterIncident.end() ) {
     callgrindDumpStats(msg().stream());
     ATH_MSG_INFO (" Creating callgrind profile #" << profileCount()
           << " after incident [" << inc.type() << "].");
   }
  
 }

◆ initialize()

StatusCode ValgrindSvc::initialize ( )

Gaudi Service Implementation.

Definition at line 73 of file ValgrindSvc.cxx.

 {
   ATH_MSG_DEBUG ("Initializing " << name());
   
   ATH_MSG_INFO ("My process ID is [" << System::procID() << "]");
   
   const bool insideValgrind = static_cast<bool>(RUNNING_ON_VALGRIND);
   if ( insideValgrind ) {
     ATH_MSG_INFO ("=== Running from inside Valgrind ! Hi there! ===");
   }
   else {
     ATH_MSG_WARNING ("=== Valgrind is not running! ===");
   }
   
   // Use incidents in case there is no auditor configured
   if (!m_algs.empty() || !m_intervals.empty()) {
  
     // FIXME: We create the auditor here in C++ due to the lack of a
     // configurable auditor.
     makeAuditor("ValgrindAuditor",auditorSvc()).ignore();
     
     if ((auditorSvc()==0) || auditorSvc()->getAuditor("ValgrindAuditor")==0) {
       ATH_MSG_ERROR ("Cannot find [ValgrindAuditor]. ");
       return StatusCode::FAILURE;
     }
     else {
       ATH_MSG_VERBOSE ("Found [ValgrindAuditor].");
     }
   }
  
   // Register incidents
   ServiceHandle<IIncidentSvc> incSvc("IncidentSvc", this->name());
   ATH_CHECK(incSvc.retrieve());
   incSvc->addListener( this, IncidentType::BeginEvent );
   incSvc->addListener( this, IncidentType::EndEvent   );
  
   for(const std::string& incident : m_dumpAfterIncident) {
     incSvc->addListener( this, incident );
   }
  
   return StatusCode::SUCCESS;
  
 }

◆ interfaceID()

const InterfaceID & ValgrindSvc::interfaceID ( )

inlinestatic

I/O operators.

Inline methods:

Definition at line 145 of file ValgrindSvc.h.

 { 
    return IValgrindSvc::interfaceID(); 
 }

◆ makeAuditor()

StatusCode ValgrindSvc::makeAuditor	(	const std::string &	audName,
		IAuditorSvc *	audSvc
	)

private

helper method to create auditors

Definition at line 224 of file ValgrindSvc.cxx.

 {
   if ( 0 == audSvc ) {
     ATH_MSG_ERROR ("Null pointer to IAuditorSvc !!");
     return StatusCode::FAILURE;
   }
  
   if ( 0 != audSvc->getAuditor( audName ) ) {
     ATH_MSG_VERBOSE ("AuditorSvc already knows about ["
              << audName << "]... good.");
     return StatusCode::SUCCESS;
   }
  
   const std::string propName = "Auditors";
   IProperty * audSvcProp = dynamic_cast<IProperty*>(audSvc);
  
   if ( 0 == audSvcProp ) {
     ATH_MSG_ERROR ("Could not dyn-cast IAuditorSvc to an IProperty !!");
     return StatusCode::FAILURE;
   }
  
   StringArrayProperty audNames;
   audNames.assign( audSvcProp->getProperty(propName) );
   std::vector<std::string> updatedNames( audNames.value() );
   updatedNames.push_back( audName );
   audNames.set( updatedNames );
   audNames.setName( propName );
   if ( !audSvcProp->setProperty( audNames ).isSuccess() ) {
     ATH_MSG_ERROR
       ("Could not add [" << audName 
        << "] to the list of auditors of [AuditorSvc] !!"
     << endmsg
        << audSvcProp->getProperty(propName));
     return StatusCode::FAILURE;
   }
  
   // make sure the auditor has been created...
   if ( 0 == audSvc->getAuditor( audName ) ) {
     ATH_MSG_ERROR ("Failed to make AuditorSvc instantiating [" 
            << audName << "] !!");
     return StatusCode::FAILURE;
   }
  
   ATH_MSG_VERBOSE ("[" << audName << "] successfully created.");
   return StatusCode::SUCCESS;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Service >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Service >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ profileCount()

virtual unsigned int ValgrindSvc::profileCount ( )

inlinevirtual

Number of created callgrind profiles.

Implements IValgrindSvc.

Definition at line 91 of file ValgrindSvc.h.

91 { return m_profileCounter; }

◆ queryInterface()

StatusCode ValgrindSvc::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)

virtual

Definition at line 124 of file ValgrindSvc.cxx.

 {
   if ( IValgrindSvc::interfaceID().versionMatch(riid) ) {
     *ppvInterface = dynamic_cast<IValgrindSvc*>(this);
   } else {
     // Interface is not directly available : try out a base class
     return AthService::queryInterface(riid, ppvInterface);
   }
   addRef();
   return StatusCode::SUCCESS;
 }

◆ valgrindDoLeakCheck()

void ValgrindSvc::valgrindDoLeakCheck ( )

virtual

Do a leak check now.

Implements IValgrindSvc.

Definition at line 216 of file ValgrindSvc.cxx.

 {
   VALGRIND_DO_LEAK_CHECK;
 }

Friends And Related Function Documentation

◆ SvcFactory< ValgrindSvc >

friend class SvcFactory< ValgrindSvc >

friend

Definition at line 145 of file ValgrindSvc.h.

Member Data Documentation

◆ m_algs

std::vector<std::string> ValgrindSvc::m_algs

private

List of algorithms to profile If list is empty, profile between begin/end event.

Definition at line 113 of file ValgrindSvc.h.

◆ m_dumpAfterEachEvent

bool ValgrindSvc::m_dumpAfterEachEvent

private

Dump separate profile after each event.

Definition at line 120 of file ValgrindSvc.h.

◆ m_dumpAfterEachInterval

bool ValgrindSvc::m_dumpAfterEachInterval

private

Dump separate profile after each interval.

Definition at line 123 of file ValgrindSvc.h.

◆ m_dumpAfterIncident

std::vector<std::string> ValgrindSvc::m_dumpAfterIncident

private

List of incidents on which to create a profile dump.

Definition at line 129 of file ValgrindSvc.h.

◆ m_eventCounter

unsigned int ValgrindSvc::m_eventCounter

private

Internal event counter for BeginEvent incident.

Definition at line 132 of file ValgrindSvc.h.

◆ m_ignoreFirstNEvents

unsigned int ValgrindSvc::m_ignoreFirstNEvents

private

Don't profile on the first N events.

Definition at line 126 of file ValgrindSvc.h.

◆ m_intervals

std::vector<std::string> ValgrindSvc::m_intervals

private

List of auditor intervals to profile Syntax: "MessageSvc.initialize:MessageSvc.finalize".

Definition at line 117 of file ValgrindSvc.h.

◆ m_profileCounter

unsigned int ValgrindSvc::m_profileCounter

private

Counter of created profiles.

Definition at line 135 of file ValgrindSvc.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ValgrindSvc() [1/2]

◆ ~ValgrindSvc()

◆ ValgrindSvc() [2/2]

Member Function Documentation

◆ callgrindDumpStats()

◆ callgrindStartInstrumentation()

◆ callgrindStopInstrumentation()

◆ callgrindToggleCollect()

◆ finalize()

◆ handle()

◆ initialize()

◆ interfaceID()

◆ makeAuditor()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ profileCount()

◆ queryInterface()

◆ valgrindDoLeakCheck()

Friends And Related Function Documentation

◆ SvcFactory< ValgrindSvc >

Member Data Documentation

◆ m_algs

◆ m_dumpAfterEachEvent

◆ m_dumpAfterEachInterval

◆ m_dumpAfterIncident

◆ m_eventCounter

◆ m_ignoreFirstNEvents

◆ m_intervals

◆ m_profileCounter