| The Gaudi Framework v30r0 (c919700c)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

SequencerTimerTool.cpp
Go to the documentation of this file.
1 // Include files
2
3 // From ROOT
4 #include "TH1D.h"
5
6 // from Gaudi
7 #include "GaudiKernel/IRndmGenSvc.h"
8 #include "GaudiKernel/RndmGenerators.h"
9 #include "GaudiUtils/Aida2ROOT.h"
10
11 // local
12 #include "SequencerTimerTool.h"
13
14 //-----------------------------------------------------------------------------
15 // Implementation file for class : SequencerTimerTool
16 //
17 // 2004-05-19 : Olivier Callot
18 //-----------------------------------------------------------------------------
19
20 // Declaration of the Tool Factory
21 DECLARE_COMPONENT( SequencerTimerTool )
22
23 //=============================================================================
24 // Standard constructor, initializes variables
25 //=============================================================================
26 SequencerTimerTool::SequencerTimerTool( const std::string& type, const std::string& name, const IInterface* parent )
27 : GaudiHistoTool( type, name, parent )
28 {
29 declareInterface<ISequencerTimerTool>( this );
30
31 // Histograms are disabled by default in this tool.
32 setProperty( "HistoProduce", false ).ignore();
33 }
34 //=========================================================================
35 //
36 //=========================================================================
37 StatusCode SequencerTimerTool::initialize()
38 {
39 const StatusCode sc = GaudiHistoTool::initialize();
40 if ( sc.isFailure() ) return sc;
41 double sum = 0;
42 TimerForSequencer norm( "normalize", m_headerSize, m_normFactor );
43 norm.start();
44 IRndmGenSvc* rsvc = svc<IRndmGenSvc>( "RndmGenSvc", true );
45 { // Use dummy loop suggested by Vanya Belyaev:
46 Rndm::Numbers gauss;
47 gauss.initialize( rsvc, Rndm::Gauss( 0., 1.0 ) ).ignore();
48 unsigned int shots = m_shots;
49 while ( 0 < --shots ) {
50 sum += gauss() * sum;
51 }
52 }
53 norm.stop();
54 double time = norm.lastCpu();
55 m_speedRatio = 1. / time;
56 info() << "This machine has a speed about " << format( "%6.2f", 1000. * m_speedRatio )
57 << " times the speed of a 2.8 GHz Xeon." << endmsg;
58 if ( m_normalised ) m_normFactor = m_speedRatio;
59 return sc;
60 }
61
62 //=========================================================================
63 // Finalize : Report timers
64 //=========================================================================
65 StatusCode SequencerTimerTool::finalize()
66 {
67
68 std::string line( m_headerSize + 68, '-' );
69 info() << line << endmsg << "This machine has a speed about " << format( "%6.2f", 1000. * m_speedRatio )
70 << " times the speed of a 2.8 GHz Xeon.";
71 if ( m_normalised ) info() << " *** All times are renormalized ***";
72 info() << endmsg << TimerForSequencer::header( m_headerSize ) << endmsg << line << endmsg;
73
74 std::string lastName;
75 for ( const auto& timr : m_timerList ) {
76 if ( lastName == timr.name() ) continue; // suppress duplicate
77 lastName = timr.name();
78 info() << timr << endmsg;
79 }
80 info() << line << endmsg;
81
82 return GaudiHistoTool::finalize();
83 }
84
85 //=========================================================================
86 // Return the index of a specified name. Trailing and leading spaces ignored
87 //=========================================================================
88 int SequencerTimerTool::indexByName( const std::string& name )
89 {
90 auto beg = name.find_first_not_of( " \t" );
91 auto end = name.find_last_not_of( " \t" );
92 auto temp = name.substr( beg, end - beg + 1 );
93 auto i = std::find_if( std::begin( m_timerList ), std::end( m_timerList ), [&]( const TimerForSequencer& timer ) {
94 beg = timer.name().find_first_not_of( " \t" );
95 end = timer.name().find_last_not_of( " \t" );
96 return timer.name().compare( beg, end - beg + 1, temp ) == 0;
97 } );
98 return i != std::end( m_timerList ) ? std::distance( std::begin( m_timerList ), i ) : -1;
99 }
100
101 //=========================================================================
102 // Build and save the histograms
103 //=========================================================================
104 void SequencerTimerTool::saveHistograms()
105 {
106 if ( produceHistos() ) {
107 info() << "Saving Timing histograms" << endmsg;
108 const size_t bins = m_timerList.size();
109 AIDA::IHistogram1D* histoTime = book( "ElapsedTime", 0, bins, bins );
110 AIDA::IHistogram1D* histoCPU = book( "CPUTime", 0, bins, bins );
111 AIDA::IHistogram1D* histoCount = book( "Count", 0, bins, bins );
112 TH1D* tHtime = Gaudi::Utils::Aida2ROOT::aida2root( histoTime );
113 TH1D* tHCPU = Gaudi::Utils::Aida2ROOT::aida2root( histoCPU );
114 TH1D* tHCount = Gaudi::Utils::Aida2ROOT::aida2root( histoCount );
115 for ( const auto& tfsq : m_timerList ) {
116 tHtime->Fill( tfsq.name().c_str(), tfsq.elapsedTotal() );
117 tHCPU->Fill( tfsq.name().c_str(), tfsq.cpuTotal() );
118 tHCount->Fill( tfsq.name().c_str(), tfsq.count() );
119 }
120 }
121 }
122
123 //=============================================================================
124 // Add a timer
125 //=============================================================================
126 int SequencerTimerTool::addTimer( const std::string& name )
127 {
128 std::string myName( 2 * m_indent, ' ' );
129 myName += name;
130 if ( myName.size() < m_headerSize ) {
131 myName += std::string( m_headerSize - myName.size(), ' ' );
132 }
133 m_timerList.emplace_back( std::move( myName ), m_headerSize, m_normFactor );
134 return m_timerList.size() - 1;
135 }
136
137 //=============================================================================
SequencerTimerTool::initialize
StatusCode initialize() override
initialize method, to compute the normalization factor
Definition: SequencerTimerTool.cpp:37
Gaudi::Utils::setProperty
StatusCode setProperty(IProperty *component, const std::string &name, const TYPE &value, const std::string &doc)
simple function to set the property of the given object from the value
Definition: Property.h:1172
TimerForSequencer
Auxiliary class.
Definition: TimerForSequencer.h:20
TimerForSequencer::header
static std::string header(std::string::size_type size)
header matching the previous format
Definition: TimerForSequencer.cpp:61
std::distance
T distance(T...args)
format
GAUDI_API std::string format(const char *,...)
MsgStream format utility "a la sprintf(...)".
Definition: MsgStream.cpp:120
std::string::find_first_not_of
T find_first_not_of(T...args)
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
CommonMessagingBase::info
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:112
SequencerTimerTool::m_normalised
Gaudi::Property< bool > m_normalised
Definition: SequencerTimerTool.h:77
GaudiHistos< GaudiTool >::finalize
StatusCode finalize() override
standard finalization method
sum
double sum(double x, double y, double z)
Definition: 3DoubleFuncTest.cpp:25
TimerForSequencer::stop
uint64_t stop()
Stop time measurement and return the last elapsed time.
Definition: TimerForSequencer.cpp:10
plotSpeedupsPyRoot.time
time
Definition: plotSpeedupsPyRoot.py:154
std
STL namespace.
std::end
T end(T...args)
TimerForSequencer::lastCpu
double lastCpu() const
returns the last measured time
Definition: TimerForSequencer.h:51
Rndm::Gauss
Parameters for the Gauss random number generation.
Definition: RndmGenerators.h:23
TimerForSequencer::start
void start()
Start a time measurement.
Definition: TimerForSequencer.h:33
SequencerTimerTool::indexByName
int indexByName(const std::string &name) override
returns the index of the counter with that name, or -1
Definition: SequencerTimerTool.cpp:88
StatusCode::isFailure
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:61
GaudiHistoTool
Simple class to extend the functionality of class GaudiTool.
Definition: GaudiHistoTool.h:39
DECLARE_COMPONENT
#define DECLARE_COMPONENT(type)
Definition: PluginService.h:33
std::string
STL class.
SequencerTimerTool::m_shots
Gaudi::Property< int > m_shots
Definition: SequencerTimerTool.h:76
SequencerTimerTool::saveHistograms
void saveHistograms() override
prepares and saves the timing histograms
Definition: SequencerTimerTool.cpp:104
Aida2ROOT.h
Rndm::Numbers
Random number accessor This small class encapsulates the use of the random number generator...
Definition: RndmGenerators.h:396
IRndmGenSvc
Random Generator service interface definition Definition of a interface for a service to access rando...
Definition: IRndmGenSvc.h:35
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
IInterface
Definition of the basic interface.
Definition: IInterface.h:277
gaudirun.type
type
Definition: gaudirun.py:133
SequencerTimerTool.h
end
auto end(reverse_wrapper< T > &w)
Definition: reverse.h:64
Gaudi::Utils::Aida2ROOT::aida2root
static TH1D * aida2root(AIDA::IHistogram1D *aida)
get the underlying pointer for 1D-histogram
Definition: Aida2ROOT.cpp:73
GaudiHistos< GaudiTool >::book
AIDA::IHistogram1D * book(const std::string &title, const double low=0, const double high=100, const unsigned long bins=100) const
book the 1D histogram
Definition: GaudiHistos.h:1865
SequencerTimerTool::addTimer
int addTimer(const std::string &name) override
add a timer entry with the specified name
Definition: SequencerTimerTool.cpp:126
std::move
T move(T...args)
RndmGenerators.h
std::string::find_last_not_of
T find_last_not_of(T...args)
SequencerTimerTool::m_indent
int m_indent
Amount of indentation.
Definition: SequencerTimerTool.h:82
std::find_if
T find_if(T...args)
std::vector::size
T size(T...args)
IRndmGenSvc.h
std::begin
T begin(T...args)
Gaudi::Units::gauss
constexpr double gauss
Definition: SystemOfUnits.h:233
GaudiHistos< GaudiTool >::initialize
StatusCode initialize() override
standard initialization method
GaudiHistos< GaudiTool >::produceHistos
bool produceHistos() const
get the flag for histogram production (property "HistoProduce")
Definition: GaudiHistos.h:2396
SequencerTimerTool
Implements the time measurement inside a sequencer.
Definition: SequencerTimerTool.h:25
TimerForSequencer::name
const std::string & name() const
returns the name
Definition: TimerForSequencer.h:45
SequencerTimerTool::m_timerList
std::vector< TimerForSequencer > m_timerList
Definition: SequencerTimerTool.h:83
std::string::substr
T substr(T...args)
Rndm::Numbers::initialize
virtual StatusCode initialize(const SmartIF< IRndmGenSvc > &svc, const IRndmGen::Param &par)
Initialization.
Definition: RndmGenerators.cpp:23
StatusCode::ignore
void ignore() const
Definition: StatusCode.h:84
SequencerTimerTool::m_headerSize
Gaudi::Property< std::string::size_type > m_headerSize
Definition: SequencerTimerTool.h:79
SequencerTimerTool::m_speedRatio
double m_speedRatio
Definition: SequencerTimerTool.h:85
SequencerTimerTool::finalize
StatusCode finalize() override
finalize method, to print the time summary table
Definition: SequencerTimerTool.cpp:65
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
INamedInterface::name
virtual const std::string & name() const =0
Retrieve the name of the instance.
plotSpeedupsPyRoot.line
line
Definition: plotSpeedupsPyRoot.py:172
std::string::compare
T compare(T...args)
SequencerTimerTool::m_normFactor
double m_normFactor
Factor to convert to standard CPU (1 GHz PIII)
Definition: SequencerTimerTool.h:84
std::vector::emplace_back
T emplace_back(T...args)