Valgrind auditor. More...

#include <ValgrindAuditor.h>

Inheritance diagram for ValgrindAuditor:

Collaboration diagram for ValgrindAuditor:

Public Member Functions
	ValgrindAuditor (const std::string &name, ISvcLocator *pSvcLocator)

virtual	~ValgrindAuditor ()

virtual StatusCode	initialize ()

virtual void	handle (const Incident &incident)
	Incident handler. More...

before Auditor hooks
virtual void	before (StandardEventType evt, const std::string &name)

virtual void	before (StandardEventType evt, INamedInterface *alg)

virtual void	before (CustomEventTypeRef evt, INamedInterface *alg)

virtual void	before (CustomEventTypeRef evt, const std::string &name)

after Auditor hooks
typedef std::pair< boost::regex, std::string >	NameEvt
	Typedef for algorithm/event pair, e.g. ("MyAlg","initialize") More...

ServiceHandle< IValgrindSvc >	m_valSvc
	Handle to ValgrindSvc. More...

std::vector< std::string >	m_algs
	List of algorithms to profile. More...

std::vector< std::string >	m_intervals
	List of auditor intervals to profile. More...

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

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

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

std::vector< boost::regex >	m_algsRegEx
	Regular expressions for algorithm name matching. More...

std::vector< std::pair< NameEvt, NameEvt > >	m_hooks
	Internal storage of intervals. More...

virtual void	after (StandardEventType evt, const std::string &name, const StatusCode &sc)

virtual void	after (StandardEventType evt, INamedInterface *alg, const StatusCode &sc)

virtual void	after (CustomEventTypeRef evt, INamedInterface *alg, const StatusCode &sc)

virtual void	after (CustomEventTypeRef evt, const std::string &name, const StatusCode &)

virtual void	do_beforeExecute (const std::string &name)
	Start callgrind instrumentation. More...

virtual void	do_afterExecute (const std::string &name)
	Stop callgrind instrumentation. More...

void	do_before (const std::string &name, const std::string &hook)

void	do_after (const std::string &name, const std::string &hook)

StatusCode	decodeIntervals ()

bool	algMatch (const std::string &name)

Detailed Description

Valgrind auditor.

Gaudi auditor to programmatically control valgrind. Currently only callgrind controls are implemented. Turns callgrind instrumentation on/off before/afterExecute.

Author: Frank Winklmeier

Id: ValgrindAuditor.h,v 1.4 2008-10-14 12:31:40 fwinkl Exp

Definition at line 35 of file ValgrindAuditor.h.

Member Typedef Documentation

◆ NameEvt

typedef std::pair<boost::regex,std::string> ValgrindAuditor::NameEvt

Typedef for algorithm/event pair, e.g. ("MyAlg","initialize")

Definition at line 85 of file ValgrindAuditor.h.

Constructor & Destructor Documentation

◆ ValgrindAuditor()

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

Definition at line 26 of file ValgrindAuditor.cxx.

   : Auditor(name, pSvcLocator),
     m_valSvc("ValgrindSvc", this->name()),
     m_eventCounter(0)
 {
   declareProperty("ProfiledAlgs", m_algs,
                   "List of algorithms to run in valgrind");
  
   declareProperty("ProfiledIntervals", m_intervals,
                   "Intervals to profile (e.g. 'MyAlg.initialize:MyAlg.finalize'" );
  
   declareProperty("IgnoreFirstNEvents", m_ignoreFirstNEvents = 0,
                   "Do not profile the first N events");
  
   declareProperty("DumpAfterEachInterval", m_dumpAfterEachInterval = true,
                   "Dump separate profile after each interval in ProfiledIntervals" );
 }

◆ ~ValgrindAuditor()

ValgrindAuditor::~ValgrindAuditor ( )

virtual

Definition at line 46 of file ValgrindAuditor.cxx.

47 {

48 }

Member Function Documentation

◆ after() [1/4]

virtual void ValgrindAuditor::after	(	CustomEventTypeRef	evt,
		const std::string &	name,
		const StatusCode &
	)

inlinevirtual

Definition at line 72 of file ValgrindAuditor.h.

73 { do_after(name, evt); }

◆ after() [2/4]

virtual void ValgrindAuditor::after	(	CustomEventTypeRef	evt,
		INamedInterface *	alg,
		const StatusCode &	sc
	)

inlinevirtual

Definition at line 69 of file ValgrindAuditor.h.

70 { if (alg) after(evt, alg->name(), sc); }

◆ after() [3/4]

void ValgrindAuditor::after	(	StandardEventType	evt,
		const std::string &	name,
		const StatusCode &	sc
	)

virtual

Definition at line 175 of file ValgrindAuditor.cxx.

 {
   if ( evt == IAuditor::Execute ) do_afterExecute(name);
   else {
     std::ostringstream os;
     os << evt;
     do_after(name, boost::to_lower_copy(os.str()));
   }
 }

◆ after() [4/4]

virtual void ValgrindAuditor::after	(	StandardEventType	evt,
		INamedInterface *	alg,
		const StatusCode &	sc
	)

inlinevirtual

Definition at line 66 of file ValgrindAuditor.h.

67 { if (alg) after(evt, alg->name(), sc); }

◆ algMatch()

bool ValgrindAuditor::algMatch ( const std::string & name )

private

Definition at line 322 of file ValgrindAuditor.cxx.

 {
   std::vector<boost::regex>::const_iterator iter;
   for ( iter=m_algsRegEx.begin(); iter!=m_algsRegEx.end(); ++iter ) {
     if ( boost::regex_match(name,*iter) ) return true;
   }
   return false;
 }

◆ before() [1/4]

virtual void ValgrindAuditor::before	(	CustomEventTypeRef	evt,
		const std::string &	name
	)

inlinevirtual

Definition at line 58 of file ValgrindAuditor.h.

59 { do_before(name, evt); }

◆ before() [2/4]

virtual void ValgrindAuditor::before	(	CustomEventTypeRef	evt,
		INamedInterface *	alg
	)

inlinevirtual

Definition at line 55 of file ValgrindAuditor.h.

56 { if (alg) before(evt, alg->name()); }

◆ before() [3/4]

void ValgrindAuditor::before	(	StandardEventType	evt,
		const std::string &	name
	)

virtual

Definition at line 165 of file ValgrindAuditor.cxx.

 {
   if ( evt == IAuditor::Execute ) do_beforeExecute(name);
   else {
     std::ostringstream os;
     os << evt;
     do_before(name, boost::to_lower_copy(os.str()));
   }
 }

◆ before() [4/4]

virtual void ValgrindAuditor::before	(	StandardEventType	evt,
		INamedInterface *	alg
	)

inlinevirtual

Definition at line 52 of file ValgrindAuditor.h.

53 { if (alg) before(evt, alg->name()); }

◆ decodeIntervals()

StatusCode ValgrindAuditor::decodeIntervals ( )

private

Definition at line 287 of file ValgrindAuditor.cxx.

 {  
   m_hooks.clear();
   m_hooks.reserve(m_intervals.size());
   
   std::vector<string>::const_iterator iter = m_intervals.begin();
   for (; iter!=m_intervals.end(); ++iter) {
     const string& spec = *iter;
     string::size_type loc = spec.find(':');
  
     // If there is no delimiter interpret as [a,a]
     string s1, s2;
     if (loc==string::npos) s1 = s2 = spec;
     else {  // Extract interval
       s1 = spec.substr(0,loc);
       s2 = spec.substr(loc+1);
     }
  
     NameEvt ne1, ne2;
     if ( s1=="" || s2=="" ||
          decodeNameEvt(s1,ne1).isFailure() || decodeNameEvt(s2,ne2).isFailure() ) {
       msgStream() << MSG::ERROR << "Invalid profiling interval [" << spec << "]" << endmsg;
       return StatusCode::FAILURE;
     }
  
     std::pair<NameEvt,NameEvt> p(ne1,ne2);
     m_hooks.push_back(p);    
   }
  
   return StatusCode::SUCCESS;
 }

◆ do_after()

void ValgrindAuditor::do_after	(	const std::string &	name,
		const std::string &	hook
	)

private

Definition at line 240 of file ValgrindAuditor.cxx.

 {
   std::vector< std::pair<NameEvt,NameEvt> >::const_iterator iter;
  
   for (iter=m_hooks.begin(); iter!=m_hooks.end(); ++iter) {
     if ( boost::regex_match(name, iter->second.first) &&
          iter->second.second == hook ) {
       m_valSvc->callgrindStopInstrumentation();
       if ( msgLevel() <= MSG::DEBUG )
         msgStream() << MSG::DEBUG << "Stopping callgrind after " << hook
                     << " of " << name << endmsg;
  
       if ( m_dumpAfterEachInterval ) {
         m_valSvc->callgrindDumpStats(msgStream().stream());
         msgStream() << MSG::INFO << "Creating callgrind profile #" << m_valSvc->profileCount()
                     << " after " << hook << " of " << name << endmsg;
       }
     }
   }
 }

◆ do_afterExecute()

void ValgrindAuditor::do_afterExecute ( const std::string & name )

virtual

Stop callgrind instrumentation.

Definition at line 206 of file ValgrindAuditor.cxx.

 {
   if ( algMatch(name) ) {
     if (m_eventCounter > m_ignoreFirstNEvents) {
       m_valSvc->callgrindStopInstrumentation();      
       if ( msgLevel() <= MSG::DEBUG )
         msgStream() << MSG::DEBUG << "Stopping callgrind after execute of " << name
                     << " [event #" << m_eventCounter << "]" << endmsg;
     }
   }
 }

◆ do_before()

void ValgrindAuditor::do_before	(	const std::string &	name,
		const std::string &	hook
	)

private

Definition at line 222 of file ValgrindAuditor.cxx.

 {
   std::vector< std::pair<NameEvt,NameEvt> >::const_iterator iter;
  
   for (iter=m_hooks.begin(); iter!=m_hooks.end(); ++iter) {
     if ( boost::regex_match(name, iter->first.first) &&
          iter->first.second == hook ) {
       m_valSvc->callgrindStartInstrumentation();
       if ( msgLevel() <= MSG::DEBUG )
         msgStream() << MSG::DEBUG << "Starting callgrind before " << hook
                     << " of " << name << endmsg;
     }
   }
 }

◆ do_beforeExecute()

void ValgrindAuditor::do_beforeExecute ( const std::string & name )

virtual

Start callgrind instrumentation.

Definition at line 189 of file ValgrindAuditor.cxx.

 {
   if ( algMatch(name) ) {
     if (m_eventCounter > m_ignoreFirstNEvents) {
       if ( msgLevel() <= MSG::DEBUG )
         msgStream() << MSG::DEBUG << "Starting callgrind before execute of " << name
                     << " [event #" << m_eventCounter << "]" << endmsg;
       
       m_valSvc->callgrindStartInstrumentation();
     }
   }
 }

◆ handle()

void ValgrindAuditor::handle ( const Incident & incident )

virtual

Incident handler.

Definition at line 146 of file ValgrindAuditor.cxx.

 {
   // Internal event counter
   if ( inc.type() == IncidentType::BeginEvent ) {
     m_eventCounter++;
   }
  
   // Check if the incident appears at beginning or end of interval
   std::vector< std::pair<NameEvt,NameEvt> >::const_iterator h;
   for (h=m_hooks.begin(); h!=m_hooks.end(); ++h) {
     if ( h->first.second=="incident" ) do_before(inc.type(), "incident");
     if ( h->second.second=="incident" ) do_after(inc.type(), "incident");
   }
 }

◆ initialize()

StatusCode ValgrindAuditor::initialize ( )

virtual

Definition at line 51 of file ValgrindAuditor.cxx.

 {
   if ( !m_valSvc.retrieve().isSuccess())  {
     msgStream() << MSG::ERROR << "Could not retrieve the ValgrindSvc" << endmsg;
     return StatusCode::FAILURE;
   }
  
   const IProperty* valSvcProp = dynamic_cast<const IProperty*>(&(*m_valSvc));
   if ( !valSvcProp ) {
     msgStream() << MSG::ERROR
                 << "Could not retrieve IProperty interface to ValgrindSvc."
                 << endmsg;
     return StatusCode::FAILURE;
   }
  
   // We inherit the OutputLevel from ValgrindSvc
   ATH_CHECK(setProperty(valSvcProp->getProperty("OutputLevel")));
  
   msgStream() << MSG::VERBOSE
               << "Initializing " << name() << "..." 
               << endmsg;
  
   // Copy some properties from ValgrindSvc
   std::string properties[] = {"ProfiledAlgs",
                               "ProfiledIntervals",
                               "IgnoreFirstNEvents",
                               "DumpAfterEachInterval"};
  
   for( std::string prop : properties ) {
     if ( !setProperty(valSvcProp->getProperty(prop)) ) {
       msgStream() << MSG::ERROR << "Cannot set " << prop << " property." << endmsg;
       return StatusCode::FAILURE;
     }     
   }
  
   // Reset internal event counter
   m_eventCounter = 0;
  
   // Create regular expressions from algorithm names
   for( const std::string& re : m_algs ) {
     try {
       m_algsRegEx.push_back( boost::regex(re) );
     }
     catch ( const boost::regex_error& ) {
       msgStream() << MSG::ERROR << "Ignoring invalid regular expression: " << re << endmsg;
     }
   }
     
   if ( msgLevel() <= MSG::INFO ) {
     std::ostringstream out;
     out << "[ ";
     std::copy( m_algs.begin(), m_algs.end(),
                std::ostream_iterator<std::string>( out, " " ) );
     out << "]";
     msgStream() << MSG::INFO << "Profiled algorithms: " << out.str() << endmsg;
  
     out.str("");
     out << "[ ";
     std::copy( m_intervals.begin(), m_intervals.end(),
                std::ostream_iterator<std::string>( out, " " ) );
     out << "]";
     msgStream() << MSG::INFO << "Profiled intervals: " << out.str() << endmsg;
   }
  
   if (!m_intervals.empty()) {
     if ( decodeIntervals().isFailure() ) {
       msgStream() << MSG::ERROR << "Syntax error in ProfiledIntervals" << endmsg;
       return StatusCode::FAILURE;
     }
   }
  
   // Register incidents
   ServiceHandle<IIncidentSvc> incSvc("IncidentSvc", this->name());
   if ( !incSvc.retrieve().isSuccess() ) {
     msgStream() << MSG::ERROR << "Unable to get the IncidentSvc" << endmsg;
     return StatusCode::FAILURE;
   }
   // Try to be the first incident handler to be called
   const long prio = std::numeric_limits<long>::max();
   
   incSvc->addListener( this, IncidentType::BeginEvent, prio );
  
   for( const std::pair<NameEvt,NameEvt>& h : m_hooks ) {
     // No regular expressions allowed for incidents. Take the original string.
     if ( h.first.second=="incident" ) incSvc->addListener( this, h.first.first.str(), prio );
     if ( h.second.second=="incident" ) incSvc->addListener( this, h.second.first.str(), prio );      
   }
   
   return StatusCode::SUCCESS;
 }

Member Data Documentation

◆ m_algs

std::vector<std::string> ValgrindAuditor::m_algs

private

List of algorithms to profile.

Definition at line 93 of file ValgrindAuditor.h.

◆ m_algsRegEx

std::vector<boost::regex> ValgrindAuditor::m_algsRegEx

private

Regular expressions for algorithm name matching.

Definition at line 108 of file ValgrindAuditor.h.

◆ m_dumpAfterEachInterval

bool ValgrindAuditor::m_dumpAfterEachInterval

private

Dump profile after each interval.

Definition at line 102 of file ValgrindAuditor.h.

◆ m_eventCounter

unsigned int ValgrindAuditor::m_eventCounter

private

Internal event counter for BeginEvent incident.

Definition at line 105 of file ValgrindAuditor.h.

◆ m_hooks

std::vector< std::pair<NameEvt,NameEvt> > ValgrindAuditor::m_hooks

private

Internal storage of intervals.

Definition at line 111 of file ValgrindAuditor.h.

◆ m_ignoreFirstNEvents

unsigned int ValgrindAuditor::m_ignoreFirstNEvents

private

Don't profile on the first N events.

Definition at line 99 of file ValgrindAuditor.h.

◆ m_intervals

std::vector<std::string> ValgrindAuditor::m_intervals

private

List of auditor intervals to profile.

Definition at line 96 of file ValgrindAuditor.h.

◆ m_valSvc

ServiceHandle<IValgrindSvc> ValgrindAuditor::m_valSvc

private

Handle to ValgrindSvc.

Definition at line 90 of file ValgrindAuditor.h.

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

Public Member Functions

after Auditor hooks

Detailed Description

Member Typedef Documentation

◆ NameEvt

Constructor & Destructor Documentation

◆ ValgrindAuditor()

◆ ~ValgrindAuditor()

Member Function Documentation

◆ after() [1/4]

◆ after() [2/4]

◆ after() [3/4]

◆ after() [4/4]

◆ algMatch()

◆ before() [1/4]

◆ before() [2/4]

◆ before() [3/4]

◆ before() [4/4]

◆ decodeIntervals()

◆ do_after()

◆ do_afterExecute()

◆ do_before()

◆ do_beforeExecute()

◆ handle()

◆ initialize()

Member Data Documentation

◆ m_algs

◆ m_algsRegEx

◆ m_dumpAfterEachInterval

◆ m_eventCounter

◆ m_hooks

◆ m_ignoreFirstNEvents

◆ m_intervals

◆ m_valSvc