#include </builds/gaudi/Gaudi/GaudiHive/src/CPUCruncher.h>

Inheritance diagram for CPUCruncher:

[legend]

Collaboration diagram for CPUCruncher:

[legend]

Public Types
typedef tbb::concurrent_hash_map< std::string, unsigned int >	CHM

Public Types inherited from Gaudi::Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm (const std::string &, ISvcLocator )>	Factory

Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
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 PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, 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...

Public Member Functions
bool	isClonable () const override

StatusCode	execute () override
	the execution of the algorithm More...

StatusCode	initialize () override
	Its initialization. More...

StatusCode	finalize () override
	the finalization of the algorithm More...

double	get_runtime () const

	CPUCruncher (const std::string &name, ISvcLocator *pSvc)

virtual	~CPUCruncher ()
	virtual & protected desctrustor More...

Public Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
	LegacyAlgorithmAdapter (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)

const EventContext &	getContext () const

bool	isExecuted () const
	Has this algorithm been executed since the last reset? More...

void	setExecuted (bool state) const
	Set the executed flag to the specified state. More...

bool	filterPassed () const
	Did this algorithm pass or fail its filter criterion for the last event? More...

void	setFilterPassed (bool state) const
	Set the filter passed flag to the specified state. More...

Public Member Functions inherited from Gaudi::Algorithm
	Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
	Constructor. More...

StatusCode	sysStart () override
	Reinitialization method invoked by the framework. More...

StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...

StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework. More...

StatusCode	sysRestart () override
	Restart method invoked by the framework. More...

StatusCode	sysExecute (const EventContext &ctx) override
	The actions to be performed by the algorithm on an event. More...

StatusCode	sysStop () override
	System stop. More...

StatusCode	sysFinalize () override
	System finalization. More...

const std::string &	name () const override
	The identifying name of the algorithm object. More...

const Gaudi::StringKey &	nameKey () const override

const std::string &	type () const override
	The type of the algorithm object. More...

void	setType (std::string type) override

const std::string &	version () const override

unsigned int	index () const override

StatusCode	configure () override
	Dummy implementation of IStateful::configure() method. More...

StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method. More...

StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method More...

StatusCode	start () override
	the default (empty) implementation of IStateful::start() method More...

StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method More...

StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method More...

StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method More...

StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method More...

Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm More...

Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition More...

bool	isEnabled () const override
	Is this algorithm enabled or disabled? More...

bool	isSequence () const override
	Are we a Sequence? More...

unsigned int	errorCount () const
	Get the number of failures of the algorithm. More...

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

SmartIF< IService >	service (std::string_view name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...

template<class T >
SmartIF< T >	service (std::string_view name, bool createIf=true, bool quiet=false) const

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

SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present. More...

SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service. More...

SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service. More...

SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service. More...

SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc More...

SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service. More...

SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service. More...

SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service. More...

SmartIF< IRndmGenSvc > &	randSvc () const
	The standard RandomGen service, Return a pointer to the service if present. More...

SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service. More...

SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service More...

SmartIF< ITimelineSvc > &	timelineSvc () const

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...

SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator More...

SmartIF< IHiveWhiteBoard > &	whiteboard () const

SmartIF< IAlgExecStateSvc > &	algExecStateSvc () const

bool	registerContext () const
	register for Algorithm Context Service? More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service. More...

template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

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

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

bool	isBlocking () const

void	setBlocking (bool value)

unsigned int	cardinality () const override
	Return the cardinality. More...

const std::vector< std::string > &	neededResources () const override

AlgExecState &	execState (const EventContext &ctx) const override
	reference to AlgExecState of Alg More...

std::ostream &	toControlFlowExpression (std::ostream &os) const override
	Produce string represention of the control flow expression. More...

Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override

std::vector< Gaudi::DataHandle * >	outputHandles () const override

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

bool	renounceInput (const DataObjID &id) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
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 PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, 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 std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view 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 (std::string_view name) const override
	Return true if we have a property with the given name. More...

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, 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...

Private Member Functions
	CPUCruncher ()
	the default constructor is disabled More...

	CPUCruncher (const CPUCruncher &)
	the copy constructor is disabled More...

CPUCruncher &	operator= (const CPUCruncher &)
	the assignement operator is disabled More...

void	declareRuntimeRequestedOutputs ()
	The CPU intensive function. More...

Private Attributes
bool	m_declAugmented { false }

Gaudi::Property< bool >	m_loader { this, "Loader", false, "Declare the algorithm to be a data loader" }

Gaudi::Property< std::vector< std::string > >	m_inpKeys { this, "inpKeys", {}, "" }

Gaudi::Property< std::vector< std::string > >	m_outKeys { this, "outKeys", {}, "" }

Gaudi::Property< double >	m_avg_runtime { this, "avgRuntime", 1., "Average runtime of the module." }

Gaudi::Property< double >	m_var_runtime { this, "varRuntime", 0.01, "Variance of the runtime of the module." }

Gaudi::Property< bool >	m_local_rndm_gen

Gaudi::Property< unsigned int >	m_rwRepetitions { this, "RwRepetitions", 1, "Increase access to the WB" }

Gaudi::Property< float >	m_sleepFraction

Gaudi::Property< bool >	m_invertCFD { this, "InvertDecision", false, "Invert control flow decision." }

Gaudi::Property< unsigned int >	m_failNEvents { this, "FailNEvents", 0, "Return FAILURE on every Nth event" }

Gaudi::Property< int >	m_nParallel { this, "NParallel", -1, "Run N parallel crunching tasks" }

const uint	MAX_INPUTS = 40

const uint	MAX_OUTPUTS = 10

std::vector< DataObjectHandle< DataObject > * >	m_inputHandles

std::vector< DataObjectHandle< DataObject > * >	m_outputHandles

SmartIF< ICPUCrunchSvc >	m_crunchSvc

Static Private Attributes
static CHM	m_name_ncopies_map

Additional Inherited Members
Public Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager

Protected Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
bool	isReEntrant () const override

Protected Member Functions inherited from Gaudi::Algorithm
std::vector< IAlgTool * > &	tools ()

bool	isInitialized () const override
	Has the Algorithm already been initialized? More...

bool	isFinalized () const override
	Has the Algorithm already been finalized? More...

void	setIndex (const unsigned int &idx) override
	set instantiation index of Alg More...

bool	isReEntrant () const override

Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this More...

Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, 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 Gaudi::Algorithm
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles. More...

Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

Detailed Description

A class that implements a search for prime numbers. A lot of allocations are performed on purpose not to stress only the FP unit of the CPU.

Definition at line 29 of file CPUCruncher.h.

Member Typedef Documentation

◆ CHM

typedef tbb::concurrent_hash_map<std::string, unsigned int> CPUCruncher::CHM

Definition at line 32 of file CPUCruncher.h.

Constructor & Destructor Documentation

◆ CPUCruncher() [1/3]

CPUCruncher::CPUCruncher	(	const std::string &	name,
		ISvcLocator *	pSvc
	)

Definition at line 34 of file CPUCruncher.cpp.

     : Algorithm( name, pSvc ) {
  
   // Register the algo in the static concurrent hash map in order to
   // monitor the # of copies
   CHM::accessor name_ninstances;
   m_name_ncopies_map.insert( name_ninstances, name );
   name_ninstances->second += 1;
 }

◆ ~CPUCruncher()

CPUCruncher::~CPUCruncher ( )

virtual

virtual & protected desctrustor

Definition at line 45 of file CPUCruncher.cpp.

                           {
   for ( uint i = 0; i < m_inputHandles.size(); ++i ) delete m_inputHandles[i];
  
   for ( uint i = 0; i < m_outputHandles.size(); ++i ) delete m_outputHandles[i];
 }

◆ CPUCruncher() [2/3]

CPUCruncher::CPUCruncher ( )

private

the default constructor is disabled

◆ CPUCruncher() [3/3]

CPUCruncher::CPUCruncher ( const CPUCruncher & )

private

the copy constructor is disabled

Member Function Documentation

◆ declareRuntimeRequestedOutputs()

void CPUCruncher::declareRuntimeRequestedOutputs ( )

private

The CPU intensive function.

Pick up late-attributed data outputs

Definition at line 90 of file CPUCruncher.cpp.

                                                  {
   //
   for ( const auto& k : outputDataObjs() ) {
     auto outputHandle = new DataObjectHandle<DataObject>( k, Gaudi::DataHandle::Writer, this );
     VERBOSE_MSG << "found late-attributed output: " << outputHandle->objKey() << endmsg;
     m_outputHandles.push_back( outputHandle );
     declareProperty( "dummy_out_" + outputHandle->objKey(), *( m_outputHandles.back() ) );
   }
  
   initDataHandleHolder();
  
   m_declAugmented = true;
 }

◆ execute()

StatusCode CPUCruncher::execute ( )

overridevirtual

the execution of the algorithm

Implements Algorithm.

Definition at line 106 of file CPUCruncher.cpp.

 {
  
   if ( m_loader && !m_declAugmented ) declareRuntimeRequestedOutputs();
  
   float crunchtime;
  
   if ( m_local_rndm_gen ) {
     /* This will disappear with a thread safe random number generator service.
      * Use basic Box-Muller to generate Gaussian random numbers.
      * The quality is not good for in depth study given that the generator is a
      * linear congruent.
      * Throw away basically a free number: we are in a cpu cruncher after all.
      * The seed is taken from the clock, but we could assign a seed per module to
      * ensure reproducibility.
      *
      * This is not an overkill but rather an exercise towards a thread safe
      * random number generation.
      */
  
     auto getGausRandom = []( double mean, double sigma ) -> double {
       unsigned int seed = std::clock();
  
       auto getUnifRandom = []( unsigned int& seed ) -> double {
         // from "Numerical Recipes"
         constexpr unsigned int m = 232;
         constexpr unsigned int a = 1664525;
         constexpr unsigned int c = 1013904223;
         seed                     = ( a * seed + c ) % m;
         const double unif        = double( seed ) / m;
         return unif;
       };
  
       double unif1, unif2;
       do {
         unif1 = getUnifRandom( seed );
         unif2 = getUnifRandom( seed );
       } while ( unif1 < std::numeric_limits<double>::epsilon() );
  
       const double normal = sqrt( -2. * log( unif1 ) ) * cos( 2 * M_PI * unif2 );
  
       return normal * sigma + mean;
     };
  
     crunchtime = std::abs( getGausRandom( m_avg_runtime * ( 1. - m_sleepFraction ), m_var_runtime ) );
     // End Of temp block
   } else {
     // Should be a member.
     HiveRndm::HiveNumbers rndmgaus( randSvc(), Rndm::Gauss( m_avg_runtime * ( 1. - m_sleepFraction ), m_var_runtime ) );
     crunchtime = std::abs( rndmgaus() );
   }
   unsigned int crunchtime_ms = 1000 * crunchtime;
  
   // Prepare to sleep (even if we won't enter the following if clause for sleeping).
   // This is needed to distribute evenly among all algorithms the overhead (around sleeping) which is harmful when
   // trying to achieve uniform distribution of algorithm timings.
   const double                        dreamtime = m_avg_runtime * m_sleepFraction;
   const std::chrono::duration<double> dreamtime_duration( dreamtime );
   tbb::tick_count                     startSleeptbb;
   tbb::tick_count                     endSleeptbb;
  
   // Start to measure the total time here, together with the dreaming process straight ahead
   tbb::tick_count starttbb = tbb::tick_count::now();
  
   // If the algorithm was declared as CPU-blocking, we will replace requested part of crunching with plain sleeping
   if ( isBlocking() ) {
     // in this block (and not in other places around) msgLevel is checked for the same reason as above, when
     // preparing to sleep several lines above: to reduce as much as possible the overhead around sleeping
     DEBUG_MSG << "Dreaming time will be: " << int( 1000 * dreamtime ) << " ms" << endmsg;
  
     ON_DEBUG startSleeptbb = tbb::tick_count::now();
     std::this_thread::sleep_for( dreamtime_duration );
     ON_DEBUG endSleeptbb = tbb::tick_count::now();
  
     // actual sleeping time can be longer due to scheduling or resource contention delays
     ON_DEBUG {
       const double actualDreamTime = ( endSleeptbb - startSleeptbb ).seconds();
       debug() << "Actual dreaming time was: " << int( 1000 * actualDreamTime ) << "ms" << endmsg;
     }
   } // end of "sleeping block"
  
   DEBUG_MSG << "Crunching time will be: " << crunchtime_ms << " ms" << endmsg;
   const EventContext& context = Gaudi::Hive::currentContext();
   DEBUG_MSG << "Start event " << context.evt() << " in slot " << context.slot() << " on pthreadID " << std::hex
             << pthread_self() << std::dec << endmsg;
  
   VERBOSE_MSG << "inputs number: " << m_inputHandles.size() << endmsg;
   for ( auto& inputHandle : m_inputHandles ) {
     if ( !inputHandle->isValid() ) continue;
  
     VERBOSE_MSG << "get from TS: " << inputHandle->objKey() << endmsg;
     DataObject* obj = nullptr;
     for ( unsigned int i = 0; i < m_rwRepetitions; ++i ) { obj = inputHandle->get(); }
     if ( obj == nullptr ) error() << "A read object was a null pointer." << endmsg;
   }
  
   if ( m_nParallel > 1 ) {
     tbb::parallel_for( tbb::blocked_range<size_t>( 0, m_nParallel ), [&]( tbb::blocked_range<size_t> r ) {
       m_crunchSvc->crunch_for( std::chrono::milliseconds( crunchtime_ms ) );
       debug() << "CPUCrunch complete in TBB parallel for block " << r.begin() << " to " << r.end() << endmsg;
     } );
   } else {
     m_crunchSvc->crunch_for( std::chrono::milliseconds( crunchtime_ms ) );
   }
  
   // Return error on fraction of events if configured
   if ( m_failNEvents > 0 && context.evt() > 0 && ( context.evt() % m_failNEvents ) == 0 ) {
     return StatusCode::FAILURE;
   }
  
   VERBOSE_MSG << "outputs number: " << m_outputHandles.size() << endmsg;
   for ( auto& outputHandle : m_outputHandles ) {
     if ( !outputHandle->isValid() ) continue;
  
     VERBOSE_MSG << "put to TS: " << outputHandle->objKey() << endmsg;
     outputHandle->put( std::make_unique<DataObject>() );
   }
  
   tbb::tick_count endtbb        = tbb::tick_count::now();
   const double    actualRuntime = ( endtbb - starttbb ).seconds();
  
   DEBUG_MSG << "Finish event " << context.evt() << " in " << int( 1000 * actualRuntime ) << " ms" << endmsg;
  
   DEBUG_MSG << "Timing: ExpectedCrunchtime= " << crunchtime_ms << " ms. ExpectedDreamtime= " << int( 1000 * dreamtime )
             << " ms. ActualTotalRuntime= " << int( 1000 * actualRuntime )
             << " ms. Ratio= " << ( crunchtime + dreamtime ) / actualRuntime << endmsg;
  
   setFilterPassed( !m_invertCFD );
  
   return StatusCode::SUCCESS;
 }

◆ finalize()

StatusCode CPUCruncher::finalize ( )

override

the finalization of the algorithm

Definition at line 240 of file CPUCruncher.cpp.

 {
   MsgStream log( msgSvc(), name() );
  
   unsigned int ninstances;
  
   {
     CHM::const_accessor const_name_ninstances;
     m_name_ncopies_map.find( const_name_ninstances, name() );
     ninstances = const_name_ninstances->second;
   }
  
   constexpr double s2ms = 1000.;
   // do not show repetitions
   if ( ninstances != 0 ) {
     info() << "Summary: name= " << name() << "\t avg_runtime= " << m_avg_runtime * s2ms << "\t n_clones= " << ninstances
            << endmsg;
  
     CHM::accessor name_ninstances;
     m_name_ncopies_map.find( name_ninstances, name() );
     name_ninstances->second = 0;
   }
  
   return Algorithm::finalize();
 }

◆ get_runtime()

double CPUCruncher::get_runtime ( ) const

inline

Definition at line 43 of file CPUCruncher.h.

43 { return m_avg_runtime; }

◆ initialize()

StatusCode CPUCruncher::initialize ( )

override

Its initialization.

Definition at line 51 of file CPUCruncher.cpp.

                                    {
   auto sc = Algorithm::initialize();
   if ( !sc ) return sc;
  
   m_crunchSvc = serviceLocator()->service( "CPUCrunchSvc" );
   if ( !m_crunchSvc.isValid() ) {
     fatal() << "unable to acquire CPUCruncSvc" << endmsg;
     return StatusCode::FAILURE;
   }
  
   // if an algorithm was setup to sleep, for whatever period, it effectively models CPU-blocking behavior
   if ( std::abs( m_sleepFraction ) > std::numeric_limits<float>::epsilon() ) setBlocking( true );
  
   // This is a bit ugly. There is no way to declare a vector of DataObjectHandles, so
   // we need to wait until initialize when we've read in the input and output key
   // properties, and know their size, and then turn them
   // into Handles and register them with the framework by calling declareProperty. We
   // could call declareInput/declareOutput on them too.
  
   int i = 0;
   for ( auto k : m_inpKeys ) {
     DEBUG_MSG << "adding input key " << k << endmsg;
     m_inputHandles.push_back( new DataObjectHandle<DataObject>( k, Gaudi::DataHandle::Reader, this ) );
     declareProperty( "dummy_in_" + std::to_string( i ), *( m_inputHandles.back() ) );
     i++;
   }
  
   i = 0;
   for ( auto k : m_outKeys ) {
     DEBUG_MSG << "adding output key " << k << endmsg;
     m_outputHandles.push_back( new DataObjectHandle<DataObject>( k, Gaudi::DataHandle::Writer, this ) );
     declareProperty( "dummy_out_" + std::to_string( i ), *( m_outputHandles.back() ) );
     i++;
   }
  
   return sc;
 }

◆ isClonable()

bool CPUCruncher::isClonable ( ) const

inlineoverride

Definition at line 34 of file CPUCruncher.h.

34 { return true; }

◆ operator=()

CPUCruncher& CPUCruncher::operator= ( const CPUCruncher & )

private

the assignement operator is disabled

Member Data Documentation

◆ m_avg_runtime

Gaudi::Property<double> CPUCruncher::m_avg_runtime { this, "avgRuntime", 1., "Average runtime of the module." }

private

Definition at line 68 of file CPUCruncher.h.

◆ m_crunchSvc

SmartIF<ICPUCrunchSvc> CPUCruncher::m_crunchSvc

private

Definition at line 90 of file CPUCruncher.h.

◆ m_declAugmented

bool CPUCruncher::m_declAugmented { false }

private

Definition at line 62 of file CPUCruncher.h.

◆ m_failNEvents

Gaudi::Property<unsigned int> CPUCruncher::m_failNEvents { this, "FailNEvents", 0, "Return FAILURE on every Nth event" }

private

Definition at line 77 of file CPUCruncher.h.

◆ m_inpKeys

Gaudi::Property<std::vector<std::string> > CPUCruncher::m_inpKeys { this, "inpKeys", {}, "" }

private

Definition at line 65 of file CPUCruncher.h.

◆ m_inputHandles

std::vector<DataObjectHandle<DataObject>*> CPUCruncher::m_inputHandles

private

Definition at line 84 of file CPUCruncher.h.

◆ m_invertCFD

Gaudi::Property<bool> CPUCruncher::m_invertCFD { this, "InvertDecision", false, "Invert control flow decision." }

private

Definition at line 76 of file CPUCruncher.h.

◆ m_loader

Gaudi::Property<bool> CPUCruncher::m_loader { this, "Loader", false, "Declare the algorithm to be a data loader" }

private

Definition at line 63 of file CPUCruncher.h.

◆ m_local_rndm_gen

Gaudi::Property<bool> CPUCruncher::m_local_rndm_gen

private

Initial value:

{ this, "localRndm", true,

"Decide if the local random generator is to be used" }

Definition at line 70 of file CPUCruncher.h.

◆ m_name_ncopies_map

CPUCruncher::CHM CPUCruncher::m_name_ncopies_map

staticprivate

Definition at line 87 of file CPUCruncher.h.

◆ m_nParallel

Gaudi::Property<int> CPUCruncher::m_nParallel { this, "NParallel", -1, "Run N parallel crunching tasks" }

private

Definition at line 78 of file CPUCruncher.h.

◆ m_outKeys

Gaudi::Property<std::vector<std::string> > CPUCruncher::m_outKeys { this, "outKeys", {}, "" }

private

Definition at line 66 of file CPUCruncher.h.

◆ m_outputHandles

std::vector<DataObjectHandle<DataObject>*> CPUCruncher::m_outputHandles

private

Definition at line 85 of file CPUCruncher.h.

◆ m_rwRepetitions

Gaudi::Property<unsigned int> CPUCruncher::m_rwRepetitions { this, "RwRepetitions", 1, "Increase access to the WB" }

private

Definition at line 72 of file CPUCruncher.h.

◆ m_sleepFraction

Gaudi::Property<float> CPUCruncher::m_sleepFraction

private

Initial value:

{
      this, "SleepFraction", 0.0f,
      "Fraction of time, between 0 and 1, when an algorithm is actually sleeping instead of crunching" }

Definition at line 73 of file CPUCruncher.h.

◆ m_var_runtime

Gaudi::Property<double> CPUCruncher::m_var_runtime { this, "varRuntime", 0.01, "Variance of the runtime of the module." }

private

Definition at line 69 of file CPUCruncher.h.

◆ MAX_INPUTS

const uint CPUCruncher::MAX_INPUTS = 40

private

Definition at line 81 of file CPUCruncher.h.

◆ MAX_OUTPUTS

const uint CPUCruncher::MAX_OUTPUTS = 10

private

Definition at line 82 of file CPUCruncher.h.

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

GaudiHive/src/CPUCruncher.h
GaudiHive/src/CPUCruncher.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CHM

Constructor & Destructor Documentation

◆ CPUCruncher() [1/3]

◆ ~CPUCruncher()

◆ CPUCruncher() [2/3]

◆ CPUCruncher() [3/3]

Member Function Documentation

◆ declareRuntimeRequestedOutputs()

◆ execute()

◆ finalize()

◆ get_runtime()

◆ initialize()

◆ isClonable()

◆ operator=()

Member Data Documentation

◆ m_avg_runtime

◆ m_crunchSvc

◆ m_declAugmented

◆ m_failNEvents

◆ m_inpKeys

◆ m_inputHandles

◆ m_invertCFD

◆ m_loader

◆ m_local_rndm_gen

◆ m_name_ncopies_map

◆ m_nParallel

◆ m_outKeys

◆ m_outputHandles

◆ m_rwRepetitions

◆ m_sleepFraction

◆ m_var_runtime

◆ MAX_INPUTS

◆ MAX_OUTPUTS