This class provides the IPCTool for SharedMemory objects. More...

#include <AthenaSharedMemoryTool.h>

Inheritance diagram for AthenaSharedMemoryTool:

Collaboration diagram for AthenaSharedMemoryTool:

Public Member Functions
	AthenaSharedMemoryTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Service Constructor. More...

virtual	~AthenaSharedMemoryTool ()
	Destructor. More...

StatusCode	initialize ()
	Gaudi Service Interface method implementations: More...

StatusCode	stop ()

StatusCode	finalize ()

StatusCode	makeServer (int num, const std::string &streamPortSuffix)

bool	isServer () const

StatusCode	makeClient (int num, std::string &streamPortSuffix)

bool	isClient () const

StatusCode putEvent	ATLAS_NOT_THREAD_SAFE (long eventNumber, const void *source, size_t nbytes, unsigned int status) const

StatusCode	getLockedEvent (void **target, unsigned int &status) const

StatusCode	lockEvent (long eventNumber) const

StatusCode	putObject (const void *source, size_t nbytes, int num=0)

StatusCode	getObject (void **target, size_t &nbytes, int num=0)

StatusCode	clearObject (const char **tokenString, int &num)

StatusCode	lockObject (const char *tokenString, int num=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

	DeclareInterfaceID (IAthenaIPCTool, 1, 0)

Protected Member Functions
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...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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
StringProperty	m_sharedMemory

const size_t	m_maxSize

const int	m_maxDataClients

int	m_num

int	m_lastClient

std::set< int >	m_dataClients

boost::interprocess::mapped_region *	m_payload

boost::interprocess::mapped_region *	m_status

long	m_fileSeqNumber

bool	m_isServer

bool	m_isClient

ServiceHandle< IIncidentSvc >	m_incidentSvc

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

This class provides the IPCTool for SharedMemory objects.

Definition at line 33 of file AthenaSharedMemoryTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ AthenaSharedMemoryTool()

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

Standard Service Constructor.

Definition at line 37 of file AthenaSharedMemoryTool.cxx.

                               : AthAlgTool(type, name, parent),
         m_maxSize(64 * 1024 * 1024),
         m_maxDataClients(256),
         m_num(-1),
         m_lastClient(-1),
         m_dataClients(),
         m_payload(nullptr),
         m_status(nullptr),
         m_fileSeqNumber(0),
         m_isServer(false),
         m_isClient(false),
         m_incidentSvc("IncidentSvc", name) {
    declareProperty("SharedMemoryName", m_sharedMemory = name);
    declareInterface<IAthenaIPCTool>(this);
 }

◆ ~AthenaSharedMemoryTool()

AthenaSharedMemoryTool::~AthenaSharedMemoryTool ( )

virtual

Destructor.

Definition at line 56 of file AthenaSharedMemoryTool.cxx.

                                                 {
    delete m_payload; m_payload = nullptr;
    delete m_status; m_status = nullptr;
 }

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE()

StatusCode putEvent AthenaSharedMemoryTool::ATLAS_NOT_THREAD_SAFE	(	long	eventNumber,
		const void *	source,
		size_t	nbytes,
		unsigned int	status
	)		const

virtual

Implements IAthenaIPCTool.

◆ clearObject()

StatusCode AthenaSharedMemoryTool::clearObject	(	const char **	tokenString,
		int &	num
	)

virtual

Implements IAthenaIPCTool.

Definition at line 393 of file AthenaSharedMemoryTool.cxx.

                                                                                  {
    if (m_isClient) {
       ShareEventHeader* evtH = static_cast<ShareEventHeader*>(m_status->get_address());
       if (evtH->evtProcessStatus != ShareEventHeader::CLEARED) {
          ATH_MSG_DEBUG("Waiting for FILL clearObject");
          return(StatusCode::RECOVERABLE);
       }
       *tokenString = evtH->token;
       evtH->evtProcessStatus = ShareEventHeader::UNLOCKED;
       return(StatusCode::SUCCESS);
    }
  
    for (int i = 1; i <= m_num; i++) { // FIXME: PvG, do round robin
       void* status = static_cast<char*>(m_status->get_address()) + i * sizeof(ShareEventHeader);
       ShareEventHeader* evtH = static_cast<ShareEventHeader*>(status);
       ShareEventHeader::ProcessStatus evtStatus = evtH->evtProcessStatus; // read only once
       if (evtStatus == ShareEventHeader::FILLED || evtStatus == ShareEventHeader::SHARED) {
          ATH_MSG_DEBUG("Waiting for UNFILL clearObject, client = " << i);
          return(StatusCode::RECOVERABLE);
       } else if (i == num && evtStatus != ShareEventHeader::LOCKED) {
          ATH_MSG_DEBUG("Waiting for LOCK clearObject, client = " << i);
          return(StatusCode::RECOVERABLE);
       }
       if (m_lastClient < 0 || m_lastClient == i) { // If Writer is not yet released, only consider last client
          if ((i == num || num < 0) && evtStatus == ShareEventHeader::LOCKED) {
             *tokenString = evtH->token;
             num = i;
             ATH_MSG_DEBUG("Setting LOCK clearObject, for client = " << num << ": " << evtH->token);
             m_lastClient = -1;
            // break;
          }
       }
    }
  
    if (num > 0 && *tokenString != nullptr) {
       m_lastClient = -1; // Release Writer from last client
       void* status = static_cast<char*>(m_status->get_address()) + num * sizeof(ShareEventHeader);
       ShareEventHeader* evtH = static_cast<ShareEventHeader*>(status);
       if (strncmp(*tokenString, "wait", 4) == 0) {
          ATH_MSG_INFO("Server clearObject() got wait, client = " << num);
          evtH->evtProcessStatus = ShareEventHeader::UNLOCKED;
          m_lastClient = num; // Keep Writer allocated
          num = -1;
          return(StatusCode::SUCCESS);
       }
       if (strncmp(*tokenString, "release", 7) == 0) {
          ATH_MSG_INFO("Server clearObject() got release, client = " << num);
          evtH->evtProcessStatus = ShareEventHeader::UNLOCKED;
          num = -1;
          return(StatusCode::SUCCESS);
       }
       if (strncmp(*tokenString, "start", 5) == 0) {
          ATH_MSG_INFO("Server clearObject() got start, client = " << num << ", of " << m_num - 1);
          if (m_dataClients.empty()) { // Annouce all workers to prevent early writer termination
             for (int i = 1; i < m_num - 1; i++) m_dataClients.insert(i);
          }
          m_dataClients.insert(num);
          evtH->evtProcessStatus = ShareEventHeader::UNLOCKED;
          num = -1;
          return(StatusCode::SUCCESS);
       }
       if (strncmp(*tokenString, "stop", 4) == 0) {
          ATH_MSG_INFO("Server clearObject() got stop, client = " << num);
          m_dataClients.erase(num);
          evtH->evtProcessStatus = ShareEventHeader::UNLOCKED;
          if (m_dataClients.empty()) {
             ATH_MSG_INFO("Server clearObject() got stop, client ALL: " << m_num);
             if (num == m_num - 1) { // mother process
               return(StatusCode::SUCCESS);
             }
             return(StatusCode::FAILURE);
          }
          num = -1;
          return(StatusCode::SUCCESS);
       }
       evtH->evtSize = 0;
       m_status->flush(0, sizeof(ShareEventHeader));
       evtH->evtProcessStatus = ShareEventHeader::CLEARED;
       return(StatusCode::SUCCESS);
    }
    return(StatusCode::RECOVERABLE);
 }

◆ 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);
   }

◆ DeclareInterfaceID()

IAthenaIPCTool::DeclareInterfaceID	(	IAthenaIPCTool	,
		1	,
		0
	)

inherited

◆ 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; }

◆ 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; }

◆ 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

◆ finalize()

StatusCode AthenaSharedMemoryTool::finalize ( )

Definition at line 94 of file AthenaSharedMemoryTool.cxx.

                                             {
    ATH_MSG_INFO("in finalize()");
    if (m_isServer) {
       try {
          boost::interprocess::shared_memory_object::remove(m_sharedMemory.value().c_str());
       } catch(boost::interprocess::interprocess_exception &e) {
          ATH_MSG_WARNING("Cannot remove shared memory " << m_sharedMemory.value() << ": " << boost::diagnostic_information(e));
       }
       const std::string statusName = m_sharedMemory.value() + "_status";
       try {
          boost::interprocess::shared_memory_object::remove(statusName.c_str());
       } catch(boost::interprocess::interprocess_exception &e) {
          ATH_MSG_WARNING("Cannot remove shared memory " << statusName << ": " << boost::diagnostic_information(e));
       }
    }
    // Release IncidentSvc
    if (!m_incidentSvc.release().isSuccess()) {
       ATH_MSG_WARNING("Cannot release IncidentSvc.");
    }
    return(::AthAlgTool::finalize());
 }

◆ getLockedEvent()

StatusCode AthenaSharedMemoryTool::getLockedEvent	(	void **	target,
		unsigned int &	status
	)		const

virtual

Implements IAthenaIPCTool.

Definition at line 258 of file AthenaSharedMemoryTool.cxx.

                                                                                            {
    ShareEventHeader* evtH = static_cast<ShareEventHeader*>(m_status->get_address());
    if (evtH->evtProcessStatus == ShareEventHeader::LOCKED) {
       const std::size_t nbytes = evtH->evtSize;
       if (target != nullptr) {
          char* buf = new char[nbytes];
          std::memcpy(buf, static_cast<char*>(m_payload->get_address()) + evtH->evtOffset, nbytes);
          *target = buf;
       }
       status = evtH->evtCoreStatusFlag;
    } else {
       ATH_MSG_ERROR("No event locked");
       return(StatusCode::FAILURE);
    }
    evtH->evtProcessStatus = ShareEventHeader::UNLOCKED;
    return(StatusCode::SUCCESS);
 }

◆ getObject()

StatusCode AthenaSharedMemoryTool::getObject	(	void **	target,
		size_t &	nbytes,
		int	num = `0`
	)

virtual

Implements IAthenaIPCTool.

Definition at line 346 of file AthenaSharedMemoryTool.cxx.

                                                                                    {
    if (target == nullptr) {
       return(StatusCode::SUCCESS);
    }
    void* status = static_cast<char*>(m_status->get_address()) + num * sizeof(ShareEventHeader);
    ShareEventHeader* evtH = static_cast<ShareEventHeader*>(status);
    ShareEventHeader::ProcessStatus evtStatus = evtH->evtProcessStatus; // read only once
    size_t evtSize = evtH->evtSize; // read only once
    if (evtStatus == ShareEventHeader::PARTIAL && evtH->evtCursor > 0) {
       ATH_MSG_DEBUG("Waiting for UNPARTIAL getObject, client = " << num);
       nbytes = evtH->evtCursor;
       return(StatusCode::RECOVERABLE);
    }
    if (evtStatus != ShareEventHeader::FILLED &&
        evtStatus != ShareEventHeader::SHARED &&
        evtStatus != ShareEventHeader::PARTIAL) {
       ATH_MSG_DEBUG("Waiting for FILLED getObject, client = " << num);
       nbytes = 0;
       return(StatusCode::RECOVERABLE);
    }
    if (evtH->evtCursor < evtSize) {
       std::memcpy(&nbytes, static_cast<char*>(m_payload->get_address()) + evtH->evtCursor, sizeof(size_t));
       evtH->evtCursor += sizeof(size_t);
       *target = static_cast<char*>(m_payload->get_address()) + evtH->evtCursor;
       if (evtStatus != ShareEventHeader::PARTIAL) {
          evtH->evtProcessStatus = ShareEventHeader::SHARED;
       }
       evtH->evtCursor += nbytes;
    } else {
       nbytes = 0;
    }
    if (evtH->evtCursor == evtSize) {
       if (evtH->evtProcessStatus == ShareEventHeader::SHARED) {
          evtH->evtProcessStatus = ShareEventHeader::FILLED;
       } else {
          evtH->evtCursor = 0;
          m_status->flush(num * sizeof(ShareEventHeader), sizeof(ShareEventHeader));
          while (evtH->evtProcessStatus != ShareEventHeader::FILLED) {
             usleep(10);
          }
          evtH->evtProcessStatus = ShareEventHeader::UNLOCKED;
       }
    }
    return(StatusCode::SUCCESS);
 }

◆ initialize()

StatusCode AthenaSharedMemoryTool::initialize ( )

Gaudi Service Interface method implementations:

Definition at line 62 of file AthenaSharedMemoryTool.cxx.

                                               {
    ATH_MSG_INFO("Initializing " << name());
    if (!::AthAlgTool::initialize().isSuccess()) {
       ATH_MSG_FATAL("Cannot initialize AthAlgTool base class.");
       return(StatusCode::FAILURE);
    }
    // Retrieve IncidentSvc
    if (!m_incidentSvc.retrieve().isSuccess()) {
       ATH_MSG_FATAL("Cannot get IncidentSvc");
       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.

◆ isClient()

bool AthenaSharedMemoryTool::isClient ( ) const

virtual

Implements IAthenaIPCTool.

Definition at line 218 of file AthenaSharedMemoryTool.cxx.

                                             {
    return(m_isClient);
 }

◆ isServer()

bool AthenaSharedMemoryTool::isServer ( ) const

virtual

Implements IAthenaIPCTool.

Definition at line 158 of file AthenaSharedMemoryTool.cxx.

                                             {
    return(m_isServer);
 }

◆ lockEvent()

StatusCode AthenaSharedMemoryTool::lockEvent ( long eventNumber ) const

virtual

Implements IAthenaIPCTool.

Definition at line 277 of file AthenaSharedMemoryTool.cxx.

                                                                    {
    ShareEventHeader* evtH = static_cast<ShareEventHeader*>(m_status->get_address());
    if (evtH->evtSeqNumber > eventNumber) {
       ATH_MSG_ERROR("eventNumber = " << eventNumber << ", already processed");
       return(StatusCode::FAILURE);
    }
    if (evtH->evtSeqNumber == 0 && evtH->fileSeqNumber == 0 && evtH->evtSize == 0) {
       ATH_MSG_DEBUG("Server has been terminated");
       return(StatusCode::FAILURE);
    }
    if (evtH->evtSeqNumber != eventNumber || evtH->evtProcessStatus != ShareEventHeader::FILLED) {
       ATH_MSG_DEBUG("Waiting for lockEvent, eventNumber = " << eventNumber);
       return(StatusCode::RECOVERABLE);
    }
    if (evtH->fileSeqNumber != m_fileSeqNumber && m_fileSeqNumber > 0) {
       FileIncident endFileIncident(name(), "EndInputFile", "SHM");
       m_incidentSvc->fireIncident(endFileIncident);
       const_cast<AthenaSharedMemoryTool*>(this)->m_fileSeqNumber = evtH->fileSeqNumber;
       FileIncident beginFileIncident(name(), "BeginInputFile", "SHM");
       m_incidentSvc->fireIncident(beginFileIncident);
    }
    ATH_MSG_DEBUG("Locking eventNumber = " << eventNumber);
    evtH->evtProcessStatus = ShareEventHeader::LOCKED;
    return(StatusCode::SUCCESS);
 }

◆ lockObject()

StatusCode AthenaSharedMemoryTool::lockObject	(	const char *	tokenString,
		int	num = `0`
	)

virtual

Implements IAthenaIPCTool.

Definition at line 477 of file AthenaSharedMemoryTool.cxx.

                                                                               {
    if (strlen(tokenString) >= maxTokenLength) {
       ATH_MSG_ERROR("Token = " << tokenString << ", too long for AthenaSharedMemoryTool");
       return(StatusCode::FAILURE);
    }
    void* status = static_cast<char*>(m_status->get_address()) + num * sizeof(ShareEventHeader);
    ShareEventHeader* evtH = static_cast<ShareEventHeader*>(status);
    if (evtH->evtProcessStatus != ShareEventHeader::UNLOCKED) {
       ATH_MSG_DEBUG("Waiting for UNLOCKED lockObject: " << tokenString);
       return(StatusCode::RECOVERABLE);
    }
    strncpy(evtH->token, tokenString, maxTokenLength - 1); evtH->token[maxTokenLength - 1] = 0;
    if (m_isServer) {
       evtH->evtSize = 0;
       m_status->flush(num * sizeof(ShareEventHeader), sizeof(ShareEventHeader));
       evtH->evtProcessStatus = ShareEventHeader::CLEARED;
    } else {
       m_status->flush(num * sizeof(ShareEventHeader), sizeof(ShareEventHeader));
       evtH->evtProcessStatus = ShareEventHeader::LOCKED;
    }
    return(StatusCode::SUCCESS);
 }

◆ makeClient()

StatusCode AthenaSharedMemoryTool::makeClient	(	int	num,
		std::string &	streamPortSuffix
	)

virtual

Implements IAthenaIPCTool.

Definition at line 163 of file AthenaSharedMemoryTool.cxx.

                                                                                   {
    if (m_isServer) {
       ATH_MSG_ERROR("Cannot make AthenaSharedMemoryTool a Client.");
       return(StatusCode::FAILURE);
    }
    if (num >= m_maxDataClients) {
       ATH_MSG_ERROR("Too many clients for AthenaSharedMemoryTool.");
       return(StatusCode::FAILURE);
    }
    if (m_num > 0 && num <= 0) {// stop running client
       ATH_MSG_DEBUG("Stop AthenaSharedMemoryTool Client.");
       m_num = -1;
       while (lockObject("stop").isRecoverable()) {
          usleep(100);
       }
       ShareEventHeader* evtH = static_cast<ShareEventHeader*>(m_status->get_address());
       while (evtH->evtProcessStatus != ShareEventHeader::UNLOCKED) {
          usleep(100);
       }
       delete m_payload ; m_payload = nullptr;
       delete m_status ; m_status = nullptr;
       m_isClient = false;
       return(StatusCode::SUCCESS);
    }
    while (!m_isClient) {
       try { // Check whether Server created shared memory object
          const std::string statusName = m_sharedMemory.value() + "_status";
          boost::interprocess::shared_memory_object shm_status(boost::interprocess::open_only,
              statusName.c_str(),
              boost::interprocess::read_write);
          m_status = new boost::interprocess::mapped_region(shm_status, boost::interprocess::read_write, num * sizeof(ShareEventHeader), sizeof(ShareEventHeader));
          boost::interprocess::shared_memory_object shm(boost::interprocess::open_only,
              m_sharedMemory.value().c_str(),
              boost::interprocess::read_write);
          m_payload = new boost::interprocess::mapped_region(shm, boost::interprocess::read_write, 0, m_maxSize);
          m_isClient = true;
       } catch (boost::interprocess::interprocess_exception& e) {
          usleep(100000);
       }
    }
    if (m_num <= 0 && num > 0) {
       ShareEventHeader* evtH = static_cast<ShareEventHeader*>(m_status->get_address());
       streamPortSuffix.assign(evtH->token);
       while (lockObject("start").isRecoverable()) {
          usleep(100);
       }
       while (evtH->evtProcessStatus != ShareEventHeader::UNLOCKED) {
          usleep(100);
       }
       m_num = num;
    }
    return(StatusCode::SUCCESS);
 }

◆ makeServer()

StatusCode AthenaSharedMemoryTool::makeServer	(	int	num,
		const std::string &	streamPortSuffix
	)

virtual

Implements IAthenaIPCTool.

Definition at line 117 of file AthenaSharedMemoryTool.cxx.

                                                                                         {
    if (m_isServer || m_isClient) {
       ATH_MSG_ERROR("Cannot make AthenaSharedMemoryTool a Server.");
       return(StatusCode::FAILURE);
    }
    if (num > m_maxDataClients) {
       ATH_MSG_ERROR("Too many clients for AthenaSharedMemoryTool Server.");
       return(StatusCode::FAILURE);
    }
    m_num = num;
    m_isServer = true;
    ATH_MSG_DEBUG("Creating shared memory object with name \"" << m_sharedMemory.value() << "\"");
    std::optional<boost::interprocess::shared_memory_object> shm;
    try {
       shm.emplace(boost::interprocess::create_only, m_sharedMemory.value().c_str(), boost::interprocess::read_write);
    } catch(boost::interprocess::interprocess_exception &e) {
       ATH_MSG_ERROR("Cannot create shared memory " << m_sharedMemory.value() << ": " << boost::diagnostic_information(e));
       return StatusCode::FAILURE;
    }
    shm->truncate(m_maxSize);
    m_payload = new boost::interprocess::mapped_region(*shm, boost::interprocess::read_write, 0, m_maxSize);
    const std::string statusName = m_sharedMemory.value() + "_status";
    std::optional<boost::interprocess::shared_memory_object> shm_status;
    try {
       shm_status.emplace(boost::interprocess::create_only, statusName.c_str(), boost::interprocess::read_write);
    } catch(boost::interprocess::interprocess_exception &e) {
       ATH_MSG_ERROR("Cannot create shared memory " << statusName << ": " << boost::diagnostic_information(e));
       return StatusCode::FAILURE;
    }
    shm_status->truncate(num * sizeof(ShareEventHeader));
    m_status = new boost::interprocess::mapped_region(*shm_status, boost::interprocess::read_write, 0, num * sizeof(ShareEventHeader));
    ShareEventHeader evtH = { ShareEventHeader::UNLOCKED, -1, -1, 0, 0, 0, 0, "" };
    std::memcpy(evtH.token, streamPortSuffix.c_str(), maxTokenLength - 1);
    evtH.token[maxTokenLength - 1] = 0;
    for (int i = 0; i < num; i++) {
       std::memcpy(static_cast<char*>(m_status->get_address()) + i * sizeof(ShareEventHeader), &evtH, sizeof(ShareEventHeader));
    }
    return(StatusCode::SUCCESS);
 }

◆ 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);
   }

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

◆ putObject()

StatusCode AthenaSharedMemoryTool::putObject	(	const void *	source,
		size_t	nbytes,
		int	num = `0`
	)

virtual

Implements IAthenaIPCTool.

Definition at line 304 of file AthenaSharedMemoryTool.cxx.

                                                                                        {
    if (nbytes > m_maxSize) {
       ATH_MSG_ERROR("Object size = " << nbytes << " greater than maximum for client = " << num);
       return(StatusCode::FAILURE);
    }
    void* status = static_cast<char*>(m_status->get_address()) + num * sizeof(ShareEventHeader);
    ShareEventHeader* evtH = static_cast<ShareEventHeader*>(status);
    ShareEventHeader::ProcessStatus evtStatus = evtH->evtProcessStatus; // read only once
    if (evtStatus != ShareEventHeader::CLEARED && evtStatus != ShareEventHeader::PARTIAL) {
       ATH_MSG_DEBUG("Waiting for CLEARED putObject, client = " << num << ", in state " << evtStatus);
       return(StatusCode::RECOVERABLE);
    }
    if (source == nullptr) {
       evtH->evtSize = evtH->evtOffset;
       evtH->evtOffset = 0;
       m_payload->flush(0 + evtH->evtOffset + evtH->evtCursor, evtH->evtSize - evtH->evtCursor);
       m_status->flush(num * sizeof(ShareEventHeader), sizeof(ShareEventHeader));
       evtH->evtProcessStatus = ShareEventHeader::FILLED;
    } else {
       if (evtH->evtOffset + sizeof(size_t) + nbytes > m_maxSize) {
          ATH_MSG_ERROR("Object location = " << evtH->evtOffset << " greater than maximum for client = " << num);
          return(StatusCode::FAILURE);
       }
       bool first = (evtH->evtOffset == 0);
       std::memcpy(static_cast<char*>(m_payload->get_address()) + evtH->evtOffset, &nbytes, sizeof(size_t));
       evtH->evtOffset += sizeof(size_t);
       std::memcpy(static_cast<char*>(m_payload->get_address()) + evtH->evtOffset, source, nbytes);
       evtH->evtOffset += nbytes;
       if (evtH->evtSize == m_maxSize) {
          evtH->evtSize = evtH->evtOffset;
          evtH->evtProcessStatus = ShareEventHeader::PARTIAL;
       }
       if (first) {
          evtH->evtSize = m_maxSize;
          m_payload->flush(0, evtH->evtOffset);
          m_status->flush(num * sizeof(ShareEventHeader), sizeof(ShareEventHeader));
       }
    }
    return(StatusCode::SUCCESS);
 }

◆ 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();
   }

◆ stop()

StatusCode AthenaSharedMemoryTool::stop ( )

Definition at line 77 of file AthenaSharedMemoryTool.cxx.

                                         {
    ATH_MSG_INFO("in stop()");
    if (m_isClient && m_num > 0) {
       ATH_MSG_INFO("Client stop() inform Server: " << m_num);
       m_num = -1;
       while (lockObject("stop").isRecoverable()) {
          usleep(100);
       }
       ShareEventHeader* evtH = static_cast<ShareEventHeader*>(m_status->get_address());
       while (evtH->evtProcessStatus != ShareEventHeader::UNLOCKED) {
          usleep(100);
       }
    }
    return(StatusCode::SUCCESS);
 }

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

◆ 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);
       }
     }
   }

Member Data Documentation

◆ m_dataClients

std::set<int> AthenaSharedMemoryTool::m_dataClients

private

Definition at line 65 of file AthenaSharedMemoryTool.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_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_fileSeqNumber

long AthenaSharedMemoryTool::m_fileSeqNumber

private

Definition at line 68 of file AthenaSharedMemoryTool.h.

◆ m_incidentSvc

ServiceHandle<IIncidentSvc> AthenaSharedMemoryTool::m_incidentSvc

private

Definition at line 71 of file AthenaSharedMemoryTool.h.

◆ m_isClient

bool AthenaSharedMemoryTool::m_isClient

private

Definition at line 70 of file AthenaSharedMemoryTool.h.

◆ m_isServer

bool AthenaSharedMemoryTool::m_isServer

private

Definition at line 69 of file AthenaSharedMemoryTool.h.

◆ m_lastClient

int AthenaSharedMemoryTool::m_lastClient

private

Definition at line 64 of file AthenaSharedMemoryTool.h.

◆ m_maxDataClients

const int AthenaSharedMemoryTool::m_maxDataClients

private

Definition at line 62 of file AthenaSharedMemoryTool.h.

◆ m_maxSize

const size_t AthenaSharedMemoryTool::m_maxSize

private

Definition at line 61 of file AthenaSharedMemoryTool.h.

◆ m_num

int AthenaSharedMemoryTool::m_num

private

Definition at line 63 of file AthenaSharedMemoryTool.h.

◆ m_payload

boost::interprocess::mapped_region* AthenaSharedMemoryTool::m_payload

private

Definition at line 66 of file AthenaSharedMemoryTool.h.

◆ m_sharedMemory

StringProperty AthenaSharedMemoryTool::m_sharedMemory

private

Definition at line 60 of file AthenaSharedMemoryTool.h.

◆ m_status

boost::interprocess::mapped_region* AthenaSharedMemoryTool::m_status

private

Definition at line 67 of file AthenaSharedMemoryTool.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

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ AthenaSharedMemoryTool()

◆ ~AthenaSharedMemoryTool()

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE()

◆ clearObject()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ DeclareInterfaceID()

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ getLockedEvent()

◆ getObject()

◆ initialize()

◆ inputHandles()

◆ isClient()

◆ isServer()

◆ lockEvent()

◆ lockObject()

◆ makeClient()

◆ makeServer()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ putObject()

◆ renounce()

◆ renounceArray()

◆ stop()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_dataClients

◆ m_detStore

◆ m_evtStore

◆ m_fileSeqNumber

◆ m_incidentSvc

◆ m_isClient

◆ m_isServer

◆ m_lastClient

◆ m_maxDataClients

◆ m_maxSize

◆ m_num

◆ m_payload

◆ m_sharedMemory

◆ m_status

◆ m_varHandleArraysDeclared

◆ m_vhka