Gaudi::RootDatabaseMerger Class Reference

Collaboration diagram for Gaudi::RootDatabaseMerger:

Classes
union	uuid_data

Public Member Functions
	RootDatabaseMerger ()
	Standard constructor. More...
virtual	~RootDatabaseMerger ()
	Default destructor. More...
bool	exists (const std::string &fid) const
	Check if a database exists. More...
MergeStatus	create (const std::string &fid)
	Create new output file. More...
MergeStatus	attach (const std::string &fid)
	Attach to existing output file for further merging. More...
MergeStatus	close ()
	Close output file. More...
MergeStatus	merge (const std::string &fid)
	Merge new input to existing output. More...
void	dumpSections ()
	Dump collected database sections. More...
MergeStatus	saveSections ()
	Save new sections to the output file. More...
MergeStatus	createFID ()
	Create and add new FID to the newly merged file. More...
MergeStatus	copyAllTrees (TFile *source)
	Copy all data trees from the input file to the output file. More...
MergeStatus	copyTree (TFile *source, const std::string &name)
	Copy one single tree from the input file to the output file. More...
MergeStatus	copyBranch (TTree *src_tree, TTree *out_tree, const std::string &name)
	Copy single reference branch. More...
MergeStatus	copyRefs (TFile *source, const std::string &name)
	Copy one single tree from the input file to the output file. More...
MergeStatus	addSections (TTree *in, TTree *out)
	Add section information for the next merge step. More...

Private Types
typedef std::vector< ContainerSection >	ContainerSections
typedef std::map< std::string, ContainerSections >	DatabaseSections

Private Attributes
DatabaseSections	m_sections
std::unique_ptr< TFile >	m_output
bool	m_treeSections = false

Detailed Description

Author

M.Frank

Version

1.0

Definition at line 43 of file merge.C.

Member Typedef Documentation

ContainerSections

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

private

Definition at line 45 of file merge.C.

DatabaseSections

typedef std::map<std::string, ContainerSections> Gaudi::RootDatabaseMerger::DatabaseSections

private

Definition at line 46 of file merge.C.

Constructor & Destructor Documentation

RootDatabaseMerger()

RootDatabaseMerger::RootDatabaseMerger ( )

default

Standard constructor.

~RootDatabaseMerger()

RootDatabaseMerger::~RootDatabaseMerger ( )

virtual

Default destructor.

Definition at line 124 of file merge.C.

{ close(); }

Member Function Documentation

addSections()

MergeStatus RootDatabaseMerger::addSections	(	TTree *	in,
		TTree *	out
	)

Add section information for the next merge step.

Definition at line 302 of file merge.C.

                                                                   {
  if ( m_treeSections ) {
    ContainerSection s;
    s.start  = (int)( out ? out->GetEntries() : 0 );
    s.length = (int)in->GetEntries();
    m_sections[in->GetName()].push_back( s );
    return MERGE_SUCCESS;
  }
 
  TObjArray* a_in = in->GetListOfBranches();
  for ( int i = 0, n = a_in->GetLast(); i < n; ++i ) {
    TBranch* b_in  = (TBranch*)a_in->At( i );
    TBranch* b_out = out ? out->GetBranch( b_in->GetName() ) : 0;
    if ( !out || b_out ) {
      ContainerSection s;
      s.start  = (int)( b_out ? b_out->GetEntries() : 0 );
      s.length = (int)b_in->GetEntries();
      m_sections[b_in->GetName()].push_back( s );
      continue;
    }
    ::printf( "+++ Cannot merge incompatible branches:%s.\n", b_in->GetName() );
    return MERGE_ERROR;
  }
  return MERGE_SUCCESS;
}

attach()

MergeStatus RootDatabaseMerger::attach

(

const std::string &

fid

)

Attach to existing output file for further merging.

Definition at line 134 of file merge.C.

                                                              {
  const char* fid = file_id.c_str();
  if ( m_output ) {
    ::printf( "+++ Another output file %s is already open. Request denied.\n", m_output->GetName() );
    return MERGE_ERROR;
  } else if ( !exists( file_id ) ) {
    ::printf( "+++ Cannot attach output file %s --- file does not exist.\n", fid );
    return MERGE_ERROR;
  }
  m_output.reset( TFile::Open( fid, "UPDATE" ) );
  if ( m_output && !m_output->IsZombie() ) {
    // if ( s_dbg ) ::printf("+++ Update output file %s.\n",fid);
    // if ( s_dbg ) ::printf("+++ Update output file.\n");
    return MERGE_SUCCESS;
  }
  ::printf( "+++ Failed to open new output file %s.\n", fid );
  return MERGE_ERROR;
}

close()

MergeStatus RootDatabaseMerger::close

(

)

Close output file.

Definition at line 207 of file merge.C.

                                      {
  if ( m_output ) {
    // if ( s_dbg ) ::printf("+++ Closing merge file: %s.\n",m_output->GetName());
    if ( s_dbg ) ::printf( "+++ Closing merge file.\n" );
    m_output->Write();
    m_output->Purge();
    if ( s_dbg ) m_output->ls();
    m_output->Close();
    m_output.reset();
  }
  return MERGE_SUCCESS;
}

copyAllTrees()

MergeStatus RootDatabaseMerger::copyAllTrees

(

TFile *

source

)

Copy all data trees from the input file to the output file.

Definition at line 346 of file merge.C.

                                                            {
  TIter nextkey( source->GetListOfKeys() );
  // m_treeSections = true;
  for ( TKey* key = (TKey*)nextkey(); key; key = (TKey*)nextkey() ) {
    const char* classname = key->GetClassName();
    TClass*     cl        = gROOT->GetClass( classname );
    if ( !cl ) continue;
    if ( cl->InheritsFrom( "TTree" ) ) {
      string name = key->GetName();
      if ( name == "Refs" ) continue;
      m_treeSections = 0 == ::strncmp( key->GetName(), "<local>_", 7 );
      printf( "+++ Copy Tree:%s %d\n", name.c_str(), int( m_treeSections ) );
      if ( copyTree( source, name ) != MERGE_SUCCESS ) {
        m_treeSections = false;
        return MERGE_ERROR;
      }
    }
  }
  m_treeSections = false;
  return MERGE_SUCCESS;
}

copyBranch()

MergeStatus RootDatabaseMerger::copyBranch	(	TTree *	src_tree,
		TTree *	out_tree,
		const std::string &	name
	)

Copy single reference branch.

Definition at line 329 of file merge.C.

                                                                                                 {
  char     text[4096];
  TBranch* s = src_tree->GetBranch( name.c_str() );
  TBranch* o = out_tree->GetBranch( name.c_str() );
  if ( s && o ) {
    s->SetAddress( text );
    o->SetAddress( text );
    for ( Long64_t i = 0, n = s->GetEntries(); i < n; ++i ) {
      s->GetEntry( i );
      o->Fill();
    }
    return MERGE_SUCCESS;
  }
  return MERGE_ERROR;
}

copyRefs()

MergeStatus RootDatabaseMerger::copyRefs	(	TFile *	source,
		const std::string &	name
	)

Copy one single tree from the input file to the output file.

Copy refs of one single tree from the input file to the output file.

Definition at line 413 of file merge.C.

                                                                            {
  TTree* src_tree = (TTree*)source->Get( name.c_str() );
  if ( src_tree ) {
    TTree* out_tree = (TTree*)m_output->Get( name.c_str() );
    if ( out_tree ) {
      addSections( src_tree, out_tree );
      copyBranch( src_tree, out_tree, "Links" );
      copyBranch( src_tree, out_tree, "Params" );
      copyBranch( src_tree, out_tree, "Containers" );
      copyBranch( src_tree, out_tree, "Databases" );
      out_tree->Write();
      return MERGE_SUCCESS;
    }
  }
  return MERGE_ERROR;
}

copyTree()

MergeStatus RootDatabaseMerger::copyTree	(	TFile *	source,
		const std::string &	name
	)

Copy one single tree from the input file to the output file.

Definition at line 369 of file merge.C.

                                                                            {
  TTree* src_tree = (TTree*)source->Get( name.c_str() );
  if ( src_tree ) {
    Long64_t src_entries = src_tree->GetEntries();
    TTree*   out_tree    = (TTree*)m_output->Get( name.c_str() );
    m_output->cd();
    if ( 0 == src_tree->GetEntries() ) { src_tree->SetEntries( 1 ); }
    addSections( src_tree, out_tree );
    if ( !out_tree ) {
      out_tree = src_tree->CloneTree( -1, "fast" );
      if ( s_dbg ) ::printf( "+++ Created new Tree %s.\n", out_tree->GetName() );
      out_tree->Write();
      delete out_tree;
      return MERGE_SUCCESS;
    }
    m_output->GetObject( name.c_str(), out_tree );
    TTreeCloner cloner( src_tree, out_tree, "fast" );
    if ( cloner.IsValid() ) {
      Long64_t out_entries = out_tree->GetEntries();
      out_tree->SetEntries( out_entries + src_entries );
      Bool_t res = cloner.Exec();
      if ( s_dbg ) ::printf( "+++ Merged tree: %s res=%d\n", out_tree->GetName(), res );
      out_tree->Write();
      delete out_tree;
      return MERGE_SUCCESS;
    } else {
      // Fast cloning is not possible for this input TTree.
      // ... see TTree::CloneTree for example of recovery code ...
      ::printf( "+++ Got a tree where fast cloning is not possible -- operation failed.\n" );
      return MERGE_ERROR;
    }
#if 0
    Long64_t nb = out_tree->CopyEntries(src_tree,-1,"fast");
    Long64_t out_entries = out_tree->GetEntries();
    out_tree->SetEntries(out_entries+src_entries);
    out_tree->Write();
    if ( s_dbg ) ::printf("+++ Merged tree: %s res=%lld\n",out_tree->GetName(),nb);
    return MERGE_SUCCESS;
#endif
  }
  return MERGE_ERROR;
}

create()

MergeStatus RootDatabaseMerger::create

(

const std::string &

fid

)

Create new output file.

Definition at line 154 of file merge.C.

                                                          {
  if ( m_output ) {
    ::printf( "+++ Another output file %s is already open. Request denied.\n", m_output->GetName() );
    return MERGE_ERROR;
  } else if ( exists( fid ) ) {
    ::printf( "+++ Cannot create output file %s --- file already exists.\n", fid.c_str() );
    return MERGE_ERROR;
  }
  m_output.reset( TFile::Open( fid.c_str(), "RECREATE" ) );
  if ( m_output && !m_output->IsZombie() ) {
    TTree* t1 = new TTree( "Sections", "Root Section data" );
    TTree* t2 = new TTree( "Refs", "Root Section data" );
    if ( t1 && t2 ) {
      t1->Branch( "Sections", 0, "Sections/C" );
      t2->Branch( "Links", 0, "Links/C" );
      t2->Branch( "Params", 0, "Params/C" );
      t2->Branch( "Databases", 0, "Databases/C" );
      t2->Branch( "Containers", 0, "Containers/C" );
      if ( s_dbg ) ::printf( "+++ Opened new output file %s.\n", fid.c_str() );
      return MERGE_SUCCESS;
    }
  }
  ::printf( "+++ Failed to open new output file %s.\n", fid.c_str() );
  return MERGE_ERROR;
}

createFID()

MergeStatus RootDatabaseMerger::createFID

(

)

Create and add new FID to the newly merged file.

Close output file.

Definition at line 181 of file merge.C.

                                          {
  static const char* fmt = "FID=%08lX-%04hX-%04hX-%02hhX%02hhX-%02hhX%02hhX%02hhX%02hhX%02hhX%02hhX";
  if ( m_output ) {
    TTree* t = (TTree*)m_output->Get( "Refs" );
    if ( t ) {
      uuid_data d;
      char      text[256];
      TUUID     uuid;
      TBranch*  b = t->GetBranch( "Params" );
      if ( b ) {
        uuid.GetUUID( d.buf );
        sprintf( text, fmt, d.ibuf[0], d.sbuf[2], d.sbuf[3], d.buf[8], d.buf[9], d.buf[10], d.buf[11], d.buf[12],
                 d.buf[13], d.buf[14], d.buf[15] );
        b->SetAddress( text );
        b->Fill();
        t->Write();
        if ( s_dbg ) ::printf( "+++ Added new GUID %s to merge file.\n", text );
        return MERGE_SUCCESS;
      }
    }
  }
  ::printf( "+++ Failed to add new GUID to merge file.\n" );
  return MERGE_ERROR;
}

dumpSections()

void RootDatabaseMerger::dumpSections

(

)

Dump collected database sections.

Definition at line 264 of file merge.C.

                                      {
  for ( const auto& i : m_sections ) {
    int    cnt    = 0;
    string prefix = i.first;
    for ( const auto& j : i.second ) {
      char text[1024];
      ::sprintf( text, "['%s'][%d]", prefix.c_str(), cnt++ );
      if ( s_dbg ) {
        ::printf( "+++ section %-55s Start:%8d ... %8d [%d entries]\n", text, j.start, j.start + j.length, j.length );
      }
    }
  }
}

exists()

bool RootDatabaseMerger::exists

(

const std::string &

fid

)

const

Check if a database exists.

Definition at line 127 of file merge.C.

                                                            {
  Bool_t result = gSystem->AccessPathName( fid.c_str(), kFileExists );
  // if ( s_dbg ) ::printf("File %s %s!\n",fid.c_str(),result == kFALSE ? "EXISTS" : "DOES NOT EXIST");
  return result == kFALSE;
}

merge()

MergeStatus RootDatabaseMerger::merge

(

const std::string &

fid

)

Merge new input to existing output.

Definition at line 279 of file merge.C.

                                                         {
  if ( m_output ) {
    std::unique_ptr<TFile> source{ TFile::Open( fid.c_str() ) };
    if ( source && !source->IsZombie() ) {
      size_t idx = fid.rfind( '/' );
      ::printf( "+++ Start merging input file:%s\n",
                idx != string::npos ? fid.substr( idx + 1 ).c_str() : fid.c_str() );
      if ( copyAllTrees( source.get() ) == MERGE_SUCCESS ) {
        if ( copyRefs( source.get(), "Refs" ) == MERGE_SUCCESS ) {
          source->Close();
          return MERGE_SUCCESS;
        }
      }
    }
    ::printf( "+++ Cannot open input file:%s\n", fid.c_str() );
    m_output->cd();
    return MERGE_ERROR;
  }
  ::printf( "+++ No valid output file present. Merge request refused for fid:%s.\n", fid.c_str() );
  return MERGE_ERROR;
}

saveSections()

MergeStatus RootDatabaseMerger::saveSections

(

)

Save new sections to the output file.

Definition at line 221 of file merge.C.

                                             {
  if ( m_output ) {
    int    nb, total = 0, nbytes = 0;
    char   text[1024];
    TTree* t = (TTree*)m_output->Get( "Sections" );
    if ( t ) {
      TBranch* b = t->GetBranch( "Sections" );
      if ( b ) {
        b->SetAddress( text );
        for ( const auto& i : m_sections ) {
          string cont = i.first;
          for ( const auto& j : i.second ) {
            ::sprintf( text, "[CNT=%s][START=%d][LEN=%d]", cont.c_str(), j.start, j.length );
            nb = t->Fill();
            ++total;
            if ( nb > 0 )
              nbytes += nb;
            else
              ::printf( "+++ Failed to update Sections tree with new entries. [WRITE_ERROR]\n" );
          }
        }
        ::sprintf( text, "[END-OF-SECTION]" );
        nb = t->Fill();
        ++total;
        if ( nb > 0 )
          nbytes += nb;
        else
          ::printf( "+++ Failed to update Sections branch with new entries. [WRITE_ERROR]\n" );
        t->Write();
        if ( s_dbg ) ::printf( "+++ Added %d Sections entries with %d bytes in total.\n", total, nbytes );
        return MERGE_SUCCESS;
      }
      ::printf( "+++ Failed to update Sections tree with new entries. [NO_OUTPUT_BRANCH]\n" );
      return MERGE_ERROR;
    }
    ::printf( "+++ Failed to update Sections tree with new entries. [NO_OUTPUT_TREE]\n" );
    return MERGE_ERROR;
  }
  ::printf( "+++ Failed to update Sections tree with new entries. [NO_OUTPUT_FILE]\n" );
  return MERGE_ERROR;
}

Member Data Documentation

m_output

std::unique_ptr<TFile> Gaudi::RootDatabaseMerger::m_output

private

Definition at line 49 of file merge.C.

m_sections

DatabaseSections Gaudi::RootDatabaseMerger::m_sections

private

Definition at line 48 of file merge.C.

m_treeSections

bool Gaudi::RootDatabaseMerger::m_treeSections = false

private

Definition at line 50 of file merge.C.

---

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

• RootCnv/merge/merge.C