edm::RootOutputTree Class Reference

#include <RootOutputTree.h>

Public Member Functions
template<typename T >
void	addAuxiliary (std::string const &branchName, T const *&pAux, int bufSize, bool allowCloning=true)
template<typename T >
void	addAuxiliary (std::string const &branchName, T *&pAux, int bufSize, bool allowCloning=true)
void	addBranch (std::string const &branchName, std::string const &className, void const *&pProd, int splitLevel, int basketSize, bool produced)
bool	checkEntriesInReadBranches (Long64_t expectedNumberOfEntries) const
bool	checkIfFastClonable (TTree *inputTree) const
bool	checkSplitLevelsAndBasketSizes (TTree *inputTree) const
void	close ()
void	fastCloneTTree (TTree *in, std::string const &option)
void	fillTree ()
bool	isValid () const
void	maybeFastCloneTree (bool canFastClone, bool canFastCloneAux, TTree *tree, std::string const &option)
RootOutputTree &	operator= (RootOutputTree const &)=delete
void	optimizeBaskets (ULong64_t size)
	RootOutputTree (std::shared_ptr< TFile > filePtr, BranchType const &branchType, int splitLevel, int treeMaxVirtualSize, std::string const &processName=std::string())
	RootOutputTree (RootOutputTree const &)=delete
void	setAutoFlush (Long64_t size)
void	setEntries ()
void	setSubBranchBasketSizes (TTree *inputTree) const
TTree const *	tree () const
TTree *	tree ()
bool	uncloned (std::string const &branchName) const
void	writeTree ()
	~RootOutputTree ()

Static Public Member Functions
static TTree *	assignTTree (TFile *file, TTree *tree)
static TTree *	makeTTree (TFile *filePtr, std::string const &name, int splitLevel)
static void	writeTTree (TTree *tree)

Static Private Member Functions
static void	fillTTree (std::vector< TBranch * > const &branches)

Private Attributes
std::vector< TBranch * >	auxBranches_
std::set< std::string >	clonedReadBranchNames_
bool	currentlyFastCloning_
bool	fastCloneAuxBranches_
edm::propagate_const < std::shared_ptr< TFile > >	filePtr_
std::vector< TBranch * >	producedBranches_
std::vector< TBranch * >	readBranches_
edm::propagate_const< TTree * >	tree_
std::vector< TBranch * >	unclonedAuxBranches_
std::vector< TBranch * >	unclonedReadBranches_

Detailed Description

Definition at line 24 of file RootOutputTree.h.

Constructor & Destructor Documentation

edm::RootOutputTree::RootOutputTree	(	std::shared_ptr< TFile >	filePtr,
		BranchType const &	branchType,
		int	splitLevel,
		int	treeMaxVirtualSize,
		std::string const &	processName = std::string()
	)

Definition at line 96 of file RootOutputTree.cc.

References tree_.

      : filePtr_(filePtr),
        tree_(processName.empty()
                  ? makeTTree(filePtr.get(), BranchTypeToProductTreeName(branchType), splitLevel)
                  : makeTTree(filePtr.get(), BranchTypeToProductTreeName(branchType, processName), splitLevel)),
        producedBranches_(),
        readBranches_(),
        auxBranches_(),
        unclonedReadBranches_(),
        clonedReadBranchNames_(),
        currentlyFastCloning_(),
        fastCloneAuxBranches_(false) {
    if (treeMaxVirtualSize >= 0)
      tree_->SetMaxVirtualSize(treeMaxVirtualSize);
  }

edm::RootOutputTree::~RootOutputTree ( )

inline

Definition at line 32 of file RootOutputTree.h.

{}

edm::RootOutputTree::RootOutputTree ( RootOutputTree const &  )

delete

Member Function Documentation

template<typename T >

void edm::RootOutputTree::addAuxiliary ( std::string const &  branchName, T const *&  pAux, int  bufSize, bool  allowCloning = true  )

inline

Definition at line 38 of file RootOutputTree.h.

References auxBranches_, tree_, and unclonedAuxBranches_.

Referenced by edm::RootOutputFile::RootOutputFile().

                                                                                                          {
      if (allowCloning) {
        auxBranches_.push_back(tree_->Branch(branchName.c_str(), &pAux, bufSize, 0));
      } else {
        unclonedAuxBranches_.push_back(tree_->Branch(branchName.c_str(), &pAux, bufSize, 0));
      }
    }

template<typename T >

void edm::RootOutputTree::addAuxiliary ( std::string const &  branchName, T *&  pAux, int  bufSize, bool  allowCloning = true  )

inline

Definition at line 47 of file RootOutputTree.h.

References auxBranches_, tree_, and unclonedAuxBranches_.

                                                                                                    {
      if (allowCloning) {
        auxBranches_.push_back(tree_->Branch(branchName.c_str(), &pAux, bufSize, 0));
      } else {
        unclonedAuxBranches_.push_back(tree_->Branch(branchName.c_str(), &pAux, bufSize, 0));
      }
    }

void edm::RootOutputTree::addBranch	(	std::string const &	branchName,
		std::string const &	className,
		void const *&	pProd,
		int	splitLevel,
		int	basketSize,
		bool	produced
	)

Definition at line 373 of file RootOutputTree.cc.

References cms::cuda::assert(), edm::BranchDescription::invalidBasketSize, edm::BranchDescription::invalidSplitLevel, producedBranches_, readBranches_, dtDQMMerge_cfg::splitLevel, and tree_.

Referenced by edm::RootOutputFile::RootOutputFile().

                                                {
    assert(splitLevel != BranchDescription::invalidSplitLevel);
    assert(basketSize != BranchDescription::invalidBasketSize);
    TBranch* branch = tree_->Branch(branchName.c_str(), className.c_str(), &pProd, basketSize, splitLevel);
    assert(branch != nullptr);
    /*
      if(pProd != nullptr) {
        // Delete the product that ROOT has allocated.
        WrapperBase const* edp = static_cast<WrapperBase const *>(pProd);
        delete edp;
        pProd = nullptr;
      }
*/
    if (produced) {
      producedBranches_.push_back(branch);
    } else {
      readBranches_.push_back(branch);
    }
  }

TTree * edm::RootOutputTree::assignTTree ( TFile *  file, TTree *  tree  )

static

Definition at line 116 of file RootOutputTree.cc.

References SiStripPI::max, and tree().

Referenced by makeTTree().

                                                                {
    tree->SetDirectory(filePtr);
    // Turn off autosaving because it is such a memory hog and we are not using
    // this check-pointing feature anyway.
    tree->SetAutoSave(std::numeric_limits<Long64_t>::max());
    return tree;
  }

bool edm::RootOutputTree::checkEntriesInReadBranches

(

Long64_t

expectedNumberOfEntries

)

const

Definition at line 247 of file RootOutputTree.cc.

References readBranches_.

Referenced by edm::RootOutputFile::writeIndexIntoFile().

                                                                                        {
    for (auto const& readBranch : readBranches_) {
      if (readBranch->GetEntries() != expectedNumberOfEntries) {
        return false;
      }
    }
    return true;
  }

bool edm::RootOutputTree::checkIfFastClonable

(

TTree *

inputTree

)

const

Definition at line 183 of file RootOutputTree.cc.

References readBranches_.

Referenced by edm::RootOutputFile::beginInputFile().

                                                                 {
    if (inputTree == nullptr)
      return false;

    // Do the sub-branches match in the input and output. Extra sub-branches in the input are OK for fast cloning, but not in the output.
    for (auto const& outputBr : readBranches_) {
      TBranchElement* outputBranch = dynamic_cast<TBranchElement*>(outputBr);
      if (outputBranch != nullptr) {
        TBranchElement* inputBranch = dynamic_cast<TBranchElement*>(inputTree->GetBranch(outputBranch->GetName()));
        if (inputBranch != nullptr) {
          // We have a matching top level branch. Do the recursive check on subbranches.
          if (!checkMatchingBranches(inputBranch, outputBranch)) {
            LogInfo("FastCloning") << "Fast Cloning disabled because a data member has been added to split branch: "
                                   << inputBranch->GetName() << "\n.";
            return false;
          }
        }
      }
    }
    return true;
  }

bool edm::RootOutputTree::checkSplitLevelsAndBasketSizes

(

TTree *

inputTree

)

const

Definition at line 135 of file RootOutputTree.cc.

References cms::cuda::assert(), and readBranches_.

Referenced by edm::RootOutputFile::beginInputFile().

                                                                            {
    assert(inputTree != nullptr);

    // Do the split level and basket size match in the input and output?
    for (auto const& outputBranch : readBranches_) {
      if (outputBranch != nullptr) {
        TBranch* inputBranch = inputTree->GetBranch(outputBranch->GetName());

        if (inputBranch != nullptr) {
          if (inputBranch->GetSplitLevel() != outputBranch->GetSplitLevel() ||
              inputBranch->GetBasketSize() != outputBranch->GetBasketSize()) {
            return false;
          }
        }
      }
    }
    return true;
  }

void edm::RootOutputTree::close

(

void

)

Definition at line 398 of file RootOutputTree.cc.

References auxBranches_, filePtr_, producedBranches_, readBranches_, tree_, unclonedAuxBranches_, and unclonedReadBranches_.

Referenced by esMonitoring.AsyncLineReaderMixin::handle_close(), and esMonitoring.FDJsonServer::handle_close().

                             {
    // The TFile was just closed.
    // Just to play it safe, zero all pointers to quantities in the file.
    auxBranches_.clear();
    unclonedAuxBranches_.clear();
    producedBranches_.clear();
    readBranches_.clear();
    unclonedReadBranches_.clear();
    tree_ = nullptr;     // propagate_const<T> has no reset() function
    filePtr_ = nullptr;  // propagate_const<T> has no reset() function
  }

void edm::RootOutputTree::fastCloneTTree	(	TTree *	in,
		std::string const &	option
	)

Definition at line 256 of file RootOutputTree.cc.

References cms::cuda::assert(), auxBranches_, Exception, fastCloneAuxBranches_, edm::errors::FatalRootError, dqmdumpme::last, edm::DuplicateTreeSentry::tree(), tree_, and unclonedAuxBranches_.

Referenced by maybeFastCloneTree().

                                                                        {
    if (in->GetEntries() != 0) {
      TObjArray* branches = tree_->GetListOfBranches();
      // If any products were produced (not just event products), the EventAuxiliary will be modified.
      // In that case, don't fast copy auxiliary branches. Remove them, and add back after fast copying.
      std::map<Int_t, TBranch*> auxIndexes;
      bool mustRemoveSomeAuxs = false;
      if (!fastCloneAuxBranches_) {
        for (auto const& auxBranch : auxBranches_) {
          int auxIndex = branches->IndexOf(auxBranch);
          assert(auxIndex >= 0);
          auxIndexes.insert(std::make_pair(auxIndex, auxBranch));
          branches->RemoveAt(auxIndex);
        }
        mustRemoveSomeAuxs = true;
      }

      //Deal with any aux branches which can never be cloned
      for (auto const& auxBranch : unclonedAuxBranches_) {
        int auxIndex = branches->IndexOf(auxBranch);
        assert(auxIndex >= 0);
        auxIndexes.insert(std::make_pair(auxIndex, auxBranch));
        branches->RemoveAt(auxIndex);
        mustRemoveSomeAuxs = true;
      }

      if (mustRemoveSomeAuxs) {
        branches->Compress();
      }

      DuplicateTreeSentry dupTree(in);
      TTreeCloner cloner(
          dupTree.tree(), tree_, option.c_str(), TTreeCloner::kNoWarnings | TTreeCloner::kIgnoreMissingTopLevel);

      if (!cloner.IsValid()) {
        // Let's check why
        static const char* okerror = "One of the export branch";
        if (strncmp(cloner.GetWarning(), okerror, strlen(okerror)) == 0) {
          // That's fine we will handle it;
        } else {
          throw edm::Exception(errors::FatalRootError) << "invalid TTreeCloner (" << cloner.GetWarning() << ")\n";
        }
      }
      tree_->SetEntries(tree_->GetEntries() + in->GetEntries());
      Service<RootHandlers> rootHandler;
      rootHandler->ignoreWarningsWhileDoing([&cloner] { cloner.Exec(); });

      if (mustRemoveSomeAuxs) {
        for (auto const& auxIndex : auxIndexes) {
          // Add the auxiliary branches back after fast copying the rest of the tree.
          Int_t last = branches->GetLast();
          if (last >= 0) {
            branches->AddAtAndExpand(branches->At(last), last + 1);
            for (Int_t ind = last - 1; ind >= auxIndex.first; --ind) {
              branches->AddAt(branches->At(ind), ind + 1);
            };
            branches->AddAt(auxIndex.second, auxIndex.first);
          } else {
            branches->Add(auxIndex.second);
          }
        }
      }
    }
  }

void edm::RootOutputTree::fillTree

(

)

Definition at line 359 of file RootOutputTree.cc.

References auxBranches_, currentlyFastCloning_, fastCloneAuxBranches_, fillTTree(), producedBranches_, tree_, unclonedAuxBranches_, and unclonedReadBranches_.

Referenced by core.AutoFillTreeProducer.AutoFillTreeProducer::process().

                                {
    if (currentlyFastCloning_) {
      if (!fastCloneAuxBranches_)
        fillTTree(auxBranches_);
      fillTTree(unclonedAuxBranches_);
      fillTTree(producedBranches_);
      fillTTree(unclonedReadBranches_);
    } else {
      // Isolate the fill operation so that IMT doesn't grab other large tasks
      // that could lead to PoolOutputModule stalling
      oneapi::tbb::this_task_arena::isolate([&] { tree_->Fill(); });
    }
  }

void edm::RootOutputTree::fillTTree ( std::vector< TBranch * > const &  branches )

staticprivate

Definition at line 331 of file RootOutputTree.cc.

References HcalObjRepresent::Fill(), and edm::for_all().

Referenced by fillTree().

                                                                    {
    for_all(branches, std::bind(&TBranch::Fill, std::placeholders::_1));
  }

bool edm::RootOutputTree::isValid

(

)

const

Referenced by ntupleDataFormat._Object::_checkIsValid(), and core.AutoHandle.AutoHandle::ReallyLoad().

TTree * edm::RootOutputTree::makeTTree ( TFile *  filePtr, std::string const &  name, int  splitLevel  )

static

Definition at line 124 of file RootOutputTree.cc.

References assignTTree(), Exception, edm::errors::FatalRootError, dtDQMMerge_cfg::splitLevel, and tree().

Referenced by edm::RootOutputFile::RootOutputFile().

                                                                                        {
    TTree* tree = new TTree(name.c_str(), "", splitLevel);
    if (!tree)
      throw edm::Exception(errors::FatalRootError) << "Failed to create the tree: " << name << "\n";
    if (tree->IsZombie())
      throw edm::Exception(errors::FatalRootError) << "Tree: " << name << " is a zombie."
                                                   << "\n";

    return assignTTree(filePtr, tree);
  }

void edm::RootOutputTree::maybeFastCloneTree	(	bool	canFastClone,
		bool	canFastCloneAux,
		TTree *	tree,
		std::string const &	option
	)

Definition at line 337 of file RootOutputTree.cc.

References clonedReadBranchNames_, currentlyFastCloning_, fastCloneAuxBranches_, fastCloneTTree(), readBranches_, AlCaHLTBitMon_QueryRunRegistry::string, tree_, and unclonedReadBranches_.

Referenced by edm::RootOutputFile::beginInputFile().

                                                                   {
    unclonedReadBranches_.clear();
    clonedReadBranchNames_.clear();
    currentlyFastCloning_ = canFastClone && !readBranches_.empty();
    if (currentlyFastCloning_) {
      fastCloneAuxBranches_ = canFastCloneAux;
      fastCloneTTree(tree, option);
      for (auto const& branch : readBranches_) {
        if (branch->GetEntries() == tree_->GetEntries()) {
          clonedReadBranchNames_.insert(std::string(branch->GetName()));
        } else {
          unclonedReadBranches_.push_back(branch);
        }
      }
      Service<JobReport> reportSvc;
      reportSvc->reportFastClonedBranches(clonedReadBranchNames_, tree_->GetEntries());
    }
  }

RootOutputTree& edm::RootOutputTree::operator= ( RootOutputTree const &  )

delete

void edm::RootOutputTree::optimizeBaskets ( ULong64_t  size )

inline

Definition at line 101 of file RootOutputTree.h.

References tree_.

Referenced by edm::RootOutputFile::writeLuminosityBlock(), and edm::RootOutputFile::writeRun().

{ tree_->OptimizeBaskets(size); }

void edm::RootOutputTree::setAutoFlush ( Long64_t  size )

inline

Definition at line 103 of file RootOutputTree.h.

References tree_.

Referenced by edm::RootOutputFile::RootOutputFile().

{ tree_->SetAutoFlush(size); }

void edm::RootOutputTree::setEntries ( )

inline

Definition at line 90 of file RootOutputTree.h.

References tree_.

Referenced by edm::RootOutputFile::respondToCloseInputFile(), and edm::RootOutputFile::writeEventAuxiliary().

                      {
      if (tree_->GetNbranches() != 0)
        tree_->SetEntries(-1);
    }

void edm::RootOutputTree::setSubBranchBasketSizes

(

TTree *

inputTree

)

const

Definition at line 231 of file RootOutputTree.cc.

References readBranches_.

Referenced by edm::RootOutputFile::beginInputFile().

                                                                     {
    if (inputTree == nullptr)
      return;

    for (auto const& outputBr : readBranches_) {
      TBranchElement* outputBranch = dynamic_cast<TBranchElement*>(outputBr);
      if (outputBranch != nullptr) {
        TBranchElement* inputBranch = dynamic_cast<TBranchElement*>(inputTree->GetBranch(outputBranch->GetName()));
        if (inputBranch != nullptr) {
          // We have a matching top level branch. Do the recursion on the subbranches.
          setMatchingBranchSizes(inputBranch, outputBranch);
        }
      }
    }
  }

TTree const* edm::RootOutputTree::tree ( ) const

inline

Definition at line 86 of file RootOutputTree.h.

References edm::propagate_const< T >::get(), and tree_.

Referenced by assignTTree(), ZJetsTreeAnalyzer.ZJetsTreeAnalyzer::beginLoop(), MetTreeProducer.MetTreeProducer::declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer::declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer::fillTree(), makeTTree(), ZJetsTreeAnalyzer.ZJetsTreeAnalyzer::process(), MetTreeProducer.MetTreeProducer::process(), edm::RootOutputFile::RootOutputFile(), python.cmstools.EventTree::SetAlias(), edm::RootOutputFile::writeEventAuxiliary(), and writeTree().

{ return tree_.get(); }

TTree* edm::RootOutputTree::tree ( )

inline

Definition at line 88 of file RootOutputTree.h.

References edm::propagate_const< T >::get(), and tree_.

Referenced by ZJetsTreeAnalyzer.ZJetsTreeAnalyzer::beginLoop(), MetTreeProducer.MetTreeProducer::declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer::declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer::fillTree(), ZJetsTreeAnalyzer.ZJetsTreeAnalyzer::process(), MetTreeProducer.MetTreeProducer::process(), and python.cmstools.EventTree::SetAlias().

{ return tree_.get(); }

bool edm::RootOutputTree::uncloned ( std::string const &  branchName ) const

inline

Definition at line 95 of file RootOutputTree.h.

References clonedReadBranchNames_.

                                                     {
      return clonedReadBranchNames_.find(branchName) == clonedReadBranchNames_.end();
    }

void edm::RootOutputTree::writeTree

(

)

Definition at line 335 of file RootOutputTree.cc.

References tree(), and writeTTree().

{ writeTTree(tree()); }

void edm::RootOutputTree::writeTTree ( TTree *  tree )

static

Definition at line 321 of file RootOutputTree.cc.

References edm::setRefCoreStreamer().

Referenced by edm::RootOutputFile::finishEndFile(), and writeTree().

                                             {
    if (tree->GetNbranches() != 0) {
      // This is required when Fill is called on individual branches
      // in the TTree instead of calling Fill once for the entire TTree.
      tree->SetEntries(-1);
    }
    setRefCoreStreamer(true);
    tree->AutoSave("FlushBaskets");
  }

Member Data Documentation

std::vector<TBranch*> edm::RootOutputTree::auxBranches_

private

Definition at line 115 of file RootOutputTree.h.

Referenced by addAuxiliary(), close(), fastCloneTTree(), and fillTree().

std::set<std::string> edm::RootOutputTree::clonedReadBranchNames_

private

Definition at line 119 of file RootOutputTree.h.

Referenced by maybeFastCloneTree(), and uncloned().

bool edm::RootOutputTree::currentlyFastCloning_

private

Definition at line 120 of file RootOutputTree.h.

Referenced by fillTree(), and maybeFastCloneTree().

bool edm::RootOutputTree::fastCloneAuxBranches_

private

Definition at line 121 of file RootOutputTree.h.

Referenced by fastCloneTTree(), fillTree(), and maybeFastCloneTree().

edm::propagate_const<std::shared_ptr<TFile> > edm::RootOutputTree::filePtr_

private

Definition at line 110 of file RootOutputTree.h.

Referenced by close().

std::vector<TBranch*> edm::RootOutputTree::producedBranches_

private

Definition at line 113 of file RootOutputTree.h.

Referenced by addBranch(), close(), and fillTree().

std::vector<TBranch*> edm::RootOutputTree::readBranches_

private

Definition at line 114 of file RootOutputTree.h.

Referenced by addBranch(), checkEntriesInReadBranches(), checkIfFastClonable(), checkSplitLevelsAndBasketSizes(), close(), maybeFastCloneTree(), and setSubBranchBasketSizes().

edm::propagate_const<TTree*> edm::RootOutputTree::tree_

private

Definition at line 111 of file RootOutputTree.h.

Referenced by addAuxiliary(), addBranch(), close(), fastCloneTTree(), fillTree(), maybeFastCloneTree(), optimizeBaskets(), RootOutputTree(), setAutoFlush(), setEntries(), and tree().

std::vector<TBranch*> edm::RootOutputTree::unclonedAuxBranches_

private

Definition at line 116 of file RootOutputTree.h.

Referenced by addAuxiliary(), close(), fastCloneTTree(), and fillTree().

std::vector<TBranch*> edm::RootOutputTree::unclonedReadBranches_

private

Definition at line 117 of file RootOutputTree.h.

Referenced by close(), fillTree(), and maybeFastCloneTree().