RootDataConnection.cpp

Go to the documentation of this file.

//====================================================================
//        RootDataConnection.cpp
//--------------------------------------------------------------------
//
//        Author     : M.Frank
//====================================================================

// Framework include files
#include "RootCnv/RootDataConnection.h"
#include "RootUtils.h"
#include "GaudiKernel/IOpaqueAddress.h"
#include "GaudiKernel/IIncidentSvc.h"
#include "GaudiKernel/LinkManager.h"
#include "GaudiKernel/strcasecmp.h"
#include "GaudiKernel/DataObject.h"
#include "GaudiKernel/IRegistry.h"
#include "GaudiKernel/Incident.h"
#include "GaudiKernel/MsgStream.h"
// ROOT include files
#include "TROOT.h"
#include "TFile.h"
#include "TTree.h"
#include "TLeaf.h"
#include "TClass.h"
#include "TBranch.h"
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,33,0)
#include "Compression.h"
static int s_compressionLevel = ROOT::CompressionSettings(ROOT::kLZMA,4);
#else
static int s_compressionLevel = 1;
#endif

// C/C++ include files
#include <stdexcept>
#include <numeric>

using namespace Gaudi;
using namespace std;
typedef const string& CSTR;

static const string s_empty;
static const string s_local = "<localDB>";

#ifdef __POOL_COMPATIBILITY
#include "PoolTool.h"
#endif
#include "RootTool.h"

namespace {
    std::array<char,256> init_table() {
        std::array<char,256> table;
        std::iota(std::begin(table),std::end(table),0);
        return table;
    }
}


static bool match_wild(const char *str, const char *pat)    {
  //
  // Credits: Code from Alessandro Felice Cantatore.
  //
  static const std::array<char,256> table = init_table();
  const char *s, *p;
  bool star = false;
loopStart:
  for (s = str, p = pat; *s; ++s, ++p) {
    switch (*p) {
    case '?':
      if (*s == '.') goto starCheck;
      break;
    case '*':
      star = true;
      str = s, pat = p;
      do { ++pat; } while (*pat == '*');
      if (!*pat) return true;
      goto loopStart;
    default:
      if ( table[*s] != table[*p] )
        goto starCheck;
      break;
    } /* endswitch */
  } /* endfor */
  while (*p == '*') ++p;
  return (!*p);

starCheck:
  if (!star) return false;
  str++;
  goto loopStart;
}

long RootConnectionSetup::setCompression(const std::string& compression) {
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,33,0)
  int res = 0, level = ROOT::CompressionSettings(ROOT::kLZMA,6);
  auto idx = compression.find(':');
  if ( idx != string::npos ) {
    string alg = compression.substr(0,idx);
    ROOT::ECompressionAlgorithm alg_code = ROOT::kUseGlobalSetting;
    if ( strcasecmp(alg.c_str(),"ZLIB") == 0 )
      alg_code = ROOT::kZLIB;
    else if ( strcasecmp(alg.c_str(),"LZMA") == 0 )
      alg_code = ROOT::kLZMA;
    else
      throw runtime_error("ERROR: request to set unknown ROOT compression algorithm:"+alg);
    res = ::sscanf(compression.c_str()+idx+1,"%d",&level);
    if ( res == 1 ) {
      s_compressionLevel = ROOT::CompressionSettings(alg_code,level);
      return StatusCode::SUCCESS;
    }
    throw runtime_error("ERROR: request to set unknown ROOT compression level:"+compression.substr(idx+1));
  }
  else if ( 1==::sscanf(compression.c_str(),"%d",&level) ) {
    s_compressionLevel = level;
    return StatusCode::SUCCESS;
  }
  throw runtime_error("ERROR: request to set unknown ROOT compression mechanism:"+compression);
#else
  if ( !compression.empty() ) {}
  return StatusCode::SUCCESS;
#endif
}

int RootConnectionSetup::compression() {
  return s_compressionLevel;
}


void RootConnectionSetup::setMessageSvc(MsgStream* m) {
  m_msgSvc.reset(m);
}

void RootConnectionSetup::setIncidentSvc(IIncidentSvc* s) {
  m_incidentSvc.reset(s);
}

RootDataConnection::RootDataConnection(const IInterface* owner, CSTR fname, std::shared_ptr<RootConnectionSetup> setup)
  : IDataConnection(owner,fname), m_setup(std::move(setup))
{ //               01234567890123456789012345678901234567890
  // Check if FID: A82A3BD8-7ECB-DC11-8DC0-000423D950B0
  if ( fname.length() == 36 && fname[8]=='-'&&fname[13]=='-'&&fname[18]=='-'&&fname[23]=='-' ) {
    m_name = "FID:"+fname;
  }
  m_age  = 0;
  m_file.reset();
  addClient(owner);
}

void RootDataConnection::addClient(const IInterface* client) {
  m_clients.insert(client);
}

size_t RootDataConnection::removeClient(const IInterface* client) {
  auto i=m_clients.find(client);
  if ( i != m_clients.end() ) m_clients.erase(i);
  return m_clients.size();
}

bool RootDataConnection::lookupClient(const IInterface* client)   const {
  auto i=m_clients.find(client);
  return i != m_clients.end();
}

void RootDataConnection::badWriteError(const string& msg)   const {
  msgSvc() << MSG::ERROR << "File:" << fid() << "Failed action:" << msg << endmsg;
}

void RootDataConnection::saveStatistics(CSTR statisticsFile) {
  if ( m_statistics ) {
    m_statistics->Print();
    if ( !statisticsFile.empty() )
      m_statistics->SaveAs(statisticsFile.c_str());
    m_statistics.reset();
  }
}

void RootDataConnection::enableStatistics(CSTR section) {
  if ( m_statistics ) {
    TTree* t=getSection(section,false);
    if ( t ) {
      m_statistics.reset( new TTreePerfStats((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;
}

RootDataConnection::Tool* RootDataConnection::makeTool()   {
  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();
}

StatusCode RootDataConnection::connectRead()  {
  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.getCode() == 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;
}

StatusCode RootDataConnection::connectWrite(IoType typ)  {
  int compress = RootConnectionSetup::compression();
  msgSvc() << MSG::DEBUG;
  switch(typ)  {
  case CREATE:
    resetAge();
    m_file.reset(TFile::Open(m_pfn.c_str(),"CREATE","Root event data",compress));
    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(m_pfn.c_str(),"RECREATE","Root event data",compress));
    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(m_pfn.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.getCode() == 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 ;
}

StatusCode RootDataConnection::disconnect()    {
  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;
}

TTree* RootDataConnection::getSection(CSTR section, bool create) {
  TTree* t = m_sections[section];
  if ( !t ) {
    t = (TTree*)m_file->Get(section.c_str());
    if ( !t && create ) {
      TDirectory::TContext ctxt(m_file.get());
      t = new TTree(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[section] = t;
    }
  }
  return t;
}

TBranch* RootDataConnection::getBranch(CSTR section, CSTR branch_name, TClass* cl, void* ptr, int buff_siz, int split_lvl) {
  string n = branch_name;
  std::replace_if(std::begin(n),std::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(branch_name.c_str());
  if ( b )   b->SetAutoDelete(kFALSE);
  return b;
}

int RootDataConnection::makeLink(CSTR p) {
  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(p);
  return m_links.size()-1;
}

CSTR RootDataConnection::getDb(int which) const {
  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;
}

CSTR RootDataConnection::empty() const {
  return s_empty;
}

pair<int,unsigned long>
RootDataConnection::saveObj(CSTR section, CSTR cnt, TClass* cl, DataObject* pObj, int buff_siz, int split_lvl,bool fill) {
  DataObjectPush push(pObj);
  return save(section,cnt,cl,pObj,buff_siz,split_lvl,fill);
}

pair<int,unsigned long>
RootDataConnection::save(CSTR section, CSTR cnt, TClass* cl, void* pObj, int buff_siz, int split_lvl, bool fill_missing) {
  split_lvl = 0;
  TBranch* b = getBranch(section, cnt, cl, pObj ? &pObj : nullptr, buff_siz, split_lvl);
  if ( b ) {
    Long64_t evt = b->GetEntries();
    //msgSvc() << MSG::DEBUG << cnt.c_str() << " Obj:" << (void*)pObj
    //         << " Split:" << split_lvl << " Buffer size:" << buff_siz << endl;
    if ( fill_missing ) {
      Long64_t num, nevt = b->GetTree()->GetEntries();
      if ( nevt > evt )   {
        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();
      }
    }
    b->SetAddress(&pObj);
    return {b->Fill(),evt};
  }
  if ( pObj ) {
    msgSvc() << MSG::ERROR << "Failed to access branch " << m_name << "/" << cnt << endmsg;
  }
  return {-1,~0};
}

int RootDataConnection::loadObj(CSTR section, CSTR cnt, unsigned long entry, DataObject*& pObj) {
  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;
}

int RootDataConnection::loadRefs(const std::string& section, const std::string& cnt,
                                 unsigned long entry, RootObjectRefs& refs)
{
  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 preesent 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;
}

pair<const RootRef*,const RootDataConnection::ContainerSection*>
RootDataConnection::getMergeSection(const string& container, int entry) const {
  //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 };
}

void RootDataConnection::makeRef(IRegistry* pR, RootRef& ref) {
  IOpaqueAddress* pA = pR->address();
  makeRef(pR->name(),pA->clID(),pA->svcType(),pA->par()[0],pA->par()[1],-1,ref);
}

void RootDataConnection::makeRef(CSTR name, long clid, int tech, CSTR dbase, CSTR cnt, int entry, RootRef& ref) {
  string db(dbase);
  if ( db == m_fid ) db = s_local;
  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(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(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(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;
  }
}