Gaudi::RootCnvSvc Class Reference

Description: More...

#include <src/RootCnvSvc.h>

Inheritance diagram for Gaudi::RootCnvSvc:

Collaboration diagram for Gaudi::RootCnvSvc:

Public Member Functions
	RootCnvSvc (const std::string &name, ISvcLocator *svc)
	Standard constructor.
StatusCode	updateServiceState (IOpaqueAddress *) override
	Update state of the service.
StatusCode	error (const std::string &msg)
	Standard way to print errors.
StatusCode	connectDatabase (const std::string &dataset, int mode, RootDataConnection **con)
	Connect the output file to the service with open mode.
StatusCode	initialize () override
	ConversionSvc overload: initialize Db service.
StatusCode	finalize () override
	ConversionSvc overload: Finalize Db service.
IConverter *	createConverter (long typ, const CLID &wanted, const ICnvFactory *fac) override
	ConversionSvc overload: Create new Converter using factory.
void	loadConverter (DataObject *pObj) override
	ConversionSvc overload: Load the class (dictionary) for the converter.
StatusCode	connectOutput (const std::string &outputFile, const std::string &openMode) override
	Connect the output file to the service with open mode.
StatusCode	connectOutput (const std::string &outputFile) override
	Connect the output file to the service.
StatusCode	commitOutput (const std::string &outputFile, bool do_commit) override
	Commit pending output.
virtual StatusCode	disconnect (const std::string &dbName)
	Disconnect from an existing data stream.
StatusCode	createAddress (long svc_type, const CLID &clid, const std::string *par, const unsigned long *ip, IOpaqueAddress *&refpAddress) override
	IAddressCreator implementation: Address creation.
StatusCode	createAddress (long svc_type, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress) override
	IAddressCreator implementation: Creates an address in string form to object form.
virtual StatusCode	createNullRep (const std::string &path)
	Insert null marker for not existent transient object.
virtual StatusCode	createNullRef (const std::string &path)
	Insert null marker for not existent transient object.
virtual StatusCode	i__createRep (DataObject *pObj, IOpaqueAddress *&refpAddr)
	Convert the transient object to the requested persistent representation.
virtual StatusCode	i__fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Resolve the references of the converted object.
virtual StatusCode	i__createObj (IOpaqueAddress *pAddr, DataObject *&refpObj)
	Create transient object from persistent data.
virtual StatusCode	i__fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Resolve the references of the created transient object.
Public Member Functions inherited from ConversionSvc
	ConversionSvc (const std::string &name, ISvcLocator *svc, long type)
	Standard Constructor.
	ConversionSvc (const ConversionSvc &)=delete
	disable copy and assignment
ConversionSvc &	operator= (const ConversionSvc &)=delete
StatusCode	initialize () override
	Initialize the service.
StatusCode	finalize () override
	stop the service.
long	repSvcType () const override
	Retrieve the class type of the data store the converter uses.
const CLID &	objType () const override
	Implementation of IConverter: dummy call.
StatusCode	setDataProvider (IDataProviderSvc *pService) override
	Implementation of IConverter: Set Data provider service.
SmartIF< IDataProviderSvc > &	dataProvider () const override
	Implementation of IConverter: Get Data provider service.
StatusCode	setConversionSvc (IConversionSvc *svc) override
	Implementation of IConverter: Set conversion service the converter is connected to.
SmartIF< IConversionSvc >	conversionSvc () override
	Implementation of IConverter: Get conversion service the converter is connected to.
StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility.
SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility.
StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
	Implementation of IConverter: Create the transient representation of an object.
StatusCode	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Implementation of IConverter: Resolve the references of the created transient object.
StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
	Implementation of IConverter: Update the transient object from the other representation.
StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Implementation of IConverter: Update the references of an updated transient object.
StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
	Implementation of IConverter: Convert the transient object to the requested representation.
StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Implementation of IConverter: Resolve the references of the converted object.
StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
	Implementation of IConverter: Update the converted representation of a transient object.
StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Implementation of IConverter: Update the references of an already converted object.
StatusCode	addConverter (const CLID &clid) override
	Add converter object to conversion service.
StatusCode	addConverter (IConverter *pConverter) override
	Add converter object to conversion service.
StatusCode	removeConverter (const CLID &clid) override
	Remove converter object from conversion service (if present).
IConverter *	converter (const CLID &wanted) override
	Retrieve converter from list.
StatusCode	connectOutput (const std::string &outputFile, const std::string &openMode) override
	Connect the output file to the service with open mode.
StatusCode	connectOutput (const std::string &output) override
	Connect the output file to the service.
StatusCode	commitOutput (const std::string &output, bool do_commit) override
	Commit pending output.
StatusCode	createAddress (long svc_type, const CLID &clid, const std::string *par, const unsigned long *ip, IOpaqueAddress *&refpAddress) override
	Create a Generic address using explicit arguments to identify a single object.
StatusCode	convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress) override
	Convert an address to string form.
StatusCode	createAddress (long svc_type, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress) override
	Convert an address in string form to object form.
Public Member Functions inherited from extends< Service, IConversionSvc, IAddressCreator >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.
Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.
StatusCode	configure () override
StatusCode	initialize () override
StatusCode	start () override
StatusCode	stop () override
StatusCode	finalize () override
StatusCode	terminate () override
Gaudi::StateMachine::State	FSMState () const override
Gaudi::StateMachine::State	targetFSMState () const override
StatusCode	reinitialize () override
StatusCode	restart () override
StatusCode	sysInitialize () override
	Initialize Service.
StatusCode	sysStart () override
	Initialize Service.
StatusCode	sysStop () override
	Initialize Service.
StatusCode	sysFinalize () override
	Finalize Service.
StatusCode	sysReinitialize () override
	Re-initialize the Service.
StatusCode	sysRestart () override
	Re-initialize the Service.
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.
template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)
template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.
template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)
const std::vector< IAlgTool * > &	tools () const
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.
StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.
StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value
	PropertyHolder ()=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.
StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties
bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.
Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected
void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
PropertyHolder &	operator= (const PropertyHolder &)=delete
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.
const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.
MsgStream &	msgStream () const
	Return an uninitialized MsgStream.
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Protected Member Functions
TClass *	getClass (DataObject *pObject)
	Helper: Get TClass for a given DataObject pointer.
MsgStream &	log () const
	Helper: Use message streamer.
Protected Member Functions inherited from ConversionSvc
virtual StatusCode	configureConverter (long typ, const CLID &clid, IConverter *cnv)
	Configure the new converter before initialize is called.
virtual StatusCode	initializeConverter (long typ, const CLID &clid, IConverter *cnv)
	Initialize the new converter.
virtual StatusCode	activateConverter (long typ, const CLID &clid, IConverter *cnv)
	Activate the new converter after initialization.
virtual SmartIF< IAddressCreator > &	addressCreator ()
	Retrieve address creation interface.
StatusCode	makeCall (int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()
	~Service () override
int	outputLevel () const
	get the Service's output level
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const override final
	Set up local caches.
MSG::Level	resetMessaging ()
	Reinitialize internal states.
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes
Gaudi::Property< std::string >	m_ioPerfStats
Gaudi::Property< std::string >	m_shareFiles
Gaudi::Property< bool >	m_incidentEnabled { this, "EnableIncident", true, "Flag to enable incidents on FILE_OPEN" }
Gaudi::Property< std::string >	m_recordName
Gaudi::Property< int >	m_minBufferSize
Gaudi::Property< int >	m_maxBufferSize
Gaudi::Property< int >	m_approxEventsPerBasket
Gaudi::Property< int >	m_splitLevel { this, "SplitLevel", 0, "Split level optimization parameter for ROOT TTree" }
Gaudi::Property< std::string >	m_compression
SmartIF< Gaudi::IIODataManager >	m_ioMgr
	Reference to the I/O data manager.
SmartIF< IIncidentSvc >	m_incidentSvc
	Reference to incident service.
Gaudi::RootDataConnection *	m_current = nullptr
	On writing: reference to active output stream.
TClass *	m_classRefs = nullptr
	TClass pointer to reference class.
TClass *	m_classDO = nullptr
	TClass pointer to DataObject class.
std::shared_ptr< RootConnectionSetup >	m_setup
	Setup structure (ref-counted) and passed to data connections.
std::string	m_currSection
	Property: ROOT section name.
std::set< std::string >	m_badFiles
	Set with bad files/tables.
std::unique_ptr< MsgStream >	m_log
	Message streamer.
Protected Attributes inherited from ConversionSvc
SmartIF< IDataProviderSvc >	m_dataSvc
	Pointer to data provider service.
SmartIF< IAddressCreator >	m_addressCreator
	Pointer to the address creation service interface.
long	m_type
	Conversion service type.
std::vector< WorkerEntry >	m_workers
	List of conversion workers.
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.
Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools
Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }
Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }
Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }
Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }
Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }
Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }
Gaudi::Property< bool >	m_autoRetrieveTools
Gaudi::Property< bool >	m_checkToolDeps
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Additional Inherited Members
Public Types inherited from extends< Service, IConversionSvc, IAddressCreator >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService*( const std::string&, ISvcLocator* )>
Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Detailed Description

Description:

RootCnvSvc class implementation definition.

Author

Markus Frank

Version

1.0

Date

20/12/2009

Definition at line 61 of file RootCnvSvc.h.

Constructor & Destructor Documentation

RootCnvSvc()

RootCnvSvc::RootCnvSvc	(	const std::string &	name,
		ISvcLocator *	svc )

Standard constructor.

Definition at line 60 of file RootCnvSvc.cpp.

    : ConversionSvc( nam, svc, ROOT_StorageType ), m_setup{ new RootConnectionSetup() } {
  m_setup->cacheBranches.push_back( "*" );
  declareProperty( "LoadSection", m_setup->loadSection = "Event" );
 
  // ROOT Read parameters: must be shared for the entire file!
  declareProperty( "CacheSize", m_setup->cacheSize = 10 * MBYTE );
  declareProperty( "LearnEntries", m_setup->learnEntries = 10 );
  declareProperty( "CacheBranches", m_setup->cacheBranches );
  declareProperty( "VetoBranches", m_setup->vetoBranches );
 
  declareProperty( m_setup->produceReproducibleFiles );
  m_setup->produceReproducibleFiles.setOwnerType<RootCnvSvc>();
 
  declareProperty( m_setup->root630ForwardCompatibility );
  m_setup->root630ForwardCompatibility.setOwnerType<RootCnvSvc>();
}

Member Function Documentation

commitOutput()

StatusCode RootCnvSvc::commitOutput ( const std::string & outputFile, bool do_commit )

override

Commit pending output.

Parameters

outputFile	String containig output file
do_commit	if true commit the output and flush eventually pending items to the database if false, discard pending buffers. Note: The possibility to commit or rollback depends on the database technology used!

Returns

Status code indicating success or failure.

fill NULL pointers to all branches, which have less entries than the section branch

Definition at line 311 of file RootCnvSvc.cpp.

                                                      {
  if ( m_current ) {
    size_t   len     = m_currSection.find( '/', 1 );
    string   section = m_currSection.substr( 1, len == string::npos ? string::npos : len - 1 );
    TBranch* b       = m_current->getBranch( section, m_currSection );
    if ( b ) {
      Long64_t   evt = b->GetEntries();
      TTree*     t   = b->GetTree();
      TObjArray* a   = t->GetListOfBranches();
      Int_t      nb  = a->GetEntriesFast();
      for ( Int_t i = 0; i < nb; ++i ) {
        TBranch* br_ptr = (TBranch*)a->UncheckedAt( i );
        Long64_t br_evt = br_ptr->GetEntries();
        if ( br_evt < evt ) {
          Long64_t num = evt - br_evt;
          br_ptr->SetAddress( nullptr );
          while ( num > 0 ) {
            br_ptr->Fill();
            --num;
          }
          if ( log().level() <= MSG::DEBUG )
            log() << MSG::DEBUG << "commit: Added " << long( evt - br_evt ) << " Section: " << evt
                  << " Branch: " << br_ptr->GetEntries() << " RefNo: " << br_ptr->GetEntries() - 1
                  << " NULL entries to:" << br_ptr->GetName() << endmsg;
        }
      }
 
      b->GetTree()->SetEntries( evt );
      if ( log().level() <= MSG::DEBUG )
        log() << MSG::DEBUG << "Set section entries of " << m_currSection << " to " << long( evt ) << " entries."
              << endmsg;
    } else {
      return error( "commitOutput> Failed to update entry numbers on " + dsn );
    }
  }
  return S_OK;
}

connectDatabase()

StatusCode RootCnvSvc::connectDatabase	(	const std::string &	dataset,
		int	mode,
		RootDataConnection **	con )

Connect the output file to the service with open mode.

Parameters

dataset	String containig file name
mode	String containig opening mode

Returns

Status code indicating success or failure.

Definition at line 210 of file RootCnvSvc.cpp.

                                                                                         {
  try {
    IDataConnection* c             = m_ioMgr->connection( dataset );
    bool             fire_incident = false;
    *con                           = nullptr;
    if ( !c ) {
      auto       connection = std::make_unique<RootDataConnection>( this, dataset, m_setup );
      StatusCode sc         = ( mode != IDataConnection::READ )
                                  ? m_ioMgr->connectWrite( connection.get(), IDataConnection::IoType( mode ), "ROOT" )
                                  : m_ioMgr->connectRead( false, connection.get() );
      c                     = sc.isSuccess() ? m_ioMgr->connection( dataset ) : nullptr;
      if ( c ) {
        bool writable = 0 != ( mode & ( IDataConnection::UPDATE | IDataConnection::RECREATE ) );
        fire_incident = m_incidentEnabled && ( 0 != ( mode & ( IDataConnection::UPDATE | IDataConnection::READ ) ) );
        if ( writable ) {
          m_incidentSvc->fireIncident(
              ContextIncident<TFile*>( connection->pfn(), "CONNECTED_OUTPUT", connection->file() ) );
        }
        if ( 0 != ( mode & IDataConnection::READ ) ) {
          m_incidentSvc->fireIncident(
              ContextIncident<TFile*>( connection->pfn(), "CONNECTED_INPUT", connection->file() ) );
          if ( !m_ioPerfStats.empty() ) { connection->enableStatistics( m_setup->loadSection ); }
        }
        connection.release();
      } else {
        m_incidentSvc->fireIncident( Incident(
            dataset, mode == IDataConnection::READ ? IncidentType::FailInputFile : IncidentType::FailOutputFile ) );
        // An error message was already printed by the IODataManager. no need to do it here!
        return StatusCode::FAILURE;
      }
    }
    RootDataConnection* pc = dynamic_cast<RootDataConnection*>( c );
    if ( pc ) {
      if ( !pc->isConnected() )
        if ( auto sc = pc->connectRead(); !sc ) return sc;
      *con = pc;
      pc->resetAge();
      pc->addClient( this );
    }
    if ( *con ) {
      if ( fire_incident ) {
        IOpaqueAddress* pAddr   = nullptr;
        string          fid     = pc->fid();
        string          section = m_recordName[0] == '/' ? m_recordName.value().substr( 1 ) : m_recordName.value();
        TBranch*        b       = pc->getBranch( section, m_recordName.value() );
        if ( b ) {
          const string  par[2]  = { fid, m_recordName };
          unsigned long ipar[2] = { (unsigned long)( *con ), (unsigned long)b->GetEntries() - 1 };
          for ( int i = 0; i < b->GetEntries(); ++i ) {
            ipar[1] = i;
            if ( !pc->mergeFIDs().empty() ) fid = pc->mergeFIDs()[i];
            if ( !createAddress( repSvcType(), CLID_DataObject, par, ipar, pAddr ).isSuccess() ) {
              if ( log().level() <= MSG::VERBOSE )
                log() << MSG::VERBOSE << "Failed to create address for " << m_recordName << " in:" << fid << " ["
                      << pc->fid() << "][" << i << "]" << endmsg;
              continue;
            }
            if ( log().level() <= MSG::VERBOSE )
              log() << MSG::VERBOSE << "Prepare " << m_recordName << " " << fid << " [" << par[0] << "][" << i << "]"
                    << endmsg;
            m_incidentSvc->fireIncident( ContextIncident<IOpaqueAddress*>( fid, "FILE_OPEN_READ", pAddr ) );
          }
        } else {
          if ( log().level() <= MSG::VERBOSE )
            log() << MSG::VERBOSE << "No valid Records " << m_recordName << " present in:" << pc->fid() << endmsg;
        }
      }
 
      // We can remove retired connections, which are no longer used....
      for ( auto& i : m_ioMgr->connections( this ) ) {
        if ( i != *con && !i->isConnected() ) {
          RootDataConnection* pc = dynamic_cast<RootDataConnection*>( i );
          if ( pc && pc->lookupClient( this ) ) {
            size_t num_client = pc->removeClient( this );
            if ( num_client == 0 ) {
              if ( m_ioMgr->disconnect( pc ).isSuccess() ) {
                log() << MSG::INFO << "Removed disconnected IO  stream:" << pc->fid() << " [" << pc->pfn() << "]"
                      << endmsg;
                delete pc;
              }
            }
          }
        }
      }
      return S_OK;
    }
    m_incidentSvc->fireIncident( Incident( dataset, IncidentType::FailOutputFile ) );
    return S_FAIL;
  } catch ( exception& e ) {
    m_incidentSvc->fireIncident( Incident( dataset, IncidentType::FailOutputFile ) );
    return error( string( "connectDatabase> Caught exception:" ) + e.what() );
  } catch ( ... ) {
    m_incidentSvc->fireIncident( Incident( dataset, IncidentType::FailOutputFile ) );
    return error( "connectDatabase> Unknown Fatal Exception for " + dataset );
  }
}

connectOutput() [1/2]

StatusCode Gaudi::RootCnvSvc::connectOutput ( const std::string & outputFile )

override

Connect the output file to the service.

Parameters

outputFile

String containig output file

Returns

Status code indicating success or failure.

connectOutput() [2/2]

StatusCode Gaudi::RootCnvSvc::connectOutput ( const std::string & outputFile, const std::string & openMode )

override

Connect the output file to the service with open mode.

Parameters

outputFile	String containig output file
openMode	String containig opening mode of the output file

Returns

Status code indicating success or failure.

createAddress() [1/2]

StatusCode Gaudi::RootCnvSvc::createAddress ( long svc_type, const CLID & clid, const std::string & refAddress, IOpaqueAddress *& refpAddress )

inlineoverride

IAddressCreator implementation: Creates an address in string form to object form.

Parameters

svc_type	Technology identifier encapsulated in this address.
clid	Class identifier of the DataObject represented by the opaque address
address	Input address.
refpAddress	Output address in string form.

Returns

Status code indicating success or failure.

Definition at line 199 of file RootCnvSvc.h.

                                                                      {
      return this->ConversionSvc::createAddress( svc_type, clid, refAddress, refpAddress );
    }

createAddress() [2/2]

StatusCode RootCnvSvc::createAddress ( long svc_type, const CLID & clid, const std::string * par, const unsigned long * ip, IOpaqueAddress *& refpAddress )

override

IAddressCreator implementation: Address creation.

Create an address using the link infotmation together with the triple (database name/container name/object name).

Parameters

refLink	Reference to abstract link information
dbName	Database name
containerName	Object container name
refpAddress	Opaque address information to retrieve object

Returns

StatusCode indicating SUCCESS or failure

Definition at line 357 of file RootCnvSvc.cpp.

                                                                     {
  refpAddress = new RootAddress( typ, clid, par[0], par[1], ip[0], ip[1] );
  return S_OK;
}

createConverter()

IConverter * RootCnvSvc::createConverter ( long typ, const CLID & wanted, const ICnvFactory * fac )

overridevirtual

ConversionSvc overload: Create new Converter using factory.

Reimplemented from ConversionSvc.

Definition at line 146 of file RootCnvSvc.cpp.

                                                                                          {
  if ( wanted == CLID_StatisticsFile )
    return new RootDatabaseCnv( typ, wanted, serviceLocator().get(), this );
  else if ( wanted == CLID_StatisticsDirectory )
    return new RootDirectoryCnv( typ, wanted, serviceLocator().get(), this );
  else if ( wanted == CLID_RowWiseTuple )
    return new RootNTupleCnv( typ, wanted, serviceLocator().get(), this );
  else if ( wanted == CLID_ColumnWiseTuple )
    return new RootNTupleCnv( typ, wanted, serviceLocator().get(), this );
  else
    return new RootConverter( typ, wanted, serviceLocator().get(), this );
}

createNullRef()

StatusCode RootCnvSvc::createNullRef ( const std::string & path )

virtual

Insert null marker for not existent transient object.

Parameters

path	[IN] Path to the (null-)object

Returns

Status code indicating success or failure.

Definition at line 373 of file RootCnvSvc.cpp.

                                                            {
  RootObjectRefs*          refs    = nullptr;
  size_t                   len     = path.find( '/', 1 );
  string                   section = path.substr( 1, len == string::npos ? string::npos : len - 1 );
  pair<int, unsigned long> ret = m_current->save( section, path + "#R", nullptr, refs, m_minBufferSize, m_maxBufferSize,
                                                  m_approxEventsPerBasket, m_splitLevel );
  if ( log().level() <= MSG::VERBOSE )
    log() << MSG::VERBOSE << "Writing object:" << path << " " << ret.first << " " << hex << ret.second << dec
          << " [NULL]" << endmsg;
  return S_OK;
}

createNullRep()

StatusCode RootCnvSvc::createNullRep ( const std::string & path )

virtual

Insert null marker for not existent transient object.

Parameters

path	[IN] Path to the (null-)object

Returns

Status code indicating success or failure.

Definition at line 364 of file RootCnvSvc.cpp.

                                                            {
  size_t len     = path.find( '/', 1 );
  string section = path.substr( 1, len == string::npos ? string::npos : len - 1 );
  m_current->saveObj( section, path, nullptr, nullptr, m_minBufferSize, m_maxBufferSize, m_approxEventsPerBasket,
                      m_splitLevel );
  return S_OK;
}

disconnect()

StatusCode RootCnvSvc::disconnect ( const std::string & dbName )

virtual

Disconnect from an existing data stream.

Parameters

dbName

String containing name of the database

Returns

Status code indicating success or failure.

Definition at line 351 of file RootCnvSvc.cpp.

                                                {
  IDataConnection* c = m_ioMgr->connection( dataset );
  return c ? m_ioMgr->disconnect( c ) : S_FAIL;
}

error()

StatusCode RootCnvSvc::error

(

const std::string &

msg

)

Standard way to print errors.

after the printout an exception is thrown.

Parameters

msg	[IN] Message string to be printed.

Returns

Status code returning failure.

Definition at line 79 of file RootCnvSvc.cpp.

                                       {
  if ( m_log ) {
    log() << MSG::ERROR << "Error: " << msg << endmsg;
    return S_FAIL;
  }
  MsgStream m( msgSvc(), name() );
  m << MSG::ERROR << "Error: " << msg << endmsg;
  return S_FAIL;
}

finalize()

StatusCode RootCnvSvc::finalize ( )

override

ConversionSvc overload: Finalize Db service.

Definition at line 118 of file RootCnvSvc.cpp.

                                {
  log() << MSG::INFO;
  if ( m_ioMgr ) {
    IIODataManager::Connections cons = m_ioMgr->connections( nullptr );
    for ( auto& i : cons ) {
      auto pc = dynamic_cast<RootDataConnection*>( i );
      if ( pc ) {
        if ( pc->owner() == this && !m_ioPerfStats.empty() ) { pc->saveStatistics( m_ioPerfStats.value() ); }
        if ( pc->lookupClient( this ) ) {
          size_t num_clients = pc->removeClient( this );
          if ( num_clients == 0 ) {
            if ( m_ioMgr->disconnect( pc ).isSuccess() ) {
              log() << "Disconnected data IO:" << pc->fid() << " [" << pc->pfn() << "]" << endmsg;
              delete pc;
            }
          }
        }
      }
    }
    m_ioMgr.reset();
  }
  m_log.reset();
  m_incidentSvc.reset();
  m_setup->setIncidentSvc( nullptr );
  return ConversionSvc::finalize();
}

getClass()

TClass * RootCnvSvc::getClass ( DataObject * pObject )

protected

Helper: Get TClass for a given DataObject pointer.

Definition at line 177 of file RootCnvSvc.cpp.

                                                  {
  auto i = s_classesClids.find( pObject->clID() );
  if ( i != s_classesClids.end() ) return i->second;
  loadConverter( pObject );
  i = s_classesClids.find( pObject->clID() );
  if ( i != s_classesClids.end() ) return i->second;
 
  string cname = System::typeinfoName( typeid( *pObject ) );
  throw runtime_error( "Unknown ROOT class for object:" + cname );
  return nullptr;
}

i__createObj()

StatusCode RootCnvSvc::i__createObj ( IOpaqueAddress * pAddr, DataObject *& refpObj )

virtual

Create transient object from persistent data.

Parameters

pAddr	[IN] Pointer to object address.
refpObj	[OUT] Location to pointer to store data object

Returns

Status code indicating success or failure.

Definition at line 448 of file RootCnvSvc.cpp.

                                                                              {
  refpObj = nullptr;
  if ( !pA ) return S_FAIL;
  RootDataConnection* con  = nullptr;
  const string*       par  = pA->par();
  unsigned long*      ipar = const_cast<unsigned long*>( pA->ipar() );
  StatusCode          sc   = connectDatabase( par[0], IDataConnection::READ, &con );
  if ( sc.isSuccess() ) {
    ipar[0]             = (unsigned long)con;
    DataObject* pObj    = nullptr;
    size_t      len     = par[1].find( '/', 1 );
    string      section = par[1].substr( 1, len == string::npos ? string::npos : len - 1 );
 
    int nb = con->loadObj( section, par[1], ipar[1], pObj );
    if ( nb > 1 || ( nb == 1 && pObj->clID() == CLID_DataObject ) ) {
      refpObj = pObj;
      return S_OK;
    }
    delete pObj;
  }
  string tag = par[0] + ":" + par[1];
 
  const auto [itr, new_bad] = m_badFiles.insert( tag );
  if ( new_bad ) { return error( "createObj> Cannot access the object:" + tag ); }
  return S_FAIL;
}

i__createRep()

StatusCode RootCnvSvc::i__createRep ( DataObject * pObj, IOpaqueAddress *& refpAddr )

virtual

Convert the transient object to the requested persistent representation.

Parameters

pObj	[IN] Pointer to data object
refpAddr	[OUT] Location to store pointer to object address.

Returns

Status code indicating success or failure.

Definition at line 386 of file RootCnvSvc.cpp.

                                                                                 {
  refpAddr = nullptr;
  if ( !pObj ) return error( "createRep> Current Database is invalid!" );
  CLID                     clid = pObj->clID();
  IRegistry*               pR   = pObj->registry();
  string                   p[2] = { m_current->fid(), pR->identifier() };
  TClass*                  cl   = ( clid == CLID_DataObject ) ? m_classDO : getClass( pObj );
  size_t                   len  = p[1].find( '/', 1 );
  string                   sect = p[1].substr( 1, len == string::npos ? string::npos : len - 1 );
  pair<int, unsigned long> ret  = m_current->saveObj( sect, p[1], cl, pObj, m_minBufferSize, m_maxBufferSize,
                                                      m_approxEventsPerBasket, m_splitLevel, true );
  if ( ret.first > 1 || ( clid == CLID_DataObject && ret.first == 1 ) ) {
    unsigned long ip[2] = { 0, ret.second };
    if ( m_currSection.empty() ) m_currSection = p[1];
    return createAddress( repSvcType(), clid, p, ip, refpAddr );
  }
  return error( "Failed to write object data for:" + p[1] );
}

i__fillObjRefs()

StatusCode RootCnvSvc::i__fillObjRefs ( IOpaqueAddress * pAddr, DataObject * pObj )

virtual

Resolve the references of the created transient object.

Parameters

pAddr	[IN] Pointer to object address.
pObj	[IN] Pointer to data object

Returns

Status code indicating success or failure.

Definition at line 476 of file RootCnvSvc.cpp.

                                                                            {
  if ( !pA || !pObj ) return error( "read> Cannot read object -- no valid object address present " );
 
  const unsigned long* ipar = pA->ipar();
  RootDataConnection*  con  = (RootDataConnection*)ipar[0];
  if ( con ) {
    RootObjectRefs refs;
    const string*  par     = pA->par();
    size_t         len     = par[1].find( '/', 1 );
    string         section = par[1].substr( 1, len == string::npos ? string::npos : len - 1 );
    int            nb      = con->loadRefs( section, par[1], ipar[1], refs );
    if ( nb >= 1 ) {
      string        npar[3];
      unsigned long nipar[2];
      IRegistry*    pR      = pObj->registry();
      auto          dataMgr = SmartIF<IDataManagerSvc>{ pR->dataSvc() };
      LinkManager*  mgr     = pObj->linkMgr();
      for ( const auto& i : refs.links ) mgr->addLink( con->getLink( i ), nullptr );
      for ( auto& r : refs.refs ) {
        npar[0]             = con->getDb( r.dbase );
        npar[1]             = con->getCont( r.container );
        npar[2]             = con->getLink( r.link );
        nipar[0]            = 0;
        nipar[1]            = r.entry;
        IOpaqueAddress* nPA = nullptr;
        StatusCode      sc  = addressCreator()->createAddress( r.svc, r.clid, npar, nipar, nPA );
        if ( sc.isSuccess() ) {
          if ( log().level() <= MSG::VERBOSE )
            log() << MSG::VERBOSE << dataMgr.as<IService>()->name() << " -> Register:" << pA->registry()->identifier()
                  << "#" << npar[2] << "[" << r.entry << "]" << endmsg;
          sc = dataMgr->registerAddress( pA->registry(), npar[2], nPA );
          if ( sc.isSuccess() ) continue;
        }
        log() << MSG::ERROR << con->fid() << ": Failed to create address!!!!" << endmsg;
        return S_FAIL;
      }
      return pObj->update();
    } else if ( nb < 0 ) {
      string tag = par[0] + ":" + par[1];
 
      const auto [itr, new_bad] = m_badFiles.insert( tag );
      if ( new_bad ) { return error( "createObj> Cannot access the object:" + tag + " [Corrupted file]" ); }
    }
  }
  return S_FAIL;
}

i__fillRepRefs()

StatusCode RootCnvSvc::i__fillRepRefs ( IOpaqueAddress * pAddr, DataObject * pObj )

virtual

Resolve the references of the converted object.

Parameters

pAddr	[IN] Pointer to object address.
pObj	[IN] Pointer to data object

Returns

Status code indicating success or failure.

Definition at line 406 of file RootCnvSvc.cpp.

                                                                           {
  if ( pObj ) {
    typedef vector<IRegistry*> Leaves;
    Leaves                     leaves;
    RootObjectRefs             refs;
    IRegistry*                 pR      = pObj->registry();
    auto                       dataMgr = SmartIF<IDataManagerSvc>{ pR->dataSvc() };
    if ( dataMgr ) {
      StatusCode status = dataMgr->objectLeaves( pObj, leaves );
      if ( status.isSuccess() ) {
        RootRef       ref;
        const string& id     = pR->identifier();
        size_t        len    = id.find( '/', 1 );
        string        sect   = id.substr( 1, len == string::npos ? string::npos : len - 1 );
        LinkManager*  pLinks = pObj->linkMgr();
        for ( auto& i : leaves ) {
          if ( i->address() ) {
            m_current->makeRef( *i, ref );
            ref.entry = i->address()->ipar()[1];
            refs.refs.push_back( ref );
          }
        }
        for ( int i = 0, n = pLinks->size(); i < n; ++i ) {
          const LinkManager::Link* lnk     = pLinks->link( i );
          int                      link_id = m_current->makeLink( lnk->path() );
          refs.links.push_back( link_id );
        }
        pair<int, unsigned long> ret = m_current->save( sect, id + "#R", m_classRefs, &refs, m_minBufferSize,
                                                        m_maxBufferSize, m_approxEventsPerBasket, m_splitLevel, true );
        if ( ret.first > 1 ) {
          if ( log().level() <= MSG::DEBUG )
            log() << MSG::DEBUG << "Writing object:" << id << " " << ret.first << " " << hex << ret.second << dec
                  << endmsg;
          return S_OK;
        }
      }
    }
  }
  return S_FAIL;
}

initialize()

StatusCode RootCnvSvc::initialize ( )

override

ConversionSvc overload: initialize Db service.

Definition at line 90 of file RootCnvSvc.cpp.

                                  {
  string     cname;
  StatusCode status = ConversionSvc::initialize();
  if ( !status.isSuccess() ) { return error( "Failed to initialize ConversionSvc base class." ); }
  m_log.reset( new MsgStream( msgSvc(), name() ) );
  if ( !m_compression.empty() ) {
    log() << MSG::INFO << "Setting global ROOT compression to:" << m_compression.value() << endmsg;
    if ( !( status = RootConnectionSetup::setCompression( m_compression.value() ) ).isSuccess() ) {
      return error( "Unable to interprete ROOT compression encoding:" + m_compression );
    }
  }
  m_ioMgr = service( "IODataManager" );
  if ( !m_ioMgr ) return error( "Unable to localize interface from service:IODataManager" );
  m_incidentSvc = service( "IncidentSvc" );
  if ( !m_incidentSvc ) return error( "Unable to localize interface from service:IncidentSvc" );
  m_setup->setMessageSvc( new MsgStream( msgSvc(), name() ) );
  m_setup->setIncidentSvc( m_incidentSvc.get() );
  GaudiRoot::patchStreamers( log() );
  cname     = System::typeinfoName( typeid( DataObject ) );
  m_classDO = TClass::GetClass( cname.c_str() );
  if ( !m_classDO ) return error( "Unable to load class description for DataObject" );
  cname       = System::typeinfoName( typeid( RootObjectRefs ) );
  m_classRefs = TClass::GetClass( cname.c_str() );
  if ( !m_classRefs ) return error( "Unable to load class description for ObjectRefs" );
  return S_OK;
}

loadConverter()

void RootCnvSvc::loadConverter ( DataObject * pObj )

overridevirtual

ConversionSvc overload: Load the class (dictionary) for the converter.

Reimplemented from ConversionSvc.

Definition at line 160 of file RootCnvSvc.cpp.

                                                    {
  if ( pObject ) {
    string cname = System::typeinfoName( typeid( *pObject ) );
    if ( log().level() <= MSG::DEBUG )
      log() << MSG::DEBUG << "Trying to 'Autoload' dictionary for class " << cname << endmsg;
    TClass* cl = s_classesNames[cname];
    if ( nullptr == cl ) {
      cl = TClass::GetClass( cname.c_str() );
      if ( cl ) {
        s_classesNames[cname]           = cl;
        s_classesClids[pObject->clID()] = cl;
      }
    }
  }
}

log()

MsgStream & Gaudi::RootCnvSvc::log ( ) const

inlineprotected

Helper: Use message streamer.

Definition at line 106 of file RootCnvSvc.h.

{ return *m_log; }

updateServiceState()

StatusCode Gaudi::RootCnvSvc::updateServiceState ( IOpaqueAddress * )

inlineoverridevirtual

Update state of the service.

Reimplemented from ConversionSvc.

Definition at line 113 of file RootCnvSvc.h.

{ return StatusCode::SUCCESS; }

Member Data Documentation

m_approxEventsPerBasket

Gaudi::Property<int> Gaudi::RootCnvSvc::m_approxEventsPerBasket

protected

Initial value:

{ this, "ApproxEventsPerBasket", 1000,
                                                  "Resize TBasket buffers to fit approximately this many events" }

Definition at line 76 of file RootCnvSvc.h.

m_badFiles

std::set<std::string> Gaudi::RootCnvSvc::m_badFiles

protected

Set with bad files/tables.

Definition at line 98 of file RootCnvSvc.h.

m_classDO

TClass* Gaudi::RootCnvSvc::m_classDO = nullptr

protected

TClass pointer to DataObject class.

Definition at line 91 of file RootCnvSvc.h.

m_classRefs

TClass* Gaudi::RootCnvSvc::m_classRefs = nullptr

protected

TClass pointer to reference class.

Definition at line 89 of file RootCnvSvc.h.

m_compression

Gaudi::Property<std::string> Gaudi::RootCnvSvc::m_compression

protected

Initial value:

{ this, "GlobalCompression", "",
                                                "Compression-algorithm:compression-level,  empty: do nothing" }

Definition at line 79 of file RootCnvSvc.h.

m_current

Gaudi::RootDataConnection* Gaudi::RootCnvSvc::m_current = nullptr

protected

On writing: reference to active output stream.

Definition at line 87 of file RootCnvSvc.h.

m_currSection

std::string Gaudi::RootCnvSvc::m_currSection

protected

Property: ROOT section name.

Definition at line 95 of file RootCnvSvc.h.

m_incidentEnabled

Gaudi::Property<bool> Gaudi::RootCnvSvc::m_incidentEnabled { this, "EnableIncident", true, "Flag to enable incidents on FILE_OPEN" }

protected

Definition at line 67 of file RootCnvSvc.h.

m_incidentSvc

SmartIF<IIncidentSvc> Gaudi::RootCnvSvc::m_incidentSvc

protected

Reference to incident service.

Definition at line 85 of file RootCnvSvc.h.

m_ioMgr

SmartIF<Gaudi::IIODataManager> Gaudi::RootCnvSvc::m_ioMgr

protected

Reference to the I/O data manager.

Definition at line 83 of file RootCnvSvc.h.

m_ioPerfStats

Gaudi::Property<std::string> Gaudi::RootCnvSvc::m_ioPerfStats

protected

Initial value:

{
        this, "IOPerfStats", "", "Enable TTree IOperfStats if not empty; otherwise perf stat file name" }

Definition at line 63 of file RootCnvSvc.h.

m_log

std::unique_ptr<MsgStream> Gaudi::RootCnvSvc::m_log

protected

Message streamer.

Definition at line 101 of file RootCnvSvc.h.

m_maxBufferSize

Gaudi::Property<int> Gaudi::RootCnvSvc::m_maxBufferSize

protected

Initial value:

{ this, "MaxBufferSize", 100 * 1024 * 1024 ,
                                          "Maximum buffer size to use for writing TTree baskets" }

Definition at line 74 of file RootCnvSvc.h.

m_minBufferSize

Gaudi::Property<int> Gaudi::RootCnvSvc::m_minBufferSize

protected

Initial value:

{ this, "MinBufferSize", 2 * 1024 ,
                                          "Minimum buffer size to use for writing TTree baskets" }

Definition at line 72 of file RootCnvSvc.h.

m_recordName

Gaudi::Property<std::string> Gaudi::RootCnvSvc::m_recordName

protected

Initial value:

{ this, "RecordsName", "/FileRecords",
                                               "Records name to fire incident for file records" }

Definition at line 68 of file RootCnvSvc.h.

m_setup

std::shared_ptr<RootConnectionSetup> Gaudi::RootCnvSvc::m_setup

protected

Setup structure (ref-counted) and passed to data connections.

Definition at line 93 of file RootCnvSvc.h.

m_shareFiles

Gaudi::Property<std::string> Gaudi::RootCnvSvc::m_shareFiles

protected

Initial value:

{ this, "ShareFiles", "NO",
                                               "Share files? If set to YES,  files will not be closed on finalize" }

Definition at line 65 of file RootCnvSvc.h.

m_splitLevel

Gaudi::Property<int> Gaudi::RootCnvSvc::m_splitLevel { this, "SplitLevel", 0, "Split level optimization parameter for ROOT TTree" }

protected

Definition at line 78 of file RootCnvSvc.h.

---

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

• RootCnv/include/RootCnv/RootCnvSvc.h
• RootCnv/src/RootCnvSvc.cpp