#include <AthenaMPToolBase.h>

Inheritance diagram for AthenaMPToolBase:

Collaboration diagram for AthenaMPToolBase:

Public Member Functions
	AthenaMPToolBase (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~AthenaMPToolBase () override

virtual StatusCode	initialize () override

virtual StatusCode	finalize () override

virtual StatusCode wait_once	ATLAS_NOT_THREAD_SAFE (pid_t &pid) override

virtual void	reportSubprocessStatuses () override

virtual AthenaMP::AllWorkerOutputs_ptr	generateOutputReport () override

virtual void	useFdsRegistry (std::shared_ptr< AthenaInterprocess::FdsRegistry >) override

virtual void	setRandString (const std::string &randStr) override

virtual void	killChildren () override

virtual std::unique_ptr< AthenaInterprocess::ScheduledWork > virtual operator() ATLAS_NOT_THREAD_SAFE(const AthenaInterprocess std::unique_ptr< AthenaInterprocess::ScheduledWork >	bootstrap_func ()=0

virtual std::unique_ptr< AthenaInterprocess::ScheduledWork >	exec_func ()=0

virtual std::unique_ptr< AthenaInterprocess::ScheduledWork >	fin_func ()=0

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

virtual int makePool	ATLAS_NOT_THREAD_SAFE (int maxevt, int nprocs, const std::string &topdir)=0

virtual StatusCode exec	ATLAS_NOT_THREAD_SAFE ()=0

virtual void	subProcessLogs (std::vector< std::string > &)=0

virtual std::unique_ptr< ScheduledWork >	operator () ATLAS_NOT_THREAD_SAFE(const ScheduledWork &)=0

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Types
enum	ESRange_Status { ESRANGE_SUCCESS, ESRANGE_NOTFOUND, ESRANGE_SEEKFAILED, ESRANGE_PROCFAILED, ESRANGE_FILENOTMADE, ESRANGE_BADINPFILE }

enum	Func_Flag { FUNC_BOOTSTRAP, FUNC_EXEC, FUNC_FIN }

Protected Member Functions
int mapAsyncFlag	ATLAS_NOT_THREAD_SAFE (Func_Flag flag, pid_t pid=0)

int	redirectLog (const std::string &rundir, bool addTimeStamp=true)

int	updateIoReg (const std::string &rundir)

std::string	fmterror (int errnum)

int	reopenFds ()

int	handleSavedPfc (const std::filesystem::path &dest_path)

void	waitForSignal ()

IEvtSelector *	evtSelector ()

void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Protected Attributes
int	m_nprocs

std::string	m_subprocTopDir

std::string	m_subprocDirPrefix

std::string	m_evtSelName

AthenaInterprocess::ProcessGroup *	m_processGroup

ServiceHandle< IEventProcessor >	m_evtProcessor

ServiceHandle< IAppMgrUI >	m_appMgr

ServiceHandle< IFileMgr >	m_fileMgr

ServiceHandle< IIoComponentMgr >	m_ioMgr

SmartIF< IEvtSelector >	m_evtSelector

std::string	m_fileMgrLog

std::shared_ptr< AthenaInterprocess::FdsRegistry >	m_fdsRegistry

std::string	m_randStr

Gaudi::Property< bool >	m_isPileup {this, "IsPileup", false, "Flag for configuring PileUpEventLoopMgr"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	AthenaMPToolBase ()

	AthenaMPToolBase (const AthenaMPToolBase &)

AthenaMPToolBase &	operator= (const AthenaMPToolBase &)

int	reopenFd (int fd, const std::string &name)

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 22 of file AthenaMPToolBase.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ ESRange_Status

enum AthenaMPToolBase::ESRange_Status

protected

Enumerator
ESRANGE_SUCCESS
ESRANGE_NOTFOUND
ESRANGE_SEEKFAILED
ESRANGE_PROCFAILED
ESRANGE_FILENOTMADE
ESRANGE_BADINPFILE

Definition at line 56 of file AthenaMPToolBase.h.

                       {
     ESRANGE_SUCCESS
     , ESRANGE_NOTFOUND
     , ESRANGE_SEEKFAILED
     , ESRANGE_PROCFAILED
     , ESRANGE_FILENOTMADE
     , ESRANGE_BADINPFILE
   };

◆ Func_Flag

enum AthenaMPToolBase::Func_Flag

protected

Enumerator
FUNC_BOOTSTRAP
FUNC_EXEC
FUNC_FIN

Definition at line 65 of file AthenaMPToolBase.h.

                  {
     FUNC_BOOTSTRAP
     , FUNC_EXEC
     , FUNC_FIN
   };

Constructor & Destructor Documentation

◆ AthenaMPToolBase() [1/3]

AthenaMPToolBase::AthenaMPToolBase	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 32 of file AthenaMPToolBase.cxx.

   : AthAlgTool(type,name,parent)
   , m_nprocs(-1)
   , m_subprocTopDir("")
   , m_subprocDirPrefix("")     // To be set in the derived classes
   , m_evtSelName("")
   , m_processGroup(0)
   , m_evtProcessor("AthenaEventLoopMgr",name)
   , m_appMgr("ApplicationMgr",name)
   , m_fileMgr("FileMgr",name)
   , m_ioMgr("IoComponentMgr",name)
   , m_evtSelector(0)
   , m_fileMgrLog("")
 {
   declareInterface<IAthenaMPTool>(this);
 }

◆ ~AthenaMPToolBase()

AthenaMPToolBase::~AthenaMPToolBase ( )

overridevirtual

Definition at line 51 of file AthenaMPToolBase.cxx.

52 {

53 }

◆ AthenaMPToolBase() [2/3]

AthenaMPToolBase::AthenaMPToolBase ( )

private

◆ AthenaMPToolBase() [3/3]

AthenaMPToolBase::AthenaMPToolBase ( const AthenaMPToolBase & )

private

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/4]

virtual StatusCode exec IAthenaMPTool::ATLAS_NOT_THREAD_SAFE ( )

pure virtualinherited

Implemented in EvtRangeProcessor, SharedEvtQueueConsumer, SharedHiveEvtQueueConsumer, EvtRangeScatterer, SharedEvtQueueProvider, SharedWriterTool, and EvtRangeProcessor.

◆ ATLAS_NOT_THREAD_SAFE() [2/4]

int mapAsyncFlag AthenaMPToolBase::ATLAS_NOT_THREAD_SAFE	(	Func_Flag	flag,
		pid_t	pid = `0`
	)

protected

◆ ATLAS_NOT_THREAD_SAFE() [3/4]

virtual int makePool IAthenaMPTool::ATLAS_NOT_THREAD_SAFE	(	int	maxevt,
		int	nprocs,
		const std::string &	topdir
	)

pure virtualinherited

Implemented in EvtRangeProcessor, SharedEvtQueueConsumer, SharedHiveEvtQueueConsumer, EvtRangeScatterer, SharedEvtQueueProvider, and SharedWriterTool.

◆ ATLAS_NOT_THREAD_SAFE() [4/4]

virtual StatusCode wait_once AthenaMPToolBase::ATLAS_NOT_THREAD_SAFE ( pid_t & pid )

overridevirtual

Implements IAthenaMPTool.

Reimplemented in EvtRangeProcessor, SharedEvtQueueConsumer, and SharedHiveEvtQueueConsumer.

◆ bootstrap_func()

virtual std::unique_ptr<AthenaInterprocess::ScheduledWork> virtual operator () ATLAS_NOT_THREAD_SAFE ( const AthenaInterprocess std::unique_ptr<AthenaInterprocess::ScheduledWork> AthenaMPToolBase::bootstrap_func ( )

pure virtual

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtSelector()

IEvtSelector* AthenaMPToolBase::evtSelector ( )

inlineprotected

Definition at line 81 of file AthenaMPToolBase.h.

81 { return m_evtSelector; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ exec_func()

virtual std::unique_ptr<AthenaInterprocess::ScheduledWork> AthenaMPToolBase::exec_func ( )

pure virtual

Implemented in EvtRangeProcessor, SharedEvtQueueConsumer, SharedHiveEvtQueueConsumer, EvtRangeScatterer, SharedEvtQueueProvider, and SharedWriterTool.

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ fin_func()

virtual std::unique_ptr<AthenaInterprocess::ScheduledWork> AthenaMPToolBase::fin_func ( )

pure virtual

Implemented in EvtRangeProcessor, SharedEvtQueueConsumer, SharedHiveEvtQueueConsumer, EvtRangeScatterer, SharedEvtQueueProvider, and SharedWriterTool.

◆ finalize()

StatusCode AthenaMPToolBase::finalize ( )

overridevirtual

Reimplemented in EvtRangeProcessor, SharedEvtQueueConsumer, SharedHiveEvtQueueConsumer, EvtRangeScatterer, and SharedWriterTool.

Definition at line 99 of file AthenaMPToolBase.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ fmterror()

std::string AthenaMPToolBase::fmterror ( int errnum )

protected

Definition at line 358 of file AthenaMPToolBase.cxx.

 {
   char buf[256];
   strerror_r(errnum, buf, sizeof(buf));
   return std::string(buf);
 }

◆ generateOutputReport()

AthenaMP::AllWorkerOutputs_ptr AthenaMPToolBase::generateOutputReport ( )

overridevirtual

Implements IAthenaMPTool.

Reimplemented in EvtRangeProcessor, EvtRangeScatterer, SharedEvtQueueProvider, and SharedWriterTool.

Definition at line 131 of file AthenaMPToolBase.cxx.

 {
   AthenaMP::AllWorkerOutputs_ptr jobOutputs(new AthenaMP::AllWorkerOutputs());
  
   if(m_fileMgrLog.empty()) {
     ATH_MSG_WARNING(name() << " cannot make output report because FileMgr has not been configured to write log file!");
   }
   else {
     // Collect output files made by the workers
     std::string line;
     for(int i=0;i<m_nprocs;++i) {
       // Get the name of FileMgr log
       std::ostringstream workindex;
       workindex<<i;
       std::filesystem::path logFilePath(m_subprocTopDir);
       logFilePath /= std::filesystem::path(m_subprocDirPrefix+workindex.str());
       std::filesystem::path logFile(logFilePath);
       logFile /= std::filesystem::path(m_fileMgrLog);
       if(!(std::filesystem::exists(logFile)&&std::filesystem::is_regular_file(logFile))) {
         ATH_MSG_WARNING(logFile.string() << " either does not exist or is not a regular file. Skipping");
         continue;
       }
  
       ATH_MSG_DEBUG("FileMgr log file (" << i << ") " << logFile);
  
       std::ifstream inpStream(logFile.string().c_str());
       std::set<std::string> reportedFiles; // Don't report the same file twice
       while(!inpStream.eof()) {
     std::getline(inpStream,line);
         if(line.find("WRITE")!=std::string::npos) {
           // Parse the entry
           size_t startpos(0);
       std::vector<std::string> entries;
           while(startpos<line.size()) {
             while(line[startpos]==' ')
               startpos++;
  
             size_t endpos = line.find(' ',startpos);
             if(endpos==std::string::npos) endpos = line.size();
             entries.push_back(line.substr(startpos,endpos-startpos));
             startpos=endpos+1;
           }
  
           // enties[0] is filename
       std::filesystem::path filenamePath(entries[0]);
       std::filesystem::path basename = filenamePath.filename();
           if(reportedFiles.find(basename.string())==reportedFiles.end())
             reportedFiles.insert(basename.string());
           else
             continue;
       std::filesystem::path absolutename = basename.is_absolute() ? basename : std::filesystem::absolute(std::filesystem::path(logFilePath)/=basename);
       AthenaMP::AllWorkerOutputsIterator it1 = jobOutputs->find(basename.string());
           if(it1==jobOutputs->end()) {
             (*jobOutputs)[basename.string()] = AthenaMP::SingleWorkerOutputs();
             (*jobOutputs)[basename.string()].reserve(m_nprocs);
           }
  
       AthenaMP::WorkerOutput newOutput;
           newOutput.filename = absolutename.string();
           newOutput.technology = entries[1];
           newOutput.description = entries[2];
           newOutput.access_mode = entries[3];
           newOutput.shared = (line.find("SHARED")!=std::string::npos);
  
           (*jobOutputs)[basename.string()].push_back(newOutput);
         }
       }
     }
   }
   return jobOutputs;
 }

◆ handleSavedPfc()

int AthenaMPToolBase::handleSavedPfc ( const std::filesystem::path & dest_path )

protected

Definition at line 421 of file AthenaMPToolBase.cxx.

 {
   if(std::filesystem::is_regular_file("PoolFileCatalog.xml.AthenaMP-saved"))
     COPY_FILE_HACK("PoolFileCatalog.xml.AthenaMP-saved",dest_path.string()+"/PoolFileCatalog.xml");
   return 0;
 }

◆ initialize()

StatusCode AthenaMPToolBase::initialize ( )

overridevirtual

Reimplemented in EvtRangeProcessor, SharedEvtQueueConsumer, SharedHiveEvtQueueConsumer, EvtRangeScatterer, and SharedWriterTool.

Definition at line 55 of file AthenaMPToolBase.cxx.

 {
   ATH_MSG_DEBUG("In initialize");
  
   if(m_isPileup) {
     m_evtProcessor = ServiceHandle<IEventProcessor>("PileUpEventLoopMgr",name());
     ATH_MSG_INFO("The job running in pileup mode");
   }
   else {
     ATH_MSG_INFO("The job running in non-pileup mode");
   }
  
   ATH_CHECK(m_evtProcessor.retrieve());
   ATH_CHECK(m_appMgr.retrieve());
  
   SmartIF<IProperty> prpMgr(serviceLocator());
   if(prpMgr.isValid()) {
     // Get event selector name. Retrieve EventSelector and EventSeek
     m_evtSelName = prpMgr->getProperty("EvtSel").toString();
     // If the job runs with no event selector, then the name will be empty
     if(!m_evtSelName.empty()) {
       m_evtSelector = serviceLocator()->service(m_evtSelName);
       ATH_CHECK(m_evtSelector.isValid());
     }
   }
   else {
     ATH_MSG_ERROR("IProperty interface not found in ApplicationMgr");
     return StatusCode::FAILURE;
   }
  
   ATH_CHECK(m_fileMgr.retrieve());
  
   SmartIF<IProperty> prpMgr1(m_fileMgr.get());
   if(prpMgr1.isValid()) {
     m_fileMgrLog = prpMgr1->getProperty("LogFile").toString();
   }
   else {
     ATH_MSG_ERROR("IProperty interface not found in FileMgr");
     return StatusCode::FAILURE;
   }
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

static const InterfaceID& IAthenaMPTool::interfaceID ( )

inlinestaticinherited

Definition at line 36 of file IAthenaMPTool.h.

36 { return IID_IAthenaMPTool; }

◆ killChildren()

void AthenaMPToolBase::killChildren ( )

overridevirtual

Implements IAthenaMPTool.

Definition at line 213 of file AthenaMPToolBase.cxx.

 {
   for(const AthenaInterprocess::Process& child : m_processGroup->getChildren()) {
     kill(child.getProcessID(),SIGKILL);
   }
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ operator()

virtual std::unique_ptr<ScheduledWork> AthenaInterprocess::IMessageDecoder::operator ( ) const &

pure virtualinherited

◆ operator=()

AthenaMPToolBase& AthenaMPToolBase::operator= ( const AthenaMPToolBase & )

private

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ redirectLog()

int AthenaMPToolBase::redirectLog	(	const std::string &	rundir,
		bool	addTimeStamp = `true`
	)

protected

Definition at line 281 of file AthenaMPToolBase.cxx.

 {
   // Redirect both stdout and stderr to the same file AthenaMP.log
   int dup2result1(0), dup2result2(0);
  
   int newout = open(std::string(rundir+"/AthenaMP.log").c_str(),O_CREAT | O_RDWR, S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH);
   if(newout==-1) {
     ATH_MSG_ERROR("Unable to open log file in the run directory. " << fmterror(errno));
     return -1;
   }
   dup2result1 = dup2(newout, STDOUT_FILENO);
   dup2result2 = dup2(newout, STDERR_FILENO);
   TEMP_FAILURE_RETRY(close(newout));
   if(dup2result1==-1) {
     ATH_MSG_ERROR("Unable to redirect standard output. " << fmterror(errno));
     return -1;
   }
   if(dup2result2==-1) {
     ATH_MSG_ERROR("Unable to redirect standard error. " << fmterror(errno));
     return -1;
   }
  
   if(addTimeStamp) {
     SmartIF<IProperty> propertyServer(msgSvc());
     if(propertyServer==0) {
       ATH_MSG_ERROR("Unable to cast message svc to IProperty");
       return -1;
     }
  
     std::string propertyName("Format");
     std::string oldFormat("");
     StringProperty formatProp(propertyName,oldFormat);
     StatusCode sc = propertyServer->getProperty(&formatProp);
     if(sc.isFailure()) {
       ATH_MSG_WARNING("Message Service does not have Format property");
     }
     else {
       oldFormat = formatProp.value();
       if(oldFormat.find("%t")==std::string::npos) {
     // Add time stamps
     std::string newFormat("%t " + oldFormat);
     StringProperty newFormatProp(propertyName,newFormat);
     if(propertyServer->setProperty(newFormatProp).isFailure()) {
       ATH_MSG_ERROR("Unable to set new Format property on the Message Service");
       return -1;
     }
       }
       else {
     ATH_MSG_DEBUG("MsgSvc format already contains timestamps. Nothing to be done");
       }
     }
   }
  
   return 0;
 }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ reopenFd()

int AthenaMPToolBase::reopenFd	(	int	fd,
		const std::string &	name
	)

private

Definition at line 444 of file AthenaMPToolBase.cxx.

 {
   ATH_MSG_DEBUG("Attempting to reopen descriptor for " << name);
   int old_openflags = fcntl(fd,F_GETFL,0);
   switch(old_openflags & O_ACCMODE) {
   case O_RDONLY: {
     ATH_MSG_DEBUG("The File Access Mode is RDONLY");
     break;
   }
   case O_WRONLY: {
     ATH_MSG_DEBUG("The File Access Mode is WRONLY");
     break;
   }
   case O_RDWR: {
     ATH_MSG_DEBUG("The File Access Mode is RDWR");
     break;
   }
   }
    
   int old_descflags = fcntl(fd,F_GETFD,0);
   off_t oldpos = lseek(fd,0,SEEK_CUR);
   if(oldpos==-1) {
     if(errno==ESPIPE) {
       ATH_MSG_WARNING("Dealing with PIPE. Skipping ... (FIXME!)");
     }
     else {
       ATH_MSG_ERROR("When re-opening file descriptors lseek failed on " << name << ". " << fmterror(errno));
       return -1;
     }
   }
   else {
     Io::Fd newfd = open(name.c_str(),old_openflags);
     if(newfd==-1) {
       ATH_MSG_ERROR("When re-opening file descriptors unable to open " << name << " for reading. " << fmterror(errno));
       return -1;
     }
     if(lseek(newfd,oldpos,SEEK_SET)==-1){
       ATH_MSG_ERROR("When re-opening file descriptors lseek failed on the newly opened " << name << ". " << fmterror(errno));
       TEMP_FAILURE_RETRY(close(newfd));
       return -1;
     }
     TEMP_FAILURE_RETRY(close(fd));
     if(dup2(newfd,fd)==-1) {
       ATH_MSG_ERROR("When re-opening file descriptors unable to duplicate descriptor for " << name << ". " << fmterror(errno));
       TEMP_FAILURE_RETRY(close(newfd));
       return -1;
     }
     if(fcntl(fd,F_SETFD,old_descflags)==-1) {
       ATH_MSG_ERROR("When re-opening file descriptors unable to set descriptor flags for " << name << ". " << fmterror(errno));
       TEMP_FAILURE_RETRY(close(newfd));
       return -1;
     }
     TEMP_FAILURE_RETRY(close(newfd));
   }
   return 0;
 }

◆ reopenFds()

int AthenaMPToolBase::reopenFds ( )

protected

Definition at line 365 of file AthenaMPToolBase.cxx.

 {
   // Reopen file descriptors.
   // First go over all open files, which have been registered with the FileMgr
   // Then also check the FdsRegistry, in case it contains some files not registered with the FileMgr
   std::set<int> fdLog;
   
   // Query the FileMgr contents
   std::vector<const Io::FileAttr*> filemgrFiles;
   std::vector<const Io::FileAttr*>::const_iterator itFile;
   unsigned filenum = m_fileMgr->getFiles(filemgrFiles); // Get attributes for open files only. We don't care about closed ones at this point
   if(filenum!=filemgrFiles.size())
     ATH_MSG_WARNING("getFiles returned " << filenum << " while vector size is " << filemgrFiles.size());
   
   for(itFile=filemgrFiles.begin();itFile!=filemgrFiles.end();++itFile) {
     ATH_MSG_DEBUG("* " << **itFile);
     const std::string& filename = (**itFile).name();
     Io::Fd fd = (**itFile).fd();
  
     if(fd==-1) {
       // It is legal to have fd=-1 for remote inputs
       // On the other hand, these inputs should not remain open after fork. The issue being tracked at ATEAM-434.
       // So, this hopefully is a temporary patch
       ATH_MSG_WARNING("FD=-1 detected on an open file retrieved from FileMgr. Skip FD reopening. File name: " << filename);
       continue;
     }
     
     if(reopenFd(fd,filename))
       return -1;
     
     fdLog.insert(fd);
   }
   
   // Check the FdsRegistry
   for(const AthenaInterprocess::FdsRegistryEntry& regEntry : *m_fdsRegistry) {
     if(fdLog.find(regEntry.fd)!=fdLog.end()) {
       ATH_MSG_DEBUG("The file from FdsRegistry " << regEntry.name << " was registered with FileMgr. Skip reopening");
     }
     else {
       ATH_MSG_WARNING("The file " << regEntry.name << " has not been registered with the FileMgr!");
       
       if(regEntry.fd==-1) {
       // Same protection as the one above
     ATH_MSG_WARNING("FD=-1 detected on an open file retrieved from FD Registry. Skip FD reopening. File name: " << regEntry.name);
     continue;
       }
  
       if(reopenFd(regEntry.fd,regEntry.name))
         return -1;
       
       fdLog.insert(regEntry.fd);
     }
   }
   return 0;
 }

◆ reportSubprocessStatuses()

void AthenaMPToolBase::reportSubprocessStatuses ( )

overridevirtual

Implements IAthenaMPTool.

Reimplemented in EvtRangeProcessor, SharedEvtQueueConsumer, and SharedHiveEvtQueueConsumer.

Definition at line 123 of file AthenaMPToolBase.cxx.

 {
   ATH_MSG_INFO("Statuses of sub-processes");
   const std::vector<AthenaInterprocess::ProcessStatus>& statuses = m_processGroup->getStatuses();
   for(size_t i=0; i<statuses.size(); ++i)
     ATH_MSG_INFO("*** Process PID=" << statuses[i].pid << ". Status " << ((statuses[i].exitcode)?"FAILURE":"SUCCESS"));
 }

◆ setRandString()

void AthenaMPToolBase::setRandString ( const std::string & randStr )

overridevirtual

Implements IAthenaMPTool.

Definition at line 208 of file AthenaMPToolBase.cxx.

 {
   m_randStr = randStr;
 }

◆ subProcessLogs()

virtual void IAthenaMPTool::subProcessLogs ( std::vector< std::string > & )

pure virtualinherited

Implemented in EvtRangeProcessor, SharedEvtQueueConsumer, SharedHiveEvtQueueConsumer, EvtRangeScatterer, SharedEvtQueueProvider, and SharedWriterTool.

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateIoReg()

int AthenaMPToolBase::updateIoReg ( const std::string & rundir )

protected

Definition at line 337 of file AthenaMPToolBase.cxx.

 {
   if (!m_ioMgr.retrieve().isSuccess()) {
     ATH_MSG_ERROR("Error retrieving IoComponentMgr");
     return -1;
   } else {
     ATH_MSG_DEBUG("Successfully retrieved IoComponentMgr");
   }
  
   // update the IoRegistry for the new workdir - make sure we use absolute path
   std::filesystem::path abs_rundir = std::filesystem::absolute(rundir);
   if(!m_ioMgr->io_update_all(abs_rundir.string()).isSuccess()) {
     ATH_MSG_ERROR("Error updating IoRegistry");
     return -1;
   } else {
     ATH_MSG_DEBUG("Successfully updated IoRegistry");
   }
  
   return 0;
 }

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

◆ useFdsRegistry()

void AthenaMPToolBase::useFdsRegistry ( std::shared_ptr< AthenaInterprocess::FdsRegistry > registry )

overridevirtual

Implements IAthenaMPTool.

Definition at line 203 of file AthenaMPToolBase.cxx.

 {
   m_fdsRegistry = registry;
 }

◆ waitForSignal()

void AthenaMPToolBase::waitForSignal ( )

protected

Definition at line 428 of file AthenaMPToolBase.cxx.

 {
   ATH_MSG_INFO("Bootstrap worker PID " << getpid() << " - waiting for SIGUSR1");
   sigset_t mask, oldmask;
   
   signal(SIGUSR1, AthenaMPToolBase_d::pauseForDebug);
   
   sigemptyset (&mask);
   sigaddset (&mask, SIGUSR1);
   
   sigprocmask (SIG_BLOCK, &mask, &oldmask);
   while (!AthenaMPToolBase_d::sig_done)
     sigsuspend (&oldmask);
   sigprocmask (SIG_UNBLOCK, &mask, NULL);
 }

Member Data Documentation

◆ m_appMgr

ServiceHandle<IAppMgrUI> AthenaMPToolBase::m_appMgr

protected

Definition at line 91 of file AthenaMPToolBase.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtProcessor

ServiceHandle<IEventProcessor> AthenaMPToolBase::m_evtProcessor

protected

Definition at line 90 of file AthenaMPToolBase.h.

◆ m_evtSelector

SmartIF<IEvtSelector> AthenaMPToolBase::m_evtSelector

protected

Definition at line 94 of file AthenaMPToolBase.h.

◆ m_evtSelName

std::string AthenaMPToolBase::m_evtSelName

protected

Definition at line 86 of file AthenaMPToolBase.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_fdsRegistry

std::shared_ptr<AthenaInterprocess::FdsRegistry> AthenaMPToolBase::m_fdsRegistry

protected

Definition at line 96 of file AthenaMPToolBase.h.

◆ m_fileMgr

ServiceHandle<IFileMgr> AthenaMPToolBase::m_fileMgr

protected

Definition at line 92 of file AthenaMPToolBase.h.

◆ m_fileMgrLog

std::string AthenaMPToolBase::m_fileMgrLog

protected

Definition at line 95 of file AthenaMPToolBase.h.

◆ m_ioMgr

ServiceHandle<IIoComponentMgr> AthenaMPToolBase::m_ioMgr

protected

Definition at line 93 of file AthenaMPToolBase.h.

◆ m_isPileup

Gaudi::Property<bool> AthenaMPToolBase::m_isPileup {this, "IsPileup", false, "Flag for configuring PileUpEventLoopMgr"}

protected

Definition at line 99 of file AthenaMPToolBase.h.

◆ m_nprocs

int AthenaMPToolBase::m_nprocs

protected

Definition at line 83 of file AthenaMPToolBase.h.

◆ m_processGroup

AthenaInterprocess::ProcessGroup* AthenaMPToolBase::m_processGroup

protected

Definition at line 88 of file AthenaMPToolBase.h.

◆ m_randStr

std::string AthenaMPToolBase::m_randStr

protected

Definition at line 97 of file AthenaMPToolBase.h.

◆ m_subprocDirPrefix

std::string AthenaMPToolBase::m_subprocDirPrefix

protected

Definition at line 85 of file AthenaMPToolBase.h.

◆ m_subprocTopDir

std::string AthenaMPToolBase::m_subprocTopDir

protected

Definition at line 84 of file AthenaMPToolBase.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ ESRange_Status

◆ Func_Flag

Constructor & Destructor Documentation

◆ AthenaMPToolBase() [1/3]

◆ ~AthenaMPToolBase()

◆ AthenaMPToolBase() [2/3]

◆ AthenaMPToolBase() [3/3]

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/4]

◆ ATLAS_NOT_THREAD_SAFE() [2/4]

◆ ATLAS_NOT_THREAD_SAFE() [3/4]

◆ ATLAS_NOT_THREAD_SAFE() [4/4]

◆ bootstrap_func()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtSelector()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ exec_func()

◆ extraDeps_update_handler()

◆ fin_func()

◆ finalize()

◆ fmterror()

◆ generateOutputReport()

◆ handleSavedPfc()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ killChildren()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator()

◆ operator=()

◆ outputHandles()

◆ redirectLog()

◆ renounce()

◆ renounceArray()

◆ reopenFd()

◆ reopenFds()

◆ reportSubprocessStatuses()

◆ setRandString()

◆ subProcessLogs()

◆ sysInitialize()

◆ sysStart()

◆ updateIoReg()

◆ updateVHKA()

◆ useFdsRegistry()

◆ waitForSignal()

Member Data Documentation

◆ m_appMgr

◆ m_detStore

◆ m_evtProcessor

◆ m_evtSelector

◆ m_evtSelName

◆ m_evtStore

◆ m_fdsRegistry

◆ m_fileMgr

◆ m_fileMgrLog