AthenaSharedMemoryTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ATHENASHAREDMEMORYTOOL_H
#define ATHENASHAREDMEMORYTOOL_H

 
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthAlgTool.h"
#include "AthenaKernel/IAthenaIPCTool.h"
#include "AthenaKernel/InputFileIncidentGuard.h"
 
#include <memory>
#include <optional>
#include <set>
#include <string>
 
// Forward declarations.
class IIncidentSvc;
 
namespace boost {
   namespace interprocess {
      class shared_memory_object;
      class mapped_region;
   }
}

class AthenaSharedMemoryTool : public extends<::AthAlgTool, IAthenaIPCTool> {
public: 
   AthenaSharedMemoryTool(const std::string& type, const std::string& name, const IInterface* parent);
   virtual ~AthenaSharedMemoryTool();

   virtual StatusCode initialize() override;
   virtual StatusCode stop() override;
   virtual StatusCode finalize() override;
 
   virtual StatusCode makeServer(int num, const std::string& streamPortSuffix) override;
   virtual bool isServer() const override;
   virtual StatusCode makeClient(int num, std::string& streamPortSuffix) override;
   virtual bool isClient() const override;
 
   virtual StatusCode putEvent ATLAS_NOT_THREAD_SAFE (long eventNumber, const void* source, size_t nbytes, unsigned int status) const override;
   virtual StatusCode getLockedEvent(void** target, unsigned int& status) const override;
   virtual StatusCode lockEvent(long eventNumber) const override;
 
   virtual StatusCode putObject(const void* source, size_t nbytes, int num = 0) override;
   virtual StatusCode getObject(void** target, size_t& nbytes, int num = 0) override;
   virtual StatusCode clearObject(const char** tokenString, int& num) override;
   virtual StatusCode lockObject(const char* tokenString, int num = 0) override;
 
private:
   Gaudi::Property<std::string> m_sharedMemory{this, "SharedMemoryName", {}};
   Gaudi::Property<size_t> m_maxSize{this, "SharedMemoryObjectSize", 64 * 1024 * 1024, "Maximum shared memory object size in B (default = 64 MB)"};
   Gaudi::Property<int> m_maxDataClients{this, "SharedMemoryClientSize", 256, "Maximum number of clients (default = 256)"};
 
   int m_num{-1};
   int m_lastClient{-1};
   std::set<int> m_dataClients;
   std::unique_ptr<boost::interprocess::mapped_region> m_payload;
   std::unique_ptr<boost::interprocess::mapped_region> m_status;
   long m_fileSeqNumber{0};
   bool m_isServer{false};
   bool m_isClient{false};
   ServiceHandle<IIncidentSvc> m_incidentSvc;
   mutable std::optional<InputFileIncidentGuard> m_inputFileGuard ATLAS_THREAD_SAFE;
};
 
#endif