IntelProfilerAuditor Class Reference

Inheritance diagram for IntelProfilerAuditor:

Collaboration diagram for IntelProfilerAuditor:

Classes
struct	stack_entity

Public Member Functions
StatusCode	initialize () override
void	handle (const Incident &incident) override
void	before (StandardEventType type, INamedInterface *i) override
void	after (StandardEventType type, INamedInterface *i, const StatusCode &sc) override
Public Member Functions inherited from extends< Auditor, IIncidentListener >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
Public Member Functions inherited from Auditor
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...
	Auditor (const Auditor &a)=delete
Auditor &	operator= (const Auditor &rhs)=delete
StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...
StatusCode	sysFinalize () override
	Finalization method invoked by the framework. More...
void	before (StandardEventType, INamedInterface *) override
	The following methods are meant to be implemented by the child class... More...
void	before (StandardEventType, const std::string &) override
void	before (CustomEventTypeRef, INamedInterface *) override
void	before (CustomEventTypeRef, const std::string &) override
void	after (StandardEventType, INamedInterface *, const StatusCode &) override
void	after (StandardEventType, const std::string &, const StatusCode &) override
void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override
void	after (CustomEventTypeRef, const std::string &, const StatusCode &) override
void	beforeInitialize (INamedInterface *) override
void	afterInitialize (INamedInterface *) override
void	beforeReinitialize (INamedInterface *) override
void	afterReinitialize (INamedInterface *) override
void	beforeExecute (INamedInterface *) override
void	afterExecute (INamedInterface *, const StatusCode &) override
void	beforeFinalize (INamedInterface *) override
void	afterFinalize (INamedInterface *) override
void	beforeBeginRun (INamedInterface *) override
void	afterBeginRun (INamedInterface *) override
void	beforeEndRun (INamedInterface *) override
void	afterEndRun (INamedInterface *) override
virtual StatusCode	finalize ()
const std::string &	name () const override
bool	isEnabled () const override
SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...
template<class T >
StatusCode	service (const std::string &name, T *&svc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T = IService>
SmartIF< T >	service (const std::string &name, bool createIf=false) const
StatusCode	setProperties ()
	Set the auditor's properties. More...
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	PropertyHolder ()=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...
StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...
const Gaudi::Details::PropertyBase &	getProperty (const std::string &name) const override
	get the property by name More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	convert the property to the string More...
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...
bool	hasProperty (const std::string &name) const override
	Return true if we have a property with the given name. More...
	PropertyHolder (const PropertyHolder &)=delete
PropertyHolder &	operator= (const PropertyHolder &)=delete
Public Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

Private Member Functions
void	start_profiling_component (const std::string &name)
void	skip_profiling_component (const std::string &name)
void	start ()
void	pause ()
void	resume ()
void	stop ()
bool	hasIncludes () const
bool	isIncluded (const std::string &name) const
bool	isExcluded (const std::string &name) const
bool	isRunning () const
int	stackLevel () const
std::string	stackIndent (bool newLevel=false) const
std::string	taskTypeName (const std::string &component_name) const

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_included {this, "IncludeAlgorithms", {}, "Names of included algorithms."}
Gaudi::Property< std::vector< std::string > >	m_excluded {this, "ExcludeAlgorithms", {}, "Names of excluded algorithms."}
Gaudi::Property< int >	m_nStartFromEvent
Gaudi::Property< int >	m_nStopAtEvent
Gaudi::Property< std::vector< std::string > >	m_algs_for_tasktypes
Gaudi::Property< std::string >	m_alg_delim
Gaudi::Property< bool >	m_enable_frames
Gaudi::Property< int >	m_frames_rate
int	m_nEvents = 0
__itt_domain *	domain = nullptr
bool	m_isStarted = false
std::vector< stack_entity >	m_stack
TaskTypes	m_tasktypes

Additional Inherited Members
Public Types inherited from extends< Auditor, IIncidentListener >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from Auditor
using	Factory = Gaudi::PluginService::Factory< IAuditor *(const std::string &, ISvcLocator *)>
Public Types inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	Typedef used to refer to this class from derived classes, as in. More...
Public Types inherited from CommonMessaging< implements< IAuditor, IProperty > >
using	base_class = CommonMessaging
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const
Protected Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...
MSG::Level	resetMessaging ()
	Reinitialize internal states. More...
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Detailed Description

Definition at line 31 of file IntelProfilerAuditor.cpp.

Member Function Documentation

void IntelProfilerAuditor::after ( StandardEventType  type, INamedInterface *  i, const StatusCode &  sc  )

override

Definition at line 344 of file IntelProfilerAuditor.cpp.

{
  // Skip unnecessary event types
  if ( !( ( type == IAuditor::Execute ) && m_isStarted ) ) return;

  if ( ( m_nEvents + 1 ) % m_frames_rate == 0 ) {
    __itt_frame_end_v3( domain, NULL );
  }

  // Name of the current component
  const std::string& name  = i->name();
  stack_entity       state = m_stack.back();
  // Remove component from stack.
  m_stack.pop_back();

  if ( state.event != 0 ) {
    debug() << stackIndent( true ) << "End event for " << name << endmsg;
    __itt_event_end( state.event );

    if ( state.parent_event != 0 ) {
      debug() << stackIndent() << "Resume event for " << state.parent_event << endmsg;
      __itt_event_start( state.parent_event );
    }
  }

  if ( m_stack.empty() ) {
    // Pause if there are no parent components (top algorithm).
    pause();
  } else if ( state.status ) {
    // If the profiling is running and we have parent component that is
    // paused then pause the profiling.
    if ( !m_stack.back().status ) {
      pause();
    }
  } else {
    // If the profiling was stopped, but the parent component should be profiled
    // then resume profiling.
    if ( m_stack.back().status ) {
      resume();
    }
  }
}

void IntelProfilerAuditor::before ( StandardEventType  type, INamedInterface *  i  )

override

Definition at line 297 of file IntelProfilerAuditor.cpp.

{
  // Skip unnecessary event types.
  if ( !( ( type == IAuditor::Execute ) && m_isStarted ) ) return;

  // Name of the current component.
  const std::string& name = i->name();
  // debug() <<  "Before: " << name << " " << type << endmsg;

  if ( isRunning() ) {
    if ( isExcluded( name ) ) {
      // If profiling is running and component is explicitly excluded
      // then skip component.
      skip_profiling_component( name );
    } else {
      // If profiling is running and component is'not explicitly excluded
      // then start profiling for component (add to stack).
      start_profiling_component( name );
    }
  } else {
    if ( hasIncludes() ) {
      // If the profiling is not running and  "includes" is explicitly defined ...
      if ( isIncluded( name ) ) {
        // and the current component is in the include's list then start the
        // component profiling.
        start_profiling_component( name );
      } else {
        // and the current component is not in the includes list then skip
        // a profiling of the component.
        skip_profiling_component( name );
      }
    } else {
      // If "Includes" property isn't present and the component is ...
      if ( isExcluded( name ) ) {
        // in the excludes list then skip a profiling
        skip_profiling_component( name );
      } else {
        // not in the exclude list then start a profiling
        start_profiling_component( name );
      }
    }
  }
  if ( m_nEvents % m_frames_rate == 0 ) {
    __itt_frame_begin_v3( domain, NULL );
  }
}

void IntelProfilerAuditor::handle ( const Incident &  incident )

override

Definition at line 280 of file IntelProfilerAuditor.cpp.

{
  if ( IncidentType::BeginEvent != incident.type() ) return;
  // Increment the event counter
  ++m_nEvents;

  if ( m_nStartFromEvent == m_nEvents ) {
    info() << "Start profiling (event #" << m_nEvents << ")" << endmsg;
    start();
  }

  if ( m_nStopAtEvent == m_nEvents ) {
    info() << "Stop profiling (event #" << m_nEvents << ")" << endmsg;
    stop();
  }
}

bool IntelProfilerAuditor::hasIncludes ( ) const

private

Definition at line 201 of file IntelProfilerAuditor.cpp.

{ return !m_included.empty(); }

StatusCode IntelProfilerAuditor::initialize ( )

overridevirtual

Reimplemented from Auditor.

Definition at line 235 of file IntelProfilerAuditor.cpp.

{
  info() << "Initialised" << endmsg;

  IIncidentSvc*    inSvc = NULL;
  const StatusCode sc    = serviceLocator()->service( "IncidentSvc", inSvc );
  if ( sc.isFailure() ) return sc;
  // Useful to start profiling only after some event, we don't need profile
  // initialization stage. For that we need to count events with BeginEvent
  // listener.
  inSvc->addListener( this, IncidentType::BeginEvent );
  // If the end event number don't setup we finish profiling at the end
  // of loop. We don't need profiling finalization stage.
  inSvc->addListener( this, IncidentType::EndProcessing );

  std::string str_excluded, str_included, str_eventtypes;
  for ( const auto& name : m_excluded ) {
    str_excluded += " " + name;
  }
  for ( const auto& name : m_included ) {
    str_included += " " + name;
  }
  for ( const auto& name : m_algs_for_tasktypes ) {
    str_eventtypes += " " + name;
  }

  if ( !m_included.empty() ) {
    info() << "Included algorithms (" << m_included.size() << "): " << str_included << endmsg;
  }

  if ( !m_excluded.empty() ) {
    info() << "Excluded algorithms (" << m_excluded.size() << "): " << str_excluded << endmsg;
  }

  if ( !m_algs_for_tasktypes.empty() ) {
    info() << "Event types (" << m_algs_for_tasktypes.size() << "): " << str_eventtypes << endmsg;
  }

  // Create a profiler domain for detection of slow events.
  domain        = __itt_domain_create( "Event loop" );
  domain->flags = m_enable_frames;

  return StatusCode::SUCCESS;
}

bool IntelProfilerAuditor::isExcluded ( const std::string &  name ) const

private

Definition at line 208 of file IntelProfilerAuditor.cpp.

{
  return std::find( m_excluded.begin(), m_excluded.end(), name ) != m_excluded.end();
}

bool IntelProfilerAuditor::isIncluded ( const std::string &  name ) const

private

Definition at line 203 of file IntelProfilerAuditor.cpp.

{
  return std::find( m_included.begin(), m_included.end(), name ) != m_included.end();
}

bool IntelProfilerAuditor::isRunning ( ) const

private

Definition at line 213 of file IntelProfilerAuditor.cpp.

{ return !m_stack.empty() && m_stack.back().status; }

void IntelProfilerAuditor::pause ( )

private

Definition at line 180 of file IntelProfilerAuditor.cpp.

{
  if ( !m_isStarted ) return;
  debug() << stackIndent() << "Pause" << endmsg;
  __itt_pause();
}

void IntelProfilerAuditor::resume ( )

private

Definition at line 173 of file IntelProfilerAuditor.cpp.

{
  if ( !m_isStarted ) return;
  debug() << stackIndent() << "Resume" << endmsg;
  __itt_resume();
}

void IntelProfilerAuditor::skip_profiling_component ( const std::string &  name )

private

Definition at line 187 of file IntelProfilerAuditor.cpp.

{
  if ( !m_isStarted ) return;
  m_stack.push_back( stack_entity( name, false ) );
  debug() << stackIndent() << "Skip component " << name << endmsg;
}

std::string IntelProfilerAuditor::stackIndent ( bool  newLevel = false ) const

private

Definition at line 217 of file IntelProfilerAuditor.cpp.

{
  std::stringstream indent( std::stringstream::out );
  indent << std::setw( stackLevel() * 2 + ( newLevel ? 2 : 0 ) ) << " ";
  return indent.str();
}

int IntelProfilerAuditor::stackLevel ( ) const

private

Definition at line 215 of file IntelProfilerAuditor.cpp.

{ return m_stack.size(); }

void IntelProfilerAuditor::start ( )

private

Definition at line 123 of file IntelProfilerAuditor.cpp.

{
  m_isStarted = true;
  __itt_resume();
}

void IntelProfilerAuditor::start_profiling_component ( const std::string &  name )

private

Definition at line 129 of file IntelProfilerAuditor.cpp.

{
  if ( !m_isStarted ) return;
  std::string               typeName = taskTypeName( name );
  __itt_event               taskId   = 0;
  TaskTypes::const_iterator iter     = m_tasktypes.find( typeName );
  if ( iter != m_tasktypes.end() ) {
    taskId = iter->second;
  }

  if ( !taskId && m_algs_for_tasktypes.empty() ) {
    // Create event
    taskId = __itt_event_create( typeName.c_str(), typeName.size() );
    m_tasktypes.insert( TaskTypes::value_type( typeName, taskId ) );
  }

  stack_entity  state  = stack_entity( name, true, taskId );
  stack_entity* parent = !m_stack.empty() ? &m_stack.back() : NULL;

  if ( parent != NULL ) {
    if ( parent->event ) {
      state.parent_event = parent->event;
    } else {
      state.parent_event = parent->parent_event;
    }
  }

  if ( taskId && state.parent_event ) {
    debug() << stackIndent() << "Pause event " << state.parent_event << endmsg;
    __itt_event_end( state.parent_event );
  }
  m_stack.push_back( state );

  debug() << stackIndent() << "Start profiling component " << typeName << endmsg;

  if ( taskId ) {
    // Start event
    debug() << stackIndent() << "Start event type " << state.event << " for " << typeName << endmsg;
    __itt_event_start( state.event );
  }

  __itt_resume();
}

void IntelProfilerAuditor::stop ( )

private

Definition at line 194 of file IntelProfilerAuditor.cpp.

{
  if ( !m_isStarted ) return;
  m_isStarted = false;
  __itt_pause();
}

std::string IntelProfilerAuditor::taskTypeName ( const std::string &  component_name ) const

private

Definition at line 224 of file IntelProfilerAuditor.cpp.

{
  std::string result;
  std::string delim = "";
  for ( const auto& value : m_stack ) {
    result += delim + value.name;
    delim = m_alg_delim;
  }
  return result + m_alg_delim + component_name;
}

Member Data Documentation

__itt_domain* IntelProfilerAuditor::domain = nullptr

private

Definition at line 95 of file IntelProfilerAuditor.cpp.

Gaudi::Property<std::string> IntelProfilerAuditor::m_alg_delim

private

Initial value:

{this, "TaskTypeNameDelimeter", " ",
                                           "The String delimiter between sequences/algorithms names in "
                                           "\"Task Type\" grouping at Amplifier. Default=\" \"."}

Definition at line 77 of file IntelProfilerAuditor.cpp.

Gaudi::Property<std::vector<std::string> > IntelProfilerAuditor::m_algs_for_tasktypes

private

Initial value:

{
      this,
      "ComponentsForTaskTypes",
      {},
      "Algorithm name,  for which intel amplifier task type will be created."
      "By default all algorithms have a corresponding task type."}

Definition at line 71 of file IntelProfilerAuditor.cpp.

Gaudi::Property<bool> IntelProfilerAuditor::m_enable_frames

private

Initial value:

{this, "EnableFrames", false,
                                        "Enable frames (needed for detecting slow events). Default=false."}

Definition at line 80 of file IntelProfilerAuditor.cpp.

Gaudi::Property<std::vector<std::string> > IntelProfilerAuditor::m_excluded {this, "ExcludeAlgorithms", {}, "Names of excluded algorithms."}

private

Definition at line 65 of file IntelProfilerAuditor.cpp.

Gaudi::Property<int> IntelProfilerAuditor::m_frames_rate

private

Initial value:

{this, "FramesRate", 100,
                                     "Frames rate. The recommended maximum rate for calling the Frame API is "
                                     "1000 frames (events) per second. A higher rate may result in large product"
                                     " memory consumption and slow finalization. "
                                     "You need update \"slow-frames-threshold\" and \"fast-frames-threshold\" "
                                     "parameters of amplxe-cl tool to separate slow,  medium and fast events. "
                                     "For use frames you need to switch on \"EnableFrames\". "
                                     "Default=100"}

Definition at line 82 of file IntelProfilerAuditor.cpp.

Gaudi::Property<std::vector<std::string> > IntelProfilerAuditor::m_included {this, "IncludeAlgorithms", {}, "Names of included algorithms."}

private

Definition at line 64 of file IntelProfilerAuditor.cpp.

bool IntelProfilerAuditor::m_isStarted = false

private

Definition at line 97 of file IntelProfilerAuditor.cpp.

int IntelProfilerAuditor::m_nEvents = 0

private

Definition at line 93 of file IntelProfilerAuditor.cpp.

Gaudi::Property<int> IntelProfilerAuditor::m_nStartFromEvent

private

Initial value:

{
      this, "StartFromEventN", 1, "After what event we stop profiling. If 0 than we also profile finalization stage."}

Definition at line 66 of file IntelProfilerAuditor.cpp.

Gaudi::Property<int> IntelProfilerAuditor::m_nStopAtEvent

private

Initial value:

{
      this, "StopAtEventN", 0,
      "After what event we stop profiling. If 0 than we also profile finalization stage. Default = 0."}

Definition at line 68 of file IntelProfilerAuditor.cpp.

std::vector<stack_entity> IntelProfilerAuditor::m_stack

private

Definition at line 99 of file IntelProfilerAuditor.cpp.

TaskTypes IntelProfilerAuditor::m_tasktypes

private

Definition at line 101 of file IntelProfilerAuditor.cpp.

---

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

• GaudiProfiling/src/component/intel/IntelProfilerAuditor.cpp