#include <src/TimelineSvc.h>

Inheritance diagram for TimelineSvc:

[legend]

Collaboration diagram for TimelineSvc:

[legend]

Public Member Functions
StatusCode	initialize () override

StatusCode	reinitialize () override

StatusCode	finalize () override

void	registerTimelineEvent (const TimelineEvent &) override

void	getTimelineEvent (TimelineEvent &) const override

bool	isEnabled () const override

	~TimelineSvc () override=default

Public Member Functions inherited from extends< Service, ITimelineSvc >
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...

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

	~PropertyHolder () override=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, TYPE &value, const std::string &doc="none") const

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
	Specializations for various GaudiHandles. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

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...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Public Member Functions inherited from extend_interfaces< Interfaces... >
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
void	outputTimeline ()

Private Attributes
Gaudi::Property< std::string >	m_timelineFile {this, "TimelineFile", "timeline.csv", ""}

Gaudi::Property< bool >	m_isEnabled {this, "RecordTimeline", false, "Enable recording of the timeline events"}

Gaudi::Property< bool >	m_dumpTimeline {this, "DumpTimeline", false, "Enable dumping of the timeline events"}

Gaudi::Property< bool >	m_partial {this, "Partial", false, ""}

tbb::concurrent_vector< TimelineEvent >	m_events

Additional Inherited Members
Public Types inherited from extends< Service, ITimelineSvc >
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 Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
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 Service
	~Service () override
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}

Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}

Gaudi::Property< bool >	m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}

Gaudi::Property< bool >	m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}

Gaudi::Property< bool >	m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}

Gaudi::Property< bool >	m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}

Gaudi::Property< bool >	m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}

Gaudi::Property< bool >	m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

Definition at line 12 of file TimelineSvc.h.

Constructor & Destructor Documentation

TimelineSvc::~TimelineSvc ( )

overridedefault

Member Function Documentation

StatusCode TimelineSvc::finalize ( )

override

Definition at line 42 of file TimelineSvc.cpp.

 {
 
   if ( m_dumpTimeline && m_events.size() > 0 ) {
     MsgStream log( msgSvc(), name() );
 
     log << MSG::INFO << "Outputting timeline with " << m_events.size() << " entries to file " << m_timelineFile
         << endmsg;
 
     outputTimeline();
   }
 
   return StatusCode::SUCCESS;
 }

void TimelineSvc::getTimelineEvent ( TimelineEvent & e ) const

override

Definition at line 75 of file TimelineSvc.cpp.

 {
 
   for ( const auto& candidate : m_events ) {
     if ( candidate.algorithm == e.algorithm ) {
       e = candidate;
       break;
     }
   }
 }

StatusCode TimelineSvc::initialize ( )

override

Definition at line 9 of file TimelineSvc.cpp.

 {
 
   StatusCode sc = Service::initialize();
   if ( !sc.isSuccess() ) return sc;
 
   if ( msgLevel( MSG::DEBUG ) ) debug() << "initialize" << endmsg;
 
   m_events.clear();
 
   if ( m_partial ) {
     std::ofstream out( m_timelineFile + ".part", std::ofstream::trunc | std::ofstream::out );
     out << "#start end algorithm thread slot event" << std::endl;
     out.close();
   }
 
   return StatusCode::SUCCESS;
 }

bool TimelineSvc::isEnabled ( ) const

inlineoverride

Definition at line 23 of file TimelineSvc.h.

23 { return m_isEnabled; }

TimelineSvc::m_isEnabled

Gaudi::Property< bool > m_isEnabled

Definition: TimelineSvc.h:34

void TimelineSvc::outputTimeline ( )

private

Definition at line 91 of file TimelineSvc.cpp.

 {
 
   std::ofstream out( m_timelineFile, std::ofstream::out | std::ofstream::trunc );
 
   out << "#start end algorithm thread slot event" << std::endl;
 
   for ( const auto& e : m_events ) {
     out << std::chrono::duration_cast<std::chrono::nanoseconds>( e.start.time_since_epoch() ).count() << " "
         << std::chrono::duration_cast<std::chrono::nanoseconds>( e.end.time_since_epoch() ).count() << " "
         << e.algorithm << " " << e.thread << " " << e.slot << " " << e.event << std::endl;
   }
 
   out.close();
 }

void TimelineSvc::registerTimelineEvent ( const TimelineEvent & e )

override

Definition at line 60 of file TimelineSvc.cpp.

 {
 
   m_events.push_back( e );
 
   if ( m_partial ) {
     std::ofstream out( m_timelineFile + ".part", std::ofstream::app | std::ofstream::out );
     out << std::chrono::duration_cast<std::chrono::nanoseconds>( e.start.time_since_epoch() ).count() << " "
         << std::chrono::duration_cast<std::chrono::nanoseconds>( e.end.time_since_epoch() ).count() << " "
         << e.algorithm << " " << e.thread << " " << e.slot << " " << e.event << std::endl;
 
     out.close();
   }
 }

StatusCode TimelineSvc::reinitialize ( )

override

Definition at line 30 of file TimelineSvc.cpp.

 {
 
   MsgStream log( msgSvc(), name() );
   log << MSG::DEBUG << "reinitialize" << endmsg;
 
   m_events.clear();
 
   return StatusCode::SUCCESS;
 }

Member Data Documentation

Gaudi::Property<bool> TimelineSvc::m_dumpTimeline {this, "DumpTimeline", false, "Enable dumping of the timeline events"}

private

Definition at line 35 of file TimelineSvc.h.

tbb::concurrent_vector<TimelineEvent> TimelineSvc::m_events

private

Definition at line 38 of file TimelineSvc.h.

Gaudi::Property<bool> TimelineSvc::m_isEnabled {this, "RecordTimeline", false, "Enable recording of the timeline events"}

private

Definition at line 34 of file TimelineSvc.h.

Gaudi::Property<bool> TimelineSvc::m_partial {this, "Partial", false, ""}

private

Definition at line 36 of file TimelineSvc.h.

Gaudi::Property<std::string> TimelineSvc::m_timelineFile {this, "TimelineFile", "timeline.csv", ""}

private

Definition at line 33 of file TimelineSvc.h.

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

GaudiHive/src/TimelineSvc.h
GaudiHive/src/TimelineSvc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation