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. More...

virtual	~RootCnvSvc ()
	Standard destructor. More...

virtual StatusCode	updateServiceState (IOpaqueAddress *)
	Update state of the service. More...

StatusCode	error (const std::string &msg)
	Standard way to print errors. More...

StatusCode	connectDatabase (const std::string &dataset, int mode, RootDataConnection **con)
	Connect the output file to the service with open mode. More...

virtual StatusCode	initialize ()
	ConversionSvc overload: initialize Db service. More...

virtual StatusCode	finalize ()
	ConversionSvc overload: Finalize Db service. More...

virtual IConverter *	createConverter (long typ, const CLID &wanted, const ICnvFactory *fac)
	ConversionSvc overload: Create new Converter using factory. More...

virtual void	loadConverter (DataObject *pObj)
	ConversionSvc overload: Load the class (dictionary) for the converter. More...

virtual StatusCode	connectOutput (const std::string &outputFile, const std::string &openMode)
	Connect the output file to the service with open mode. More...

virtual StatusCode	connectOutput (const std::string &outputFile)
	Connect the output file to the service. More...

virtual StatusCode	commitOutput (const std::string &outputFile, bool do_commit)
	Commit pending output. More...

virtual StatusCode	disconnect (const std::string &dbName)
	Disconnect from an existing data stream. More...

virtual StatusCode	createAddress (long svc_type, const CLID &clid, const std::string par, const unsigned long ip, IOpaqueAddress *&refpAddress)
	IAddressCreator implementation: Address creation. More...

virtual StatusCode	createAddress (long svc_type, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress)
	IAddressCreator implementation: Creates an address in string form to object form. More...

virtual StatusCode	createNullRep (const std::string &path)
	Insert null marker for not existent transient object. More...

virtual StatusCode	createNullRef (const std::string &path)
	Insert null marker for not existent transient object. More...

virtual StatusCode	i__createRep (DataObject pObj, IOpaqueAddress &refpAddr)
	Convert the transient object to the requested persistent representation. More...

virtual StatusCode	i__fillRepRefs (IOpaqueAddress pAddr, DataObject pObj)
	Resolve the references of the converted object. More...

virtual StatusCode	i__createObj (IOpaqueAddress pAddr, DataObject &refpObj)
	Create transient object from persistent data. More...

virtual StatusCode	i__fillObjRefs (IOpaqueAddress pAddr, DataObject pObj)
	Resolve the references of the created transient object. More...

Public Member Functions inherited from ConversionSvc
virtual long	repSvcType () const
	Retrieve the class type of the data store the converter uses. More...

const CLID &	objType () const
	Implementation of IConverter: dummy call. More...

virtual StatusCode	setDataProvider (IDataProviderSvc *pService)
	Implementation of IConverter: Set Data provider service. More...

virtual SmartIF< IDataProviderSvc > &	dataProvider () const
	Implementation of IConverter: Get Data provider service. More...

virtual StatusCode	setConversionSvc (IConversionSvc *svc)
	Implementation of IConverter: Set conversion service the converter is connected to. More...

virtual SmartIF< IConversionSvc > &	conversionSvc () const
	Implementation of IConverter: Get conversion service the converter is connected to. More...

virtual StatusCode	setAddressCreator (IAddressCreator *creator)
	Set address creator facility. More...

virtual SmartIF< IAddressCreator > &	addressCreator () const
	Retrieve address creator facility. More...

virtual StatusCode	createObj (IOpaqueAddress pAddress, DataObject &refpObject)
	Implementation of IConverter: Create the transient representation of an object. More...

virtual StatusCode	fillObjRefs (IOpaqueAddress pAddress, DataObject pObject)
	Implementation of IConverter: Resolve the references of the created transient object. More...

virtual StatusCode	updateObj (IOpaqueAddress pAddress, DataObject refpObject)
	Implementation of IConverter: Update the transient object from the other representation. More...

virtual StatusCode	updateObjRefs (IOpaqueAddress pAddress, DataObject pObject)
	Implementation of IConverter: Update the references of an updated transient object. More...

virtual StatusCode	createRep (DataObject pObject, IOpaqueAddress &refpAddress)
	Implementation of IConverter: Convert the transient object to the requested representation. More...

virtual StatusCode	fillRepRefs (IOpaqueAddress pAddress, DataObject pObject)
	Implementation of IConverter: Resolve the references of the converted object. More...

virtual StatusCode	updateRep (IOpaqueAddress pAddress, DataObject pObject)
	Implementation of IConverter: Update the converted representation of a transient object. More...

virtual StatusCode	updateRepRefs (IOpaqueAddress pAddress, DataObject pObject)
	Implementation of IConverter: Update the references of an already converted object. More...

virtual StatusCode	addConverter (const CLID &clid)
	Add converter object to conversion service. More...

virtual StatusCode	addConverter (IConverter *pConverter)
	Add converter object to conversion service. More...

virtual StatusCode	removeConverter (const CLID &clid)
	Remove converter object from conversion service (if present). More...

virtual IConverter *	converter (const CLID &wanted)
	Retrieve converter from list. More...

virtual StatusCode	convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress)
	Convert an address to string form. More...

	ConversionSvc (const std::string &name, ISvcLocator *svc, long type)
	Standard Constructor. More...

Public Member Functions inherited from extends< Service, IConversionSvc, IAddressCreator >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...

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. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Member Functions
TClass *	getClass (DataObject *pObject)
	Helper: Get TClass for a given DataObject pointer. More...

MsgStream &	log () const
	Helper: Use message streamer. More...

Protected Member Functions inherited from ConversionSvc
virtual	~ConversionSvc ()
	Standard Destructor. More...

virtual StatusCode	configureConverter (long typ, const CLID &clid, IConverter *cnv)
	Configure the new converter before initialize is called. More...

virtual StatusCode	initializeConverter (long typ, const CLID &clid, IConverter *cnv)
	Initialize the new converter. More...

virtual StatusCode	activateConverter (long typ, const CLID &clid, IConverter *cnv)
	Activate the new converter after initialization. More...

virtual SmartIF< IAddressCreator > &	addressCreator ()
	Retrieve address creation interface. More...

StatusCode	makeCall (int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress &pAddress, DataObject &pObject)

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes
SmartIF< Gaudi::IIODataManager >	m_ioMgr
	Reference to the I/O data manager. More...

SmartIF< IIncidentSvc >	m_incidentSvc
	Reference to incident service. More...

Gaudi::RootDataConnection *	m_current = nullptr
	On writing: reference to active output stream. More...

TClass *	m_classRefs
	TClass pointer to reference class. More...

TClass *	m_classDO
	TClass pointer to DataObject class. More...

std::shared_ptr< RootConnectionSetup >	m_setup
	Setup structure (ref-counted) and passed to data connections. More...

std::string	m_currSection
	Property: ROOT section name. More...

bool	m_incidentEnabled
	Property: Flag to enable incidents on FILE_OPEN. More...

std::string	m_shareFiles
	Property: Share files ? If set to YES, files will not be closed on finalize. More...

std::string	m_recordName
	Property: Records name to fire incident for file records. More...

std::string	m_ioPerfStats
	Property: Enable TTree IOperfStats if not empty; otherwise perf stat file name. More...

std::string	m_compression
	Property: Compression-algorithm:compression-level. More...

int	m_autoFlush
	Property: AutoFlush parameter for ROOT TTree (Number of events between auto flushes) More...

int	m_basketSize
	Property: Basket optimization parameter for ROOT TTree (total basket size) More...

int	m_bufferSize
	Property: Buffer size optimization parameter for ROOT TTree. More...

int	m_splitLevel
	Property: Split level optimization parameter for ROOT TTree. More...

std::set< std::string >	m_badFiles
	Set with bad files/tables. More...

std::unique_ptr< MsgStream >	m_log
	Message streamer. More...

Protected Attributes inherited from ConversionSvc
SmartIF< IDataProviderSvc >	m_dataSvc
	Pointer to data provider service. More...

SmartIF< IAddressCreator >	m_addressCreator
	Pointer to the address creation service interface. More...

SmartIF< IConversionSvc >	m_cnvSvc
	Pointer to the IConversionSvc interface of this. More...

long	m_type
	Conversion service type. More...

std::vector< WorkerEntry >	m_workers
	List of conversion workers. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...

Additional Inherited Members
Public Types inherited from extends< Service, IConversionSvc, IAddressCreator >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

Public Types inherited from Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Description:

RootCnvSvc class implementation definition.

Author: Markus Frank

Version: 1.0

Date: 20/12/2009

Definition at line 52 of file RootCnvSvc.h.

Constructor & Destructor Documentation

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

Standard constructor.

Definition at line 49 of file RootCnvSvc.cpp.

 : ConversionSvc( nam, svc, ROOT_StorageType),
   m_setup{ new RootConnectionSetup() }
 {
   m_classRefs = m_classDO = nullptr;
   m_setup->cacheBranches.push_back("*");
   declareProperty("IOPerfStats",      m_ioPerfStats);
   declareProperty("ShareFiles",       m_shareFiles          = "NO");
   declareProperty("EnableIncident",   m_incidentEnabled     = true);
   declareProperty("RecordsName",      m_recordName          = "/FileRecords");
   declareProperty("LoadSection",      m_setup->loadSection  = "Event");
 
   // ROOT Write parameters
   declareProperty("AutoFlush",        m_autoFlush    = 100);
   declareProperty("BasketSize",       m_basketSize   = 2*MBYTE);
   declareProperty("BufferSize",              m_bufferSize   = 2*kBYTE);
   declareProperty("SplitLevel",       m_splitLevel   = 0);
   declareProperty("GlobalCompression",m_compression); // empty: do nothing
 
   // 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);
 }

RootCnvSvc::~RootCnvSvc ( )

virtual

Standard destructor.

Definition at line 76 of file RootCnvSvc.cpp.

76 {

77 }

Member Function Documentation

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

virtual

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

Reimplemented from ConversionSvc.

Definition at line 329 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 ( evt == 1 )  {
         b->GetTree()->OptimizeBaskets(m_basketSize,1.1,"");
       }
       if ( evt > 0 && (evt%m_autoFlush)==0 ) {
         if ( evt == m_autoFlush ) {
           b->GetTree()->SetAutoFlush(m_autoFlush);
           b->GetTree()->OptimizeBaskets(m_basketSize,1.,"");
         }
         else   {
           b->GetTree()->FlushBaskets();
         }
       }
       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;
 }

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 223 of file RootCnvSvc.cpp.

                                                                              {
   try {
     IDataConnection* c = m_ioMgr->connection(dataset);
     bool fire_incident = false;
     *con = nullptr;
     if ( !c )  {
       std::unique_ptr<RootDataConnection> connection(new 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) ) {
           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() ) pc->connectRead();
       *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.substr(1) : m_recordName;
         TBranch* b = pc->getBranch(section,m_recordName);
         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);
   }
 }

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

virtual

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.

Reimplemented from ConversionSvc.

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

virtual

Connect the output file to the service.

Parameters

outputFile String containig output file

Returns: Status code indicating success or failure.

Reimplemented from ConversionSvc.

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

virtual

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

Reimplemented from ConversionSvc.

Definition at line 389 of file RootCnvSvc.cpp.

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

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

inlinevirtual

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.

Reimplemented from ConversionSvc.

Definition at line 204 of file RootCnvSvc.h.

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

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

virtual

ConversionSvc overload: Create new Converter using factory.

Reimplemented from ConversionSvc.

Definition at line 156 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);
 }

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 408 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_bufferSize,m_splitLevel);
   if( log().level() <= MSG::VERBOSE )
     log() << MSG::VERBOSE << "Writing object:" << path << " "
           << ret.first << " " << hex << ret.second << dec << " [NULL]" << endmsg;
   return S_OK;
 }

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 400 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_bufferSize,m_splitLevel);
   return S_OK;
 }

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 383 of file RootCnvSvc.cpp.

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

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 80 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;
 }

StatusCode RootCnvSvc::finalize ( )

virtual

ConversionSvc overload: Finalize Db service.

Reimplemented from ConversionSvc.

Definition at line 125 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);
         }
         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();
 }

TClass * RootCnvSvc::getClass ( DataObject * pObject )

protected

Helper: Get TClass for a given DataObject pointer.

Definition at line 187 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;
 }

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 483 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];
   if ( m_badFiles.find(tag) == m_badFiles.end() ) {
     m_badFiles.insert(tag);
     return error("createObj> Cannot access the object:"+tag);
   }
   return S_FAIL;
 
 }

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 421 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_bufferSize,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]);
 }

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 513 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];
       if ( m_badFiles.find(tag) == m_badFiles.end() ) {
         m_badFiles.insert(tag);
         return error("createObj> Cannot access the object:"+tag+" [Corrupted file]");
       }
     }
   }
   return S_FAIL;
 }

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 441 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)  {
           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_bufferSize,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;
 }

StatusCode RootCnvSvc::initialize ( )

virtual

ConversionSvc overload: initialize Db service.

Reimplemented from ConversionSvc.

Definition at line 91 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 << endmsg;
     if ( !(status=RootConnectionSetup::setCompression(m_compression)).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;
 }

void RootCnvSvc::loadConverter ( DataObject * pObj )

virtual

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

Reimplemented from ConversionSvc.

Definition at line 170 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;
       }
     }
   }
 }

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

inlineprotected

Helper: Use message streamer.

Definition at line 99 of file RootCnvSvc.h.

99 { return *m_log; }

Gaudi::RootCnvSvc::m_log

std::unique_ptr< MsgStream > m_log

Message streamer.

Definition: RootCnvSvc.h:94

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

inlinevirtual

Update state of the service.

Reimplemented from ConversionSvc.

Definition at line 110 of file RootCnvSvc.h.

111 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

Definition: StatusCode.h:30

Member Data Documentation

int Gaudi::RootCnvSvc::m_autoFlush

protected

Property: AutoFlush parameter for ROOT TTree (Number of events between auto flushes)

Definition at line 82 of file RootCnvSvc.h.

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

protected

Set with bad files/tables.

Definition at line 91 of file RootCnvSvc.h.

int Gaudi::RootCnvSvc::m_basketSize

protected

Property: Basket optimization parameter for ROOT TTree (total basket size)

Definition at line 84 of file RootCnvSvc.h.

int Gaudi::RootCnvSvc::m_bufferSize

protected

Property: Buffer size optimization parameter for ROOT TTree.

Definition at line 86 of file RootCnvSvc.h.

TClass* Gaudi::RootCnvSvc::m_classDO

protected

TClass pointer to DataObject class.

Definition at line 64 of file RootCnvSvc.h.

TClass* Gaudi::RootCnvSvc::m_classRefs

protected

TClass pointer to reference class.

Definition at line 62 of file RootCnvSvc.h.

std::string Gaudi::RootCnvSvc::m_compression

protected

Property: Compression-algorithm:compression-level.

Definition at line 79 of file RootCnvSvc.h.

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

protected

On writing: reference to active output stream.

Definition at line 60 of file RootCnvSvc.h.

std::string Gaudi::RootCnvSvc::m_currSection

protected

Property: ROOT section name.

Definition at line 68 of file RootCnvSvc.h.

bool Gaudi::RootCnvSvc::m_incidentEnabled

protected

Property: Flag to enable incidents on FILE_OPEN.

Definition at line 71 of file RootCnvSvc.h.

SmartIF<IIncidentSvc> Gaudi::RootCnvSvc::m_incidentSvc

protected

Reference to incident service.

Definition at line 58 of file RootCnvSvc.h.

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

protected

Reference to the I/O data manager.

Definition at line 56 of file RootCnvSvc.h.

std::string Gaudi::RootCnvSvc::m_ioPerfStats

protected

Property: Enable TTree IOperfStats if not empty; otherwise perf stat file name.

Definition at line 77 of file RootCnvSvc.h.

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

protected

Message streamer.

Definition at line 94 of file RootCnvSvc.h.

std::string Gaudi::RootCnvSvc::m_recordName

protected

Property: Records name to fire incident for file records.

Definition at line 75 of file RootCnvSvc.h.

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

protected

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

Definition at line 66 of file RootCnvSvc.h.

std::string Gaudi::RootCnvSvc::m_shareFiles

protected

Property: Share files ? If set to YES, files will not be closed on finalize.

Definition at line 73 of file RootCnvSvc.h.

int Gaudi::RootCnvSvc::m_splitLevel

protected

Property: Split level optimization parameter for ROOT TTree.

Definition at line 88 of file RootCnvSvc.h.

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

RootCnv/RootCnv/RootCnvSvc.h
RootCnv/src/RootCnvSvc.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation