IOVDbSvc Class Reference

Athena service for Interval Of Validity database. The IOVDbSvc may be in one of three time states which determines from where the IOV time is coming: initialization - IOV time must be set from the EventSelector begin run - IOV time should have been set with signalBeginRun event loop - IOV time is from EventInfo. More...

#include <IOVDbSvc.h>

Inheritance diagram for IOVDbSvc:

Collaboration diagram for IOVDbSvc:

Classes
class	SvcFactory

Public Types
typedef IAddressProvider::tadList	tadList
typedef IAddressProvider::tadListIterator	tadListIterator

Public Member Functions
virtual	~IOVDbSvc ()
virtual StatusCode	initialize () override
	Service init. More...
StatusCode	io_reinit () override final
virtual StatusCode	finalize () override
	Service finalize. More...
StatusCode	io_finalize () override final
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface) override
	Query the interfaces. More...
virtual cool::IDatabasePtr	getDatabase (bool readOnly) override
	Access to COOL database for a given folder. More...
	DeclareInterfaceID (IAddressProvider, 1, 0)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const
Address use
virtual StatusCode	preLoadAddresses (StoreID::type storeID, tadList &list) override
	Get all addresses that the provider wants to preload in SG maps. More...
virtual StatusCode	loadAddresses (StoreID::type storeID, tadList &list) override
	Get all new addresses from Provider for this Event. More...
virtual StatusCode	updateAddress (StoreID::type storeID, SG::TransientAddress *tad, const EventContext &ctx) override
	Update a transient Address. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()

IOV range access
enum	IOVDbSvc_state { INITIALIZATION = 0, BEGIN_RUN, EVENT_LOOP, FINALIZE_ALG }
typedef std::vector< IOVDbConn * >	ConnVec
typedef std::map< std::string, IOVDbFolder * >	FolderMap
Gaudi::Property< std::string >	m_par_defaultConnection {this,"dbConnection","sqlite://;schema=cooldummy.db;dbname=OFLP200","default DB connection string"}
Gaudi::Property< std::string >	m_par_globalTag {this,"GlobalTag","","Global database tag"}
Gaudi::Property< std::string >	m_par_dbinst {this,"DBInstance","","Database instance (like OFLP200)"}
Gaudi::Property< std::vector< std::string > >	m_par_folders {this,"Folders",{},"List of database folders to preload","OrderedSet<std::string>"}
Gaudi::Property< std::vector< std::string > >	m_par_overrideTags {this,"overrideTags",{},"List of foolder-tag overrides","OrderedSet<std::string>"}
Gaudi::Property< std::vector< std::string > >	m_par_foldersToWrite {this,"FoldersToMetaData",{},"list of folders to write to file meta data","OrderedSet<std::string>"}
BooleanProperty	m_par_manageConnections {this,"ManageConnections",true,"flag to trigger the connections management"}
BooleanProperty	m_par_managePoolConnections {this,"ManagePoolConnections",true,"flag to manage pool connections"}
IntegerProperty	m_par_forceRunNumber {this,"forceRunNumber",0,"globally force run-number (default: no force)"}
IntegerProperty	m_par_forceLumiblockNumber {this,"forceLumiblockNumber",0,"globally force LB-number (default: no force)"}
IntegerProperty	m_par_forceTimestamp {this,"forceTimeStamp",0,"globally force time-stamp (default: no force)"}
IntegerProperty	m_par_maxNumPoolFiles {this,"MaxPoolFilesOpen",5,"max number of pool files open allowed (0 means no limit)"}
FloatProperty	m_par_timeStampSlop {this,"TimeStampSlop",0.0,"backdata timestamp IOVs by this many seconds"}
IntegerProperty	m_par_cacheRun {this,"CacheRun",0,"force larger numbers of runs to be cached"}
IntegerProperty	m_par_cacheTime {this,"CacheTime",0,"force larger timeranges to be cached (seconds)"}
UnsignedIntegerProperty	m_par_cacheAlign {this,"CacheAlign",0,"cache alignment - divide cache into N slices and align queries on slice"}
BooleanProperty	m_par_onlineMode {this,"OnlineMode",false,"online mode flag to ignore missing channels outside cache range"}
BooleanProperty	m_par_checklock {this,"CheckLock",false,"check to ensure global/HVS tags are locked (for production)"}
StringProperty	m_par_source {this,"Source","COOL_DATABASE","source of data as a string (default COOL_DATABASE)"}
StringProperty	m_par_crestServer {this,"crestServer","http://crest-undertow-api.web.cern.ch","CREST URL with the port number as a string (default http://crest-undertow-api.web.cern.ch)"}
std::map< std::string, std::string >	m_cresttagmap
StringProperty	m_par_format {this,"Format",{},"Format of data; default is empty string (default for a given source)"}
BooleanProperty	m_outputToFile {this,"OutputToFile",false,"output to file for debugging purposes"}
BooleanProperty	m_crestToFile {this,"CrestToFile",false,"output to file crest data for debugging purposes"}
BooleanProperty	m_crestCoolToFile {this,"CrestCoolToFile",false,"output to file crest or cool data in the same format for debugging purposes"}
ServiceHandle< IIOVSvc >	m_h_IOVSvc {this,"IOVSvc","IOVSvc"}
ServiceHandle< StoreGateSvc >	m_h_sgSvc {this,"StoreGateSvc","StoreGateSvc"}
ServiceHandle< StoreGateSvc >	m_h_detStore {this,"DetectorStore","DetectorStore"}
ServiceHandle< StoreGateSvc >	m_h_metaDataStore {this,"MetaDataStore","StoreGateSvc/MetaDataStore"}
ServiceHandle< IAddressCreator >	m_h_persSvc {this,"EventPersistencySvc","EventPersistencySvc"}
ServiceHandle< IClassIDSvc >	m_h_clidSvc {this,"ClassIDSvc","ClassIDSvc"}
ServiceHandle< IPoolSvc >	m_h_poolSvc {this,"PoolSvc","PoolSvc"}
PublicToolHandle< IIOVDbMetaDataTool >	m_h_metaDataTool {this,"IOVDbMetaDataTool","IOVDbMetaDataTool"}
ServiceHandle< ITagInfoMgr >	m_h_tagInfoMgr {this,"TagInfoMgr","TagInfoMgr"}
bool	m_poolPayloadRequested {false}
int	m_poolSvcContext {-1}
IOVDbSvc_state	m_state {INITIALIZATION}
IOVTime	m_iovTime {}
std::string	m_globalTag {}
cool::ValidityKey	m_iovslop {}
ConnVec	m_connections
FolderMap	m_foldermap
bool	m_abort {false}
virtual StatusCode	getRange (const CLID &clid, const std::string &dbKey, const IOVTime &time, IOVRange &range, std::string &tag, std::unique_ptr< IOpaqueAddress > &ioa) override
	Get range for a particular data object identified by its clid and key and a requested IOVTime. More...
virtual StatusCode	setRange (const CLID &clid, const std::string &dbKey, const IOVRange &range, const std::string &tag) override
	Set range for a particular data object. More...
virtual StatusCode	signalBeginRun (const IOVTime &beginRunTime, const EventContext &ctx) override
	Set time for begin run. More...
virtual void	signalEndProxyPreload () override
	Signal that callback has been fired. More...
virtual void	postConditionsLoad () override
	May be called once conditions are loaded to let IOVDbSvc release resources. More...
virtual void	handle (const Incident &incident) override
	Incident service handle for EndEvent. More...
virtual StatusCode	processTagInfo () override
	Process TagInfo. More...
virtual std::vector< std::string >	getKeyList () override
	return list of SG keys being provided by IOVDbSvc More...
virtual bool	getKeyInfo (const std::string &key, IIOVDbSvc::KeyInfo &info) override
	Return information about SG key return false if this key is not known to IOVDbSvc. More...
virtual bool	dropObject (const std::string &key, const bool resetCache=false) override
StatusCode	checkConfigConsistency () const
StatusCode	checkEventSel ()
StatusCode	setupFolders ()
StatusCode	fillTagInfo ()
StatusCode	loadCaches (IOVDbConn *conn, const IOVTime *time=nullptr)
int	poolSvcContext ()

Detailed Description

Athena service for Interval Of Validity database. The IOVDbSvc may be in one of three time states which determines from where the IOV time is coming: initialization - IOV time must be set from the EventSelector begin run - IOV time should have been set with signalBeginRun event loop - IOV time is from EventInfo.

Definition at line 77 of file IOVDbSvc.h.

Member Typedef Documentation

ConnVec

typedef std::vector<IOVDbConn*> IOVDbSvc::ConnVec

private

Definition at line 286 of file IOVDbSvc.h.

FolderMap

typedef std::map<std::string,IOVDbFolder*> IOVDbSvc::FolderMap

private

Definition at line 289 of file IOVDbSvc.h.

tadList

typedef IAddressProvider::tadList IOVDbSvc::tadList

Definition at line 110 of file IOVDbSvc.h.

tadListIterator

typedef IAddressProvider::tadListIterator IOVDbSvc::tadListIterator

Definition at line 111 of file IOVDbSvc.h.

Member Enumeration Documentation

IOVDbSvc_state

enum IOVDbSvc::IOVDbSvc_state

private

Enumerator
INITIALIZATION
BEGIN_RUN
EVENT_LOOP
FINALIZE_ALG

Definition at line 268 of file IOVDbSvc.h.

                      {
    INITIALIZATION = 0,
    BEGIN_RUN,
    EVENT_LOOP,
    FINALIZE_ALG
  };

Constructor & Destructor Documentation

~IOVDbSvc()

IOVDbSvc::~IOVDbSvc ( )

virtualdefault

Member Function Documentation

checkConfigConsistency()

StatusCode IOVDbSvc::checkConfigConsistency ( ) const

private

Definition at line 1177 of file IOVDbSvc.cxx.

                                                  {
// check consistency of global tag and database instance, if set
  // catch most common user misconfigurations
  // this is only done here as need global tag to be set even if read from file
  // @TODO should this not be done during initialize
  if (!m_par_dbinst.empty() && !m_globalTag.empty() and (m_par_source!="CREST")) {
    const std::string_view tagstub=std::string_view(m_globalTag).substr(0,7);
    ATH_MSG_DEBUG( "Checking " << m_par_dbinst << " against " <<tagstub );
    if (((m_par_dbinst=="COMP200" || m_par_dbinst=="CONDBR2") &&
         (tagstub!="COMCOND" && tagstub!="CONDBR2")) ||
        (m_par_dbinst=="OFLP200" && (tagstub!="OFLCOND" && tagstub!="CMCCOND"))) {
      ATH_MSG_FATAL( "Likely incorrect conditions DB configuration! "
             <<  "Attached to database instance " << m_par_dbinst <<
        " but global tag begins " << tagstub );
      ATH_MSG_FATAL( "See Atlas/CoolTroubles wiki for details," <<
        " or set IOVDbSvc.DBInstance=\"\" to disable check" );
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

checkEventSel()

StatusCode IOVDbSvc::checkEventSel ( )

private

Definition at line 886 of file IOVDbSvc.cxx.

                                   {
  // check if EventSelector is being used to override run numbers
  // if so, we can set IOV time already to allow conditons retrieval
  // in the initialise phase, needed for setting up simulation
 
  ServiceHandle<Gaudi::Interfaces::IOptionsSvc> joSvc("JobOptionsSvc",name());
  ATH_CHECK( joSvc.retrieve() );
 
  if (!joSvc->has("EventSelector.OverrideRunNumber")) {
    // do not return FAILURE if the EventSelector cannot be found, or it has
    // no override property, can e.g. happen in online running
    ATH_MSG_DEBUG( "No EventSelector.OverrideRunNumber property found" );
    return StatusCode::SUCCESS;
  }
 
  BooleanProperty bprop("OverrideRunNumber",false);
  ATH_CHECK( bprop.fromString(joSvc->get("EventSelector.OverrideRunNumber")) );
  if (bprop.value()) {
    // if flag is set, extract Run,LB and time
    ATH_MSG_INFO(  "Setting run/LB/time from EventSelector override in initialize" );
    uint32_t run,lumib;
    uint64_t time;
    bool allGood=true;
    if (m_par_forceRunNumber.value()!=0 ||
        m_par_forceLumiblockNumber.value()!=0)
      ATH_MSG_WARNING( "forceRunNumber property also set" );
    IntegerProperty iprop1("RunNumber",0);
    if (iprop1.fromString(joSvc->get("EventSelector.RunNumber","INVALID"))) {
      run=iprop1.value();
    } else {
      ATH_MSG_ERROR( "Unable to get RunNumber from EventSelector");
      allGood=false;
    }
    IntegerProperty iprop2("FirstLB",0);
    if (iprop2.fromString(joSvc->get("EventSelector.FirstLB","INVALID"))) {
      lumib=iprop2.value();
    } else {
      ATH_MSG_ERROR( "Unable to get FirstLB from EventSelector");
      allGood=false;
    }
    IntegerProperty iprop3("InitialTimeStamp",0);
    if (iprop3.fromString(joSvc->get("EventSelector.InitialTimeStamp","INVALID"))) {
      time=iprop3.value();
    } else {
      ATH_MSG_ERROR("Unable to get InitialTimeStamp from EventSelector" );
      allGood=false;
    }
    if (allGood) {
      m_iovTime.setRunEvent(run,lumib);
      uint64_t nsTime=time*1000000000LL;
      m_iovTime.setTimestamp(nsTime);
      ATH_MSG_INFO( "run/LB/time set to [" << run << "," << lumib << " : " << nsTime << "]" );
    } else {
      ATH_MSG_ERROR( "run/LB/Time NOT changed" );
    }
  }
 
  return StatusCode::SUCCESS;
}

DeclareInterfaceID()

IAddressProvider::DeclareInterfaceID ( IAddressProvider  , 1  , 0    )

inherited

dropObject()

bool IOVDbSvc::dropObject ( const std::string &  key, const bool  resetCache = false  )

overridevirtual

Implements IIOVDbSvc.

Definition at line 858 of file IOVDbSvc.cxx.

                                                                     {
  // find the folder corresponding to this object
  FolderMap::const_iterator itr=m_foldermap.find(key);
  if (itr!=m_foldermap.end()) {
    IOVDbFolder* folder=itr->second;
    CLID clid=folder->clid();
    SG::DataProxy* proxy=m_h_detStore->proxy(clid,key);
    if (proxy!=nullptr) {
      m_h_detStore->clearProxyPayload(proxy);
      ATH_MSG_DEBUG("Dropped payload for key " << key );
      folder->setDropped(true);
      if (resetCache) {
        folder->resetCache();
        ATH_MSG_DEBUG( "Cache reset done for folder " << folder->folderName() );
      }
      return true;
    } else {
      return false;
    }
  } else {
    return false;
  }
}

fillTagInfo()

StatusCode IOVDbSvc::fillTagInfo ( )

private

Definition at line 1096 of file IOVDbSvc.cxx.

                                 {
  if (!m_par_globalTag.empty()) {
    ATH_MSG_DEBUG( "Adding GlobalTag " << m_par_globalTag << " into TagInfo" );
    if (StatusCode::SUCCESS!=m_h_tagInfoMgr->addTag("IOVDbGlobalTag",m_par_globalTag))
      return StatusCode::FAILURE;
  }
  // add all explicit tags specified in folders
  // can be from Folders or tagOverrides properties
  for (const auto & thisFolder : m_foldermap) {
    const IOVDbFolder* folder=thisFolder.second;
    if (!folder->joTag().empty()) {
      ATH_MSG_DEBUG( "Adding folder " << folder->folderName() <<" tag " << folder->joTag() << " into TagInfo" );
      if (StatusCode::SUCCESS!=m_h_tagInfoMgr->addTag(folder->folderName(),folder->joTag()))
        return StatusCode::FAILURE;
    }
    // check to see if any input TagInfo folder overrides should be removed
    // this anticipates the decisions which will be made in processTagInfo
    // Here we do not have access to the TagInfo object, but can put remove
    // requests in for all folders if the global tag is set, or if there is
    // an explict joboption tag, nooverride spec, or data comes from metadata
    if (!m_par_globalTag.empty() || !folder->joTag().empty() || folder->noOverride() ||
        folder->readMeta()) {
      if (StatusCode::SUCCESS!=
          m_h_tagInfoMgr->removeTagFromInput(folder->folderName())) {
        ATH_MSG_WARNING( "Could not add TagInfo remove request for "
               << folder->folderName() );
      } else {
        ATH_MSG_INFO( "Added taginfo remove for " << 
          folder->folderName() );
      }
    }
  }
  return StatusCode::SUCCESS;
}

finalize()

StatusCode IOVDbSvc::finalize ( )

overridevirtual

Service finalize.

Definition at line 272 of file IOVDbSvc.cxx.

                              {
  // summarise and delete folders, adding total read from COOL
  float readtime=0.;
  // accumulate a map of readtime by connection
  typedef std::map<IOVDbConn*,float> CTMap;
  CTMap ctmap;
  for (const auto & namePtrPair : m_foldermap) {
    IOVDbFolder* folder=namePtrPair.second;
    folder->summary();
    const float& fread=folder->readTime();
    readtime+=fread;
    IOVDbConn* cptr=folder->conn();
    CTMap::iterator citr=ctmap.find(cptr);
    if (citr!=ctmap.end()) {
      (citr->second)+=fread;
    } else {
      ctmap.insert(CTMap::value_type(cptr,fread));
    }
    delete folder;
  }
  ATH_MSG_INFO(  " bytes in (( " << std::fixed << std::setw(9) << std::setprecision(2) <<
    readtime << " ))s" );
 
  // close and delete connections, printing time in each one
  for (auto & pThisConnection : m_connections) {
    float fread=0;
    CTMap::iterator citr=ctmap.find(pThisConnection);
    if (citr!=ctmap.end()) fread=citr->second;
    pThisConnection->setInactive();
    pThisConnection->summary(fread);
    delete pThisConnection;
  }
  // finally remove the msg svc
  //delete m_log;
  return AthService::finalize();
}

getDatabase()

cool::IDatabasePtr IOVDbSvc::getDatabase ( bool  readOnly )

overridevirtual

Access to COOL database for a given folder.

Implements IIOVCondDbSvc.

Definition at line 309 of file IOVDbSvc.cxx.

                                                    {
  // get default database connection
  cool::IDatabasePtr dbconn;
  if (m_par_defaultConnection.empty() || m_connections.empty()) {
    ATH_MSG_INFO( "No default COOL database connection is available");
    dbconn.reset();
  } else {
    Athena::DBLock dblock;
    if (m_connections[0]->isReadOnly()!=readOnly) {
      ATH_MSG_INFO("Changing state of default connection to readonly=" << readOnly );
      m_connections[0]->setReadOnly(readOnly);
    }
    dbconn = std::make_shared<LockedDatabase> (m_connections[0]->getCoolDb(),
                                               dblock);
  }
  return dbconn;
}

getKeyInfo()

bool IOVDbSvc::getKeyInfo ( const std::string &  key, IIOVDbSvc::KeyInfo &  info  )

overridevirtual

Return information about SG key return false if this key is not known to IOVDbSvc.

Implements IIOVDbSvc.

Definition at line 838 of file IOVDbSvc.cxx.

                                                                      {
  // return information about given SG key
  // first attempt to find the folder object for this key
  FolderMap::const_iterator itr = m_foldermap.find(key);
  if (itr!=m_foldermap.end()) {
    const IOVDbFolder* f=itr->second;
    info.folderName = f->folderName();
    info.tag = f->resolvedTag();
    info.range = f->currentRange();
    info.retrieved = f->retrieved();
    info.bytesRead = f->bytesRead();
    info.readTime = f->readTime();
    info.extensible = f->extensible();
    return true;
  } else {
    info.retrieved = false;
    return false;
  }
}

getKeyList()

std::vector< std::string > IOVDbSvc::getKeyList ( )

overridevirtual

return list of SG keys being provided by IOVDbSvc

Implements IIOVDbSvc.

Definition at line 830 of file IOVDbSvc.cxx.

                     {
  // return a list of all the StoreGate keys being managed by IOVDbSvc
  std::vector<std::string> keys;
  keys.reserve(m_foldermap.size());
  std::for_each(m_foldermap.begin(),m_foldermap.end(), [&keys](const auto &i){keys.emplace_back(i.first);});
  return keys;
}

getRange()

StatusCode IOVDbSvc::getRange ( const CLID &  clid, const std::string &  dbKey, const IOVTime &  time, IOVRange &  range, std::string &  tag, std::unique_ptr< IOpaqueAddress > &  ioa  )

overridevirtual

Get range for a particular data object identified by its clid and key and a requested IOVTime.

Implements IIOVDbSvc.

Definition at line 576 of file IOVDbSvc.cxx.

                                                                         {
 
  Athena::DBLock dblock;
 
  ATH_MSG_DEBUG( "getRange  clid: " << clid << " key: \""<< dbKey << "\"  t: " << time );
  const std::string& key=dbKey;
  FolderMap::const_iterator fitr=m_foldermap.find(key);
  if (fitr==m_foldermap.end()) {
    ATH_MSG_VERBOSE("getRange cannot find description for dbKey " << key );
    return StatusCode::FAILURE;
  }
  IOVDbFolder* folder=fitr->second;
  if (folder->clid()!=clid) {
    ATH_MSG_VERBOSE( "supplied CLID for " << key << " is " 
             << clid
             << " but expecting " << folder->clid() );
    
    return StatusCode::FAILURE;
  }
 
  tag = folder->key();
 
  // obtain the validity key for this folder (includes overrides)
  cool::ValidityKey vkey=folder->iovTime(time);
  if (!folder->readMeta() && !folder->cacheValid(vkey)) {
    // mark this folder as not-dropped so cache-read will succeed
    folder->setDropped(false);
    // reload cache for this folder (and all others sharing this DB connection)
    ATH_MSG_DEBUG( "Triggering cache load for folder " << folder->folderName() );
    if (StatusCode::SUCCESS!=loadCaches(folder->conn(),&time)) {
      ATH_MSG_ERROR( "Cache load failed for at least one folder from " << folder->conn()->name()
                     << ". You may see errors from other folders sharing the same connection." );
      return StatusCode::FAILURE;
    }
  }
 
  // data should now be in cache
  address.reset();
  // setup address and range
  {
    Gaudi::Guards::AuditorGuard auditor(std::string("FldrSetup:")+(key.empty() ? "anonymous" : key),
                                        auditorSvc(), "preLoadProxy");
    if (!folder->getAddress(vkey,&(*m_h_persSvc),poolSvcContext(),address,
                            range,m_poolPayloadRequested)) {
      ATH_MSG_ERROR("getAddress failed for folder " <<folder->folderName() );
      return StatusCode::FAILURE;
    }
  }
 
  // Special handling for extensible folders:
  if (folder->extensible()) {
    // Set the end time to just past the current event or lumiblock.
    IOVTime extStop = range.stop();
    if (folder->timeStamp()) {
      extStop.setTimestamp (time.timestamp() + 1);
    }
    else {
      extStop.setRETime (time.re_time() + 1);
    }
    range = IOVRange (range.start(), extStop);
  }
 
  // Special handling for IOV override: set the infinite validity range
  if (folder->iovOverridden()) {
    if (folder->timeStamp()) {
      range = IOVRange ( IOVTime(IOVTime::MINTIMESTAMP)
             , IOVTime(IOVTime::MAXTIMESTAMP) );
    }
    else {
      range = IOVRange ( IOVTime(IOVTime::MINRUN,IOVTime::MINEVENT)
             , IOVTime(IOVTime::MAXRUN,IOVTime::MAXEVENT) );
    }
  }
 
  return StatusCode::SUCCESS;
}

handle()

void IOVDbSvc::handle ( const Incident &  incident )

overridevirtual

Incident service handle for EndEvent.

Definition at line 768 of file IOVDbSvc.cxx.

                                          {
  // Handle incidents:
  // BeginEvent to set IOVDbSvc state to EVENT_LOOP
  // StoreCleared/EndProcessing to close any open POOL files
  ATH_MSG_VERBOSE( "entering handle(), incident type " << inc.type() << " from " << inc.source() );
  if (inc.type()=="BeginEvent") {
    m_state=IOVDbSvc::EVENT_LOOP;
  } else {
    Athena::DBLock dblock;
 
    const StoreClearedIncident* sinc = dynamic_cast<const StoreClearedIncident*>(&inc);
    if( (inc.type()=="StoreCleared" && sinc!=nullptr && sinc->store()==&*m_h_sgSvc)
        or inc.type()==IncidentType::EndProcessing )
    {
       m_state=IOVDbSvc::FINALIZE_ALG;
       postConditionsLoad();
    }
  }
}

initialize()

StatusCode IOVDbSvc::initialize ( )

overridevirtual

Service init.

Definition at line 173 of file IOVDbSvc.cxx.

                                {
  if (StatusCode::SUCCESS!=AthService::initialize()) return StatusCode::FAILURE;
  // subscribe to events
  ServiceHandle<IIncidentSvc> incSvc("IncidentSvc",name());
  if (StatusCode::SUCCESS!=incSvc.retrieve()) {
    ATH_MSG_ERROR( "Unable to get the IncidentSvc" );
    return StatusCode::FAILURE;
  }
  long int pri=100;
  incSvc->addListener( this, "BeginEvent", pri );
  incSvc->addListener( this, "StoreCleared", pri );   // for SP Athena
  incSvc->addListener( this, IncidentType::EndProcessing, pri );  // for MT Athena
 
  // Register this service for 'I/O' events
  ServiceHandle<IIoComponentMgr> iomgr("IoComponentMgr", name());
  if (!iomgr.retrieve().isSuccess()) {
     ATH_MSG_FATAL("Could not retrieve IoComponentMgr !");
     return(StatusCode::FAILURE);
  }
  if (!iomgr->io_register(this).isSuccess()) {
     ATH_MSG_FATAL("Could not register myself with the IoComponentMgr !");
     return(StatusCode::FAILURE);
  }
  // print warnings/info depending on state of job options
  if (!m_par_manageConnections)
    ATH_MSG_INFO( "COOL connection management disabled - connections kept open throughout job" );
  if (!m_par_managePoolConnections)
    ATH_MSG_INFO( "POOL file connection management disabled - files kept open throught job" );
  if (m_par_maxNumPoolFiles.value() > 0)
    ATH_MSG_INFO( "Only " << m_par_maxNumPoolFiles.value() <<  " POOL conditions files will be open at once" );
  if (m_par_forceRunNumber.value() > 0 || m_par_forceLumiblockNumber.value() > 0)
    ATH_MSG_WARNING( "Global run/LB number forced to be [" <<
      m_par_forceRunNumber.value() << "," << m_par_forceLumiblockNumber.value() <<  "]" );
  if (m_par_forceTimestamp.value() > 0) 
    ATH_MSG_WARNING( "Global timestamp forced to be " <<
      m_par_forceTimestamp.value() );
  if (m_par_cacheRun.value() > 0) 
    ATH_MSG_INFO( "Run-LB data will be cached in groups of " << 
      m_par_cacheRun.value() << " runs" );
  if (m_par_cacheTime.value() > 0)
    ATH_MSG_INFO( "Timestamp data will be cached in groups of " << m_par_cacheTime.value() << " seconds" );
  if (m_par_cacheAlign > 0) 
    ATH_MSG_INFO( "Cache alignment will be done in " << m_par_cacheAlign.value() << " slices" );
  if (m_par_onlineMode) 
    ATH_MSG_INFO(  "Online mode ignoring potential missing channels outside cache" );
  if (m_par_checklock)
    ATH_MSG_INFO( "Tags will be required to be locked");
 
  // make sure iovTime is undefined
  m_iovTime.reset();
 
  // extract information from EventSelector for run/LB/time overrides
  if (StatusCode::SUCCESS!=checkEventSel()) return StatusCode::FAILURE;
 
  // initialise default connection
  if (!m_par_defaultConnection.empty()) {
    // default connection is readonly if no : in name (i.e. logical conn)
    bool readonly=(m_par_defaultConnection.value().find(':')==std::string::npos);
    m_connections.push_back(new IOVDbConn(m_par_defaultConnection,readonly,msg()));
  }
 
  // set time of timestampslop in nanoseconds
  m_iovslop=static_cast<cool::ValidityKey>(m_par_timeStampSlop*1.E9);
 
  // check for global tag in jobopt, which will override anything in input file
  if (!m_par_globalTag.empty()) {
    m_globalTag=m_par_globalTag;
    ATH_MSG_INFO( "Global tag: " << m_par_globalTag.value() << " set from joboptions" );
  }
 
  // setup folders and process tag overrides
  if (StatusCode::SUCCESS!=setupFolders()) return StatusCode::FAILURE;
 
  // Set state to initialize
  m_state=IOVDbSvc::INITIALIZATION;
  ATH_MSG_INFO( "Initialised with " << m_connections.size() << 
    " connections and " << m_foldermap.size() << " folders" );
  if (m_outputToFile.value()) ATH_MSG_INFO("Db dump to file activated");
  if (m_crestToFile.value()) ATH_MSG_INFO("Crest dump to file activated");
  if (m_crestCoolToFile.value())ATH_MSG_INFO("Crest or Cool dump to file activated");
  ATH_MSG_INFO( "Service IOVDbSvc initialised successfully" );
 
  ATH_CHECK( checkConfigConsistency() );
  return StatusCode::SUCCESS;
}

interfaceID()

static const InterfaceID& IOVDbSvc::interfaceID ( )

static

io_finalize()

StatusCode IOVDbSvc::io_finalize ( )

finaloverride

Definition at line 267 of file IOVDbSvc.cxx.

                                 {
   ATH_MSG_DEBUG("I/O finalization...");
   return(StatusCode::SUCCESS);
}

io_reinit()

StatusCode IOVDbSvc::io_reinit ( )

finaloverride

Definition at line 260 of file IOVDbSvc.cxx.

                               {
   ATH_MSG_DEBUG("I/O reinitialization...");
   // PoolSvc clears all connections on IO_reinit - forget the stored contextId
   m_poolSvcContext = -1;
   return(StatusCode::SUCCESS);
}

loadAddresses()

StatusCode IOVDbSvc::loadAddresses ( StoreID::type  storeID, tadList &  list  )

overridevirtual

Get all new addresses from Provider for this Event.

Reimplemented from IAddressProvider.

Definition at line 453 of file IOVDbSvc.cxx.

                                                             {
  // this method does nothing
  return StatusCode::SUCCESS;
}

loadCaches()

StatusCode IOVDbSvc::loadCaches ( IOVDbConn *  conn, const IOVTime *  time = nullptr  )

private

Definition at line 1131 of file IOVDbSvc.cxx.

                                                                    {
  // load the caches for all folders using the given connection
  // so connection use is optimised
 
  Gaudi::Guards::AuditorGuard auditor(std::string("loadCachesOverhead:")+conn->name(), auditorSvc(), "preLoadProxy");
 
  ATH_MSG_DEBUG( "loadCaches: Begin for connection " << conn->name());
  // if global abort already set, load nothing
  if (m_abort) return StatusCode::FAILURE;
  bool access=false;
  StatusCode sc=StatusCode::SUCCESS;
  for (const auto & thisNamePtrPair : m_foldermap) {
    IOVDbFolder* folder=thisNamePtrPair.second;
    if (folder->conn()!=conn) continue;
    cool::ValidityKey vkey=folder->iovTime(time==nullptr ? m_iovTime : *time);
    // protect against out of range times (timestamp -1 happened in FDR2)
    if (vkey>cool::ValidityKeyMax) {
      ATH_MSG_WARNING( "Requested validity key " << vkey << " is out of range, reset to 0" );
      vkey=0;
    }
    if (!folder->cacheValid(vkey) && !folder->dropped()) {
      access=true;
      {
        Gaudi::Guards::AuditorGuard auditor(std::string("FldrCache:")+folder->folderName(), auditorSvc(), "preLoadProxy");
        if (!folder->loadCache(vkey,m_par_cacheAlign,m_globalTag,m_par_onlineMode)) {
          ATH_MSG_ERROR( "Cache load (prefetch) failed for folder " << folder->folderName() );
          // remember the failure, but also load other folders on this connection
          // while it is open
          sc=StatusCode::FAILURE;
        }
      }
    }
  }
  // disconnect from database if we connected
  if (access && m_par_manageConnections) conn->setInactive();
  // if connection aborted, set overall abort so we do not waste time trying
  // to read data from other schema
  if (conn->aborted()) {
    ATH_MSG_FATAL( "Connection " << conn->name() << " was aborted, set global abort" );
    m_abort=true;
    ATH_MSG_FATAL( "loadCache: impossible to load cache!" ); 
    throw std::exception();
  }
  return sc;
}

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< Service >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< Service >::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

poolSvcContext()

int IOVDbSvc::poolSvcContext ( )

private

Definition at line 154 of file IOVDbSvc.cxx.

{
   if( m_poolSvcContext < 0 ) {
      // Get context for POOL conditions files, and created an initial connection
      if (m_par_managePoolConnections) {
         m_poolSvcContext=m_h_poolSvc->getInputContext("Conditions", m_par_maxNumPoolFiles);
      } else {
         m_poolSvcContext=m_h_poolSvc->getInputContext("Conditions");
      }
      if( m_h_poolSvc->connect(pool::ITransaction::READ, m_poolSvcContext).isSuccess() ) {
         ATH_MSG_INFO( "Opened read transaction for POOL PersistencySvc");
      } else {
         // We only emit info for failure to connect (for the moment? RDS 01/2008)
         ATH_MSG_INFO( "Cannot connect to POOL PersistencySvc" );
      }
   }
   return m_poolSvcContext;
}

postConditionsLoad()

void IOVDbSvc::postConditionsLoad ( )

overridevirtual

May be called once conditions are loaded to let IOVDbSvc release resources.

Implements IIOVDbSvc.

Definition at line 743 of file IOVDbSvc.cxx.

                                  {
   // Close any open POOL files after loding Conditions
   ATH_MSG_DEBUG( "postConditionsLoad: m_par_managePoolConnections=" << m_par_managePoolConnections
                  << "  m_poolPayloadRequested=" << m_poolPayloadRequested );
 
   if (m_par_managePoolConnections && m_poolPayloadRequested) {
      // reset POOL connection to close all open conditions POOL files
      m_par_managePoolConnections.set(false);
      m_poolPayloadRequested=false;
      if( m_poolSvcContext ) {
         if (StatusCode::SUCCESS==m_h_poolSvc->disconnect(m_poolSvcContext)) {
            ATH_MSG_DEBUG( "Successfully closed input POOL connections");
         } else {
            ATH_MSG_WARNING( "Unable to close input POOL connections" );
         }
         // reopen transaction
         if (StatusCode::SUCCESS==m_h_poolSvc->connect(pool::ITransaction::READ, m_poolSvcContext)) {
            ATH_MSG_DEBUG("Reopend read transaction for POOL conditions input files" );
         } else {
            ATH_MSG_WARNING("Cannot reopen read transaction for POOL conditions input files");
         }
      }
   }
}

preLoadAddresses()

StatusCode IOVDbSvc::preLoadAddresses ( StoreID::type  storeID, tadList &  list  )

overridevirtual

Get all addresses that the provider wants to preload in SG maps.

Reimplemented from IAddressProvider.

Definition at line 327 of file IOVDbSvc.cxx.

                                                                        {
  // Read information for folders and setup TADs
  if (storeID!=StoreID::DETECTOR_STORE) return StatusCode::SUCCESS;
  // Preloading of addresses should be done ONLY for detector store
  ATH_MSG_DEBUG( "preLoadAddress: storeID -> " << storeID );
 
  Athena::DBLock dblock;
 
  // check File Level Meta Data of input, see if any requested folders are available there
  SG::ConstIterator<IOVMetaDataContainer> cont;
  SG::ConstIterator<IOVMetaDataContainer> contEnd;
  if (StatusCode::SUCCESS==m_h_metaDataStore->retrieve(cont,contEnd)) {
    unsigned int ncontainers=0;
    unsigned int nused=0;
    for (;cont!=contEnd; ++cont) {
      ++ncontainers;
      const std::string& fname=cont->folderName();
      // check if this folder is in list requested by IOVDbSvc
      for (const auto & thisNamePtrPair : m_foldermap) {
        // take data from FLMD only if tag override is NOT set
        if (thisNamePtrPair.second->folderName()==fname && !(thisNamePtrPair.second->tagOverride())) {
          ATH_MSG_INFO( "Folder " << fname << " will be taken from file metadata" );
          thisNamePtrPair.second->useFileMetaData();
          thisNamePtrPair.second->setFolderDescription( cont->folderDescription() );
          ++nused;
          break;
        }
      }
    }
    ATH_MSG_INFO( "Found " << ncontainers <<  " metadata containers in input file, " << nused << " will be used");
  } else {
    ATH_MSG_DEBUG( "Could not retrieve IOVMetaDataContainer objects from MetaDataStore" );
  }
 
  // Remove folders which should only be read from file meta data, but
  // were not found in the MetaDataStore
 
  // Note: we cannot iterate and perform erase within the iteration
  // because the iterator becomes invalid. So first collect the keys
  // to erase in a first pass and then erase them.
  std::vector<std::string> keysToDelete;
   for (const auto & thisNamePtrPair : m_foldermap)  {
    if (thisNamePtrPair.second->fromMetaDataOnly() && !thisNamePtrPair.second->readMeta()) {
      ATH_MSG_INFO( "preLoadAddresses: Removing folder " << thisNamePtrPair.second->folderName() << 
        ". It should only be in the file meta data and was not found." );
      keysToDelete.push_back(thisNamePtrPair.first);
    }
  }
  
  for (auto & thisKey : keysToDelete) {
    FolderMap::iterator fitr=m_foldermap.find(thisKey);
    if (fitr != m_foldermap.end()) {
      fitr->second->conn()->decUsage();
      delete (fitr->second);
      m_foldermap.erase(fitr);
    } else {
      ATH_MSG_ERROR( "preLoadAddresses: Could not find folder " << thisKey << " for removal" );
    }
  }
  
 
  // loop over all folders, grouped by connection
  // do metadata folders on first connection (default connection)
  bool doMeta=true;
  // do not close COOL connection until next one has been opened, this enables
  // connection sharing in CORAL, so all COOL connections will use the same
  // CORAL one (althugh they will each be given a separate session)
  IOVDbConn* oldconn=nullptr;
  for (const auto & pThisConnection : m_connections) {
    if (pThisConnection->nFolders()>0 || doMeta) {
      // loop over all folders using this connection
      for (const auto & thisNamePtrPair : m_foldermap) {
        IOVDbFolder* folder=thisNamePtrPair.second;
        if (folder->conn()==pThisConnection || (folder->conn()==nullptr && doMeta)) {
          std::unique_ptr<SG::TransientAddress> tad =
            folder->preLoadFolder( &(*m_h_tagInfoMgr), m_par_cacheRun.value(),
                                   m_par_cacheTime.value());
          if (oldconn!=pThisConnection) {
            // close old connection if appropriate
            if (m_par_manageConnections && oldconn!=nullptr) oldconn->setInactive();
            oldconn=pThisConnection;
          }
          if (tad==nullptr) {
            ATH_MSG_ERROR( "preLoadFolder failed for folder " << folder->folderName() );
            return StatusCode::FAILURE;
          }
          // for write-metadata folder, request data preload
          if (folder->writeMeta()) {
            if (StatusCode::SUCCESS!=m_h_IOVSvc->preLoadDataTAD(tad.get(),folder->eventStore())) {
              ATH_MSG_ERROR( "Could not request IOVSvc to preload metadata for " << folder->folderName() );
              return StatusCode::FAILURE;
            }
          } else {
            // for other folders, just preload TAD (not data)
            if (StatusCode::SUCCESS!=m_h_IOVSvc->preLoadTAD(tad.get(), folder->eventStore())) {
              ATH_MSG_ERROR( "Could not request IOVSvc to preload metadata for " << folder->folderName() );
              return StatusCode::FAILURE;
            }
          }
          // Add TAD to Storegate
          tlist.push_back(tad.release());
          // check for IOV override
          folder->setIOVOverride(m_par_forceRunNumber.value(),
                                 m_par_forceLumiblockNumber.value(),m_par_forceTimestamp.value());
        }
      }
    }
    doMeta=false;
  }
  // close last connection
  if (oldconn!=nullptr and m_par_manageConnections) oldconn->setInactive();
 
  // some folder keys may have changed during preloadFolder due to use of
  // <key> specification in folder description string
  // build a new foldermap with the updated keys
  FolderMap newmap;
  for (const auto & thisNamePtrPair : m_foldermap) {
    newmap[thisNamePtrPair.second->key()]=thisNamePtrPair.second;
  }
  m_foldermap=newmap;
  // fill global and explicit folder tags into TagInfo
  if (StatusCode::SUCCESS!=fillTagInfo()) 
    ATH_MSG_ERROR("Could not fill TagInfo object from preLoadAddresses" );
  return StatusCode::SUCCESS;
}

processTagInfo()

StatusCode IOVDbSvc::processTagInfo ( )

overridevirtual

Process TagInfo.

Implements IIOVDbSvc.

Definition at line 788 of file IOVDbSvc.cxx.

                                    {
  // Processing of taginfo
  // Set GlobalTag and any folder-specific overrides if given
 
  // dump out contents of TagInfo
  ATH_MSG_DEBUG( "Tags from input TagInfo:");
  if( msg().level()>=MSG::DEBUG ) m_h_tagInfoMgr->printTags(msg());
  
  // check IOVDbSvc GlobalTag, if not already set
  if (m_globalTag.empty()) {
    m_globalTag = m_h_tagInfoMgr->findTag("IOVDbGlobalTag");
    if (!m_globalTag.empty()) ATH_MSG_INFO( "Global tag: " << m_globalTag<< " set from input file" );
    ATH_CHECK( checkConfigConsistency() );
  }
 
  // now check for tag overrides for specific folders
  const ITagInfoMgr::NameTagPairVec nameTagPairs = m_h_tagInfoMgr->getInputTags();
  for (const auto & thisNameTagPair: nameTagPairs) {
    // assume tags relating to conditions folders start with /
    if (not refersToConditionsFolder(thisNameTagPair)) continue;
    // check for folder(s) with this name in (key, ptr) pair
    for (const auto & thisKeyPtrPair: m_foldermap) {
      IOVDbFolder* folder=thisKeyPtrPair.second;
      const std::string& ifname=folder->folderName();
      if (ifname!=thisNameTagPair.first) continue; 
      // use an override from TagInfo only if there is not an explicit jo tag,
      // and folder meta-data is not used, and there is no <noover/> spec,
      // and no global tag set in job options
      const auto & theTag{thisNameTagPair.second};
      if (folder->joTag().empty() && !folder->readMeta() && !folder->noOverride() && m_par_globalTag.empty()) {
        folder->setTagOverride(theTag,false);
        ATH_MSG_INFO( "TagInfo override for tag " << theTag << " in folder " << ifname );
      } else if (folder->joTag()!=theTag) {
        const std::string_view tagTypeString=(folder->joTag().empty()) ? "hierarchical" : "jobOption";
        ATH_MSG_INFO( "Ignoring inputfile TagInfo request for tag " << theTag << " in folder " << ifname<<" in favour of "<<tagTypeString);
      }
    }
  }
  return StatusCode::SUCCESS;
}

queryInterface()

StatusCode IOVDbSvc::queryInterface ( const InterfaceID &  riid, void **  ppvInterface  )

overridevirtual

Query the interfaces.

Identify interfaces to which this service is responsive.

Definition at line 142 of file IOVDbSvc.cxx.

                                                                     {
  if (IIOVDbSvc::interfaceID().versionMatch(riid)) {
    *ppvInterface=(IIOVDbSvc*)this;
  } else if  ( IIOVCondDbSvc::interfaceID().versionMatch(riid)) {
    *ppvInterface=(IIOVCondDbSvc*)this;
  } else {
    // Interface is not directly available: try out a base class
    return AthService::queryInterface(riid, ppvInterface);
  }
  return StatusCode::SUCCESS;
}

setRange()

StatusCode IOVDbSvc::setRange ( const CLID &  clid, const std::string &  dbKey, const IOVRange &  range, const std::string &  tag  )

overridevirtual

Set range for a particular data object.

Implements IIOVDbSvc.

Definition at line 660 of file IOVDbSvc.cxx.

                                                    {
  // this method does nothing
  return StatusCode::SUCCESS;
}

setupFolders()

StatusCode IOVDbSvc::setupFolders ( )

private

Definition at line 946 of file IOVDbSvc.cxx.

                                  {
  // read the Folders joboptions and setup the folder list
  // no wildcards are allowed
 
  // getting the pairs: folder name - CREST tag name:
  if (m_par_source == "CREST"){
    IOVDbNamespace::CrestFunctions cfunctions(m_par_crestServer);
    m_cresttagmap.clear();
    m_cresttagmap = cfunctions.getGlobalTagMap(m_par_globalTag);
  }
  
  //1. Loop through folders
  std::list<IOVDbParser> allFolderdata;
  for (const auto & thisFolder : m_par_folders.value()) {
    ATH_MSG_DEBUG( "Setup folder " << thisFolder );
    IOVDbParser folderdata(thisFolder,msg());
    if (!folderdata.isValid()) {
      ATH_MSG_FATAL("setupFolders: Folder setup string is invalid: " <<thisFolder);
      return StatusCode::FAILURE;
    }
    
    allFolderdata.push_back(folderdata);
  }
 
  //2. Loop through overwrites:
  // syntax for entries is <prefix>folderpath</prefix> <tag>value</tag>
  // folderpath matches from left of folderName
  // but if partial match, next character must be / so override for /Fred/Ji
  // matches /Fred/Ji/A and /Fred/Ji but not /Fred/Jim
 
  for (const auto & thisOverrideTag : m_par_overrideTags) {
    IOVDbParser keys(thisOverrideTag,msg());
    if (not keys.isValid()){
      ATH_MSG_ERROR("An override tag was invalid: " << thisOverrideTag);
      return StatusCode::FAILURE;
    }
    std::string prefix;
    if (!keys.getKey("prefix","",prefix)) { // || !keys.getKey("tag","",tag)) {
      ATH_MSG_ERROR( "Problem in overrideTag specification " <<thisOverrideTag );
      return StatusCode::FAILURE;
    }
 
    for (auto& folderdata : allFolderdata) {
      const std::string& ifname=folderdata.folderName();
      if (ifname.compare(0,prefix.size(), prefix)==0 && 
          (ifname.size()==prefix.size() || ifname[prefix.size()]=='/')) {
        //Match! 
        folderdata.applyOverrides(keys,msg());
      }// end if
    }// end loop over allFolderdata
  }// end loop over overrides
 
  //3. Remove any duplicates:
  std::list<IOVDbParser>::iterator it1=allFolderdata.begin(); 
  std::list<IOVDbParser>::iterator it_e=allFolderdata.end(); 
  for (;it1!=it_e;++it1) {
    const IOVDbParser& folder1=*it1;
    std::list<IOVDbParser>::iterator it2=it1;
    ++it2;
    while(it2!=it_e) {
      const IOVDbParser& folder2=*it2;
      if (folder1==folder2) {
        it2=allFolderdata.erase(it2); //FIXME: Smarter distinction/reporting about same folder but different keys.
        ATH_MSG_DEBUG( "Removing duplicate folder " << folder1.folderName());
      } else {
        ++it2;
        //Catch suspicous cases:
        if (folder1.folderName()==folder2.folderName()) {
          ATH_MSG_WARNING( "Folder name appears twice: " << folder1.folderName() );
          ATH_MSG_WARNING( folder1 << " vs " << folder2 );
        }
      }
    }//end inner loop
  }//end outer loop
 
  //4.Set up folder map with cleaned folder list
 
  for (const auto& folderdata : allFolderdata) {
    // find the connection specification first - db or dbConnection
    // default is to use the 'default' connection
    IOVDbConn* conn=nullptr;
    std::string connstr;
    if (folderdata.getKey("db","",connstr) || 
        folderdata.getKey("dbConnection","",connstr)) {
      // an explicit database name is specified
      // check if it is already present in the existing connections
      for (const auto & pThisConnection : m_connections) {
        if (pThisConnection->name()==connstr) {
          // found existing connection - use that
          conn=pThisConnection;
          break;
        }
      }
      if (conn==nullptr) {
        // create new read-onlyconnection
        conn=new IOVDbConn(connstr,true,msg());
        m_connections.push_back(conn);
      }
    } else {
      // no connection specified - use default if available
      if (!m_par_defaultConnection.empty()) {
        conn=m_connections[0];
      } else {
        ATH_MSG_FATAL( "Folder request " << folderdata.folderName() << 
          " gives no DB connection information and no default set" );
        return StatusCode::FAILURE;
      }
    }
    
    // create the new folder, but only if a folder for this SG key has not
    // already been requested
 
    std::string crestTag = "";
    if (m_par_source == "CREST"){
      crestTag = m_cresttagmap[folderdata.folderName()];
    }
    
    IOVDbFolder* folder=new IOVDbFolder(conn,folderdata,msg(),&(*m_h_clidSvc), &(*m_h_metaDataTool),
                                        m_par_checklock, m_outputToFile.value(), m_par_source, m_crestToFile.value(), m_par_crestServer, crestTag, m_crestCoolToFile);
    const std::string& key=folder->key();
    if (m_foldermap.find(key)==m_foldermap.end()) {  //This check is too weak. For POOL-based folders, the SG key is in the folder description (not known at this point).
      m_foldermap[key]=folder;
      conn->incUsage();
    } else {
      ATH_MSG_ERROR( "Duplicate request for folder " << 
        folder->folderName() << 
        " associated to already requested Storegate key " << key );
      // clean up this duplicate request
      delete folder;
    }
  }// end loop over folders
  // check for folders to be written to metadata
  for (const auto & folderToWrite : m_par_foldersToWrite) {
    // match wildcard * at end of string only (i.e. /A/* matches /A/B, /A/C/D)
    std::string_view match=folderToWrite;
    std::string::size_type idx=folderToWrite.find('*');
    if (idx!=std::string::npos) {
      match=std::string_view(folderToWrite).substr(0,idx);
    }
    for (const auto & thisFolder : m_foldermap) {
      IOVDbFolder* fptr=thisFolder.second;
      if ((fptr->folderName()).compare(0,match.size(), match)==0) {
        fptr->setWriteMeta();
        ATH_MSG_INFO( "Folder " << fptr->folderName() << " will be written to file metadata" );
      }
    }//end loop over FolderMap
  }//end loop over  m_par_foldersToWrite
  return StatusCode::SUCCESS;
}

signalBeginRun()

StatusCode IOVDbSvc::signalBeginRun ( const IOVTime &  beginRunTime, const EventContext &  ctx  )

overridevirtual

Set time for begin run.

Implements IIOVDbSvc.

Definition at line 668 of file IOVDbSvc.cxx.

{
  Athena::DBLock dblock;
 
  // Begin run - set state and save time for later use
  m_state=IOVDbSvc::BEGIN_RUN;
  // Is this a different run compared to the previous call?
  bool newRun = m_iovTime.isValid() && (m_iovTime.run() != beginRunTime.run());
  m_iovTime=beginRunTime;
  // For a MC event, the run number we need to use to look up the conditions
  // may be different from that of the event itself.  Override the run
  // number with the conditions run number from the event context,
  // if it is defined.
  EventIDBase::number_type conditionsRun =
    Atlas::getExtendedEventContext(ctx).conditionsRun();
  if (conditionsRun != EventIDBase::UNDEFNUM) {
    m_iovTime.setRunEvent (conditionsRun, m_iovTime.event());
  }
 
  ATH_MSG_DEBUG( "signalBeginRun> begin run time " << m_iovTime);
  if (!m_par_onlineMode) {
    return StatusCode::SUCCESS;
  }
 
  // ONLINE mode: allow adding of new calibration constants between runs
  if (!newRun) {
    ATH_MSG_DEBUG( "Same run as previous signalBeginRun call. Skipping re-loading of folders..." );
    return StatusCode::SUCCESS;
  }
 
  // all other stuff is event based so happens after this.
  // this is before first event of each run
  ATH_MSG_DEBUG( "In online mode will recheck ... " );
  ATH_MSG_DEBUG( "First reload PoolCataloge ... " );
  
  pool::IFileCatalog* catalog ATLAS_THREAD_SAFE =  // we are not within the event loop yet
    const_cast<pool::IFileCatalog*>(m_h_poolSvc->catalog());
  catalog->commit();
  catalog->start(); 
 
  for (const auto & pThisConnection : m_connections){
    // only access connections which are actually in use - avoids waking up
    // the default DB connection if it is not being used
    if (pThisConnection->nFolders()>0) {
      //request for database activates connection
      cool::IDatabasePtr dbconn=pThisConnection->getCoolDb();
      if (dbconn.get()==nullptr) {
        ATH_MSG_FATAL( "Conditions database connection " <<  pThisConnection->name() << " cannot be opened - STOP" );
        return StatusCode::FAILURE;
      }
      for (const auto & thisNamePtrPair: m_foldermap) { 
        IOVDbFolder* folder=thisNamePtrPair.second;
        if (folder->conn()!=pThisConnection) continue; 
        folder->printCache();
        cool::ValidityKey vkey=folder->iovTime(m_iovTime);
        {
          Gaudi::Guards::AuditorGuard auditor(std::string("FldrCache:")+folder->folderName(), auditorSvc(), "preLoadProxy");
          if (!folder->loadCacheIfDbChanged(vkey, m_globalTag, dbconn, m_h_IOVSvc)) {
            ATH_MSG_ERROR( "Problem RELOADING: " << folder->folderName());
            return StatusCode::FAILURE;
          }
        }
        folder->printCache();
      }
    }
    if (m_par_manageConnections) pThisConnection->setInactive();
  }
  return StatusCode::SUCCESS;
}

signalEndProxyPreload()

void IOVDbSvc::signalEndProxyPreload ( )

overridevirtual

Signal that callback has been fired.

Implements IIOVDbSvc.

Definition at line 739 of file IOVDbSvc.cxx.

                                     {
  // this method does nothing
}

updateAddress()

StatusCode IOVDbSvc::updateAddress ( StoreID::type  storeID, SG::TransientAddress *  tad, const EventContext &  ctx  )

overridevirtual

Update a transient Address.

Implements IAddressProvider.

Definition at line 459 of file IOVDbSvc.cxx.

{
  // Provide TAD and associated range, actually reading the conditions data
 
  // Read information for folders and setup TADs
  if (storeID!=StoreID::DETECTOR_STORE) return StatusCode::FAILURE;
  Gaudi::Guards::AuditorGuard auditor(std::string("UpdateAddr::")+(tad->name().empty() ? "anonymous" : tad->name()),
                                      auditorSvc(), "preLoadProxy");
 
  IOVTime iovTime{m_iovTime};
  IOVRange range;
  std::unique_ptr<IOpaqueAddress> address;
 
  // first check if this key is managed by IOVDbSvc
  // return FAILURE if not - this allows other AddressProviders to be 
  // asked for the TAD
  const std::string& key=tad->name();
  FolderMap::const_iterator fitr=m_foldermap.find(key);
  if (fitr==m_foldermap.end()) {
    ATH_MSG_VERBOSE( 
        "updateAddress cannot find description for TAD " << key );
    return StatusCode::FAILURE;
  }
  IOVDbFolder* folder=fitr->second;
  if (folder->clid()!=tad->clID()) {
    ATH_MSG_VERBOSE( "CLID for TAD " << key << " is " << tad->clID()
             << " but expecting " << folder->clid() );
    
    return StatusCode::FAILURE;
  }
 
  // IOVDbSvc will satisfy the request, using already found folder
  // now determine the current IOVTime
  if (m_state==IOVDbSvc::INITIALIZATION && !m_iovTime.isValid()) {
    ATH_MSG_DEBUG( "updateAddress: in initialisation phase and no iovTime defined" );
    return::StatusCode::SUCCESS;
  }
  if (m_state==IOVDbSvc::EVENT_LOOP) {
    // determine iovTime from eventID in the event context
    const EventIDBase* evid = EventIDFromStore( m_h_sgSvc );
    if( evid ) {
      iovTime.setRunEvent( evid->run_number(), evid->lumi_block()) ;
      // save both seconds and ns offset for timestamp
      uint64_t nsTime = evid->time_stamp() *1000000000LL;
      nsTime += evid->time_stamp_ns_offset();
      iovTime.setTimestamp(nsTime);
      m_iovTime = iovTime;
      ATH_MSG_DEBUG( "updateAddress - using iovTime from EventInfo: " << iovTime);
    } else {
      // failed to get event info - just return success
      ATH_MSG_DEBUG( "Could not get event - initialise phase");
      return StatusCode::SUCCESS;
    }
  } else {
    ATH_MSG_DEBUG("updateAddress: using iovTime from init/beginRun: " << iovTime);
  }
 
 
 
  // obtain the validity key for this folder (includes overrides)
  cool::ValidityKey vkey=folder->iovTime(iovTime);
  {
     // The dblock is currently abused to also protect the cache in the IOVDbFolders.
     // This global lock may give rise to deadlocks between the dblock and the internal lock
     // of the SGImplSvc. The deadlock may arise if the order of the initial call to IOVDbSvc
     // and SGImplSvc are different, because the two services call each other.
     // A problem was observed when SG::DataProxy::isValidAddress first called IOVDbSvc::updateAddress
     // which called IOVSvc::setRange then SGImplSvc::proxy, and at the same time
     // StoreGateSvc::contains called first SGImplSvc::proxy which then called IOVDbSvc::updateAddress.
     // This problem is mitigated by limiting the scope of the dblock here.
     Athena::DBLock dblock;
     ATH_MSG_DEBUG("Validity key "<<vkey);
     if (!folder->readMeta() && !folder->cacheValid(vkey)) {
        // mark this folder as not-dropped so cache-read will succeed
        folder->setDropped(false);
        // reload cache for this folder (and all others sharing this DB connection)
        ATH_MSG_DEBUG( "Triggering cache load for folder " << folder->folderName());
        if (StatusCode::SUCCESS!=loadCaches(folder->conn())) {
           ATH_MSG_ERROR( "Cache load failed for at least one folder from " << folder->conn()->name()
                          << ". You may see errors from other folders sharing the same connection." );
           return StatusCode::FAILURE;
        }
     }
 
     // data should now be in cache
     // setup address and range
     {
        Gaudi::Guards::AuditorGuard auditor(std::string("FldrSetup:")+(tad->name().empty() ? "anonymous" : tad->name()),
                                            auditorSvc(), "preLoadProxy");
        if (!folder->getAddress(vkey,&(*m_h_persSvc),poolSvcContext(),address,
                                range,m_poolPayloadRequested)) {
           ATH_MSG_ERROR( "getAddress failed for folder " << folder->folderName() );
           return StatusCode::FAILURE;
        }
     }
     // reduce minimum IOV of timestamp folders to avoid 'thrashing'
     // due to events slightly out of order in HLT
     if (folder->timeStamp()) {
        cool::ValidityKey start=range.start().timestamp();
        if (start>m_iovslop) start-=m_iovslop;
        range=IOVRange(IOVTime(start),range.stop());
     }
  }
 
  // Pass range onto IOVSvc
  if (StatusCode::SUCCESS!=m_h_IOVSvc->setRange(tad->clID(),tad->name(),
                                                range,folder->eventStore())) {
    ATH_MSG_ERROR( "setRange failed for folder " << folder->folderName() );
    return StatusCode::FAILURE;
  }
  tad->setAddress(address.release());
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_abort

bool IOVDbSvc::m_abort {false}

private

Definition at line 292 of file IOVDbSvc.h.

m_connections

ConnVec IOVDbSvc::m_connections

private

Definition at line 287 of file IOVDbSvc.h.

m_crestCoolToFile

BooleanProperty IOVDbSvc::m_crestCoolToFile {this,"CrestCoolToFile",false,"output to file crest or cool data in the same format for debugging purposes"}

private

Definition at line 240 of file IOVDbSvc.h.

m_cresttagmap

std::map<std::string, std::string> IOVDbSvc::m_cresttagmap

private

Definition at line 234 of file IOVDbSvc.h.

m_crestToFile

BooleanProperty IOVDbSvc::m_crestToFile {this,"CrestToFile",false,"output to file crest data for debugging purposes"}

private

Definition at line 239 of file IOVDbSvc.h.

m_foldermap

FolderMap IOVDbSvc::m_foldermap

private

Definition at line 290 of file IOVDbSvc.h.

m_globalTag

std::string IOVDbSvc::m_globalTag {}

private

Definition at line 280 of file IOVDbSvc.h.

m_h_clidSvc

ServiceHandle<IClassIDSvc> IOVDbSvc::m_h_clidSvc {this,"ClassIDSvc","ClassIDSvc"}

private

Definition at line 248 of file IOVDbSvc.h.

m_h_detStore

ServiceHandle<StoreGateSvc> IOVDbSvc::m_h_detStore {this,"DetectorStore","DetectorStore"}

private

Definition at line 245 of file IOVDbSvc.h.

m_h_IOVSvc

ServiceHandle<IIOVSvc> IOVDbSvc::m_h_IOVSvc {this,"IOVSvc","IOVSvc"}

private

Definition at line 243 of file IOVDbSvc.h.

m_h_metaDataStore

ServiceHandle<StoreGateSvc> IOVDbSvc::m_h_metaDataStore {this,"MetaDataStore","StoreGateSvc/MetaDataStore"}

private

Definition at line 246 of file IOVDbSvc.h.

m_h_metaDataTool

PublicToolHandle<IIOVDbMetaDataTool> IOVDbSvc::m_h_metaDataTool {this,"IOVDbMetaDataTool","IOVDbMetaDataTool"}

private

Definition at line 250 of file IOVDbSvc.h.

m_h_persSvc

ServiceHandle<IAddressCreator> IOVDbSvc::m_h_persSvc {this,"EventPersistencySvc","EventPersistencySvc"}

private

Definition at line 247 of file IOVDbSvc.h.

m_h_poolSvc

ServiceHandle<IPoolSvc> IOVDbSvc::m_h_poolSvc {this,"PoolSvc","PoolSvc"}

private

Definition at line 249 of file IOVDbSvc.h.

m_h_sgSvc

ServiceHandle<StoreGateSvc> IOVDbSvc::m_h_sgSvc {this,"StoreGateSvc","StoreGateSvc"}

private

Definition at line 244 of file IOVDbSvc.h.

m_h_tagInfoMgr

ServiceHandle<ITagInfoMgr> IOVDbSvc::m_h_tagInfoMgr {this,"TagInfoMgr","TagInfoMgr"}

private

Definition at line 251 of file IOVDbSvc.h.

m_iovslop

cool::ValidityKey IOVDbSvc::m_iovslop {}

private

Definition at line 283 of file IOVDbSvc.h.

m_iovTime

IOVTime IOVDbSvc::m_iovTime {}

private

Definition at line 277 of file IOVDbSvc.h.

m_outputToFile

BooleanProperty IOVDbSvc::m_outputToFile {this,"OutputToFile",false,"output to file for debugging purposes"}

private

Definition at line 238 of file IOVDbSvc.h.

m_par_cacheAlign

UnsignedIntegerProperty IOVDbSvc::m_par_cacheAlign {this,"CacheAlign",0,"cache alignment - divide cache into N slices and align queries on slice"}

private

Definition at line 224 of file IOVDbSvc.h.

m_par_cacheRun

IntegerProperty IOVDbSvc::m_par_cacheRun {this,"CacheRun",0,"force larger numbers of runs to be cached"}

private

Definition at line 219 of file IOVDbSvc.h.

m_par_cacheTime

IntegerProperty IOVDbSvc::m_par_cacheTime {this,"CacheTime",0,"force larger timeranges to be cached (seconds)"}

private

Definition at line 221 of file IOVDbSvc.h.

m_par_checklock

BooleanProperty IOVDbSvc::m_par_checklock {this,"CheckLock",false,"check to ensure global/HVS tags are locked (for production)"}

private

Definition at line 228 of file IOVDbSvc.h.

m_par_crestServer

StringProperty IOVDbSvc::m_par_crestServer {this,"crestServer","http://crest-undertow-api.web.cern.ch","CREST URL with the port number as a string (default http://crest-undertow-api.web.cern.ch)"}

private

Definition at line 232 of file IOVDbSvc.h.

m_par_dbinst

Gaudi::Property<std::string> IOVDbSvc::m_par_dbinst {this,"DBInstance","","Database instance (like OFLP200)"}

private

Definition at line 197 of file IOVDbSvc.h.

m_par_defaultConnection

Gaudi::Property<std::string> IOVDbSvc::m_par_defaultConnection {this,"dbConnection","sqlite://;schema=cooldummy.db;dbname=OFLP200","default DB connection string"}

private

Definition at line 193 of file IOVDbSvc.h.

m_par_folders

Gaudi::Property<std::vector<std::string> > IOVDbSvc::m_par_folders {this,"Folders",{},"List of database folders to preload","OrderedSet<std::string>"}

private

Definition at line 199 of file IOVDbSvc.h.

m_par_foldersToWrite

Gaudi::Property<std::vector<std::string> > IOVDbSvc::m_par_foldersToWrite {this,"FoldersToMetaData",{},"list of folders to write to file meta data","OrderedSet<std::string>"}

private

Definition at line 203 of file IOVDbSvc.h.

m_par_forceLumiblockNumber

IntegerProperty IOVDbSvc::m_par_forceLumiblockNumber {this,"forceLumiblockNumber",0,"globally force LB-number (default: no force)"}

private

Definition at line 211 of file IOVDbSvc.h.

m_par_forceRunNumber

IntegerProperty IOVDbSvc::m_par_forceRunNumber {this,"forceRunNumber",0,"globally force run-number (default: no force)"}

private

Definition at line 209 of file IOVDbSvc.h.

m_par_forceTimestamp

IntegerProperty IOVDbSvc::m_par_forceTimestamp {this,"forceTimeStamp",0,"globally force time-stamp (default: no force)"}

private

Definition at line 213 of file IOVDbSvc.h.

m_par_format

StringProperty IOVDbSvc::m_par_format {this,"Format",{},"Format of data; default is empty string (default for a given source)"}

private

Definition at line 236 of file IOVDbSvc.h.

m_par_globalTag

Gaudi::Property<std::string> IOVDbSvc::m_par_globalTag {this,"GlobalTag","","Global database tag"}

private

Definition at line 195 of file IOVDbSvc.h.

m_par_manageConnections

BooleanProperty IOVDbSvc::m_par_manageConnections {this,"ManageConnections",true,"flag to trigger the connections management"}

private

Definition at line 205 of file IOVDbSvc.h.

m_par_managePoolConnections

BooleanProperty IOVDbSvc::m_par_managePoolConnections {this,"ManagePoolConnections",true,"flag to manage pool connections"}

private

Definition at line 207 of file IOVDbSvc.h.

m_par_maxNumPoolFiles

IntegerProperty IOVDbSvc::m_par_maxNumPoolFiles {this,"MaxPoolFilesOpen",5,"max number of pool files open allowed (0 means no limit)"}

private

Definition at line 215 of file IOVDbSvc.h.

m_par_onlineMode

BooleanProperty IOVDbSvc::m_par_onlineMode {this,"OnlineMode",false,"online mode flag to ignore missing channels outside cache range"}

private

Definition at line 226 of file IOVDbSvc.h.

m_par_overrideTags

Gaudi::Property<std::vector<std::string> > IOVDbSvc::m_par_overrideTags {this,"overrideTags",{},"List of foolder-tag overrides","OrderedSet<std::string>"}

private

Definition at line 201 of file IOVDbSvc.h.

m_par_source

StringProperty IOVDbSvc::m_par_source {this,"Source","COOL_DATABASE","source of data as a string (default COOL_DATABASE)"}

private

Definition at line 230 of file IOVDbSvc.h.

m_par_timeStampSlop

FloatProperty IOVDbSvc::m_par_timeStampSlop {this,"TimeStampSlop",0.0,"backdata timestamp IOVs by this many seconds"}

private

Definition at line 217 of file IOVDbSvc.h.

m_poolPayloadRequested

bool IOVDbSvc::m_poolPayloadRequested {false}

private

Definition at line 256 of file IOVDbSvc.h.

m_poolSvcContext

int IOVDbSvc::m_poolSvcContext {-1}

private

Definition at line 260 of file IOVDbSvc.h.

m_state

IOVDbSvc_state IOVDbSvc::m_state {INITIALIZATION}

private

Definition at line 274 of file IOVDbSvc.h.

---

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

• IOVDbSvc.h
• IOVDbSvc.cxx