HLTResultMTByteStreamDecoderTool Class Reference

Tool filling an HLTResultMT from ByteStream event data. More...

#include <HLTResultMTByteStreamDecoderTool.h>

Inheritance diagram for HLTResultMTByteStreamDecoderTool:

Collaboration diagram for HLTResultMTByteStreamDecoderTool:

Public Member Functions
	HLTResultMTByteStreamDecoderTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
HLT::HLTResultMT::RODMinorVersion	getHltRodMinorVersion (const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vrobf) const
	Retrieves the HLT ROD minor version from vector of ROBFragments, checking it is the same in all of them.
StatusCode	decodeHeader (const RawEvent *rawEvent, HLT::HLTResultMT &resultToFill) const
	Fills the HLTResultMT object from the ByteStream event header.
StatusCode	decodePayload (const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vrobf, HLT::HLTResultMT &resultToFill) const
	Fills the HLTResultMT object from vector of ROBFragments.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	checkRodMinorVersion (const HLT::HLTResultMT::RODMinorVersion version) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool filling an HLTResultMT from ByteStream event data.

Definition at line 18 of file HLTResultMTByteStreamDecoderTool.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

HLTResultMTByteStreamDecoderTool()

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

Standard constructor.

Definition at line 23 of file HLTResultMTByteStreamDecoderTool.cxx.

: AthAlgTool(type,name,parent) {}

Member Function Documentation

checkRodMinorVersion()

StatusCode HLTResultMTByteStreamDecoderTool::checkRodMinorVersion ( const HLT::HLTResultMT::RODMinorVersion version ) const

private

Definition at line 219 of file HLTResultMTByteStreamDecoderTool.cxx.

                                                                                                     {
  if (version == RODMinorVersion{0xff, 0xff}) {
    ATH_MSG_ERROR("Invalid HLT ROD minor version {0xff, 0xff}");
    return StatusCode::FAILURE;
  }
  if (version.first < 1) {
    ATH_MSG_ERROR("HLT ROD minor version " << printRodMinorVersion(version) << " is lower than 1.0. "
                  << "This tool is for decoding versions 1.0 or later (i.e. HLT ByteStream from Run 3 or later)");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("HLT ROD minor version is " << printRodMinorVersion(version));
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

decodeHeader()

StatusCode HLTResultMTByteStreamDecoderTool::decodeHeader	(	const RawEvent *	rawEvent,
		HLT::HLTResultMT &	resultToFill ) const

Fills the HLTResultMT object from the ByteStream event header.

The decoding may depend on HLT ROD Minor version. The passed HLTResultMT should have a valid version set.

Parameters

[in]	rawEvent	A pointer to the FullEventFragment to decode
[out]	resultToFill	The HLTResultMT object to be updated with the decoded information

Returns

FAILURE if anything goes wrong, else SUCCESS

Definition at line 78 of file HLTResultMTByteStreamDecoderTool.cxx.

                                                                                                                      {
 
  if (!rawEvent) {
    ATH_MSG_ERROR("Decoding requested with nullptr RawEvent");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("Decoding HLTResultMT from ByteStream event " << rawEvent->global_id());
 
  const RODMinorVersion hltRodMinorVersion = resultToFill.getVersion();
  ATH_CHECK(checkRodMinorVersion(hltRodMinorVersion));
 
  // ---------------------------------------------------------------------------
  // Read the status words (error codes from online event processing)
  // ---------------------------------------------------------------------------
  std::vector<uint32_t> statusWords;
  // try-catch around eformat calls and raw-pointer operations
  try {
    const uint32_t nStatus = rawEvent->nstatus();
    const uint32_t* rawStatus = rawEvent->status(); // owned by rawEvent
    //Copy range of data into vector using efficient memmove/memcopy
    statusWords.assign(rawStatus, rawStatus+nStatus);
  }
  catch (const std::exception& ex) {
    ATH_MSG_ERROR("std::exception caught when reading status words: " << ex.what());
    return StatusCode::FAILURE;
  }
  catch (...) {
    ATH_MSG_ERROR("Unknown exception caught when reading status words");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("Successfully read " << statusWords.size() << " status words");
  resultToFill.setStatus(std::move(statusWords)); //statusWords is moved so it now empty
 
  // ---------------------------------------------------------------------------
  // Read the stream tags
  // ---------------------------------------------------------------------------
  std::vector<eformat::helper::StreamTag> streamTags;
  // try-catch around eformat calls and raw-pointer operations
  try {
    eformat::helper::decode(rawEvent->nstream_tag(),rawEvent->stream_tag(),streamTags);
  }
  catch (const std::exception& ex) {
    ATH_MSG_ERROR("std::exception caught when reading stream tags: " << ex.what());
    return StatusCode::FAILURE;
  }
  catch (...) {
    ATH_MSG_ERROR("Unknown exception caught when reading stream tags");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("Successfully read " << streamTags.size() << " stream tags");
  ATH_CHECK(resultToFill.setStreamTags(streamTags));
 
 
  // ---------------------------------------------------------------------------
  // Read the HLT bits
  // ---------------------------------------------------------------------------
  std::vector<uint32_t> hltBitWords;
  // try-catch around eformat calls and raw-pointer operations
  try {
    const uint32_t nHltInfo = rawEvent->nhlt_info();
    const uint32_t* hltInfo = rawEvent->hlt_info(); // owned by rawEvent
    //Copy range of data into vector using efficient memmove/memcopy
    hltBitWords.assign(hltInfo, hltInfo+nHltInfo);
  }
  catch (const std::exception& ex) {
    ATH_MSG_ERROR("std::exception caught when reading HLT bits: " << ex.what());
    return StatusCode::FAILURE;
  }
  catch (...) {
    ATH_MSG_ERROR("Unknown exception caught when reading HLT bits");
    return StatusCode::FAILURE;
  }
 
  // Version 1.0 includes rerun bits, removed since version 1.1
  const size_t numBitSets = (hltRodMinorVersion==RODMinorVersion{1,0}) ? 3 : 2;
 
  if (hltBitWords.size() % numBitSets != 0) {
    ATH_MSG_ERROR("Size of hltBitWords=" << hltBitWords.size() << " must be divisible by " << numBitSets
                  << ". Expecting {raw, prescaled" << (numBitSets==3 ? ", rerun" : "") << "} bits.");
    return StatusCode::FAILURE;
  }
  const size_t sizeOfBlock = hltBitWords.size() / numBitSets;
  auto beginPrescaledIt = hltBitWords.cbegin() + sizeOfBlock;
  auto endIt = (numBitSets==2) ? hltBitWords.cend() : hltBitWords.cbegin() + 2*sizeOfBlock;
  resultToFill.setHltBits( {hltBitWords.cbegin(), beginPrescaledIt},
                           {beginPrescaledIt, endIt} );
  ATH_MSG_DEBUG("Successfully read " << std::distance(hltBitWords.cbegin(), endIt) << " HLT bit words");
  return StatusCode::SUCCESS;
}

decodePayload()

StatusCode HLTResultMTByteStreamDecoderTool::decodePayload	(	const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &	vrobf,
		HLT::HLTResultMT &	resultToFill ) const

Fills the HLTResultMT object from vector of ROBFragments.

The decoding may depend on HLT ROD Minor version. The passed HLTResultMT should have a valid version set.

Parameters

[in]	vrobf	A vector of HLT ROBFragments to decode (subdetector identifier TDAQ_HLT)
[out]	resultToFill	The HLTResultMT object to be updated with the decoded information

Returns

FAILURE if anything goes wrong, else SUCCESS

Definition at line 169 of file HLTResultMTByteStreamDecoderTool.cxx.

                                                                                               {
  const RODMinorVersion hltRodMinorVersion = resultToFill.getVersion();
  ATH_CHECK(checkRodMinorVersion(hltRodMinorVersion));
 
  for (const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment* robf : vrobf) {
    eformat::helper::SourceIdentifier sid(robf->rob_source_id());
    ATH_MSG_DEBUG("Reading ROBFragment " << sid.human());
 
    // ---------------------------------------------------------------------------
    // Read the ROB status words (error codes from online event processing)
    // ---------------------------------------------------------------------------
    if (robf->nstatus() > 1) {
      eformat::helper::Status firstStatusWord(*robf->status());
      if (firstStatusWord.generic() == eformat::GenericStatus::DATA_CORRUPTION &&
          *(robf->status()+1) == static_cast<uint32_t>(HLT::OnlineErrorCode::RESULT_TRUNCATION)) {
        ATH_MSG_DEBUG("Detected truncated ROBFragment " << sid.human());
        resultToFill.addTruncatedModuleId(sid.module_id());
      }
    }
 
    // ---------------------------------------------------------------------------
    // Read the payload
    // ---------------------------------------------------------------------------
    std::vector<uint32_t> data;
    // try-catch around eformat calls and raw-pointer operations
    try {
      const uint32_t nRodData = robf->rod_ndata();
      const uint32_t* rodData = robf->rod_data(); // owned by robf
      //Copy range of data into vector using efficient memmove
      data.assign(rodData, rodData+nRodData);
    }
    catch (const std::exception& ex) {
      ATH_MSG_ERROR("std::exception caught when reading HLT result payload: " << ex.what());
      return StatusCode::FAILURE;
    }
    catch (...) {
      ATH_MSG_ERROR("Unknown exception caught when reading HLT result payload");
      return StatusCode::FAILURE;
    }
    size_t datasize = data.size(); //I need to ask size before moving the vector
    ATH_CHECK( resultToFill.addSerialisedDataWithCheck(sid.module_id(), std::move(data)) );
    //Moved "data" so it is now empty vector
    ATH_MSG_DEBUG("Successfully read " << datasize << " words of HLT result payload for module ID "
                  << sid.module_id());
  }
  return StatusCode::SUCCESS;
}

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.

{ return m_detStore; }

evtStore()

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.

{ 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 HLTResultMTByteStreamDecoderTool::finalize ( )

overridevirtual

Definition at line 39 of file HLTResultMTByteStreamDecoderTool.cxx.

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

getHltRodMinorVersion()

RODMinorVersion HLTResultMTByteStreamDecoderTool::getHltRodMinorVersion

(

const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &

vrobf

)

const

Retrieves the HLT ROD minor version from vector of ROBFragments, checking it is the same in all of them.

Parameters

[in]

vrobf

A vector of HLT ROBFragments to decode (subdetector identifier TDAQ_HLT)

Returns

The decoded minor version number or {0xff,0xff} in case of errors

Definition at line 45 of file HLTResultMTByteStreamDecoderTool.cxx.

                                                                               {
 
  if (vrobf.empty()) {
    ATH_MSG_ERROR("Empty ROBFragment vector passed to getHltRodMinorVersion, returning invalid version");
    return {0xff, 0xff};
  }
 
  uint16_t version{0xffff};
  bool first{true};
  for (const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment* robf : vrobf) {
    uint32_t thisRodVersion = robf->rod_version();
    uint16_t thisRodMinorVersion = (thisRodVersion & 0xffffu);
    if (thisRodMinorVersion == 0xffffu) {
      ATH_MSG_WARNING("Invalid HLT ROD minor version 0xffff found in ROBFragment 0x"
                      << MSG::hex << robf->rob_source_id() << MSG::dec);
    }
    if (first) {
      version = thisRodMinorVersion;
    }
    else if (thisRodMinorVersion != version) {
      ATH_MSG_ERROR("Inconsistent HLT ROD minor versions in different ROBFragments, 0x"
                    << MSG::hex << version << " and " << thisRodMinorVersion << MSG::dec
                    << ", getHltRodMinorVersion returning invalid version");
      return {0xff, 0xff};
    }
    first = false;
  }
  // Split the version 0xabcd into {0xab, 0xcd}
  return {((version & 0xff00u) >> 8u), (version & 0x00ffu)};
}

initialize()

StatusCode HLTResultMTByteStreamDecoderTool::initialize ( )

overridevirtual

Definition at line 31 of file HLTResultMTByteStreamDecoderTool.cxx.

                                                        {
  ATH_MSG_DEBUG("Initialising " << name());
  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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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.

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

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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_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_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:

• HLTResultMTByteStreamDecoderTool.h
• HLTResultMTByteStreamDecoderTool.cxx