OnlineEventDisplaysSvc Class Reference

#include <OnlineEventDisplaysSvc.h>

Inheritance diagram for OnlineEventDisplaysSvc:

Collaboration diagram for OnlineEventDisplaysSvc:

Public Member Functions
	OnlineEventDisplaysSvc (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode	initialize () override
StatusCode	finalize () override
void	beginEvent ()
void	endEvent ()
void	handle (const Incident &incident) override
void	createWriteableDir (const std::string &directory, gid_t zpgid)
gid_t	setOwnershipToZpGrpOrDefault ()
std::string	getFileNamePrefix () override
std::string	getEntireOutputStr () override
std::string	getStreamName () override

Private Member Functions
	OnlineEventDisplaysSvc ()

Private Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_evt {this, "EventInfo", "EventInfo", "Input event information"}
Gaudi::Property< std::string >	m_outputDirectory {this, "OutputDirectory", "/atlas/EventDisplayEvents", "Output Directory"}
Gaudi::Property< std::vector< std::string > >	m_streamsWanted {this, "StreamsWanted", {}, "Desired trigger streams"}
Gaudi::Property< std::vector< std::string > >	m_publicStreams {this, "PublicStreams", {}, "Streams that can be seen by the public"}
Gaudi::Property< std::string >	m_projectTag {this, "ProjectTag", "", "Is needed to add streams to the Public trigger streams"}
Gaudi::Property< bool >	m_BeamSplash {this, "BeamSplash", false, "Is a beam splash event"}
Gaudi::Property< bool >	m_CheckPair {this, "CheckPair", false, "Check for matching ESD and JiveXML files"}
Gaudi::Property< int >	m_maxEvents {this, "MaxEvents", 200, "Number of events to keep per stream"}
std::string	m_FileNamePrefix = "JiveXML"
std::string	m_outputStreamDir = ".Unknown"
std::string	m_entireOutputStr = "."
int	m_runNumber {}
long	m_eventNumber {}

Detailed Description

Definition at line 16 of file OnlineEventDisplaysSvc.h.

Constructor & Destructor Documentation

OnlineEventDisplaysSvc() [1/2]

OnlineEventDisplaysSvc::OnlineEventDisplaysSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 30 of file OnlineEventDisplaysSvc.cxx.

                                                     :
  base_class(name, pSvcLocator){}

OnlineEventDisplaysSvc() [2/2]

OnlineEventDisplaysSvc::OnlineEventDisplaysSvc ( )

private

Member Function Documentation

beginEvent()

void OnlineEventDisplaysSvc::beginEvent

(

)

Definition at line 34 of file OnlineEventDisplaysSvc.cxx.

                                       {
 
  SG::ReadHandle<xAOD::EventInfo> evt (m_evt);
  if (!evt.isValid()) {
    ATH_MSG_FATAL("Could not find event info");
  }
  std::vector<std::string> streams;
 
  m_eventNumber = evt->eventNumber();
  m_runNumber = evt->runNumber();
 
  //Check what trigger streams were fired, if in list of desired
  //streams to be reconstructed pick one randomly
  for (const xAOD::EventInfo::StreamTag& tag : evt->streamTags()){
    ATH_MSG_DEBUG("A trigger in stream " << tag.type() << "_" << tag.name() << " was fired in this event.");
    std::string stream_fullname = tag.type() + "_" + tag.name();
 
    if (m_streamsWanted.empty()) {
      ATH_MSG_WARNING("You have not requested any specific streams, going to allow all streams");
      streams.emplace_back(stream_fullname);
    }
 
    else{
      //If the stream is in the list of streams requested, add it
      if(std::find(m_streamsWanted.begin(), m_streamsWanted.end(), tag.name()) != m_streamsWanted.end()){
    streams.emplace_back(stream_fullname);
      }
      bool isPublic = false;
      //if the stream is not in the list of public streams wanted, continue
      if(std::find(m_publicStreams.begin(), m_publicStreams.end(), tag.name()) == m_publicStreams.end()) continue;
      // Acquire the Global Interpreter Lock (GIL) to ensure thread safety when interacting with Python objects
      RootUtils::PyGILStateEnsure ensure;
      // Convert the project tag string to a Python Unicode object
      std::string tag = m_projectTag;
      PyObject* pProjectTag = PyUnicode_FromString(tag.c_str());
      if (!pProjectTag) {
    // Error handling: Print Python exception if conversion fails
    PyErr_Print();
    ATH_MSG_WARNING("Failed to create Python Unicode object from project tag");
      } else {
    // Import the Python module
    PyObject* pHelper = PyImport_ImportModule("EventDisplaysOnline.EventDisplaysOnlineHelpers");
    if (!pHelper) {
      // Error handling: Print Python exception if import fails
      PyErr_Print();
      ATH_MSG_WARNING("Failed to import EventDisplaysOnline.EventDisplaysOnlineHelpers module");
    } else {
      // Get the "EventCanBeSeenByPublic" function from the module
      PyObject* EventCanBeSeenByPublic = PyObject_GetAttrString(pHelper, "EventCanBeSeenByPublic");
      if (!EventCanBeSeenByPublic || !PyCallable_Check(EventCanBeSeenByPublic)) {
        // Error handling: Print warning if function not found or not callable
        ATH_MSG_WARNING("Could not find or call EventCanBeSeenByPublic function in EventDisplaysOnline.EventDisplaysOnlineHelpers module");
      } else {
        // Call the "EventCanBeSeenByPublic" function with the project tag as argument
        PyObject* result = PyObject_CallFunctionObjArgs(EventCanBeSeenByPublic, pProjectTag, NULL);
        if (!result) {
          PyErr_Print();
          ATH_MSG_WARNING("Failed to call EventCanBeSeenByPublic function");
        } else {
          // Convert the result to a boolean value
          isPublic = PyObject_IsTrue(result);
          Py_DECREF(result); // Decrement reference count of the result object
        }
      }
      Py_XDECREF(EventCanBeSeenByPublic);
      Py_DECREF(pHelper);
    }
    Py_DECREF(pProjectTag);
      }
      if(isPublic){
    streams.emplace_back("Public");
    ATH_MSG_DEBUG("Can send event to public stream");
      }
    }
  }
  for (const std::string& stream : streams){
    ATH_MSG_DEBUG("streams where a trigger fired and in your desired streams list: " << stream);
  }
  std::random_shuffle(streams.begin(), streams.end());
  //Pick the first stream as the output directory
  if(!streams.empty()){
    m_outputStreamDir = streams[0];
  }
  else{
    ATH_MSG_WARNING("Cannot find a stream adding to .Unknown directory");
    m_outputStreamDir = ".Unknown";
  }
 
  m_entireOutputStr = m_outputDirectory + "/" + m_outputStreamDir;
  m_FileNamePrefix = m_entireOutputStr + "/JiveXML";;
 
  gid_t zpgid = setOwnershipToZpGrpOrDefault();
  createWriteableDir(m_outputDirectory, zpgid);
  createWriteableDir(m_entireOutputStr, zpgid);
}

createWriteableDir()

void OnlineEventDisplaysSvc::createWriteableDir	(	const std::string &	directory,
		gid_t	zpgid )

Definition at line 188 of file OnlineEventDisplaysSvc.cxx.

                                                                                      {
 
  const char* char_dir = directory.c_str();
  //Time of Check, Time of Use
  //coverity[TOCTOU]
  if (access(char_dir, F_OK) == 0) {
    struct stat directoryStat;
    //Time of Check, Time of Use
    //coverity[TOCTOU]
    if (stat(char_dir, &directoryStat) == 0 && S_ISDIR(directoryStat.st_mode) &&
    access(char_dir, W_OK) == 0) {
      ATH_MSG_DEBUG("Going to write file to existing directory: " << directory);
      if (directoryStat.st_gid != zpgid) {
    ATH_MSG_DEBUG("Setting group to 'zp' for directory: " << directory);
    chown(char_dir, -1, zpgid);
      }
    } else {
      ATH_MSG_WARNING("Directory '" << directory << "' is not usable, trying next alternative");
    }
  } else {
    try {
      auto rc = mkdir(char_dir, S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
      if (rc !=0){
        ATH_MSG_ERROR("mkdir failed for directory: " << directory);
      }
      rc = chown(char_dir, -1, zpgid);
      if (rc !=0){
         ATH_MSG_ERROR( "chown failed for directory: " << directory);
      }
      ATH_MSG_DEBUG("Created output directory " << directory);
    } catch (const std::system_error& err) {
      ATH_MSG_ERROR( "Failed to create output directory " << directory << err.what());
    }
  }
}

endEvent()

void OnlineEventDisplaysSvc::endEvent

(

)

Definition at line 130 of file OnlineEventDisplaysSvc.cxx.

                                     {
  RootUtils::PyGILStateEnsure ensure;
  PyObject* pCheckPair = PyBool_FromLong(m_CheckPair);
  PyObject* pBeamSplash = PyBool_FromLong(m_BeamSplash);
  PyObject* pMaxEvents = PyLong_FromLong(m_maxEvents);
  const char* cString = m_entireOutputStr.c_str();
  PyObject* pDirectory = PyUnicode_FromString(cString);
  PyObject* pArgs = PyTuple_Pack(4, pDirectory, pMaxEvents, pCheckPair,pBeamSplash);
  PyObject* pModule = PyImport_ImportModule(const_cast< char* >("EventDisplaysOnline.EventUtils"));
  if(!pCheckPair || !pBeamSplash || !pMaxEvents || !pDirectory || !pArgs){
    PyErr_Print();
    ATH_MSG_WARNING("Failed to create Python Unicode object");}
  if (!pModule) {
    PyErr_Print();
    ATH_MSG_WARNING("Failed to import EventDisplaysOnline.EventUtils module");
  } else {
    ATH_MSG_DEBUG("Successfully imported EventDisplaysOnline.EventUtils module");
 
    // Get the "cleanDirectory" function from the module
    PyObject* cleanDirectory = PyObject_GetAttrString(pModule, "cleanDirectory");
    if (!cleanDirectory || !PyCallable_Check(cleanDirectory)) {
      ATH_MSG_WARNING("Could not find or call cleanDirectory function in EventDisplaysOnline.EventUtils module");
    } else {
      ATH_MSG_DEBUG("Found cleanDirectory function in EventDisplaysOnline.EventUtils module");
 
      // Call the "cleanDirectory" function with the provided arguments
      PyObject_CallObject(cleanDirectory, pArgs);
      if (PyErr_Occurred()) {
    PyErr_Print();
      }
    }
    if (anyNullPtr(cleanDirectory)){
      throw std::runtime_error("OnlineEventDisplaysSvc::endEvent: Py_DECREF on nullptr argument");
    }
    Py_DECREF(cleanDirectory);
  }
 
  if (anyNullPtr(pModule, pArgs, pCheckPair, pMaxEvents, pDirectory)){
    throw std::runtime_error("OnlineEventDisplaysSvc::endEvent: Py_DECREF on nullptr argument");
  }
  Py_DECREF(pModule);
  Py_DECREF(pArgs);
  Py_DECREF(pCheckPair);
  Py_DECREF(pMaxEvents);
  Py_DECREF(pDirectory);
}

finalize()

StatusCode OnlineEventDisplaysSvc::finalize ( )

override

Definition at line 259 of file OnlineEventDisplaysSvc.cxx.

                                           {
 
  ATH_MSG_DEBUG("Finalizing " << name());
  return StatusCode::SUCCESS;
}

getEntireOutputStr()

std::string OnlineEventDisplaysSvc::getEntireOutputStr ( )

override

Definition at line 181 of file OnlineEventDisplaysSvc.cxx.

                                                    {
  return m_entireOutputStr;
}

getFileNamePrefix()

std::string OnlineEventDisplaysSvc::getFileNamePrefix ( )

override

Definition at line 177 of file OnlineEventDisplaysSvc.cxx.

                                                   {
  return m_FileNamePrefix;
}

getStreamName()

std::string OnlineEventDisplaysSvc::getStreamName ( )

override

Definition at line 185 of file OnlineEventDisplaysSvc.cxx.

                                               {
  return m_outputStreamDir;
}

handle()

void OnlineEventDisplaysSvc::handle ( const Incident & incident )

override

Definition at line 265 of file OnlineEventDisplaysSvc.cxx.

                                                             {
  ATH_MSG_DEBUG("Received incident " << incident.type() << " from " << incident.source() );
  if ( incident.type() == IncidentType::BeginEvent && incident.source() == "BeginIncFiringAlg" ){
    beginEvent();
  }
  if (incident.type() == "EndEvent" && incident.source() == "EndIncFiringAlg"){
    endEvent();
  }
}

initialize()

StatusCode OnlineEventDisplaysSvc::initialize ( )

override

Definition at line 239 of file OnlineEventDisplaysSvc.cxx.

                                             {
 
  ATH_MSG_DEBUG("Initializing " << name());
  ServiceHandle<IIncidentSvc> incSvc("IncidentSvc", name());
  ATH_CHECK( incSvc.retrieve() );
  ATH_MSG_DEBUG("You have requested to only output JiveXML and ESD files when a trigger in the following streams was fired: ");
  for (const std::string& stream : m_streamsWanted){
    ATH_MSG_DEBUG(stream);
  }
  if(m_BeamSplash){
    m_CheckPair = false;
  }
  incSvc->addListener( this, "BeginEvent");
  incSvc->addListener( this, "EndEvent");
 
  ATH_CHECK( m_evt.initialize() );
 
  return StatusCode::SUCCESS;
}

setOwnershipToZpGrpOrDefault()

gid_t OnlineEventDisplaysSvc::setOwnershipToZpGrpOrDefault

(

)

Definition at line 224 of file OnlineEventDisplaysSvc.cxx.

                                                          {
  gid_t zpgid;
  struct group grp;
  struct group* grp_result;
  char buf[1024];  // sysconf(_SC_GETGR_R_SIZE_MAX)
  (void)getgrnam_r("zp", &grp, buf, sizeof(buf), &grp_result);
  if (grp_result != nullptr) {
    zpgid = grp.gr_gid;
  } else {
    ATH_MSG_DEBUG("If running on private machine, zp group might not exist. Just set to the likely value 1307.");
    zpgid = 1307;
  }
  return zpgid;
}

Member Data Documentation

m_BeamSplash

Gaudi::Property<bool> OnlineEventDisplaysSvc::m_BeamSplash {this, "BeamSplash", false, "Is a beam splash event"}

private

Definition at line 41 of file OnlineEventDisplaysSvc.h.

{this, "BeamSplash", false, "Is a beam splash event"};

m_CheckPair

Gaudi::Property<bool> OnlineEventDisplaysSvc::m_CheckPair {this, "CheckPair", false, "Check for matching ESD and JiveXML files"}

private

Definition at line 42 of file OnlineEventDisplaysSvc.h.

{this, "CheckPair", false, "Check for matching ESD and JiveXML files"};

m_entireOutputStr

std::string OnlineEventDisplaysSvc::m_entireOutputStr = "."

private

Definition at line 46 of file OnlineEventDisplaysSvc.h.

m_eventNumber

long OnlineEventDisplaysSvc::m_eventNumber {}

private

Definition at line 48 of file OnlineEventDisplaysSvc.h.

{};

m_evt

SG::ReadHandleKey<xAOD::EventInfo> OnlineEventDisplaysSvc::m_evt {this, "EventInfo", "EventInfo", "Input event information"}

private

Definition at line 36 of file OnlineEventDisplaysSvc.h.

{this, "EventInfo", "EventInfo", "Input event information"};

m_FileNamePrefix

std::string OnlineEventDisplaysSvc::m_FileNamePrefix = "JiveXML"

private

Definition at line 44 of file OnlineEventDisplaysSvc.h.

m_maxEvents

Gaudi::Property<int> OnlineEventDisplaysSvc::m_maxEvents {this, "MaxEvents", 200, "Number of events to keep per stream"}

private

Definition at line 43 of file OnlineEventDisplaysSvc.h.

{this, "MaxEvents", 200, "Number of events to keep per stream"};

m_outputDirectory

Gaudi::Property<std::string> OnlineEventDisplaysSvc::m_outputDirectory {this, "OutputDirectory", "/atlas/EventDisplayEvents", "Output Directory"}

private

Definition at line 37 of file OnlineEventDisplaysSvc.h.

{this, "OutputDirectory", "/atlas/EventDisplayEvents", "Output Directory"};

m_outputStreamDir

std::string OnlineEventDisplaysSvc::m_outputStreamDir = ".Unknown"

private

Definition at line 45 of file OnlineEventDisplaysSvc.h.

m_projectTag

Gaudi::Property<std::string> OnlineEventDisplaysSvc::m_projectTag {this, "ProjectTag", "", "Is needed to add streams to the Public trigger streams"}

private

Definition at line 40 of file OnlineEventDisplaysSvc.h.

{this, "ProjectTag", "", "Is needed to add streams to the Public trigger streams"};

m_publicStreams

Gaudi::Property<std::vector<std::string> > OnlineEventDisplaysSvc::m_publicStreams {this, "PublicStreams", {}, "Streams that can be seen by the public"}

private

Definition at line 39 of file OnlineEventDisplaysSvc.h.

{this, "PublicStreams", {}, "Streams that can be seen by the public"};

m_runNumber

int OnlineEventDisplaysSvc::m_runNumber {}

private

Definition at line 47 of file OnlineEventDisplaysSvc.h.

{};

m_streamsWanted

Gaudi::Property<std::vector<std::string> > OnlineEventDisplaysSvc::m_streamsWanted {this, "StreamsWanted", {}, "Desired trigger streams"}

private

Definition at line 38 of file OnlineEventDisplaysSvc.h.

{this, "StreamsWanted", {}, "Desired trigger streams"};

---

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

• OnlineEventDisplaysSvc.h
• OnlineEventDisplaysSvc.cxx