| The Gaudi Framework v32r1 (f65d50dc)

Public Member Functions | Private Member Functions | Private Attributes | List of all members
TimelineSvc Class Reference

`#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
TimelineRecorder | getRecorder (std::string alg, const EventContext &ctx) override
bool | getTimelineEvent (TimelineEvent &) const override
bool | isEnabled () const override
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...
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
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< IService, IProperty, IStateful > >
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 | 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
using | Factory = Gaudi::PluginService::Factory< IService *(const std::string &, ISvcLocator *)>
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 > >
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...
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, " 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.

## Member Function Documentation

## ◆ finalize()

StatusCode TimelineSvc::finalize | ( |  | ) |
| override

Definition at line 37 of file TimelineSvc.cpp.

37 {
38 if ( m_dumpTimeline && m_events.size() > 0 ) {
39 MsgStream log( msgSvc(), name() );
40
41 log << MSG::INFO << "Outputting timeline with " << m_events.size() << " entries to file " << m_timelineFile
42 << endmsg;
43
44 outputTimeline();
45 }
46
47 return StatusCode::SUCCESS;
48 }
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
CommonMessagingBase::msgSvc
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: CommonMessaging.h:68
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
Service::name
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
TimelineSvc::m_events
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:33
TimelineSvc::m_timelineFile
Gaudi::Property< std::string > m_timelineFile
Definition: TimelineSvc.h:28
MSG::INFO
Definition: IMessageSvc.h:15
TimelineSvc::outputTimeline
void outputTimeline()
Definition: TimelineSvc.cpp:76
TimelineSvc::m_dumpTimeline
Gaudi::Property< bool > m_dumpTimeline
Definition: TimelineSvc.h:30
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
Gaudi.Configuration.log
log
Definition: Configuration.py:13

## ◆ getRecorder()

ITimelineSvc::TimelineRecorder TimelineSvc::getRecorder | ( | std::string | alg,
|  | const EventContext & | ctx
| ) |  |
| override

Definition at line 50 of file TimelineSvc.cpp.

50 {
51 auto& newTimelineEvent = *m_events.emplace_back();
52 TimelineRecorder recorder{newTimelineEvent, std::move( alg ), ctx};
53 if ( m_partial ) {
54 std::ofstream out( m_timelineFile + ".part", std::ofstream::app | std::ofstream::out );
55 out << std::chrono::duration_cast<std::chrono::nanoseconds>( newTimelineEvent.start.time_since_epoch() ).count()
56 << " "
57 << std::chrono::duration_cast<std::chrono::nanoseconds>( newTimelineEvent.end.time_since_epoch() ).count()
58 << " " << newTimelineEvent.algorithm << " " << newTimelineEvent.thread << " " << newTimelineEvent.slot << " "
59 << newTimelineEvent.event << std::endl;
60
61 out.close();
62 }
63 return recorder;
64 }
ManySmallAlgs.alg
alg
Definition: ManySmallAlgs.py:69
TimelineSvc::m_partial
Gaudi::Property< bool > m_partial
Definition: TimelineSvc.h:31
std::endl
T endl(T... args)
std::ofstream
STL class.
TimelineSvc::m_events
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:33
std::move
T move(T... args)
std::count
T count(T... args)
TimelineSvc::m_timelineFile
Gaudi::Property< std::string > m_timelineFile
Definition: TimelineSvc.h:28

## ◆ getTimelineEvent()

bool TimelineSvc::getTimelineEvent | ( | TimelineEvent & | e | ) | const
| override

Definition at line 66 of file TimelineSvc.cpp.

66 {
67 for ( const auto& candidate : m_events ) {
68 if ( candidate.algorithm == e.algorithm && candidate.event == e.event ) {
69 e = candidate;
70 return true;
71 }
72 }
73 return false;
74 }
TimelineEvent::algorithm
std::string algorithm
Definition: ITimelineSvc.h:21
TimelineSvc::m_events
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:33
TimelineEvent::event
size_t event
Definition: ITimelineSvc.h:19

## ◆ initialize()

StatusCode TimelineSvc::initialize | ( |  | ) |
| override

Definition at line 7 of file TimelineSvc.cpp.

7 {
8 StatusCode sc = Service::initialize();
9 if ( !sc.isSuccess() ) return sc;
10
11 if ( msgLevel( MSG::DEBUG ) ) debug() << "initialize" << endmsg;
12
13 m_events.clear();
14 // the initial allocation of tbb::concurrent_vector determines the size of
15 // the first allocated array, useful to reduce fragmentation
16 m_events.reserve( 1024 );
17
18 if ( m_partial ) {
19 std::ofstream out( m_timelineFile + ".part", std::ofstream::trunc | std::ofstream::out );
20 out << "#start end algorithm thread slot event" << std::endl;
21 out.close();
22 }
23
24 return StatusCode::SUCCESS;
25 }
Service::initialize
StatusCode initialize() override
Definition: Service.cpp:60
TimelineSvc::m_partial
Gaudi::Property< bool > m_partial
Definition: TimelineSvc.h:31
MSG::DEBUG
Definition: IMessageSvc.h:15
std::endl
T endl(T... args)
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
CommonMessaging< implements< IService, IProperty, IStateful > >::msgLevel
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
Definition: CommonMessaging.h:138
std::ofstream
STL class.
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
TimelineSvc::m_events
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:33
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:107
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:267
TimelineSvc::m_timelineFile
Gaudi::Property< std::string > m_timelineFile
Definition: TimelineSvc.h:28
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

## ◆ isEnabled()

bool TimelineSvc::isEnabled | ( |  | ) | const
| inline override

Definition at line 23 of file TimelineSvc.h.

23 { return m_isEnabled; }
TimelineSvc::m_isEnabled
Gaudi::Property< bool > m_isEnabled
Definition: TimelineSvc.h:29

## ◆ outputTimeline()

void TimelineSvc::outputTimeline | ( |  | ) |
| private

Definition at line 76 of file TimelineSvc.cpp.

76 {
77 std::ofstream out( m_timelineFile, std::ofstream::out | std::ofstream::trunc );
78
79 out << "#start end algorithm thread slot event" << std::endl;
80
81 for ( const auto& e : m_events ) {
82 out << std::chrono::duration_cast<std::chrono::nanoseconds>( e.start.time_since_epoch() ).count() << " "
83 << std::chrono::duration_cast<std::chrono::nanoseconds>( e.end.time_since_epoch() ).count() << " "
84 << e.algorithm << " " << e.thread << " " << e.slot << " " << e.event << std::endl;
85 }
86
87 out.close();
88 }
std::endl
T endl(T... args)
std::ofstream
STL class.
TimelineSvc::m_events
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:33
std::count
T count(T... args)
TimelineSvc::m_timelineFile
Gaudi::Property< std::string > m_timelineFile
Definition: TimelineSvc.h:28

## ◆ reinitialize()

StatusCode TimelineSvc::reinitialize | ( |  | ) |
| override

Definition at line 27 of file TimelineSvc.cpp.

27 {
28
29 MsgStream log( msgSvc(), name() );
30 log << MSG::DEBUG << "reinitialize" << endmsg;
31
32 m_events.clear();
33
34 return StatusCode::SUCCESS;
35 }
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
CommonMessagingBase::msgSvc
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: CommonMessaging.h:68
MSG::DEBUG
Definition: IMessageSvc.h:15
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
Service::name
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
TimelineSvc::m_events
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:33
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
Gaudi.Configuration.log
log
Definition: Configuration.py:13

## Member Data Documentation

## ◆ m_dumpTimeline

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

Definition at line 30 of file TimelineSvc.h.

## ◆ m_events

tbb::concurrent_vector<TimelineEvent> TimelineSvc::m_events
| private

Definition at line 33 of file TimelineSvc.h.

## ◆ m_isEnabled

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

Definition at line 29 of file TimelineSvc.h.

## ◆ m_partial

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

Definition at line 31 of file TimelineSvc.h.

## ◆ m_timelineFile

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

Definition at line 28 of file TimelineSvc.h.

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

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