ByteStreamCnvSvc Class Reference

Gaudi Conversion Service class for ByteStream Persistency. More...

#include <ByteStreamCnvSvc.h>

Inheritance diagram for ByteStreamCnvSvc:

Collaboration diagram for ByteStreamCnvSvc:

Classes
struct	SlotData
	Slot-specific state. More...

Public Member Functions
	ByteStreamCnvSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor.
virtual	~ByteStreamCnvSvc ()=default
	Standard Destructor.
virtual StatusCode	initialize () override
	Gaudi Service Interface method implementations:
virtual StatusCode	finalize () override
virtual StatusCode	connectOutput (const std::string &t, const std::string &mode) override
	Implements ConversionSvc's connectOutput.
virtual StatusCode	connectOutput (const std::string &t) override
virtual StatusCode	commitOutput (const std::string &outputConnection, bool b) override
	Implements ConversionSvc's commitOutput.
virtual RawEventWrite *	getRawEvent () override
	Implementation of IByteStreamEventAccess: Get RawEvent.

Protected Member Functions
RawEventWrite *	setRawEvent (std::unique_ptr< RawEventWrite > rawEventWrite)
virtual FullEventAssemblerBase *	findFullEventAssembler (const std::string &name) const override
	Implementation of IByteStreamCnvSvc interface.
virtual StatusCode	storeFullEventAssembler (std::unique_ptr< FullEventAssemblerBase > fea, const std::string &name) override

Private Member Functions
void	writeFEA (SlotData &slot)
	Write the FEA to RawEvent.

Private Attributes
Gaudi::Property< std::string >	m_ioSvcName {this, "ByteStreamOutputSvc", "", "ByteStream output service name"}
	name of the service
Gaudi::Property< std::vector< std::string > >	m_ioSvcNameList {this, "ByteStreamOutputSvcList", {}, "", "OrderedSet<T>"}
	list of service names
Gaudi::Property< bool >	m_fillTriggerBits {this, "FillTriggerBits", true, "Read in xTrigDecision and use it to fill Trigger bits in event header"}
	fill trigger bits
std::map< std::string, IByteStreamOutputSvc * >	m_ioSvcMap
	Services for writing output.
ServiceHandle< StoreGateSvc >	m_evtStore {this, "EventStore", "StoreGateSvc"}
	Event store.
Gaudi::Property< std::string >	m_userType {this, "UserType", "RawEvent", "User type"}
	user type
SG::SlotSpecificObj< SlotData >	m_slots

Detailed Description

Gaudi Conversion Service class for ByteStream Persistency.

This class is responsible for converting data object to and from BS format It inherits from ByteStreamCnvSvcBase, which is used by HLT in online.

When reading the ByteStream data, the ByteStream converters are called, which in turn call IRODDataProviderSvc to retrieve the raw data.

When writing the object data to ByteStream, an FullEventFragment is assembled from lower level fragments using FullEventAssembler, and written out to BS in commitOutput method through IByteStreamOutputSvc.

Definition at line 36 of file ByteStreamCnvSvc.h.

Constructor & Destructor Documentation

ByteStreamCnvSvc()

ByteStreamCnvSvc::ByteStreamCnvSvc	(	const std::string &	name,
		ISvcLocator *	svc )

Standard Constructor.

Standard constructor.

Definition at line 34 of file ByteStreamCnvSvc.cxx.

  : base_class(name, pSvcLocator)
{
}

~ByteStreamCnvSvc()

virtual ByteStreamCnvSvc::~ByteStreamCnvSvc ( )

virtualdefault

Standard Destructor.

Member Function Documentation

commitOutput()

StatusCode ByteStreamCnvSvc::commitOutput ( const std::string & outputConnection, bool b )

overridevirtual

Implements ConversionSvc's commitOutput.

Definition at line 183 of file ByteStreamCnvSvc.cxx.

                                                                                   {
   ATH_MSG_DEBUG("In flushOutput " << outputConnection);
 
   const EventContext& ctx = Gaudi::Hive::currentContext();
   SlotData& slot = *m_slots.get(ctx);
 
   if (m_ioSvcMap.size() == 0) {
      ATH_MSG_ERROR("ByteStreamCnvSvc not configured for output");
      return StatusCode::FAILURE;
   }
 
   writeFEA (slot);
 
   // convert RawEventWrite to RawEvent
   RawEventWrite* re = slot.m_rawEventWrite.get();
   uint32_t rawSize = re->size_word();
   std::vector<uint32_t> buffer (rawSize);
   uint32_t count = eformat::write::copy(*(re->bind()), buffer.data(), rawSize);
   if (count != rawSize) {
      ATH_MSG_ERROR("Memcopy failed");
      return StatusCode::FAILURE;
   }
   RawEvent rawEvent(buffer.data());
   // check validity
   try {
      rawEvent.check_tree();
   } catch (...) {
      ATH_MSG_ERROR("commitOutput failed, because FullEventFragment invalid");
      return StatusCode::FAILURE;
   }
   ATH_MSG_DEBUG("commitOutput: Size of Event (words) = " << rawEvent.fragment_size_word());
   // put event to OutputSvc
   if ((m_ioSvcMap.size() == 1) or (m_ioSvcMap.count(outputConnection) > 0)) {
      std::map<std::string, IByteStreamOutputSvc*>::iterator itSvc = m_ioSvcMap.find(outputConnection);
      // for backward compatibility
      if (itSvc == m_ioSvcMap.end()) {
         itSvc = m_ioSvcMap.begin();
      }
      // put
      if (!itSvc->second->putEvent(&rawEvent)) {
         ATH_MSG_ERROR("commitOutput failed to send output");
         return StatusCode::FAILURE;
      }
   }
   // Clear slot-specific data.
   slot.clear();
   return StatusCode::SUCCESS;
}

connectOutput() [1/2]

StatusCode ByteStreamCnvSvc::connectOutput ( const std::string & t )

overridevirtual

Definition at line 97 of file ByteStreamCnvSvc.cxx.

                                                             {
   ATH_MSG_DEBUG("In connectOutput");
 
   const EventContext& ctx = Gaudi::Hive::currentContext();
   SlotData& slot = *m_slots.get(ctx);
 
   // Get the EventInfo obj for run/event number
   const xAOD::EventInfo* evtInfo{nullptr};
   ATH_CHECK( m_evtStore->retrieve(evtInfo) );
   uint64_t event = evtInfo->eventNumber();
   uint32_t run_no = evtInfo->runNumber();
   uint32_t bc_time_sec = evtInfo->timeStamp();
   uint32_t bc_time_ns = evtInfo->timeStampNSOffset();
   uint32_t run_type = 0;
   uint32_t lvl1_id = evtInfo->extendedLevel1ID();
   if (lvl1_id == 0) {
      lvl1_id = event;
   }
   uint8_t lvl1_type = evtInfo->level1TriggerType();
   uint64_t global_id = event;
   uint16_t lumi_block = evtInfo->lumiBlock();
   uint16_t bc_id = evtInfo->bcid();
   uint8_t nevt = 0;
   // create an empty RawEvent
   eformat::helper::SourceIdentifier sid = eformat::helper::SourceIdentifier(eformat::FULL_SD_EVENT, nevt);
   RawEventWrite* re = setRawEvent (std::make_unique<RawEventWrite>(sid.code(), bc_time_sec, bc_time_ns, global_id, run_type, run_no, lumi_block, lvl1_id, bc_id, lvl1_type));
 
   // set stream tags
   std::vector<eformat::helper::StreamTag> on_streamTags;
   for (const auto& sTag : evtInfo->streamTags()) {
      on_streamTags.emplace_back(sTag.name(), sTag.type(), sTag.obeysLumiblock(), sTag.robs(), detsOnline(sTag.dets()));
   }
   uint32_t nStreamTagWords = eformat::helper::size_word(on_streamTags);
   slot.m_tagBuff.resize (nStreamTagWords);
   eformat::helper::encode(on_streamTags, nStreamTagWords, slot.m_tagBuff.data());
   re->stream_tag(nStreamTagWords, slot.m_tagBuff.data());
 
   // Nothing left to do, unless processing trigger bits
   if (!m_fillTriggerBits.value()) {
      return StatusCode::SUCCESS;
   }
 
   // try to get TrigDecision
   const xAOD::TrigDecision *trigDecision{nullptr};
   if (m_evtStore->retrieve(trigDecision, "xTrigDecision") != StatusCode::SUCCESS) {
      ATH_MSG_WARNING("Property " << m_fillTriggerBits.name() << " set to True but failed to retrieve xAOD::TrigDecision. Leaving empty trigger bits in the event header.");
      return StatusCode::SUCCESS;
   }
 
   // LVL1 info
   const std::vector<uint32_t> &tbp = trigDecision->tbp();
   const std::vector<uint32_t> &tap = trigDecision->tap();
   const std::vector<uint32_t> &tav = trigDecision->tav();
   const size_t l1TotSize = tbp.size() + tap.size() + tav.size();
   if (l1TotSize > 0) {
      slot.m_l1Buff.resize (l1TotSize);
      size_t l1Size{0};
      for (const uint32_t tb : tbp) {
         slot.m_l1Buff[l1Size++] = tb;
      }
      for (const uint32_t tb : tap) {
         slot.m_l1Buff[l1Size++] = tb;
      }
      for (const uint32_t tb : tav) {
         slot.m_l1Buff[l1Size++] = tb;
      }
      re->lvl1_trigger_info(l1TotSize, slot.m_l1Buff.data());
   }
 
   // LVL2 info
   const std::vector<uint32_t>& lvl2PP = trigDecision->lvl2PassedPhysics();
   if (lvl2PP.size() > 0) {
      slot.m_l2Buff = lvl2PP;
      re->lvl2_trigger_info(lvl2PP.size(), slot.m_l2Buff.data());
   }
 
   // EF info
   const std::vector<uint32_t>& efPP = trigDecision->efPassedPhysics();
   if (efPP.size() > 0) {
      slot.m_efBuff = efPP;
      re->event_filter_info(efPP.size(), slot.m_efBuff.data());
   }
 
   return StatusCode::SUCCESS;
}

connectOutput() [2/2]

StatusCode ByteStreamCnvSvc::connectOutput ( const std::string & t, const std::string & mode )

overridevirtual

Implements ConversionSvc's connectOutput.

Definition at line 93 of file ByteStreamCnvSvc.cxx.

                                                                                 {
   return connectOutput(t);
}

finalize()

StatusCode ByteStreamCnvSvc::finalize ( )

overridevirtual

Definition at line 89 of file ByteStreamCnvSvc.cxx.

                                      {
   return ByteStreamCnvSvcBase::finalize();
}

findFullEventAssembler()

FullEventAssemblerBase * ByteStreamCnvSvc::findFullEventAssembler ( const std::string & name ) const

overrideprotectedvirtual

Implementation of IByteStreamCnvSvc interface.

Definition at line 39 of file ByteStreamCnvSvc.cxx.

{
   const EventContext& ctx = Gaudi::Hive::currentContext();
   const auto& feaMap = m_slots.get(ctx)->m_feaMap;
   const auto& fea = feaMap.find(name);
   return fea!=feaMap.end() ? fea->second.get() : nullptr;
}

getRawEvent()

virtual RawEventWrite * ByteStreamCnvSvc::getRawEvent ( )

inlineoverridevirtual

Implementation of IByteStreamEventAccess: Get RawEvent.

Definition at line 57 of file ByteStreamCnvSvc.h.

   {
     return m_slots->m_rawEventWrite.get();
   }

initialize()

StatusCode ByteStreamCnvSvc::initialize ( )

overridevirtual

Gaudi Service Interface method implementations:

Initialize the service.

Definition at line 55 of file ByteStreamCnvSvc.cxx.

                                        {
   ATH_CHECK(ByteStreamCnvSvcBase::initialize());
 
   ATH_CHECK(m_evtStore.retrieve());
 
   // get ready for output
   std::vector<std::string> ioSvcNames = m_ioSvcNameList.value();
   if (!m_ioSvcName.empty()) {
      // add ioSvcName if ioSvcNameList is missing it
      auto it = find(ioSvcNames.begin(), ioSvcNames.end(), m_ioSvcName);
      if (it == ioSvcNames.end()) {
         ioSvcNames.push_back(m_ioSvcName);
      }
   }
   if (!ioSvcNames.empty()) {
      // Check ByteStreamCnvSvc
      for (const std::string& svcName : ioSvcNames) {
         ATH_MSG_DEBUG("Retrieving " << svcName);
         // get service
         SmartIF<IByteStreamOutputSvc> ioSvc{service(svcName)};
         ATH_CHECK(ioSvc.isValid());
 
         // get stream name
         std::string bsOutputStreamName;
         SimpleProperty<std::string> propBSO("BSOutputStreamName", bsOutputStreamName);
         ATH_CHECK(ioSvc.as<IProperty>()->getProperty(&propBSO));
         bsOutputStreamName = propBSO.value();
         // append
         m_ioSvcMap[bsOutputStreamName] = ioSvc;
      }
   }
   return StatusCode::SUCCESS;
}

setRawEvent()

RawEventWrite * ByteStreamCnvSvc::setRawEvent ( std::unique_ptr< RawEventWrite > rawEventWrite )

protected

Definition at line 244 of file ByteStreamCnvSvc.cxx.

{
  RawEventWrite* ptr = rawEventWrite.get();
  m_slots->m_rawEventWrite = std::move (rawEventWrite);
  // cppcheck-suppress returnDanglingLifetime
  return ptr;
}

storeFullEventAssembler()

StatusCode ByteStreamCnvSvc::storeFullEventAssembler ( std::unique_ptr< FullEventAssemblerBase > fea, const std::string & name )

overrideprotectedvirtual

Definition at line 47 of file ByteStreamCnvSvc.cxx.

{
  const EventContext& ctx = Gaudi::Hive::currentContext();
  m_slots.get(ctx)->m_feaMap[name] = std::move(fea);
  return StatusCode::SUCCESS;
}

writeFEA()

void ByteStreamCnvSvc::writeFEA ( SlotData & slot )

private

Write the FEA to RawEvent.

Definition at line 232 of file ByteStreamCnvSvc.cxx.

{
   const auto& feaMap = slot.m_feaMap;
   ATH_MSG_DEBUG("before FEAMAP size = " << feaMap.size());
   for (auto& p : feaMap) {
      MsgStream log(msgSvc(), name());
      p.second->fill(slot.m_rawEventWrite.get(), log);
   }
   ATH_MSG_DEBUG("after FEAMAP size = " << feaMap.size());
}

Member Data Documentation

m_evtStore

ServiceHandle<StoreGateSvc> ByteStreamCnvSvc::m_evtStore {this, "EventStore", "StoreGateSvc"}

private

Event store.

Definition at line 83 of file ByteStreamCnvSvc.h.

{this, "EventStore", "StoreGateSvc"};

m_fillTriggerBits

Gaudi::Property<bool> ByteStreamCnvSvc::m_fillTriggerBits {this, "FillTriggerBits", true, "Read in xTrigDecision and use it to fill Trigger bits in event header"}

private

fill trigger bits

Definition at line 77 of file ByteStreamCnvSvc.h.

{this, "FillTriggerBits", true, "Read in xTrigDecision and use it to fill Trigger bits in event header"};

m_ioSvcMap

std::map<std::string, IByteStreamOutputSvc*> ByteStreamCnvSvc::m_ioSvcMap

private

Services for writing output.

Definition at line 80 of file ByteStreamCnvSvc.h.

m_ioSvcName

Gaudi::Property<std::string> ByteStreamCnvSvc::m_ioSvcName {this, "ByteStreamOutputSvc", "", "ByteStream output service name"}

private

name of the service

Definition at line 71 of file ByteStreamCnvSvc.h.

{this, "ByteStreamOutputSvc", "", "ByteStream output service name"};

m_ioSvcNameList

Gaudi::Property<std::vector<std::string> > ByteStreamCnvSvc::m_ioSvcNameList {this, "ByteStreamOutputSvcList", {}, "", "OrderedSet<T>"}

private

list of service names

Definition at line 74 of file ByteStreamCnvSvc.h.

{this, "ByteStreamOutputSvcList", {}, "", "OrderedSet<T>"};

m_slots

SG::SlotSpecificObj<SlotData> ByteStreamCnvSvc::m_slots

private

Definition at line 108 of file ByteStreamCnvSvc.h.

m_userType

Gaudi::Property<std::string> ByteStreamCnvSvc::m_userType {this, "UserType", "RawEvent", "User type"}

private

user type

Definition at line 86 of file ByteStreamCnvSvc.h.

{this, "UserType", "RawEvent", "User type"};

---

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

• ByteStreamCnvSvc.h
• ByteStreamCnvSvc.cxx