IOVSvc.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
/*****************************************************************************
 *
 *  IOVSvc.cxx
 *  IOVSvc
 *
 *  Author: Charles Leggett
 *
 *  Provides automatic updating and callbacks for time dependent data
 *
 *****************************************************************************/
 
#include "IOVSvc.h"
 
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/IAlgTool.h"
#include "GaudiKernel/IToolSvc.h"
#include "GaudiKernel/IClassIDSvc.h"
#include "GaudiKernel/IConversionSvc.h"
 
#include "AthenaKernel/DataBucketBase.h"
#include "AthenaKernel/IAddressProvider.h"
#include "AthenaKernel/IIOVDbSvc.h"
#include "AthenaKernel/IOVInfiniteRange.h"
#include "IOVSvc/IIOVSvcTool.h"
#include "SGTools/DataProxy.h"
 
#include <ranges>
 
 
namespace {
 
const std::string defaultStore = "StoreGateSvc";

bool eventIDMatch (const EventIDBase& e1, const EventIDBase& e2)
{
  if (e1.isRunLumi()) {
    if (e1.run_number() != e2.run_number()) return false;
    if (e1.lumi_block() != e2.lumi_block()) return false;
  }
  if (e1.isTimeStamp()) {
    if (e1.time_stamp() != e2.time_stamp()) return false;
    if (e1.time_stamp_ns_offset() != e2.time_stamp_ns_offset()) return false;
  }
  return true;
}
 
 
} // anonymous namespace
 
 
 
//
//
 
IOVSvc::IOVSvc( const std::string& name, ISvcLocator* svc )
  : base_class( name, svc ), 
    p_toolSvc("ToolSvc",name),
    p_CLIDSvc("ClassIDSvc",name),
    p_sgs("StoreGateSvc",name),
    p_detStore("StoreGateSvc/DetectorStore",name),
    p_condSvc("CondSvc",name)
{
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode IOVSvc::initialize() {
 
  msg().setLevel( m_outputLevel.value() );
  ATH_MSG_DEBUG( "Initializing IOVSvc" );
 
  ATH_CHECK( p_sgs.retrieve() );
  ATH_CHECK( p_detStore.retrieve() );
  ATH_CHECK( p_condSvc.retrieve() );
 
  return StatusCode::SUCCESS;
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

StatusCode 
IOVSvc::regProxy( SG::DataProxy *proxy, const std::string& key,
                  const std::string& storeName ) {
 
  std::scoped_lock lock(m_lock);
  IIOVSvcTool *ist = getTool( storeName );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "regProxy: no IOVSvcTool associated with store \"" 
                   << storeName << "\" and failed to create one"  );
    return (StatusCode::FAILURE);
  }
 
  IIOVSvcTool *ist2 = getTool( proxy );
  if (ist2 != nullptr) {
    if (ist2 != ist) {
      ATH_MSG_ERROR( "regProxy: when registering proxy for " 
                     << fullProxyName(proxy) << " with store \"" << storeName
                     << "\", it is already registered with store \"" 
                     << ist2->getStoreName() << "\""  );
      return StatusCode::FAILURE;
    } else {
      ATH_MSG_DEBUG( "regProxy: proxy for " << fullProxyName(proxy)
                     << " already registered with store \"" << storeName << "\""
                     );
      return StatusCode::SUCCESS;
    }
  }
 
  return ist->regProxy( proxy, key );
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

StatusCode 
IOVSvc::regProxy( const CLID& clid, const std::string& key,
                  const std::string& storeName ) {
 
  std::scoped_lock lock(m_lock);
  IIOVSvcTool *ist = getTool( storeName );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "regProxy: no IOVSvcTool associated with store \"" 
                   << storeName << "\" and failed to create one."  );
    return (StatusCode::FAILURE);
  }
 
  IIOVSvcTool *ist2 = getTool( clid, key );
  if (ist2 != nullptr) {
    if (ist2 != ist) {
      ATH_MSG_ERROR( "regProxy: when registering proxy for "
                     << fullProxyName(clid,key)
                     << " with store " << storeName
                     << ", it is already registered with store \"" 
                     << ist2->getStoreName() << "\""  );
      return StatusCode::FAILURE;
    } else {
      ATH_MSG_DEBUG( "regProxy: proxy for " << fullProxyName(clid,key)
                     << " already registered with store \"" << storeName << "\""
                     );
      return StatusCode::SUCCESS;
    }
  }
 
  return ist->regProxy( clid, key );
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

StatusCode 
IOVSvc::deregProxy( SG::DataProxy *proxy ) {
 
  std::scoped_lock lock(m_lock);
  IIOVSvcTool *ist = getTool( proxy );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "deregProxy: no IOVSvcTool found for proxy "
          << fullProxyName( proxy ) );
    return StatusCode::FAILURE;
  }
 
  return ist->deregProxy( proxy );
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

StatusCode 
IOVSvc::deregProxy( const CLID& clid, const std::string& key ) {
 
  std::scoped_lock lock(m_lock);
  IIOVSvcTool *ist = getTool( clid, key );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "deregProxy: no IOVSvcTool found for proxy " 
                   << fullProxyName(clid,key) );
    return StatusCode::FAILURE; 
  }
 
  return ist->deregProxy( clid, key );
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

void
IOVSvc::ignoreProxy( const CLID& clid, const std::string& key, 
                     const std::string& storeName ) {
 
  IIOVSvcTool *ist = getTool( storeName );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "ignoreProxy: no IOVSvcTool found for store " 
                   << storeName << " and failed to create one" );
    return;
  }
 
  return ist->ignoreProxy( clid, key );
}
 
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

StatusCode 
IOVSvc::replaceProxy( SG::DataProxy* pOld, SG::DataProxy* pNew,
                      const std::string& storeName ) {
 
  StatusCode sc(StatusCode::FAILURE);
  IIOVSvcTool *ist = getTool( storeName );
  if (ist != nullptr) {
    sc = ist->replaceProxy(pOld, pNew);
  } else {
    ATH_MSG_ERROR( "regProxy: no IOVSvcTool associated with store \"" 
                   << storeName << "\" and failed to create one."  );
  } 
  return sc;
}
 
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

 
StatusCode 
IOVSvc::preLoadTAD( const SG::TransientAddress *tad,
                    const std::string& storeName ) {
 
 
  IIOVSvcTool *ist = getTool( storeName );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "preLoadTAD: no IOVSvcTool associated with store \""
                   << storeName << "\" and failed to create one."  );
    return StatusCode::FAILURE;
  } else {
    return ist->preLoadTAD( tad );
  }
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

StatusCode 
IOVSvc::preLoadDataTAD( const SG::TransientAddress *tad,
                        const std::string& storeName ) {
 
  IIOVSvcTool *ist = getTool( storeName );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "preLoadDataTAD: no IOVSvcTool associated with store \""
                   << storeName << "\" and failed to create one."  );
    return StatusCode::FAILURE;
  } else {
    return ist->preLoadDataTAD( tad );
  }
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode 
IOVSvc::setRange(const CLID& clid, const std::string& key,
                 IOVRange& iovr, const std::string& storeName) {
 
  std::scoped_lock lock(m_lock);
 
  IIOVSvcTool *ist = getTool( storeName );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "setRange: no IOVSvcTool associated with store \""
                   << storeName << "\" and failed to create one."  );
    return StatusCode::FAILURE;
  }
 
  IIOVSvcTool *ist2 = getTool( clid, key );
  if (ist2 == nullptr) {
    ATH_MSG_INFO( "setRange: proxy for " << fullProxyName(clid,key)
                  << " not registered with store \"" << storeName << "\". Doing it now"
                  );
    if (ist->regProxy(clid, key).isFailure()) {
      return StatusCode::FAILURE;
    }
  } else if (ist2 != ist) {
    ATH_MSG_INFO( "setRange: when registering proxy (clid: " 
                  << clid << " key: " << key << ") with store \"" << storeName
                  << "\" --> already registered with store \"" << ist2->getStoreName()
                  << "\""  );
    return StatusCode::FAILURE;
  }
 
  return ist->setRange( clid, key, iovr );
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode
IOVSvc::dropObjectFromDB(const CLID& clid, const std::string& key,
                         const std::string& storeName) {
 
  std::scoped_lock lock(m_lock);
 
  IIOVSvcTool *ist = getTool( clid, key );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "dropObjectFromDB: no IOVSvcTool associated with store "
                   << storeName << " and failed to create one."  );
    return StatusCode::FAILURE;
  }
 
  SG::DataProxy* proxy = p_detStore->proxy(clid, key);
  if (proxy == nullptr) {
    ATH_MSG_DEBUG("Proxy for (clid: " << clid << " key: " << key << ") in store " << storeName
                  << " does not exist. Cannot drop associated object.");
    return StatusCode::SUCCESS;
  }
 
  // Set IOV in the past to trigger reload on next range check
  IOVRange iovr(IOVTime(0, 0), IOVTime(0, 0));
  ATH_CHECK( ist->setRange(clid, key, iovr) );
 
  IIOVDbSvc *iovDB = dynamic_cast<IIOVDbSvc*>(proxy->provider());
  if (iovDB != nullptr) {
    ATH_MSG_DEBUG("Dropping " << key << "via IOVDBSvc");
    ATH_CHECK( iovDB->dropObject(key, /*resetCache=*/true) );
  } else {
    ATH_MSG_ERROR("dropObjectFromDB: Provider for " << key << " is not an IIOVDbSvc.");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}
 
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode 
IOVSvc::getRange(const CLID& clid, const std::string& key, 
                 IOVRange& iov) const {
 
  IIOVSvcTool *ist = getTool( clid, key );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "getRange: proxy for " << fullProxyName(clid,key)
                   << " not registered"  );
    return StatusCode::FAILURE;
  } else {
    return ist->getRange( clid, key, iov );
  }
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode 
IOVSvc::getRangeFromDB(const CLID& clid, const std::string& key, 
                       IOVRange& range, std::string& tag,
                       std::unique_ptr<IOpaqueAddress>& ioa,
                       const EventIDBase& now) const {
 
  std::scoped_lock lock(m_lock);
 
  IIOVSvcTool *ist = getTool( clid, key );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "getRangeFromDB: proxy for " 
                   << fullProxyName(clid,key) << " not registered"  );
    return StatusCode::FAILURE;
  } else {
    
    uint32_t event = now.lumi_block();
    uint32_t run   = now.run_number();
    IOVTime curTime;
    curTime.setRunEvent(run,event);
    // get ns timestamp from event
    curTime.setTimestamp(1000000000L*static_cast<uint64_t>(now.time_stamp()) + now.time_stamp_ns_offset());
 
 
    return ist->getRangeFromDB( clid, key, range, tag, ioa, curTime );
  }
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode 
IOVSvc::getRangeFromDB(const CLID& clid, const std::string& key,
                       const IOVTime& time, IOVRange& range, 
                       std::string& tag,
                       std::unique_ptr<IOpaqueAddress>& ioa) const {
 
  std::scoped_lock lock(m_lock);
 
  IIOVSvcTool *ist = getTool( clid, key );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "getRangeFromDB: proxy for "
                   << fullProxyName(clid, key) << " not registered"  );
    return StatusCode::FAILURE;
  } else {
    return ist->getRangeFromDB( clid, key, time, range, tag, ioa );
  }
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode 
IOVSvc::setRangeInDB(const CLID& clid, const std::string& key, 
                     const IOVRange& range, const std::string &tag) {
  
  IIOVSvcTool *ist = getTool( clid, key );
  if (ist == nullptr) {
    ATH_MSG_ERROR( "setRangeInDB: proxy for "
                   << fullProxyName(clid,key) << " not registered"  );
    return StatusCode::FAILURE;
  } else {
    return ist->setRangeInDB( clid, key, range, tag );
  }
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode 
IOVSvc::reinitialize()
{
  StatusCode sc;
  for (const auto& [name, ist] : m_toolMap) {
    sc &= ist->reinitialize();
  }
  return sc;
 
}
 
 
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode
IOVSvc::createIOVTool( const std::string& storeName, IIOVSvcTool*& ist ) {
 
  std::string store(storeName);
  std::string toolName("IOVSvcTool");
  if (storeName == "default") {
    store = defaultStore;
  }
  else {
    // Append the store name if not default
    toolName += '_';
    toolName += store;
  }
 
  ATH_MSG_DEBUG( "Creating " << toolName << " associated with store \"" << store
                 << "\""  );
 
  const auto itr = m_toolMap.find( store );
  if ( itr == m_toolMap.end() ) {
    ist = nullptr;
    if (p_toolSvc->retrieveTool( "IOVSvcTool/" + toolName, ist, this ).isFailure()) {
      ATH_MSG_ERROR( "Unable to create IOVSvcTool associated with store \"" 
                     << store << "\""  );
      return StatusCode::FAILURE;
    } else {
      m_toolMap[ store ] = ist;
      ist->setStoreName( store );
      return StatusCode::SUCCESS;
    }
  } else {
    ATH_MSG_INFO( "an IOVSvcTool already exists associated with store \"" 
                  << store << "\""  );
    ist = itr->second;
    return StatusCode::SUCCESS;
  }
 
}
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode
IOVSvc::createIOVTool( const std::string& storeName )
{
  IIOVSvcTool* ist = nullptr;
  return createIOVTool (storeName, ist);
}
 
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
IIOVSvcTool* 
IOVSvc::getTool( const std::string& storeName, bool createIF ) {
 
  const std::string store = (storeName=="default" ? defaultStore : storeName);
 
  const auto itr = m_toolMap.find( store );
  IIOVSvcTool *ist = nullptr;
  if ( itr == m_toolMap.end() ) {
    ATH_MSG_INFO( "No IOVSvcTool associated with store \"" << store
                  << "\""  );
 
    if (createIF) {
      createIOVTool(store, ist).ignore();
    }
 
  } else {
    ist = itr->second;
  }
 
  return ist;
}
    
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
IIOVSvcTool* 
IOVSvc::getTool( SG::DataProxy* proxy ) const {
 
  for (const auto& [name, ist] : m_toolMap) {
    if (ist->holdsProxy( proxy )) {
      return ist;
    }
  }
 
  return nullptr;
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
IIOVSvcTool* 
IOVSvc::getTool( const CLID& clid, const std::string& key ) const {
 
  for (const auto& [name, ist] : m_toolMap) {
    if (ist->holdsProxy( clid, key )) {
      return ist;
    }
  }
 
  return nullptr;
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
std::string
IOVSvc::fullProxyName( const SG::DataProxy* dp ) const {
 
  return fullProxyName(dp->clID(), dp->name());
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
std::string
IOVSvc::fullProxyName( const CLID& clid, const std::string& key ) const {
 
  std::string fullname, tname;
  if (p_CLIDSvc->getTypeNameOfID( clid, tname ).isFailure()) {
    fullname = "[";
    fullname += std::to_string(clid);
    fullname += '/';
    fullname += key;
    fullname += ']';
  } else {
    fullname = "[";
    fullname += tname;
    fullname += ':';
    fullname += std::to_string(clid);
    fullname += '/';
    fullname += key;
    fullname += ']';
  }
 
  return fullname;
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
std::vector<std::string>
IOVSvc::getStoreNames() const {
 
  auto keys = m_toolMap | std::views::keys;
  return std::vector<std::string>(keys.begin(), keys.end());
 
}
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
void
IOVSvc::resetAllProxies() {
 
  for (auto& [name, ist] : m_toolMap) {
    ATH_MSG_DEBUG( "resetting all proxies for store \""
                   << ist->getStoreName() << "\""  );
    ist->resetAllProxies();
  }
 
}
  
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
StatusCode 
IOVSvc::createCondObj(CondContBase* ccb, const DataObjID& id, 
                      const EventIDBase& now) {
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  ATH_MSG_DEBUG("createCondObj:  id: " << id << "  t: " << now << "  valid: "
                << ccb->valid(now));
 
  if (ccb->valid(now)) {
    if (msgLvl(MSG::DEBUG)) {
      EventIDRange r;
      ccb->range(now,r);
      ATH_MSG_DEBUG( "  range " << r << " for " << id 
                     << " is still valid at " << now );
    }
    return StatusCode::SUCCESS;
  }
 
  IOVTime t(now.run_number(), now.lumi_block(),
            now.time_stamp()*1000000000LL + now.time_stamp_ns_offset());
 
  // remove storename from key
  std::string sgKey = id.key();
  auto sep = sgKey.find('+');
  if (sep != std::string::npos) {
    sgKey.erase(0,sep+1);
  }
  
  std::unique_ptr<IOpaqueAddress> ioa;
  std::string tag;
  IOVRange range;
  if (getRangeFromDB(id.clid(), sgKey, t, range, tag, ioa).isFailure()) {
    ATH_MSG_ERROR( "unable to get range from db for time "  << t << " clid "
                   << id.clid() << " " << sgKey );
    return StatusCode::FAILURE;
  }
     
  //In case the conditons-container is a 'mixed' type, we need both run/lb and time-stamps in the range. 
  //Assume infinite IOV in the other dimension 
  EventIDRange eidRange(range);   
  if (ccb->keyType()==CondContBase::KeyType::MIXED) { 
    eidRange=EventIDRange::intersect(IOVInfiniteRange::infiniteMixed(),eidRange);    
  } 
  ATH_MSG_DEBUG( " new range for ID " << id << " : " << range 
                 << " IOA: " << ioa.get());
 
  // If the start of the new range matches the start of the last range, then
  // extend the last range rather than trying to insert a new range.
  // This can happen when a folder is tagged as `extensible' in IOVDbSvc.
  EventIDRange r;
  if (ccb->range (eidRange.start(), r) &&
      eventIDMatch (r.start(), eidRange.start()))
  {
    if (ccb->extendLastRange (eidRange, ctx).isSuccess()) {
      return StatusCode::SUCCESS;
    }
  }
 
  if (ccb->proxy() == nullptr) {
    // nb. We don't want to be holding the IOVSvc lock here,
    // as SGImplSvc can call to IOVSvc with the store lock held.
    SG::DataProxy* dp = p_detStore->proxy (id.clid(), sgKey);
    ATH_MSG_DEBUG( " found DataProxy " << dp << " for " << id );
    ccb->setProxy(dp);
  }
 
  // this will talk to the IOVDbSvc, get current run/event from EventInfo 
  // object, load
  SG::DataProxy* dp = ccb->proxy();
  DataObject* dobj = nullptr;
  void* v = nullptr;
 
  if (dp->store()->createObj(dp->loader(), ioa.get(), dobj).isFailure()) {
    ATH_MSG_ERROR(" could not create a new DataObject ");
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_DEBUG(" created new obj at " << dobj );
 
    v = SG::Storable_cast(dobj, id.clid());
  }
 
  // Free the DataBucket that was created along with the object we read.
  if (DataBucketBase* dbb = dynamic_cast<DataBucketBase*> (dobj)) {
    dbb->relinquish();
    delete dobj;
    dobj = nullptr;
  }
 
  // Some data objects may be reference counted by the address.
  // CondCont will take ownership of the object, but doesn't
  // do refcounting.  We'll have gotten a reference via the Storable_cast
  // above, so it should be ok ... unless CondCont deletes
  // the new object immediately instead of inserting.
  // In that case, when we delete the address, it will
  // follow an invalid pointer.  So be sure to delete
  // the address before the object is added to CondCont.
  ioa.reset();
 
  // DataObject *d2 = static_cast<DataObject*>(v);
  
  ATH_MSG_DEBUG( " SG::Storable_cast to obj: " << v );
 
  StatusCode sc = ccb->typelessInsert (eidRange, v, ctx);
  if (!sc.isSuccess()) {
    ATH_MSG_ERROR("unable to insert Object at " << v << " into CondCont " 
                  << ccb->id() << " for range " << eidRange );
    return StatusCode::FAILURE;
  }
  else if (CondContBase::Category::isOverlap (sc)) {
    // Disable this for now... IOVDbSvc can sometimes produce overlapping
    // ranges.
    //ATH_MSG_ERROR ("IOV range overlap.");
    //return StatusCode::FAILURE;
  }
 
  return sc;
 
}