AthenaPoolConverter.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "AthenaPoolCnvSvc/AthenaPoolConverter.h"
#include "AthenaPoolCnvSvc/IAthenaPoolCnvSvc.h"
 
#include "SGTools/DataProxy.h"
 
#include "PersistentDataModel/Guid.h"
#include "PersistentDataModel/Placement.h"
#include "PersistentDataModel/Token.h"
#include "PersistentDataModel/TokenAddress.h"
#include "StorageSvc/DbType.h"
#include "RootUtils/APRDefaults.h"
#include <format>
 
//__________________________________________________________________________
AthenaPoolConverter::~AthenaPoolConverter() {
   delete m_i_poolToken; m_i_poolToken = nullptr;
}
//__________________________________________________________________________
StatusCode AthenaPoolConverter::initialize() {
   ATH_CHECK(::Converter::initialize());
 
   // We do not retrieve m_detStore as that store may not always be available!
 
   ATH_CHECK( m_athenaPoolCnvSvc.retrieve() );
 
   IProperty* propertyServer(dynamic_cast<IProperty*>(m_athenaPoolCnvSvc.get()));
   StringProperty containerPrefixProp("PoolContainerPrefix", "CollectionTree");
   StringProperty containerNameHintProp("TopLevelContainerName", "");
   StringProperty branchNameHintProp("SubLevelBranchName", "<type>/<key>");
   if (propertyServer) {
      propertyServer->getProperty(&containerPrefixProp).ignore();
      propertyServer->getProperty(&containerNameHintProp).ignore();
      propertyServer->getProperty(&branchNameHintProp).ignore();
   }
   m_containerPrefix = containerPrefixProp.value();
   m_containerNameHint = containerNameHintProp.value();
   m_branchNameHint = branchNameHintProp.value();
   return StatusCode::SUCCESS;
}
//__________________________________________________________________________
StatusCode AthenaPoolConverter::finalize() {
   // Release AthenaPoolCnvSvc
   if (!m_athenaPoolCnvSvc.release().isSuccess()) {
      ATH_MSG_WARNING("Cannot release AthenaPoolCnvSvc.");
   }
   return(::Converter::finalize());
}
//__________________________________________________________________________
long AthenaPoolConverter::repSvcType() const {
   return pool::POOL_StorageType.type();
}
//__________________________________________________________________________
StatusCode AthenaPoolConverter::createObj(IOpaqueAddress* pAddr, DataObject*& pObj) {
   TokenAddress* tokAddr = dynamic_cast<TokenAddress*>(pAddr);
   
   bool ownTokAddr = false;
   if (tokAddr == nullptr || tokAddr->getToken() == nullptr) {
      ownTokAddr = true;
      auto token = std::make_unique<Token>();
      token->fromString(*(pAddr->par()));
      GenericAddress* genAddr = dynamic_cast<GenericAddress*>(pAddr);
      if (not genAddr){
        ATH_MSG_ERROR("Dynamic cast failed in AthenaPoolConverter::createObj");
        //clean up
        return StatusCode::FAILURE;
      }
      tokAddr = new TokenAddress(*genAddr, std::move(token));
   }
   if( tokAddr->ipar()[0] > 0 and tokAddr->getToken()->auxString().empty() ) {
      char text[32];
      const std::string contextStr = std::format("[CTXT={:08X}]", static_cast<int>(*(pAddr->ipar())));
      std::strncpy(text, contextStr.c_str(), sizeof(text) - 1);
      text[sizeof(text) - 1] = '\0';
      tokAddr->getToken()->setAuxString(text);
   }
   ATH_MSG_VERBOSE("createObj: " << tokAddr->getToken()->toString() << ", CTX=" << tokAddr->ipar()[0]
                   << ", auxStr=" << tokAddr->getToken()->auxString() );
   std::lock_guard<CallMutex> lock(m_conv_mut);
   m_i_poolToken = tokAddr->getToken();
   try {
      std::string key = pAddr->par()[1];
      if (!PoolToDataObject(pObj, tokAddr->getToken(), key).isSuccess()) {
         ATH_MSG_ERROR("createObj PoolToDataObject() failed, Token = " << (tokAddr->getToken() ? tokAddr->getToken()->toString() : "NULL"));
         pObj = nullptr;
      }
   } catch (std::exception& e) {
      ATH_MSG_ERROR("createObj - caught exception: " << e.what());
      pObj = nullptr;
   }
   if (pObj == nullptr) {
      ATH_MSG_ERROR("createObj failed to get DataObject, Token = " << (tokAddr->getToken() ? tokAddr->getToken()->toString() : "NULL"));
   }
   if (ownTokAddr) {
      delete tokAddr; tokAddr = nullptr;
   }
   m_i_poolToken = nullptr;
   if (pObj == nullptr) {
      return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
}
//__________________________________________________________________________
StatusCode AthenaPoolConverter::createRep(DataObject* pObj, IOpaqueAddress*& pAddr) {
   const SG::DataProxy* proxy = dynamic_cast<SG::DataProxy*>(pObj->registry());
   if (proxy == nullptr) {
      ATH_MSG_ERROR("AthenaPoolConverter CreateRep failed to cast DataProxy, key = " << pObj->name());
      return StatusCode::FAILURE;
   }
   try {
      std::lock_guard<CallMutex> lock(m_conv_mut);
      if (!DataObjectToPers(pObj, pAddr).isSuccess()) {
         ATH_MSG_ERROR("CreateRep failed, key = " << pObj->name());
         return StatusCode::FAILURE;
      }
   } catch (std::exception& e) {
      ATH_MSG_ERROR("createRep - caught exception: " << e.what());
      return StatusCode::FAILURE;
   }
   const CLID clid = proxy->clID();
   if (pAddr == nullptr) {
      // Create a IOpaqueAddress for this object.
      pAddr = new TokenAddress(this->storageType(), clid, "", "", 0, 0);
   } else {
      GenericAddress* gAddr = dynamic_cast<GenericAddress*>(pAddr);
      if (gAddr != nullptr) {
         gAddr->setSvcType(this->storageType());
      }
   }
   return StatusCode::SUCCESS;
}
//__________________________________________________________________________
StatusCode AthenaPoolConverter::fillRepRefs(IOpaqueAddress* pAddr, DataObject* pObj) {
   std::lock_guard<CallMutex> lock(m_conv_mut);
   try {
      if (!DataObjectToPool(pAddr, pObj).isSuccess()) {
         ATH_MSG_ERROR("FillRepRefs failed, key = " << pObj->name());
         return StatusCode::FAILURE;
      }
   } catch (std::exception& e) {
      ATH_MSG_ERROR("fillRepRefs - caught exception: " << e.what());
      return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
}
//__________________________________________________________________________
long AthenaPoolConverter::storageType() {
   return pool::POOL_StorageType.type();
}
//__________________________________________________________________________
AthenaPoolConverter::AthenaPoolConverter(const CLID& myCLID, ISvcLocator* pSvcLocator,
                                         const char* name /*= nullptr*/) :
        ::Converter(storageType(), myCLID, pSvcLocator),
        ::AthMessaging((pSvcLocator != nullptr ? msgSvc() : nullptr),
                               name ? name : "AthenaPoolConverter"),
    m_detStore("DetectorStore", name ? name : "AthenaPoolConverter"),
    m_athenaPoolCnvSvc(pSvcLocator && pSvcLocator->existsService("AthenaPoolSharedIOCnvSvc") ? "AthenaPoolSharedIOCnvSvc" : "AthenaPoolCnvSvc", name ? name : "AthenaPoolConverter"),
    m_classDesc(),
    m_className(),
    m_classDescs(),
    m_containerPrefix(""),
    m_containerNameHint(""),
    m_branchNameHint(""),
    m_dataObject(nullptr),
    m_i_poolToken(nullptr) {
}
//__________________________________________________________________________
Placement AthenaPoolConverter::setPlacementWithType(const std::string& tname, const std::string& key, const std::string& output) {
   Placement placement;
   // Override streaming parameters from StreamTool if requested.
   std::string::size_type pos1 = output.find('[');
   std::string outputConnectionSpec = output.substr(0, pos1);
   int tech = 0;
   m_athenaPoolCnvSvc->decodeOutputSpec(outputConnectionSpec, tech).ignore();
   // Set DB and Container names
   placement.setFileName(outputConnectionSpec);
 
   std::string containerPrefix = m_containerPrefix;
   if( containerPrefix == "Default" ) {
      containerPrefix = pool::ROOTRNTUPLE_StorageType.exactMatch(tech) ? APRDefaults::RNTupleNames::EventData : APRDefaults::TTreeNames::EventData;
   }
   std::string dhContainerPrefix = pool::ROOTRNTUPLE_StorageType.exactMatch(tech) ? APRDefaults::RNTupleNames::DataHeader : APRDefaults::TTreeNames::DataHeader;
   std::string containerName;
 
   // Get Technology from containerPrefix
   std::size_t colonPos = containerPrefix.find(':');
   if (colonPos != std::string::npos) {
      dhContainerPrefix = containerPrefix.substr(0, colonPos + 1) + dhContainerPrefix;
   }
 
   // Override streaming parameters from StreamTool if requested.
   std::string containerNameHint = m_containerNameHint;
   std::string branchNameHint = m_branchNameHint;
   std::string containerFriendPostfix;
   while (pos1 != std::string::npos) {
      const std::string::size_type pos2 = output.find('=', pos1);
      const std::string thisKey = output.substr(pos1 + 1, pos2 - pos1 - 1);
      const std::string::size_type pos3 = output.find(']', pos2);
      const std::string value = output.substr(pos2 + 1, pos3 - pos2 - 1);
      if (thisKey == "OutputCollection") {
         dhContainerPrefix = std::move(value);
      } else if (thisKey == "PoolContainerPrefix") {
         containerPrefix = std::move(value);
      } else if (thisKey == "TopLevelContainerName") {
        containerNameHint = std::move(value);
      } else if (thisKey == "SubLevelBranchName") {
         branchNameHint = std::move(value);
      } else if (thisKey == "PoolContainerFriendPostfix") {
         containerFriendPostfix = std::move(value);
      }
      pos1 = output.find('[', pos3);
   }
 
   // ---  Special types:   DataHeader & Form
   if( tname.compare(0, 10, "DataHeader") == 0 ) {
      if( tname.compare(10, 4, "Form") == 0 ) {
         containerName = dhContainerPrefix + "Form" + "(" + tname + ")";
      } else {
         if (key[key.size() - 1] == '/') {
            containerName = dhContainerPrefix + "(" + key + tname + ")";
         } else {
            containerName = dhContainerPrefix + "(" + tname + ")";
         }
      }
   }
   // AttributeList - writing attributes separately to EventTag container group
   else if (tname.compare(0, 13, "AttributeList") == 0) {
      // Find the right storage type and name for EventTag values
      if( pool::ROOTRNTUPLE_StorageType.exactMatch(tech) ) {
         containerName = std::string(APRDefaults::RNTupleNames::EventTag) + "(" + key + ")";
      } else {
         // no indexing needed (nothing points to Tags)
         // safe to set tech here - it will not be overwritten by decodeOutput
         tech = pool::ROOTTREE_StorageType.type();
         containerName = std::string(APRDefaults::TTreeNames::EventTag) + "(" + key + ")";
      }
   }
   // all other object types
   else {
      const std::string typeTok = "<type>", keyTok = "<key>";
      containerName = containerPrefix + containerFriendPostfix + containerNameHint;
      if (!branchNameHint.empty()) {
         containerName += "(" + branchNameHint + ")";
      }
      const std::size_t pos1 = containerName.find(typeTok);
      if (pos1 != std::string::npos) {
         containerName.replace(pos1, typeTok.size(), tname);
      }
      const std::size_t pos2 = containerName.find(keyTok);
      if (pos2 != std::string::npos) {
         if (key.empty()) {
            containerName.replace(pos2, keyTok.size(), tname);
         } else {
            containerName.replace(pos2, keyTok.size(), key);
         }
      }
   }
   m_athenaPoolCnvSvc->decodeOutputSpec(containerName, tech).ignore();
   placement.setContainerName(containerName);
   placement.setTechnology(tech);
   return(placement);
}
//__________________________________________________________________________
const DataObject* AthenaPoolConverter::getDataObject() const {
   return(m_dataObject);
}
//__________________________________________________________________________
bool AthenaPoolConverter::compareClassGuid(const Guid &guid) const {
   return(m_i_poolToken ? (guid == m_i_poolToken->classID()) : false);
}
//__________________________________________________________________________
StatusCode AthenaPoolConverter::cleanUp(const std::string& /*output*/) {
   ATH_MSG_DEBUG("AthenaPoolConverter cleanUp called for base class.");
   return StatusCode::SUCCESS;
}