TrigSerializeConvHelper.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "TrigSerializeCnvSvc/TrigSerializeConvHelper.h"
#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/ClassID.h"
 
#include "TrigSerializeCnvSvc/TrigStreamAddress.h"
#include "TrigSerializeResult/ITrigSerializerToolBase.h"
#include "TrigSerializeTP/TrigSerTPTool.h"
#include "TrigSerializeCnvSvc/ITrigSerGuidHelper.h"
 
#include "DataModelRoot/RootType.h"
#include "CxxUtils/FPControl.h"
 
 
TrigSerializeConvHelper::TrigSerializeConvHelper(const std::string& toolname, const std::string& type, const IInterface* parent) :
  AthAlgTool(toolname, type, parent),
  m_serializerTool("TrigTSerializer/TrigTSerializer"),
  m_TPTool("TrigSerTPTool/TrigSerTPTool"),
  m_guidTool("TrigSerializeGuidHelper/TrigSerializeGuidHelper"),
  m_doTP(true)
{
  declareInterface<ITrigSerializeConvHelper>( this );
  declareProperty("doTP", m_doTP, "allows to serialize/deserialize transient classes");
}
 
TrigSerializeConvHelper::~TrigSerializeConvHelper(){
}
 
StatusCode TrigSerializeConvHelper::initialize(){
 
  StatusCode sc = m_serializerTool.retrieve();
 
  if (!sc.isSuccess()){
    ATH_MSG_DEBUG("m_serializer not retrieved");
    return sc;
  } else {
    ATH_MSG_DEBUG("m_serializer retrieved");
    /*
      if (m_serializerTool->initialize().isSuccess()){
      ATH_MSG_DEBUG( "serializer initialized" );
      }
    */
  }
  
  StatusCode sctp = m_TPTool.retrieve();
  if (!sctp.isSuccess()){
    ATH_MSG_DEBUG( "m_TPTool not retrieved" );
    return sctp;
  } else {
    ATH_MSG_DEBUG( "m_TPTool retrieved" );
    /*
      if (m_TPTool->initialize().isSuccess())
      ATH_MSG_DEBUG( "m_TPTool initialized" );
      */
  }
 
  StatusCode scg = m_guidTool.retrieve();
  if (!scg.isSuccess()){
    ATH_MSG_DEBUG( m_guidTool << " not retrieved" );
    return scg;
  } else {
    ATH_MSG_DEBUG( m_guidTool << "retrieved" );
  }
  
  m_oldEDMmap[ "TrigRoiDescriptor" ]         = "TrigRoiDescriptorCollection_tlp1";
  m_oldEDMmap[ "TrigOperationalInfo" ]       = "TrigOperationalInfoCollection_tlp1";
  m_oldEDMmap[ "TrigInDetTrackCollection" ]  = "TrigInDetTrackCollection_tlp1";
  m_oldEDMmap[ "MuonFeature" ]               = "MuonFeatureContainer_tlp1";
  m_oldEDMmap[ "IsoMuonFeature" ]            = "IsoMuonFeatureContainer_tlp1";
  m_oldEDMmap[ "CombinedMuonFeature" ]       = "CombinedMuonFeatureContainer_tlp1";
  m_oldEDMmap[ "TileMuFeature" ]             = "TileMuFeatureContainer_tlp1";
  m_oldEDMmap[ "TileTrackMuFeature" ]        = "TileTrackMuFeatureContainer_tlp1";
  m_oldEDMmap[ "TrigEMCluster" ]             = "TrigEMClusterContainer_tlp1";
  //m_oldEDMmap[ "TrigEMCluster" ]             = "TrigEMClusterContainer_tlp2";
  m_oldEDMmap[ "RingerRings" ]               = "RingerRingsContainer_tlp1";
  m_oldEDMmap[ "TrigTauCluster" ]            = "TrigTauClusterContainer_tlp1";
  m_oldEDMmap[ "TrigTauClusterDetails" ]     = "TrigTauClusterDetailsContainer_tlp1";
  m_oldEDMmap[ "TrigTauTracksInfo" ]         = "TrigTauTracksInfoCollection_tlp1";
  m_oldEDMmap[ "TrigElectronContainer" ]     = "TrigElectronContainer_tlp2";
  m_oldEDMmap[ "TrigPhotonContainer" ]       = "TrigPhotonContainer_tlp2";
  m_oldEDMmap[ "TrigMissingET" ]             = "TrigMissingETContainer_tlp1";
  m_oldEDMmap[ "TrigT2MbtsBits" ]            = "TrigT2MbtsBitsContainer_tlp1";
  m_oldEDMmap[ "TrigSpacePointCounts" ]      = "TrigSpacePointCountsCollection_tlp1";
  m_oldEDMmap[ "TrigTrtHitCounts" ]          = "TrigTrtHitCountsCollection_tlp1";
  m_oldEDMmap[ "CosmicMuonCollection" ]      = "CosmicMuonCollection_tlp1";
  m_oldEDMmap[ "MdtTrackSegmentCollection" ] = "MdtTrackSegmentCollection_tlp1";
  m_oldEDMmap[ "TrigVertexCollection" ]      = "TrigVertexCollection_tlp1";
  m_oldEDMmap[ "JetCollection" ]             = "JetCollection_tlp2";
  m_oldEDMmap[ "CaloClusterContainer" ]      = "CaloClusterContainer_p4";
  m_oldEDMmap[ "CaloShowerContainer" ]       = "CaloShowerContainer_p2";
  //m_oldEDMmap[ "CaloTowerContainer" ]        = "CaloTowerContainer_p1";
  m_oldEDMmap[ "TrigMuonEFContainer" ]       = "TrigMuonEFContainer_tlp1";
  m_oldEDMmap[ "TrigMuonEFInfoContainer" ]   = "TrigMuonEFInfoContainer_tlp1";
  m_oldEDMmap[ "egDetailContainer" ]         = "egDetailContainer_p1";
  m_oldEDMmap[ "egammaContainer" ]           = "egammaContainer_p1";
  m_oldEDMmap[ "Analysis::TauJetContainer" ] = "TauJetContainer_p3";
  m_oldEDMmap[ "TrigTrackCounts" ]           = "TrigTrackCountsCollection_tlp1";
  m_oldEDMmap[ "TrackCollection" ]           = "Trk::TrackCollection_tlp2";
  m_oldEDMmap[ "Rec::TrackParticleContainer" ]   = "Rec::TrackParticleContainer_tlp1";
  m_oldEDMmap[ "Analysis::TauDetailsContainer" ] ="TauDetailsContainer_tlp1";
  m_oldEDMmap[ "VxContainer" ]               = "";
  m_oldEDMmap[ "CaloCellContainer" ]         = "CaloCompactCellContainer";
 
  
  return StatusCode::SUCCESS;
}
 
StatusCode TrigSerializeConvHelper::createObj(const std::string &clname, IOpaqueAddress* iAddr, void *&ptr, bool isxAOD){
  ptr = 0;
  ATH_MSG_DEBUG("in TrigSerializeConvHelper::createObj for clname " << clname << " is xAOD? " << (isxAOD?"yes":"no"));
 
  //could alse get DATA (perhaps as std::any) from the IOA
  TrigStreamAddress *addr = dynamic_cast<TrigStreamAddress*>(iAddr);
  if (!addr) {
    ATH_MSG_WARNING("createObj cast failed");
    return StatusCode::FAILURE;
  }
  
  ITrigSerializerToolBase* serializer = m_serializerTool.operator->();
  serializer->reset();
  
  std::vector<uint32_t> v = addr->get();
  
  //we need to find the name of the ob
  std::string cl = clname;
 
  if (m_doTP and !isxAOD)
    cl = m_TPTool->persClassName(clname);
 
  uint32_t guid[4];
 
  bool versionChange = false;
 
  if (cl!=""){
    StatusCode scid;
    scid = serializer->peekCLID(v, guid);
    if (scid.isFailure()){
      //BS has no hint on the pers class - use the original table
      ATH_MSG_DEBUG("BS does not hint on payload object " << cl);
      if (m_oldEDMmap.find(clname)!=m_oldEDMmap.end()){
        if (cl!=m_oldEDMmap[clname]){
          ATH_MSG_DEBUG("Using backward compatibility map with " <<  m_oldEDMmap[clname]
                        << " instead of " << cl);
          cl = m_oldEDMmap[clname];
        }
      }
    } else {
      //get the pers version from the BS
      std::string nclass = cl;
      StatusCode ai = m_guidTool->IntsToClassName(guid, nclass);
      if (ai.isFailure()) {
    //better do not decode
    return StatusCode::FAILURE;
      }
      if (cl != nclass){
        cl =  nclass;
        ATH_MSG_DEBUG("Got hint of " << cl << " different persistent class from the BS payload. Name from GUID: " << nclass);
 
        if(isxAOD){
          ATH_MSG_DEBUG("This is an xAOD so probably the BS version is an older version of the xAOD type.");
        }
        versionChange = true;
      }
    }
 
    // Many variables in this class were changed from double to float.
    // However, we wrote data in the past which contained values
    // that were valid doubles but which were out of range for floats.
    // So we can get FPEs when we read them.
    // Disable FPEs when we're reading an instance of this class.
    CxxUtils::FPControl fpcontrol;
    if (cl == "xAOD::BTaggingTrigAuxContainer_v1") {
      fpcontrol.holdExceptions();
    }
 
    ptr = serializer->deserialize(cl, v);
 
    ATH_MSG_DEBUG(cl << " deserialized to " << ptr << " version change detected: " << (versionChange ? "yes":"no"));
  }
   
  // T/P separation
  bool isViewVector = cl.substr(0, 11) == "ViewVector<";
  if (m_doTP and (!isxAOD or versionChange) and !isViewVector){
    std::string transclass;
 
    ATH_MSG_DEBUG("converting with pername " << cl);
    
    void *transObj = m_TPTool->convertPT(cl,ptr, transclass);
 
    ATH_MSG_DEBUG("was converted to " << transclass << " at " << transObj);
 
    //persistent object not needed anymore
    RootType persClObj(cl);
    persClObj.Destruct(ptr);
 
    ptr = transObj;
  }
 
  return StatusCode::SUCCESS;
}
 
 
 
StatusCode TrigSerializeConvHelper::createRep(const std::string &clname,
                          void *ptr, std::vector<uint32_t> &out, bool isxAOD){
  
  StatusCode sc(StatusCode::SUCCESS);
 
  ATH_MSG_DEBUG("in TrigSerializeConvHelper::createRep for clname" << clname << " is xAOD? " << (isxAOD?"yes":"no"));
 
  std::string cl = clname;
  void *pObj = ptr;
 
  // T/P separation
  if (m_doTP and !isxAOD){
    std::string persclass("");
    pObj = m_TPTool->convertTP(clname,ptr, persclass);
    cl = std::move(persclass);
  }
 
  ATH_MSG_DEBUG("convertTP: " << pObj << " of " << cl);
 
  //void *serptr(0);
  //
  ITrigSerializerToolBase* serializer = m_serializerTool.operator->();
  serializer->reset();
 
  ATH_MSG_VERBOSE("About to get GUID for " << cl);
 
  //opposite from string to class
  uint32_t irep[4];
  StatusCode ai = m_guidTool->ClassNameToInts(cl, irep);
  if (ai.isFailure()){
    ATH_MSG_WARNING("Cannot store class identification for " << cl << " to BS");
  }
 
  ATH_MSG_VERBOSE("got GUID: " << irep[0] << "-" << irep[1] << "-" << irep[2] << "-" << irep[3]);
 
  if (cl != "" && pObj){
    serializer->setCLID(irep);
    serializer->serialize(cl, pObj, out);
  } else {
    ATH_MSG_WARNING("did not serialize " << ptr << " of " << clname);
  }
 
  if (m_doTP and !isxAOD){
    //we don't need the persistent object anymore
     RootType persClObj(cl);
     persClObj.Destruct(pObj);
  }
 
  ATH_MSG_DEBUG("pObj: " << pObj << " of " << cl << " payload: " << out.size());
 
  return sc;
}