Concrete implementation of the IDataConnection interface to access ROOT files. More...

#include <GaudiRootCnv/RootDataConnection.h>

Inheritance diagram for Gaudi::RootDataConnection:

Collaboration diagram for Gaudi::RootDataConnection:

[legend]

Classes
class	ContainerSection
	Internal helper class, which described a TBranch section in a ROOT file. More...

class	Tool
	Helper class to facilitate an abstraction layer for reading POOL style files with this package. More...

Public Types
enum class	Status : StatusCode::code_t { ROOT_READ_ERROR = 0x2 , ROOT_OPEN_ERROR = 0x4 }

typedef std::vector< std::string >	StringVec
	Type definition for string maps.

typedef std::vector< std::pair< std::string, std::string > >	ParamMap
	Type definition for the parameter map.

typedef std::map< std::string, TTree *, std::less<> >	Sections
	Definition of tree sections.

typedef std::vector< ContainerSection >	ContainerSections
	Definition of container sections to handle merged files.

typedef std::map< std::string, ContainerSections, std::less<> >	MergeSections
	Definition of database section to handle merged files.

typedef std::vector< RootRef >	LinkSections
	Link sections definition.

typedef std::set< const IInterface * >	Clients
	Client set.

Public Types inherited from Gaudi::IDataConnection
enum	IoType { READ = 1 << 1 , UPDATE = 1 << 2 , CREATE = 1 << 3 , RECREATE = ( 1 << 4 ) + ( 1 << 3 ) }
	I/O Connection types. More...

enum	IoStatus { BAD_DATA_CONNECTION = 4 }
	Status Code on bad file connection. More...

Public Member Functions
MsgStream &	msgSvc () const
	Allow access to printer service.

IIncidentSvc *	incidentSvc () const

Tool *	makeTool ()
	Create file access tool to encapsulate POOL compatibiliy.

	RootDataConnection (const IInterface *own, std::string_view nam, std::shared_ptr< RootConnectionSetup > setup)
	Standard constructor.

TFile *	file () const
	Direct access to TFile structure.

bool	isConnected () const override
	Check if connected to data source.

bool	isWritable () const
	Is the file writable?

Tool *	tool () const
	Access tool.

const MergeSections &	mergeSections () const
	Access merged data section inventory.

const StringVec &	mergeFIDs () const
	Access merged FIDs.

void	addClient (const IInterface *client)
	Add new client to this data source.

size_t	removeClient (const IInterface *client)
	Remove client from this data source.

bool	lookupClient (const IInterface *client) const
	Lookup client for this data source.

void	badWriteError (std::string_view msg) const
	Error handler when bad write statements occur.

std::pair< const RootRef , const ContainerSection >	getMergeSection (std::string_view container, int entry) const
	Access link section for single container and entry.

void	enableStatistics (std::string_view section)
	Enable TTreePerStats.

void	saveStatistics (std::string_view statisticsFile)
	Save TTree access statistics if required.

int	loadObj (std::string_view section, std::string_view cnt, unsigned long entry, DataObject *&pObj)
	Load object.

int	loadRefs (std::string_view section, std::string_view cnt, unsigned long entry, RootObjectRefs &refs)
	Load references object.

std::pair< int, unsigned long >	saveObj (std::string_view section, std::string_view cnt, TClass cl, DataObject pObj, int minBufferSize, int maxBufferSize, int approxEventsPerBasket, int split_lvl, bool fill_missing=false)
	Save object of a given class to section and container.

std::pair< int, unsigned long >	save (std::string_view section, std::string_view cnt, TClass cl, void pObj, int minBufferSize, int maxBufferSize, int approxEventsPerBasket, int split_lvl, bool fill_missing=false)
	Save object of a given class to section and container.

StatusCode	connectRead () override
	Open data stream in read mode.

StatusCode	connectWrite (IoType typ) override
	Open data stream in write mode.

StatusCode	disconnect () override
	Release data stream and release implementation dependent resources.

StatusCode	read (void *const, size_t) override
	Read root byte buffer from input stream.

StatusCode	write (const void *, int) override
	Write root byte buffer to output stream.

long long int	seek (long long int, int) override
	Seek on the file described by ioDesc. Arguments as in seek()

TTree *	getSection (std::string_view sect, bool create=false)
	Access TTree section from section name. The section is created if required.

TBranch *	getBranch (std::string_view section, std::string_view branch_name)
	Access data branch by name: Get existing branch in read only mode.

TBranch *	getBranch (std::string_view section, std::string_view branch_name, TClass cl, void ptr, int buff_siz, int split_lvl)
	Access data branch by name: Get existing branch in write mode.

void	makeRef (const IRegistry &pA, RootRef &ref)
	Create reference object from registry entry.

void	makeRef (std::string_view name, long clid, int tech, std::string_view db, std::string_view cnt, int entry, RootRef &ref)
	Create reference object from values.

int	makeLink (std::string_view p)
	Convert path string to path index.

const std::string &	getDb (int which) const
	Access database/file name from saved index.

const std::string &	getCont (int which) const
	Access container name from saved index.

const std::string &	getLink (int which) const
	Access link name from saved index.

Public Member Functions inherited from Gaudi::IDataConnection
	IDataConnection (const IInterface *own, std::string nam)
	Standard constructor.

virtual	~IDataConnection ()=default
	Standard destructor.

const std::string &	name () const
	Connection name.

void	setFID (std::string fid)
	Set file ID.

const std::string &	fid () const
	Access file id.

const std::string &	pfn () const
	Access physical file name.

void	setPFN (std::string fn)
	Set physical file name.

int	ageFile ()
	Increase age of I/O source.

void	resetAge ()
	Reset age.

int	age () const
	Access age counter.

const IInterface *	owner () const
	Owner instance.

Public Attributes
std::unique_ptr< Tool >	m_tool

Protected Member Functions
const std::string &	empty () const
	Empty string reference.

StatusCode	saveRefs ()
	Internal helper to save/update reference tables.

Protected Attributes
std::shared_ptr< RootConnectionSetup >	m_setup
	Reference to the setup structure.

std::unique_ptr< TTreePerfStats >	m_statistics
	I/O read statistics from TTree.

std::unique_ptr< TFile >	m_file
	Reference to ROOT file.

TTree *	m_refs = nullptr
	Pointer to the reference tree.

Sections	m_sections
	Tree sections in TFile.

StringVec	m_dbs
	Map containing external database file names (fids)

StringVec	m_conts
	Map containing external container names.

StringVec	m_links
	Map containing internal links names.

StringVec	m_mergeFIDs
	Map containing merge FIDs.

ParamMap	m_params
	Parameter map for file parameters.

MergeSections	m_mergeSects
	Database section map for merged files.

LinkSections	m_linkSects
	Database link sections.

Clients	m_clients
	Client list.

std::string	m_empty
	Buffer for empty string reference.

Protected Attributes inherited from Gaudi::IDataConnection
std::string	m_name
	Connection name/identifier.

std::string	m_fid
	File ID of the connection.

std::string	m_pfn
	Physical file name of the connection.

int	m_age = 0
	Age counter.

const IInterface *	m_owner = nullptr
	Owner pointer.

Friends
class	Tool

Detailed Description

Concrete implementation of the IDataConnection interface to access ROOT files.

Author: M.Frank

Version: 1.0

Date: 20/12/2009

Definition at line 112 of file RootDataConnection.h.

Member Typedef Documentation

◆ Clients

typedef std::set<const IInterface*> Gaudi::RootDataConnection::Clients

Client set.

Definition at line 160 of file RootDataConnection.h.

◆ ContainerSections

typedef std::vector<ContainerSection> Gaudi::RootDataConnection::ContainerSections

Definition of container sections to handle merged files.

Definition at line 154 of file RootDataConnection.h.

◆ LinkSections

typedef std::vector<RootRef> Gaudi::RootDataConnection::LinkSections

Link sections definition.

Definition at line 158 of file RootDataConnection.h.

◆ MergeSections

typedef std::map<std::string, ContainerSections, std::less<> > Gaudi::RootDataConnection::MergeSections

Definition of database section to handle merged files.

Definition at line 156 of file RootDataConnection.h.

◆ ParamMap

typedef std::vector<std::pair<std::string, std::string> > Gaudi::RootDataConnection::ParamMap

Type definition for the parameter map.

Definition at line 150 of file RootDataConnection.h.

◆ Sections

typedef std::map<std::string, TTree*, std::less<> > Gaudi::RootDataConnection::Sections

Definition of tree sections.

Definition at line 152 of file RootDataConnection.h.

◆ StringVec

typedef std::vector<std::string> Gaudi::RootDataConnection::StringVec

Type definition for string maps.

Definition at line 148 of file RootDataConnection.h.

Member Enumeration Documentation

◆ Status

enum class Gaudi::RootDataConnection::Status : StatusCode::code_t

strong

Enumerator
ROOT_READ_ERROR
ROOT_OPEN_ERROR

Definition at line 114 of file RootDataConnection.h.

114: StatusCode::code_t { ROOT_READ_ERROR = 0x2, ROOT_OPEN_ERROR = 0x4 };

StatusCode::code_t

unsigned long code_t

type of StatusCode value

Definition StatusCode.h:66

Constructor & Destructor Documentation

◆ RootDataConnection()

RootDataConnection::RootDataConnection	(	const IInterface *	own,
		std::string_view	nam,
		std::shared_ptr< RootConnectionSetup >	setup )

Standard constructor.

Definition at line 175 of file RootDataConnection.cpp.

    : IDataConnection( owner, std::string{ fname } ), m_setup( std::move( setup ) ) {
  //               01234567890123456789012345678901234567890
  // Check if FID: A82A3BD8-7ECB-DC11-8DC0-000423D950B0
  if ( fname.size() == 36 && fname[8] == '-' && fname[13] == '-' && fname[18] == '-' && fname[23] == '-' ) {
    m_name = "FID:";
    m_name.append( fname.data(), fname.size() );
  }
  m_age = 0;
  m_file.reset();
  addClient( owner );
}

Member Function Documentation

◆ addClient()

void RootDataConnection::addClient ( const IInterface * client )

Add new client to this data source.

Definition at line 190 of file RootDataConnection.cpp.

190{ m_clients.insert( client ); }

Gaudi::RootDataConnection::m_clients

Clients m_clients

Client list.

Definition RootDataConnection.h:192

◆ badWriteError()

void RootDataConnection::badWriteError ( std::string_view msg ) const

Error handler when bad write statements occur.

Definition at line 206 of file RootDataConnection.cpp.

                                                                 {
  msgSvc() << MSG::ERROR << "File:" << fid() << "Failed action:" << msg << endmsg;
}

◆ connectRead()

StatusCode RootDataConnection::connectRead ( )

overridevirtual

Open data stream in read mode.

Connect the file in READ mode.

Implements Gaudi::IDataConnection.

Definition at line 247 of file RootDataConnection.cpp.

                                           {
  m_file.reset( TFile::Open( m_pfn.c_str() ) );
  if ( !m_file || m_file->IsZombie() ) {
    m_file.reset();
    return StatusCode::FAILURE;
  }
  StatusCode sc = StatusCode::FAILURE;
  msgSvc() << MSG::DEBUG << "Opened file " << m_pfn << " in mode READ. [" << m_fid << "]" << endmsg << MSG::DEBUG;
  if ( msgSvc().isActive() ) m_file->ls();
  msgSvc() << MSG::VERBOSE;
  if ( msgSvc().isActive() ) m_file->Print();
  if ( makeTool() ) {
    sc = m_tool->readRefs();
    sc.ignore();
#if ROOT_VERSION_CODE >= ROOT_VERSION( 5, 33, 0 )
    if ( sc == Status::ROOT_READ_ERROR ) {
      IIncidentSvc* inc = m_setup->incidentSvc();
      if ( inc ) { inc->fireIncident( Incident( pfn(), IncidentType::CorruptedInputFile ) ); }
    }
#endif
  }
  if ( !sc.isSuccess() ) return sc;
  bool   need_fid = m_fid == m_pfn;
  string fid      = m_fid;
  m_mergeFIDs.clear();
  for ( auto& elem : m_params ) {
    if ( elem.first == "FID" ) {
      m_mergeFIDs.push_back( elem.second );
      if ( elem.second != m_fid ) {
        msgSvc() << MSG::DEBUG << "Check FID param:" << elem.second << endmsg;
        // if ( m_fid == m_pfn ) {
        m_fid = elem.second;
        //}
      }
    }
  }
  if ( !need_fid && fid != m_fid ) {
    msgSvc() << MSG::ERROR << "FID mismatch:" << fid << "(Catalog) != " << m_fid << "(file)" << endmsg
             << "for PFN:" << m_pfn << endmsg;
    return StatusCode::FAILURE;
  }
  msgSvc() << MSG::DEBUG << "Using FID " << m_fid << " from params table...." << endmsg << "for PFN:" << m_pfn
           << endmsg;
  return sc;
}

◆ connectWrite()

StatusCode RootDataConnection::connectWrite ( IoType typ )

overridevirtual

Open data stream in write mode.

Implements Gaudi::IDataConnection.

Definition at line 294 of file RootDataConnection.cpp.

                                                        {
  int compress = RootConnectionSetup::compression();
  msgSvc() << MSG::DEBUG;
  std::string spec = m_pfn;
  if ( m_setup->produceReproducibleFiles ) spec += "?reproducible"; // https://root.cern.ch/doc/master/classTFile.html
  switch ( typ ) {
  case CREATE:
    resetAge();
    m_file.reset( TFile::Open( spec.c_str(), "CREATE", "Root event data", compress ) );
#if ROOT_HAS_630_FWD_COMPAT
    if ( m_file && m_setup->root630ForwardCompatibility ) m_file->SetBit( TFile::k630forwardCompatibility );
#endif
    m_refs = new TTree( "Refs", "Root reference data" );
    msgSvc() << "Opened file " << m_pfn << " in mode CREATE. [" << m_fid << "]" << endmsg;
    m_params.emplace_back( "PFN", m_pfn );
    if ( m_fid != m_pfn ) { m_params.emplace_back( "FID", m_fid ); }
    makeTool();
    break;
  case RECREATE:
    resetAge();
    m_file.reset( TFile::Open( spec.c_str(), "RECREATE", "Root event data", compress ) );
#if ROOT_HAS_630_FWD_COMPAT
    if ( m_file && m_setup->root630ForwardCompatibility ) m_file->SetBit( TFile::k630forwardCompatibility );
#endif
    msgSvc() << "Opened file " << m_pfn << " in mode RECREATE. [" << m_fid << "]" << endmsg;
    m_refs = new TTree( "Refs", "Root reference data" );
    m_params.emplace_back( "PFN", m_pfn );
    if ( m_fid != m_pfn ) { m_params.emplace_back( "FID", m_fid ); }
    makeTool();
    break;
  case UPDATE:
    resetAge();
    m_file.reset( TFile::Open( spec.c_str(), "UPDATE", "Root event data", compress ) );
    msgSvc() << "Opened file " << m_pfn << " in mode UPDATE. [" << m_fid << "]" << endmsg;
    if ( m_file && !m_file->IsZombie() ) {
      if ( makeTool() ) {
        StatusCode sc = m_tool->readRefs();
        sc.ignore();
        if ( sc == Status::ROOT_READ_ERROR ) {
#if ROOT_VERSION_CODE >= ROOT_VERSION( 5, 33, 0 )
          IIncidentSvc* inc = m_setup->incidentSvc();
          if ( inc ) { inc->fireIncident( Incident( pfn(), IncidentType::CorruptedInputFile ) ); }
#endif
        }
        return sc;
      }
      TDirectory::TContext ctxt( m_file.get() );
      m_refs = new TTree( "Refs", "Root reference data" );
      makeTool();
      return StatusCode::SUCCESS;
    }
    break;
  default:
    m_refs = nullptr;
    m_file.reset();
    return StatusCode::FAILURE;
  }
  return m_file ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

◆ disconnect()

StatusCode RootDataConnection::disconnect ( )

overridevirtual

Release data stream and release implementation dependent resources.

Implements Gaudi::IDataConnection.

Definition at line 355 of file RootDataConnection.cpp.

                                          {
  if ( m_file ) {
    if ( !m_file->IsZombie() ) {
      if ( m_file->IsWritable() ) {
        msgSvc() << MSG::DEBUG;
        TDirectory::TContext ctxt( m_file.get() );
        if ( m_refs ) {
          if ( !m_tool->saveRefs().isSuccess() ) badWriteError( "Saving References" );
          if ( m_refs->Write() < 0 ) badWriteError( "Write Reference branch" );
        }
        for ( auto& i : m_sections ) {
          if ( i.second ) {
            if ( i.second->Write() < 0 ) badWriteError( "Write section:" + i.first );
            msgSvc() << "Disconnect section " << i.first << " " << i.second->GetName() << endmsg;
          }
        }
        m_sections.clear();
      }
      msgSvc() << MSG::DEBUG;
      if ( msgSvc().isActive() ) m_file->ls();
      msgSvc() << MSG::VERBOSE;
      if ( msgSvc().isActive() ) m_file->Print();
      m_file->Close();
    }
    msgSvc() << MSG::DEBUG << "Disconnected file " << m_pfn << " " << m_file->GetName() << endmsg;
    m_file.reset();
    m_tool.reset();
  }
  return StatusCode::SUCCESS;
}

◆ empty()

CSTR RootDataConnection::empty ( ) const

protected

Empty string reference.

Definition at line 495 of file RootDataConnection.cpp.

495{ return s_empty; }

◆ enableStatistics()

void RootDataConnection::enableStatistics ( std::string_view section )

Enable TTreePerStats.

Definition at line 220 of file RootDataConnection.cpp.

                                                                  {
  if ( m_statistics ) {
    TTree* t = getSection( section, false );
    if ( t ) {
      m_statistics.reset( new TTreePerfStats( ( std::string{ section } + "_ioperf" ).c_str(), t ) );
      return;
    }
    msgSvc() << MSG::WARNING << "Failed to enable perfstats for tree:" << section << endmsg;
    return;
  }
  msgSvc() << MSG::INFO << "Perfstats are ALREADY ENABLED." << endmsg;
}

◆ file()

TFile * Gaudi::RootDataConnection::file ( ) const

inline

Direct access to TFile structure.

Definition at line 264 of file RootDataConnection.h.

264{ return m_file.get(); }

◆ getBranch() [1/2]

TBranch * Gaudi::RootDataConnection::getBranch	(	std::string_view	section,
		std::string_view	branch_name )

inline

Access data branch by name: Get existing branch in read only mode.

Definition at line 326 of file RootDataConnection.h.

                                                                             {
      return m_tool->getBranch( section, branch_name );
    }

◆ getBranch() [2/2]

TBranch * RootDataConnection::getBranch	(	std::string_view	section,
		std::string_view	branch_name,
		TClass *	cl,
		void *	ptr,
		int	buff_siz,
		int	split_lvl )

Access data branch by name: Get existing branch in write mode.

Definition at line 461 of file RootDataConnection.cpp.

                                                                      {
  string n = std::string{ branch_name };
  std::replace_if(
      begin( n ), end( n ), []( const char c ) { return !isalnum( c ); }, '_' );
  n += ".";
  TTree*   t = getSection( section, true );
  TBranch* b = t->GetBranch( n.c_str() );
  if ( !b && cl && m_file->IsWritable() ) {
    b = t->Branch( n.c_str(), cl->GetName(), (void*)( ptr ? &ptr : nullptr ), buff_siz, split_lvl );
  }
  if ( !b ) b = t->GetBranch( std::string{ branch_name }.c_str() );
  if ( b ) b->SetAutoDelete( kFALSE );
  return b;
}

◆ getCont()

const std::string & Gaudi::RootDataConnection::getCont ( int which ) const

inline

Access container name from saved index.

Definition at line 346 of file RootDataConnection.h.

                                                {
      return ( which >= 0 ) && ( size_t( which ) < m_conts.size() ) ? *( m_conts.begin() + which ) : empty();
    }

◆ getDb()

CSTR RootDataConnection::getDb ( int which ) const

Access database/file name from saved index.

Definition at line 486 of file RootDataConnection.cpp.

                                                {
  if ( ( which >= 0 ) && ( size_t( which ) < m_dbs.size() ) ) {
    if ( *( m_dbs.begin() + which ) == s_local ) return m_fid;
    return *( m_dbs.begin() + which );
  }
  return s_empty;
}

◆ getLink()

const std::string & Gaudi::RootDataConnection::getLink ( int which ) const

inline

Access link name from saved index.

Definition at line 351 of file RootDataConnection.h.

                                                {
      return ( which >= 0 ) && ( size_t( which ) < m_links.size() ) ? *( m_links.begin() + which ) : empty();
    }

◆ getMergeSection()

pair< const RootRef , const RootDataConnection::ContainerSection > RootDataConnection::getMergeSection	(	std::string_view	container,
		int	entry ) const

Access link section for single container and entry.

Definition at line 620 of file RootDataConnection.cpp.

                                                                               {
  // size_t idx = cont.find('/',1);
  // string container = cont[0]=='/' ? cont.substr(1,idx==string::npos?idx:idx-1) : cont;
  auto i = m_mergeSects.find( container );
  if ( i != m_mergeSects.end() ) {
    size_t                   cnt = 0;
    const ContainerSections& s   = ( *i ).second;
    for ( auto j = s.cbegin(); j != s.cend(); ++j, ++cnt ) {
      const ContainerSection& c = *j;
      if ( entry >= c.start && entry < ( c.start + c.length ) ) {
        if ( m_linkSects.size() > cnt ) {
          if ( msgSvc().isActive() ) {
            msgSvc() << MSG::VERBOSE << "MergeSection for:" << container << "  [" << entry << "]" << endmsg
                     << "FID:" << m_fid << " -> PFN:" << m_pfn << endmsg;
          }
          return { &( m_linkSects[cnt] ), &c };
        }
      }
    }
  }
  msgSvc() << MSG::DEBUG << "Return INVALID MergeSection for:" << container << "  [" << entry << "]" << endmsg
           << "FID:" << m_fid << " -> PFN:" << m_pfn << endmsg;
  return { nullptr, nullptr };
}

◆ getSection()

TTree * RootDataConnection::getSection	(	std::string_view	sect,
		bool	create = false )

Access TTree section from section name. The section is created if required.

Definition at line 387 of file RootDataConnection.cpp.

                                                                           {
  auto   it = m_sections.find( section );
  TTree* t  = ( it != m_sections.end() ? it->second : nullptr );
  if ( !t ) {
    t = (TTree*)m_file->Get( std::string{ section }.c_str() );
    if ( !t && create ) {
      TDirectory::TContext ctxt( m_file.get() );
      t = new TTree( std::string{ section }.c_str(), "Root data for Gaudi" );
    }
    if ( t ) {
      int cacheSize = m_setup->cacheSize;
      if ( create ) {
        // t->SetAutoFlush(100);
      }
      if ( section == m_setup->loadSection && cacheSize > -2 ) {
        MsgStream& msg          = msgSvc();
        int        learnEntries = m_setup->learnEntries;
        t->SetCacheSize( cacheSize );
        t->SetCacheLearnEntries( learnEntries );
        msg << MSG::DEBUG;
        if ( create ) {
          msg << "Tree:" << section << "Setting up tree cache:" << cacheSize << endmsg;
        } else {
          const StringVec& vB = m_setup->vetoBranches;
          const StringVec& cB = m_setup->cacheBranches;
          msg << "Tree:" << section << " Setting up tree cache:" << cacheSize << " Add all branches." << endmsg;
          msg << "Tree:" << section << " Learn for " << learnEntries << " entries." << endmsg;
 
          if ( cB.empty() && vB.empty() ) {
            msg << "Adding (default) all branches to tree cache." << endmsg;
            t->AddBranchToCache( "*", kTRUE );
          }
          if ( cB.size() == 1 && cB[0] == "*" ) {
            msg << "Adding all branches to tree cache according to option \"CacheBranches\"." << endmsg;
            t->AddBranchToCache( "*", kTRUE );
          } else {
            for ( TIter it( t->GetListOfBranches() ); it.Next(); ) {
              const char* n   = ( (TNamed*)( *it ) )->GetName();
              bool        add = false, veto = false;
              for ( const auto& i : cB ) {
                if ( !match_wild( n, ( i ).c_str() ) ) continue;
                add = true;
                break;
              }
              for ( auto i = vB.cbegin(); !add && i != vB.cend(); ++i ) {
                if ( !match_wild( n, ( *i ).c_str() ) ) continue;
                veto = true;
                break;
              }
              if ( add && !veto ) {
                msg << "Add " << n << " to branch cache." << endmsg;
                t->AddBranchToCache( n, kTRUE );
              } else {
                msg << "Do not cache branch " << n << endmsg;
              }
            }
          }
        }
      }
      m_sections[std::string{ section }] = t;
    } else {
      // in some rare cases we do have the entry we expect, but we cannot read it
      // https://gitlab.cern.ch/gaudi/Gaudi/-/issues/301
      auto key = m_file->GetKey( std::string{ section }.c_str() );
      if ( key ) {
        incidentSvc()->fireIncident( Incident( pfn(), IncidentType::CorruptedInputFile ) );
        msgSvc() << MSG::ERROR << fmt::format( "failed to get TTree '{}' in {}", section, pfn() ) << endmsg;
      }
    }
  }
  return t;
}

◆ incidentSvc()

IIncidentSvc * Gaudi::RootDataConnection::incidentSvc ( ) const

inline

Definition at line 164 of file RootDataConnection.h.

164{ return m_setup->incidentSvc(); }

◆ isConnected()

bool Gaudi::RootDataConnection::isConnected ( ) const

inlineoverridevirtual

Check if connected to data source.

Implements Gaudi::IDataConnection.

Definition at line 266 of file RootDataConnection.h.

266{ return bool( m_file ); }

◆ isWritable()

bool Gaudi::RootDataConnection::isWritable ( ) const

inline

Is the file writable?

Definition at line 268 of file RootDataConnection.h.

268{ return m_file && m_file->IsWritable(); }

◆ loadObj()

int RootDataConnection::loadObj	(	std::string_view	section,
		std::string_view	cnt,
		unsigned long	entry,
		DataObject *&	pObj )

Load object.

Definition at line 553 of file RootDataConnection.cpp.

                                                     {
  TBranch* b = getBranch( section, cnt );
  if ( b ) {
    TClass* cl = gROOT->GetClass( b->GetClassName(), kTRUE );
    if ( cl ) {
      int nb = -1;
      pObj   = (DataObject*)cl->New();
      {
        DataObjectPush push( pObj );
        b->SetAddress( &pObj );
        if ( section == m_setup->loadSection ) {
          TTree* t = b->GetTree();
          if ( Long64_t( entry ) != t->GetReadEntry() ) { t->LoadTree( Long64_t( entry ) ); }
        }
        nb = b->GetEntry( entry );
        msgSvc() << MSG::VERBOSE;
        if ( msgSvc().isActive() ) {
          msgSvc() << "Load [" << entry << "] --> " << section << ":" << cnt << "  " << nb << " bytes." << endmsg;
        }
        if ( nb < 0 ) { // This is definitely an error...ROOT says if reads fail, -1 is issued.
#if ROOT_VERSION_CODE >= ROOT_VERSION( 5, 33, 0 )
          IIncidentSvc* inc = m_setup->incidentSvc();
          if ( inc ) { inc->fireIncident( Incident( pfn(), IncidentType::CorruptedInputFile ) ); }
#endif
        } else if ( nb == 0 && pObj->clID() == CLID_DataObject ) {
          TFile* f   = b->GetFile();
          int    vsn = f->GetVersion();
          if ( vsn < 52400 ) {
            // For Gaudi v21r5 (ROOT 5.24.00b) DataObject::m_version was not written!
            // Still this call be well be successful.
            nb = 1;
          } else if ( vsn > 1000000 && ( vsn % 1000000 ) < 52400 ) {
            // dto. Some POOL files have for unknown reasons a version
            // not according to ROOT standards. Hack this explicitly.
            nb = 1;
          }
        }
        if ( nb < 0 ) {
          delete pObj;
          pObj = nullptr;
        }
      }
      return nb;
    }
  }
  return -1;
}

◆ loadRefs()

int RootDataConnection::loadRefs	(	std::string_view	section,
		std::string_view	cnt,
		unsigned long	entry,
		RootObjectRefs &	refs )

Load references object.

Definition at line 603 of file RootDataConnection.cpp.

                                                         {
  int nbytes = m_tool->loadRefs( section, cnt, entry, refs );
#if ROOT_VERSION_CODE >= ROOT_VERSION( 5, 33, 0 )
  if ( nbytes < 0 ) {
    // This is definitely an error:
    // -- Either branch not present at all or
    // -- ROOT I/O error, which issues -1
    IIncidentSvc* inc = m_setup->incidentSvc();
    if ( inc ) { inc->fireIncident( Incident( pfn(), IncidentType::CorruptedInputFile ) ); }
  }
#endif
  return nbytes;
}

◆ lookupClient()

bool RootDataConnection::lookupClient ( const IInterface * client ) const

Lookup client for this data source.

Definition at line 200 of file RootDataConnection.cpp.

                                                                      {
  auto i = m_clients.find( client );
  return i != m_clients.end();
}

◆ makeLink()

int RootDataConnection::makeLink ( std::string_view p )

Convert path string to path index.

Definition at line 478 of file RootDataConnection.cpp.

                                                   {
  auto ip = std::find( std::begin( m_links ), std::end( m_links ), p );
  if ( ip != std::end( m_links ) ) return std::distance( std::begin( m_links ), ip );
  m_links.push_back( std::string{ p } );
  return m_links.size() - 1;
}

◆ makeRef() [1/2]

void RootDataConnection::makeRef	(	const IRegistry &	pA,
		RootRef &	ref )

Create reference object from registry entry.

Definition at line 646 of file RootDataConnection.cpp.

                                                                    {
  IOpaqueAddress* pA = pR.address();
  makeRef( pR.name(), pA->clID(), pA->svcType(), pA->par()[0], pA->par()[1], -1, ref );
}

◆ makeRef() [2/2]

void RootDataConnection::makeRef	(	std::string_view	name,
		long	clid,
		int	tech,
		std::string_view	db,
		std::string_view	cnt,
		int	entry,
		RootRef &	ref )

Create reference object from values.

Definition at line 652 of file RootDataConnection.cpp.

                                                                                {
  auto db   = ( dbase == m_fid ? std::string_view{ s_local } : dbase );
  ref.entry = entry;
 
  int cdb = -1;
  if ( !db.empty() ) {
    auto idb = std::find_if( m_dbs.begin(), m_dbs.end(), [&]( const std::string& i ) { return i == db; } );
    cdb      = std::distance( m_dbs.begin(), idb );
    if ( idb == m_dbs.end() ) m_dbs.push_back( std::string{ db } );
  }
 
  int ccnt = -1;
  if ( !cnt.empty() ) {
    auto icnt = std::find_if( m_conts.begin(), m_conts.end(), [&]( const std::string& i ) { return i == cnt; } );
    ccnt      = std::distance( m_conts.begin(), icnt );
    if ( icnt == m_conts.end() ) m_conts.push_back( std::string{ cnt } );
  }
 
  int clnk = -1;
  if ( !name.empty() ) {
    auto ilnk = std::find_if( m_links.begin(), m_links.end(), [&]( const std::string& i ) { return i == name; } );
    clnk      = std::distance( m_links.begin(), ilnk );
    if ( ilnk == m_links.end() ) m_links.push_back( std::string{ name } );
  }
 
  ref.dbase     = cdb;
  ref.container = ccnt;
  ref.link      = clnk;
  ref.clid      = clid;
  ref.svc       = tech;
  if ( ref.svc == POOL_ROOT_StorageType || ref.svc == POOL_ROOTKEY_StorageType ||
       ref.svc == POOL_ROOTTREE_StorageType ) {
    ref.svc = ROOT_StorageType;
  }
}

◆ makeTool()

RootDataConnection::Tool * RootDataConnection::makeTool ( )

Create file access tool to encapsulate POOL compatibiliy.

Create file access tool to encapsulate POOL compatibility.

Definition at line 234 of file RootDataConnection.cpp.

                                                     {
  if ( !m_refs ) m_refs = (TTree*)m_file->Get( "Refs" );
  if ( m_refs ) m_tool.reset( new RootTool( this ) );
#ifdef __POOL_COMPATIBILITY
  else if ( m_file->Get( "##Links" ) != nullptr )
    m_tool.reset( new PoolTool( this ) );
#endif
  else
    m_tool.reset();
  return m_tool.get();
}

◆ mergeFIDs()

const StringVec & Gaudi::RootDataConnection::mergeFIDs ( ) const

inline

Access merged FIDs.

Definition at line 274 of file RootDataConnection.h.

274{ return m_mergeFIDs; }

◆ mergeSections()

const MergeSections & Gaudi::RootDataConnection::mergeSections ( ) const

inline

Access merged data section inventory.

Definition at line 272 of file RootDataConnection.h.

272{ return m_mergeSects; }

◆ msgSvc()

MsgStream & Gaudi::RootDataConnection::msgSvc ( ) const

inline

Allow access to printer service.

Definition at line 163 of file RootDataConnection.h.

163{ return m_setup->msgSvc(); }

◆ read()

StatusCode Gaudi::RootDataConnection::read	(	void * const	,
		size_t	)

inlineoverridevirtual

Read root byte buffer from input stream.

Implements Gaudi::IDataConnection.

Definition at line 316 of file RootDataConnection.h.

316{ return StatusCode::FAILURE; }

◆ removeClient()

size_t RootDataConnection::removeClient ( const IInterface * client )

Remove client from this data source.

Definition at line 193 of file RootDataConnection.cpp.

                                                                  {
  auto i = m_clients.find( client );
  if ( i != m_clients.end() ) m_clients.erase( i );
  return m_clients.size();
}

◆ save()

pair< int, unsigned long > RootDataConnection::save	(	std::string_view	section,
		std::string_view	cnt,
		TClass *	cl,
		void *	pObj,
		int	minBufferSize,
		int	maxBufferSize,
		int	approxEventsPerBasket,
		int	split_lvl,
		bool	fill_missing = false )

Save object of a given class to section and container.

Definition at line 506 of file RootDataConnection.cpp.

                                                                                                                 {
  split_lvl  = 0;
  TBranch* b = getBranch( section, cnt, cl, pObj ? &pObj : nullptr, minBufferSize, split_lvl );
  if ( b ) {
    Long64_t evt = b->GetEntries();
    // msgSvc() << MSG::DEBUG << cnt.c_str() << " Obj:" << (void*)pObj
    //         << " Split:" << split_lvl << " Buffer size:" << minBufferSize << endl;
    bool set_buffer_size = ( evt == 0 );
    if ( fill_missing ) {
      Long64_t num, nevt = b->GetTree()->GetEntries();
      if ( nevt > evt ) {
        set_buffer_size = true;
        b->SetAddress( nullptr );
        num = nevt - evt;
        while ( num > 0 ) {
          b->Fill();
          --num;
        }
        msgSvc() << MSG::DEBUG << "Added " << long( nevt - evt ) << " / Tree: " << nevt
                 << " / Branch: " << b->GetEntries() + 1 << " NULL entries to:" << cnt << endmsg;
        evt = b->GetEntries();
      }
    }
    if ( set_buffer_size ) {
      auto     dummy_file = make_unique<TMemFile>( "dummy.root", "CREATE" );
      auto     dummy_tree = make_unique<TTree>( "DummyTree", "DummyTree", split_lvl, dummy_file->GetDirectory( "/" ) );
      TBranch* dummy_branch = dummy_tree->Branch( "DummyBranch", cl->GetName(), &pObj, minBufferSize, split_lvl );
      Int_t    nWritten     = dummy_branch->Fill();
      if ( nWritten < 0 ) return { nWritten, evt };
      Int_t newBasketSize = nWritten * approxEventsPerBasket;
      // Ensure that newBasketSize doesn't wrap around
      if ( std::numeric_limits<Int_t>::max() / approxEventsPerBasket < nWritten ) {
        newBasketSize = std::numeric_limits<Int_t>::max();
      }
      b->SetBasketSize( std::min( maxBufferSize, std::max( minBufferSize, newBasketSize ) ) );
      msgSvc() << MSG::DEBUG << "Setting basket size to " << newBasketSize << " for " << cnt << endmsg;
    }
    b->SetAddress( &pObj );
    return { b->Fill(), evt };
  }
  if ( pObj ) { msgSvc() << MSG::ERROR << "Failed to access branch " << m_name << "/" << cnt << endmsg; }
  return { -1, ~0 };
}

◆ saveObj()

pair< int, unsigned long > RootDataConnection::saveObj	(	std::string_view	section,
		std::string_view	cnt,
		TClass *	cl,
		DataObject *	pObj,
		int	minBufferSize,
		int	maxBufferSize,
		int	approxEventsPerBasket,
		int	split_lvl,
		bool	fill_missing = false )

Save object of a given class to section and container.

Definition at line 498 of file RootDataConnection.cpp.

                                                                                                            {
  DataObjectPush push( pObj );
  return save( section, cnt, cl, pObj, minBufferSize, maxBufferSize, approxEventsPerBasket, split_lvl, fill );
}

◆ saveRefs()

StatusCode Gaudi::RootDataConnection::saveRefs ( )

protected

Internal helper to save/update reference tables.

◆ saveStatistics()

void RootDataConnection::saveStatistics ( std::string_view statisticsFile )

Save TTree access statistics if required.

Definition at line 211 of file RootDataConnection.cpp.

                                                                       {
  if ( m_statistics ) {
    m_statistics->Print();
    if ( !statisticsFile.empty() ) m_statistics->SaveAs( std::string{ statisticsFile }.c_str() );
    m_statistics.reset();
  }
}

◆ seek()

long long int Gaudi::RootDataConnection::seek	(	long long int	,
		int	)

inlineoverridevirtual

Seek on the file described by ioDesc. Arguments as in seek()

Implements Gaudi::IDataConnection.

Definition at line 320 of file RootDataConnection.h.

320{ return -1; }

◆ tool()

Tool * Gaudi::RootDataConnection::tool ( ) const

inline

Access tool.

Definition at line 270 of file RootDataConnection.h.

270{ return m_tool.get(); }

◆ write()

StatusCode Gaudi::RootDataConnection::write	(	const void *	,
		int	)

inlineoverridevirtual

Write root byte buffer to output stream.

Implements Gaudi::IDataConnection.

Definition at line 318 of file RootDataConnection.h.

318{ return StatusCode::FAILURE; }

Friends And Related Symbol Documentation

◆ Tool

friend class Tool

friend

Definition at line 254 of file RootDataConnection.h.

Member Data Documentation

◆ m_clients

Clients Gaudi::RootDataConnection::m_clients

protected

Client list.

Definition at line 192 of file RootDataConnection.h.

◆ m_conts

StringVec Gaudi::RootDataConnection::m_conts

protected

Map containing external container names.

Definition at line 180 of file RootDataConnection.h.

◆ m_dbs

StringVec Gaudi::RootDataConnection::m_dbs

protected

Map containing external database file names (fids)

Definition at line 178 of file RootDataConnection.h.

◆ m_empty

std::string Gaudi::RootDataConnection::m_empty

protected

Buffer for empty string reference.

Definition at line 194 of file RootDataConnection.h.

◆ m_file

std::unique_ptr<TFile> Gaudi::RootDataConnection::m_file

protected

Reference to ROOT file.

Definition at line 172 of file RootDataConnection.h.

◆ m_links

StringVec Gaudi::RootDataConnection::m_links

protected

Map containing internal links names.

Definition at line 182 of file RootDataConnection.h.

◆ m_linkSects

LinkSections Gaudi::RootDataConnection::m_linkSects

protected

Database link sections.

Definition at line 190 of file RootDataConnection.h.

◆ m_mergeFIDs

StringVec Gaudi::RootDataConnection::m_mergeFIDs

protected

Map containing merge FIDs.

Definition at line 184 of file RootDataConnection.h.

◆ m_mergeSects

MergeSections Gaudi::RootDataConnection::m_mergeSects

protected

Database section map for merged files.

Definition at line 188 of file RootDataConnection.h.

◆ m_params

ParamMap Gaudi::RootDataConnection::m_params

protected

Parameter map for file parameters.

Definition at line 186 of file RootDataConnection.h.

◆ m_refs

TTree* Gaudi::RootDataConnection::m_refs = nullptr

protected

Pointer to the reference tree.

Definition at line 174 of file RootDataConnection.h.

◆ m_sections

Sections Gaudi::RootDataConnection::m_sections

protected

Tree sections in TFile.

Definition at line 176 of file RootDataConnection.h.

◆ m_setup

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

protected

Reference to the setup structure.

Definition at line 168 of file RootDataConnection.h.

◆ m_statistics

std::unique_ptr<TTreePerfStats> Gaudi::RootDataConnection::m_statistics

protected

I/O read statistics from TTree.

Definition at line 170 of file RootDataConnection.h.

◆ m_tool

std::unique_ptr<Tool> Gaudi::RootDataConnection::m_tool

Definition at line 253 of file RootDataConnection.h.

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

RootCnv/include/RootCnv/RootDataConnection.h
RootCnv/src/RootDataConnection.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Clients

◆ ContainerSections

◆ LinkSections

◆ MergeSections

◆ ParamMap

◆ Sections

◆ StringVec

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ RootDataConnection()

Member Function Documentation

◆ addClient()

◆ badWriteError()

◆ connectRead()

◆ connectWrite()

◆ disconnect()

◆ empty()

◆ enableStatistics()

◆ file()

◆ getBranch() [1/2]

◆ getBranch() [2/2]

◆ getCont()

◆ getDb()

◆ getLink()

◆ getMergeSection()

◆ getSection()

◆ incidentSvc()

◆ isConnected()

◆ isWritable()

◆ loadObj()

◆ loadRefs()

◆ lookupClient()

◆ makeLink()

◆ makeRef() [1/2]

◆ makeRef() [2/2]

◆ makeTool()

◆ mergeFIDs()

◆ mergeSections()

◆ msgSvc()

◆ read()

◆ removeClient()

◆ save()

◆ saveObj()

◆ saveRefs()

◆ saveStatistics()

◆ seek()

◆ tool()

◆ write()

Friends And Related Symbol Documentation

◆ Tool

Member Data Documentation

◆ m_clients

◆ m_conts

◆ m_dbs

◆ m_empty

◆ m_file

◆ m_links

◆ m_linkSects

◆ m_mergeFIDs

◆ m_mergeSects

◆ m_params

◆ m_refs

◆ m_sections

◆ m_setup

◆ m_statistics

◆ m_tool