SessionTool Class Reference

More...

#include <SessionTool.h>

Inheritance diagram for SessionTool:

Collaboration diagram for SessionTool:

Public Member Functions
	SessionTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructors.
virtual	~SessionTool ()
	Destructor.
	SessionTool (const SessionTool &)=delete
SessionTool &	operator= (const SessionTool &)=delete
virtual void	setupFC (Gaudi::IFileCatalog &fileCatalog, int ageLimit) override final
	Use this FileCatalog and DB ageing value for this session.
virtual void *	readObject (const Token &token, void *object=0) override final
	Retrieves an object from persistent store and return with type information The handle to the reflection class is necessary to later delete the object.
virtual Token *	registerForWrite (const Placement &place, const void *object, const RootType &type) override final
	registerForWrite registers an object for writing to the persistent medium higher level interactions with the framework are necessary.
pool::DatabaseRegistry &	registry ()
virtual bool	disconnectAll () override final
	Explicitly disconnects all the databases.
virtual bool	start (Io::IoFlag type=Io::READ) override final
	Starts a new transaction. Returns the success of the operation.
virtual bool	commit () override final
	Commits the transaction.
virtual bool	commitAndHold () override final
	Commits and holds the transaction.
virtual Io::IoFlag	openMode () const override final
	Returns the transaction type.
virtual std::unique_ptr< pool::IDatabase >	databaseHandle (const std::string &dbName, pool::DatabaseSpecification::NameType dbNameType) override final
	Creates and returns a new database handle object.
virtual Gaudi::IFileCatalog &	fileCatalog ()
	Returns the file catalog in use.
virtual pool::IStorageSvc &	getStorageSvc (long technology) override final
	Return StorageSvc for a given technology used in this session.
pool::MicroSessionManager &	microSessionManager (long technology) override final
	Returns the technology given a technology type.
void	closeSession () override final
StatusCode	finalize () override final
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Attributes
Gaudi::IFileCatalog *	m_catalog
int	m_ageLimit
std::unique_ptr< pool::DatabaseRegistry >	m_registry
Io::IoFlag	m_transactionType
std::map< long, std::unique_ptr< pool::MicroSessionManager > >	m_technologies

Detailed Description

Definition at line 19 of file SessionTool.h.

Constructor & Destructor Documentation

SessionTool() [1/2]

SessionTool::SessionTool ( const std::string & type, const std::string & name, const IInterface * parent )

explicit

Constructors.

Definition at line 15 of file SessionTool.cxx.

  : AthAlgTool(type, name, parent),
    m_catalog(nullptr),
    m_ageLimit(-1),
    m_registry( std::make_unique<pool::DatabaseRegistry>() ),
    m_transactionType(Io::INVALID)
{
}

~SessionTool()

SessionTool::~SessionTool ( )

virtual

Destructor.

Definition at line 33 of file SessionTool.cxx.

{
  closeSession();
}

SessionTool() [2/2]

SessionTool::SessionTool ( const SessionTool & )

delete

Member Function Documentation

closeSession()

void SessionTool::closeSession ( )

finaloverridevirtual

Implements ISessionTool.

Definition at line 38 of file SessionTool.cxx.

{
  // order is important
  disconnectAll();
  m_transactionType = Io::INVALID;
  m_technologies.clear();
}

commit()

bool SessionTool::commit ( )

finaloverridevirtual

Commits the transaction.

Implements ISessionTool.

Definition at line 106 of file SessionTool.cxx.

{
  if( m_transactionType != Io::INVALID ) {
    bool OK = true;
    for( auto db : *m_registry ) {
      bool bCommit = db->commitTransaction(); // This has to be replaced with a two phase commit
      if ( ! bCommit ) {
        ATH_MSG_ERROR("Could not commit the transaction for the database with:" << endmsg
                      << "FID = " << db->fid() << endmsg   << "PFN = " << db->pfn() );
      }
      OK = OK && bCommit;
    }
    m_transactionType = Io::INVALID;
    return OK;
  }
  return false;
}

commitAndHold()

bool SessionTool::commitAndHold ( )

finaloverridevirtual

Commits and holds the transaction.

Implements ISessionTool.

Definition at line 126 of file SessionTool.cxx.

{
  if( m_transactionType != Io::INVALID ) {
    bool OK = true;
    for( auto db : *m_registry ) {
      bool bCommit = db->commitAndHoldTransaction(); // This has to be replaced with a two phase commit
      if ( ! bCommit ) {
        ATH_MSG_ERROR("Could not commit and hold the transaction for the database with:" << endmsg
            << "FID = " << db->fid() << endmsg  << "PFN = " << db->pfn() );
      }
      OK = OK && bCommit;
    }
    return OK;
  }
  return false;
}

databaseHandle()

std::unique_ptr< pool::IDatabase > SessionTool::databaseHandle ( const std::string & dbName, pool::DatabaseSpecification::NameType dbNameType )

finaloverridevirtual

Creates and returns a new database handle object.

Implements ISessionTool.

Definition at line 146 of file SessionTool.cxx.

{
  if( m_transactionType != Io::INVALID ) {
     return std::make_unique<pool::UserDatabase>( *this, dbName, dbNameType );
  }
  return nullptr;
}

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

disconnectAll()

bool SessionTool::disconnectAll ( )

finaloverridevirtual

Explicitly disconnects all the databases.

If a transaction is active, then all the changes since the last commit are aborted.

Implements ISessionTool.

Definition at line 86 of file SessionTool.cxx.

{
  bool ret = true;
  for( auto& iManager : m_technologies ) {
    if( !iManager.second->disconnectAll() ) ret = false;
  }
  return ret;
}

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

fileCatalog()

Gaudi::IFileCatalog & SessionTool::fileCatalog ( )

virtual

Returns the file catalog in use.

Definition at line 156 of file SessionTool.cxx.

{
  return *m_catalog;
}

finalize()

StatusCode SessionTool::finalize ( )

finaloverride

Definition at line 46 of file SessionTool.cxx.

{
  closeSession();
  return AthAlgTool::finalize();
}

getStorageSvc()

pool::IStorageSvc & SessionTool::getStorageSvc ( long technology )

finaloverridevirtual

Return StorageSvc for a given technology used in this session.

Implements ISessionTool.

Definition at line 163 of file SessionTool.cxx.

{ 
  return microSessionManager( technology ).getStorageSvc(); 
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

microSessionManager()

pool::MicroSessionManager & SessionTool::microSessionManager ( long technology )

finaloverridevirtual

Returns the technology given a technology type.

Implements ISessionTool.

Definition at line 170 of file SessionTool.cxx.

{
  pool::DbType dbType( technology );
  long majorType = dbType.majorType();
  auto iManager = m_technologies.find( majorType );
  if ( iManager != m_technologies.end() ) {
    iManager->second->connect( m_transactionType, m_ageLimit );
    return *(iManager->second);
  }
  // Technology does not exist. Create the new session.
  auto mgr = new pool::MicroSessionManager( *m_registry, majorType );
  m_technologies.insert( std::make_pair( majorType, mgr ) );
  mgr->connect( m_transactionType, m_ageLimit );
  return *mgr;
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

openMode()

virtual Io::IoFlag SessionTool::openMode ( ) const

inlinefinaloverridevirtual

Returns the transaction type.

Implements ISessionTool.

Definition at line 81 of file SessionTool.h.

{ return m_transactionType; }

operator=()

SessionTool & SessionTool::operator= ( const SessionTool & )

delete

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

readObject()

void * SessionTool::readObject ( const Token & token, void * object = 0 )

finaloverridevirtual

Retrieves an object from persistent store and return with type information The handle to the reflection class is necessary to later delete the object.

The Guid of the transient class is assumed to be the classID of the token

Parameters

token	[IN] reference to the token for the object
object	[IN] pointer to memory for the object (created if 0)

Returns

void* The data.

In case of failure zero is returned.

Implements ISessionTool.

Definition at line 54 of file SessionTool.cxx.

{
  void* result {};
  if( m_transactionType != Io::INVALID ) {
    pool::UserDatabase db( *this, token.dbID().toString(), pool::DatabaseSpecification::FID );
    if ( db.openMode() == Io::INVALID ) {
      db.setTechnology( token.technology() );
      db.connectForRead();
    }
    result = db.readObject( token, object );
  }
  return result;
}

registerForWrite()

Token * SessionTool::registerForWrite ( const Placement & place, const void * object, const RootType & type )

finaloverridevirtual

registerForWrite registers an object for writing to the persistent medium higher level interactions with the framework are necessary.

Parameters

place	[IN] the placement hint
object	[IN] pointer to transient object which will be written
type	[IN] reflection class description with the layout of transient object

Returns

Token* the token address of the persistent object. I case of failure 0 is returned.

Implements ISessionTool.

Definition at line 69 of file SessionTool.cxx.

{
  if( m_transactionType != Io::WRITE && m_transactionType != Io::APPEND ) {
    return 0;
  }
  pool::UserDatabase db( *this, place.fileName(), pool::DatabaseSpecification::PFN );
  if ( db.openMode() == Io::INVALID ) {
    db.setTechnology( place.technology() );
    db.connectForWrite();
  }
  return db.writeObject( place.containerName(), place.technology(), object, type );
}

registry()

pool::DatabaseRegistry & SessionTool::registry ( )

inline

Definition at line 64 of file SessionTool.h.

{return *m_registry; }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 368 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setupFC()

void SessionTool::setupFC ( Gaudi::IFileCatalog & fileCatalog, int ageLimit )

finaloverridevirtual

Use this FileCatalog and DB ageing value for this session.

Implements ISessionTool.

Definition at line 27 of file SessionTool.cxx.

{
  m_catalog = &fileCatalog;
  m_ageLimit = ageLimit;
}

start()

bool SessionTool::start ( Io::IoFlag type = Io::READ )

finaloverridevirtual

Starts a new transaction. Returns the success of the operation.

Implements ISessionTool.

Definition at line 97 of file SessionTool.cxx.

{
  if( m_transactionType != Io::INVALID ) return false;
  m_transactionType = type;
  return true;
}

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_ageLimit

int SessionTool::m_ageLimit

private

Definition at line 101 of file SessionTool.h.

m_catalog

Gaudi::IFileCatalog* SessionTool::m_catalog

private

Definition at line 100 of file SessionTool.h.

m_registry

std::unique_ptr<pool::DatabaseRegistry> SessionTool::m_registry

private

Definition at line 102 of file SessionTool.h.

m_technologies

std::map< long, std::unique_ptr<pool::MicroSessionManager> > SessionTool::m_technologies

private

Definition at line 104 of file SessionTool.h.

m_transactionType

Io::IoFlag SessionTool::m_transactionType

private

Definition at line 103 of file SessionTool.h.

---

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

• SessionTool.h
• SessionTool.cxx