ByteStream converter for L1TriggerResult. More...

#include <L1TriggerResultByteStreamCnv.h>

Inheritance diagram for L1TriggerResultByteStreamCnv:

Collaboration diagram for L1TriggerResultByteStreamCnv:

Public Member Functions
	L1TriggerResultByteStreamCnv (ISvcLocator *svcLoc)
	Standard constructor.
virtual	~L1TriggerResultByteStreamCnv ()
	Standard destructor.
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual StatusCode	createObj (IOpaqueAddress pAddr, DataObject &pObj) override
	Create xAOD (L1TriggerResult) from ByteStream.
virtual StatusCode	createRep (DataObject pObj, IOpaqueAddress &pAddr) override
	Create ByteStream from xAOD (L1TriggerResult).
long	repSvcType () const override
	return repSvcType
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Static Public Member Functions
static long	storageType ()
	Storage type used by this converter.
static CLID	classID ()
	CLID of the class of the L1TriggerResult converted by this converter (xAOD::TrigCompositeContainer).

Private Member Functions
void	printRob (const OFFLINE_FRAGMENTS_NAMESPACE_WRITE::ROBFragment &rob) const
	Helper method for debug printouts.
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
ServiceHandle< IByteStreamEventAccess >	m_ByteStreamEventAccess {"ByteStreamCnvSvc", "L1TriggerResultByteStreamCnv"}
	Helper to obtain the RawEvent pointer.
ToolHandle< IL1TriggerByteStreamTool >	m_muonEncoderTool {"MuonRoIByteStreamTool/L1MuonBSEncoderTool"}
	Encoder tools for L1Muon RoIs (one writing RoIB ROB, one writing DAQ ROB).
ToolHandle< IL1TriggerByteStreamTool >	m_muonEncoderToolDaq {"MuonRoIByteStreamTool/L1MuonBSEncoderToolDAQ"}
ToolHandle< IL1TriggerByteStreamTool >	m_ctpResultEncoderTool {"CTPResultByteStreamTool/CTPResultBSEncoderTool"}
	Encoder tool for CTP result.
ToolHandle< IL1TriggerByteStreamTool >	m_efexEncoderTool {"eFexByteStreamTool/eFexBSEncoderTool"}
	eFEX tool
ToolHandle< IL1TriggerByteStreamTool >	m_jfexEncoderTool {"jFexRoiByteStreamTool/jFexBSEncoderTool"}
	jFEX tool
ToolHandle< IL1TriggerByteStreamTool >	m_gfexEncoderTool {"gFexByteStreamTool/gFexBSEncoderTool"}
	gFEX tool
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging).

Detailed Description

ByteStream converter for L1TriggerResult.

Definition at line 27 of file L1TriggerResultByteStreamCnv.h.

Constructor & Destructor Documentation

◆ L1TriggerResultByteStreamCnv()

L1TriggerResultByteStreamCnv::L1TriggerResultByteStreamCnv ( ISvcLocator * svcLoc )

Standard constructor.

Definition at line 29 of file L1TriggerResultByteStreamCnv.cxx.

                                                                              :
  Converter(storageType(), classID(), svcLoc),
  AthMessaging(msgSvc(), "L1TriggerResultByteStreamCnv") {}

◆ ~L1TriggerResultByteStreamCnv()

L1TriggerResultByteStreamCnv::~L1TriggerResultByteStreamCnv ( )

virtual

Standard destructor.

Definition at line 36 of file L1TriggerResultByteStreamCnv.cxx.

36{}

Member Function Documentation

◆ classID()

CLID L1TriggerResultByteStreamCnv::classID ( )

static

CLID of the class of the L1TriggerResult converted by this converter (xAOD::TrigCompositeContainer).

Definition at line 244 of file L1TriggerResultByteStreamCnv.cxx.

                                           {
  return ClassID_traits<xAOD::TrigCompositeContainer>::ID();
}

◆ createObj()

StatusCode L1TriggerResultByteStreamCnv::createObj	(	IOpaqueAddress *	pAddr,
		DataObject *&	pObj )

overridevirtual

Create xAOD (L1TriggerResult) from ByteStream.

Definition at line 100 of file L1TriggerResultByteStreamCnv.cxx.

                                                                                    {
  ATH_MSG_ERROR("L1TriggerResult cannot be created directly from ByteStream!"
                << " Use the L1TriggerResultMaker algorithm instead");
  return StatusCode::FAILURE;
}

◆ createRep()

StatusCode L1TriggerResultByteStreamCnv::createRep	(	DataObject *	pObj,
		IOpaqueAddress *&	pAddr )

overridevirtual

Create ByteStream from xAOD (L1TriggerResult).

Definition at line 109 of file L1TriggerResultByteStreamCnv.cxx.

                                                                                           {
  ATH_MSG_VERBOSE("start of " << __FUNCTION__);
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  // Cast the DataObject to L1TriggerResult
  xAOD::TrigCompositeContainer* l1TriggerResult = nullptr;
  bool castSuccessful = SG::fromStorable(pObj, l1TriggerResult);
  if (!castSuccessful || !l1TriggerResult) {
    ATH_MSG_ERROR("Failed to convert DataObject to xAOD::TrigCompositeContainer for L1TriggerResult");
    return StatusCode::FAILURE;
  }
 
  // Obtain the RawEventWrite (aka eformat::write::FullEventFragment) pointer
  RawEventWrite* re = m_ByteStreamEventAccess->getRawEvent();
  if (!re) {
    ATH_MSG_ERROR("Failed to obtain a pointer to RawEventWrite");
    return StatusCode::FAILURE;
  }
  ATH_MSG_VERBOSE("Obtained RawEventWrite pointer = " << re);
 
  //  ===== CTPResult encoding =================
 
  // Only perform encoding if tool was enabled, hence only when xAOD::CTPResult is used instead of ROIB::CTPResult (as part of ROIB::RoIBResult)
  if (m_ctpResultEncoderTool.isEnabled()) {
 
    // Extract the CTPResult SG key stored as a detail of the TrigComposite
    const xAOD::TrigComposite* l1tr = l1TriggerResult->at(0);
    std::string ctpKey;
    l1tr->getDetail<std::string>("CTPResultKey", ctpKey);
 
    // Use the retrieved key to read the CTPResult from the event store
    SG::ReadHandle<xAOD::CTPResult> result(ctpKey, ctx);
    ATH_CHECK(result.isValid());
 
    // Helpful lambda function to convert from vectors of 32-bit words to bitsets
    auto wordsToBitset = [](const std::vector<uint32_t>& words) {
        std::bitset<512> out;
        for (size_t i = 0; i < words.size(); ++i) {
            uint32_t w = words[i];
            for (size_t b = 0; b < 32; ++b) {
                if (w & (1u << b)) {
                    out.set(i * 32 + b);
                }
            }
        }
        return out;
    };
 
    std::bitset<512> tbp = wordsToBitset(result->getTBPWords());
    std::bitset<512> tap = wordsToBitset(result->getTAPWords());
    std::bitset<512> tav = wordsToBitset(result->getTAVWords());
 
    // Number of L1 words computed from TBP/TAP/TAV
    constexpr size_t wordSize = 32;
    constexpr size_t wordsPerSet = 512 / wordSize;
    constexpr size_t numWords = 3 * wordsPerSet;
 
    // Allocate per-event storage
    std::vector<uint32_t> l1BitsData(numWords, 0);
 
    // Fill l1BitsData from TBP/TAP/TAV
    size_t iset{0};
    for (const std::bitset<512>& bset : {tbp, tap, tav}) {
        const std::string sbits = bset.to_string();
        const size_t iWordOutputStart = wordsPerSet * iset;
        for (size_t iWordInSet = 0; iWordInSet < wordsPerSet; ++iWordInSet) {
            const size_t bwordPos = 512 - (iWordInSet + 1) * wordSize;
            std::bitset<wordSize> bword{sbits.substr(bwordPos, wordSize)};
            l1BitsData[iWordOutputStart + iWordInSet] = static_cast<uint32_t>(bword.to_ulong());
        }
        ++iset;
    }
    const uint32_t triggerType = result->triggerType();
 
    // Update RawEventWrite
    re->lvl1_trigger_info(l1BitsData.size(), l1BitsData.data());
    re->lvl1_trigger_type(static_cast<uint8_t>(triggerType & 0xFF));
 
  // Check there is no CTPResult ReadHandleKey in the L1TriggerResult when CTP bytestream encoding tool is not enabled
  } else {
    const xAOD::TrigComposite* l1tr = l1TriggerResult->at(0);
    std::string ctpKey;
    if (l1tr->getDetail<std::string>("CTPResultKey", ctpKey)) {
      ATH_MSG_WARNING("L1TriggerResult contains CTPResult ReadHandleKey but CTP bytestream encoding tool is not enabled");
    }
  }
 
  //  ===== MuonRoI + eFex encoding =================
 
  for (ToolHandle<IL1TriggerByteStreamTool>& tool : {std::reference_wrapper(m_muonEncoderTool), std::reference_wrapper(m_muonEncoderToolDaq), std::reference_wrapper(m_efexEncoderTool), std::reference_wrapper(m_jfexEncoderTool), std::reference_wrapper(m_gfexEncoderTool), std::reference_wrapper(m_ctpResultEncoderTool)}) {
    if (not tool.isEnabled()) {continue;}
    std::vector<WROBF*> muon_robs;
    ATH_CHECK(tool->convertToBS(muon_robs, l1TriggerResult, ctx)); // TODO: find a way to avoid ThreadLocalContext
    ATH_MSG_DEBUG(tool.name() << " created " << muon_robs.size() << " L1Muon ROB Fragments");
    for (WROBF* rob : muon_robs) {
      printRob(*rob);
      // Set LVL1 Trigger Type from the full event
      rob->rod_lvl1_type(re->lvl1_trigger_type());
      // Set LVL1 ID from the full event
      rob->rod_lvl1_id(re->lvl1_id());
      // Add the ROBFragment to the full event
      re->append(rob);
      ATH_MSG_DEBUG("Added ROB fragment 0x" << MSG::hex << rob->source_id() << MSG::dec << " to the output raw event");
    }
  }
 
  // Placeholder for other systems: L1Topo, gFEX
 
  // Create a ByteStreamAddress for L1TriggerResult
  if ( pAddr != nullptr ) pAddr->release();
  ByteStreamAddress* bsAddr = new ByteStreamAddress(classID(), pObj->registry()->name(), "");
  pAddr = static_cast<IOpaqueAddress*>(bsAddr);
  pAddr->addRef();
 
  ATH_MSG_VERBOSE("end of " << __FUNCTION__);
  return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode L1TriggerResultByteStreamCnv::finalize ( )

overridevirtual

Definition at line 77 of file L1TriggerResultByteStreamCnv.cxx.

                                                  {
  ATH_MSG_VERBOSE("start of " << __FUNCTION__);
  if (m_ByteStreamEventAccess.release().isFailure())
    ATH_MSG_WARNING("Failed to release service " << m_ByteStreamEventAccess.typeAndName());
  if (m_muonEncoderTool.isEnabled() && m_muonEncoderTool.release().isFailure())
    ATH_MSG_WARNING("Failed to release tool " << m_muonEncoderTool.typeAndName());
  if (m_muonEncoderToolDaq.isEnabled() && m_muonEncoderToolDaq.release().isFailure())
    ATH_MSG_WARNING("Failed to release tool " << m_muonEncoderToolDaq.typeAndName());
  if (m_ctpResultEncoderTool.isEnabled() && m_ctpResultEncoderTool.release().isFailure())
    ATH_MSG_WARNING("Failed to release tool " << m_ctpResultEncoderTool.typeAndName());
  if (m_efexEncoderTool.isEnabled() && m_efexEncoderTool.release().isFailure())
    ATH_MSG_WARNING("Failed to release tool " << m_efexEncoderTool.typeAndName());
  if (m_jfexEncoderTool.isEnabled() && m_jfexEncoderTool.release().isFailure())
    ATH_MSG_WARNING("Failed to release tool " << m_jfexEncoderTool.typeAndName());
  if (m_gfexEncoderTool.isEnabled() && m_gfexEncoderTool.release().isFailure())
    ATH_MSG_WARNING("Failed to release tool " << m_gfexEncoderTool.typeAndName());
  ATH_MSG_VERBOSE("end of " << __FUNCTION__);
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode L1TriggerResultByteStreamCnv::initialize ( )

overridevirtual

Definition at line 41 of file L1TriggerResultByteStreamCnv.cxx.

                                                    {
  ATH_MSG_VERBOSE("start of " << __FUNCTION__);
  ATH_CHECK(m_ByteStreamEventAccess.retrieve());
 
  // Check one property of the encoder tools to determine if the tools are configured in the job
  const bool doMuon = not serviceLocator()->getOptsSvc().get("ToolSvc.L1MuonBSEncoderTool.ROBIDs").empty();
  ATH_MSG_DEBUG("MUCTPI BS encoding is " << (doMuon ? "enabled" : "disabled"));
  ATH_CHECK(m_muonEncoderTool.retrieve(EnableTool(doMuon)));
 
  const bool doMuonDaq = not serviceLocator()->getOptsSvc().get("ToolSvc.L1MuonBSEncoderToolDAQ.ROBIDs").empty();
  ATH_MSG_DEBUG("MUCTPI DAQ ROB encoding is " << (doMuonDaq ? "enabled" : "disabled"));
  ATH_CHECK(m_muonEncoderToolDaq.retrieve(EnableTool(doMuonDaq)));
 
  const bool doCTP = not serviceLocator()->getOptsSvc().get("ToolSvc.CTPResultBSEncoderTool.ROBIDs").empty();
  ATH_MSG_DEBUG("CTP BS encoding is " << (doCTP ? "enabled" : "disabled"));
  ATH_CHECK(m_ctpResultEncoderTool.retrieve(EnableTool(doCTP)));
 
  const bool doEfex = not serviceLocator()->getOptsSvc().get("ToolSvc.eFexBSEncoderTool.ROBIDs").empty();
  ATH_MSG_DEBUG("eFex BS encoding is " << (doEfex ? "enabled" : "disabled"));
  ATH_CHECK(m_efexEncoderTool.retrieve(EnableTool(doEfex)));
 
  const bool doJfex = not serviceLocator()->getOptsSvc().get("ToolSvc.jFexBSEncoderTool.ROBIDs").empty();
  ATH_MSG_DEBUG("jFex BS encoding is " << (doJfex ? "enabled" : "disabled"));
  ATH_CHECK(m_jfexEncoderTool.retrieve(EnableTool(doJfex)));
 
  const bool doGfex = not serviceLocator()->getOptsSvc().get("ToolSvc.gFexBSEncoderTool.ROBIDs").empty();
  ATH_MSG_DEBUG("gFex BS encoding is " << (doGfex ? "enabled" : "disabled"));
  ATH_CHECK(m_gfexEncoderTool.retrieve(EnableTool(doGfex)));
 
  ATH_MSG_VERBOSE("end of " << __FUNCTION__);
  return StatusCode::SUCCESS;
}

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 167 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 182 of file AthMessaging.h.

183{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:167

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ printRob()

void L1TriggerResultByteStreamCnv::printRob ( const OFFLINE_FRAGMENTS_NAMESPACE_WRITE::ROBFragment & rob ) const

private

Helper method for debug printouts.

Definition at line 231 of file L1TriggerResultByteStreamCnv.cxx.

                                                                                                         {
  if (not msgLvl(MSG::DEBUG)) {return;}
  const uint32_t ndata = rob.rod_ndata();
  const uint32_t* data = rob.rod_data();
  ATH_MSG_DEBUG("This ROB has " << ndata << " data words");
  for (uint32_t i=0; i<ndata; ++i, ++data) {
    ATH_MSG_DEBUG("--- 0x" << MSG::hex << *data << MSG::dec);
  }
}

◆ repSvcType()

long L1TriggerResultByteStreamCnv::repSvcType ( ) const

inlineoverride

return repSvcType

Definition at line 49 of file L1TriggerResultByteStreamCnv.h.

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

◆ storageType()

long L1TriggerResultByteStreamCnv::storageType ( )

static

Storage type used by this converter.

Definition at line 248 of file L1TriggerResultByteStreamCnv.cxx.

                                               {
  return ByteStreamAddress::storageType();
}

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging).

Definition at line 141 of file AthMessaging.h.

◆ m_ByteStreamEventAccess

ServiceHandle<IByteStreamEventAccess> L1TriggerResultByteStreamCnv::m_ByteStreamEventAccess {"ByteStreamCnvSvc", "L1TriggerResultByteStreamCnv"}

private

Helper to obtain the RawEvent pointer.

Definition at line 56 of file L1TriggerResultByteStreamCnv.h.

56{"ByteStreamCnvSvc", "L1TriggerResultByteStreamCnv"};

◆ m_ctpResultEncoderTool

ToolHandle<IL1TriggerByteStreamTool> L1TriggerResultByteStreamCnv::m_ctpResultEncoderTool {"CTPResultByteStreamTool/CTPResultBSEncoderTool"}

private

Encoder tool for CTP result.

Definition at line 63 of file L1TriggerResultByteStreamCnv.h.

63{"CTPResultByteStreamTool/CTPResultBSEncoderTool"};

◆ m_efexEncoderTool

ToolHandle<IL1TriggerByteStreamTool> L1TriggerResultByteStreamCnv::m_efexEncoderTool {"eFexByteStreamTool/eFexBSEncoderTool"}

private

eFEX tool

Definition at line 65 of file L1TriggerResultByteStreamCnv.h.

65{"eFexByteStreamTool/eFexBSEncoderTool"};

◆ m_gfexEncoderTool

ToolHandle<IL1TriggerByteStreamTool> L1TriggerResultByteStreamCnv::m_gfexEncoderTool {"gFexByteStreamTool/gFexBSEncoderTool"}

private

gFEX tool

Definition at line 69 of file L1TriggerResultByteStreamCnv.h.

69{"gFexByteStreamTool/gFexBSEncoderTool"};

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_jfexEncoderTool

ToolHandle<IL1TriggerByteStreamTool> L1TriggerResultByteStreamCnv::m_jfexEncoderTool {"jFexRoiByteStreamTool/jFexBSEncoderTool"}

private

jFEX tool

Definition at line 67 of file L1TriggerResultByteStreamCnv.h.

67{"jFexRoiByteStreamTool/jFexBSEncoderTool"};

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels).

Definition at line 132 of file AthMessaging.h.

◆ m_muonEncoderTool

ToolHandle<IL1TriggerByteStreamTool> L1TriggerResultByteStreamCnv::m_muonEncoderTool {"MuonRoIByteStreamTool/L1MuonBSEncoderTool"}

private

Encoder tools for L1Muon RoIs (one writing RoIB ROB, one writing DAQ ROB).

Definition at line 60 of file L1TriggerResultByteStreamCnv.h.

60{"MuonRoIByteStreamTool/L1MuonBSEncoderTool"};

◆ m_muonEncoderToolDaq

ToolHandle<IL1TriggerByteStreamTool> L1TriggerResultByteStreamCnv::m_muonEncoderToolDaq {"MuonRoIByteStreamTool/L1MuonBSEncoderToolDAQ"}

private

Definition at line 61 of file L1TriggerResultByteStreamCnv.h.

61{"MuonRoIByteStreamTool/L1MuonBSEncoderToolDAQ"};

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ L1TriggerResultByteStreamCnv()

◆ ~L1TriggerResultByteStreamCnv()

Member Function Documentation

◆ classID()

◆ createObj()

◆ createRep()

◆ finalize()

◆ initialize()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ printRob()

◆ repSvcType()

◆ setLevel()

◆ storageType()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_ByteStreamEventAccess

◆ m_ctpResultEncoderTool

◆ m_efexEncoderTool

◆ m_gfexEncoderTool

◆ m_imsg

◆ m_jfexEncoderTool

◆ m_lvl

◆ m_msg_tls

◆ m_muonEncoderTool

◆ m_muonEncoderToolDaq

◆ m_nm