#include "RootOutputTree.h"

Public Member Functions
template<typename Aux >
	RootOutputTree (cet::exempt_ptr< TFile > filePtr, BranchType const branchType, Aux const &pAux, ProductProvenances &pProductProvenanceVector, int const bufSize, int const splitLevel, int64_t const treeMaxVirtualSize, int64_t const saveMemoryObjectThreshold)

	RootOutputTree (RootOutputTree const &)=delete

RootOutputTree &	operator= (RootOutputTree const &)=delete

bool	isValid () const

void	setOutputBranchAddress (BranchDescription const &pd, void const *&pProd)

void	resetOutputBranchAddress (BranchDescription const &)

void	addOutputBranch (BranchDescription const &, void const *&pProd)

bool	checkSplitLevelAndBasketSize (cet::exempt_ptr< TTree const >) const

bool	fastCloneTree (cet::exempt_ptr< TTree const >)

void	fillTree ()

void	writeTree () const

TTree *	tree () const

TTree *	metaTree () const

void	setEntries ()

void	beginInputFile (bool fastCloning)

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

Static Public Member Functions
static TTree *	makeTTree (TFile *, std::string const &name, int splitLevel)

static void	writeTTree (TTree *) noexcept(false)

Private Attributes
cet::exempt_ptr< TFile >	filePtr_

TTree *const	tree_

TTree *const	metaTree_

TBranch *	auxBranch_ {nullptr}

TBranch *	productProvenanceBranch_ {nullptr}

std::vector< TBranch * >	producedBranches_ {}

std::vector< TBranch * >	metaBranches_ {}

std::vector< TBranch * >	readBranches_ {}

std::vector< TBranch * >	unclonedReadBranches_ {}

std::set< std::string >	unclonedReadBranchNames_ {}

bool	fastCloningEnabled_ {false}

int	basketSize_

int	splitLevel_

int64_t	saveMemoryObjectThreshold_

int	nEntries_ {0}

Detailed Description

Definition at line 24 of file RootOutputTree.h.

Constructor & Destructor Documentation

template<typename Aux >

art::RootOutputTree::RootOutputTree	(	cet::exempt_ptr< TFile >	filePtr,
		BranchType const	branchType,
		Aux const *&	pAux,
		ProductProvenances *&	pProductProvenanceVector,
		int const	bufSize,
		int const	splitLevel,
		int64_t const	treeMaxVirtualSize,
		int64_t const	saveMemoryObjectThreshold
	)

inline

Definition at line 35 of file RootOutputTree.h.

References addOutputBranch(), auxBranch_, basketSize_, art::BranchTypeToAuxiliaryBranchName(), art::BranchTypeToMetaDataTreeName(), art::BranchTypeToProductTreeName(), checkSplitLevelAndBasketSize(), fastCloneTree(), fillTree(), isValid(), makeTTree(), metaBranches_, metaTree_, operator=(), productProvenanceBranch_, art::productProvenanceBranchName(), readBranches_, resetOutputBranchAddress(), saveMemoryObjectThreshold_, setOutputBranchAddress(), splitLevel_, tree_, and writeTree().

       : filePtr_{filePtr}
       , tree_{makeTTree(filePtr.get(),
                         BranchTypeToProductTreeName(branchType),
                         splitLevel)}
       , metaTree_{makeTTree(filePtr.get(),
                             BranchTypeToMetaDataTreeName(branchType),
                             0)}
       , basketSize_{bufSize}
       , splitLevel_{splitLevel}
       , saveMemoryObjectThreshold_{saveMemoryObjectThreshold}
     {
       if (treeMaxVirtualSize >= 0) {
         tree_->SetMaxVirtualSize(treeMaxVirtualSize);
       }
       auxBranch_ = tree_->Branch(
         BranchTypeToAuxiliaryBranchName(branchType).c_str(), &pAux, bufSize, 0);
       delete pAux;
       pAux = nullptr;
       readBranches_.push_back(auxBranch_);
       productProvenanceBranch_ =
         metaTree_->Branch(productProvenanceBranchName(branchType).c_str(),
                           &pProductProvenanceVector,
                           bufSize,
                           0);
       metaBranches_.push_back(productProvenanceBranch_);
     }

art::RootOutputTree::RootOutputTree ( RootOutputTree const & )

delete

Member Function Documentation

void art::RootOutputTree::addOutputBranch	(	BranchDescription const &	pd,
		void const *&	pProd
	)

Definition at line 185 of file RootOutputTree.cc.

References art::BranchDescription::basketSize(), art::BranchDescription::branchName(), art::BranchDescription::compression(), art::errors::FatalRootError, art::BranchDescription::produced(), art::BranchDescription::splitLevel(), and art::BranchDescription::wrappedName().

Referenced by RootOutputTree().

   {
     TClassRef cls = TClass::GetClass(pd.wrappedName().c_str());
     if (auto br = tree_->GetBranch(pd.branchName().c_str())) {
       // Already have this branch, possibly update the branch address.
       if (pProd == nullptr) {
         // The OutputItem is freshly constructed and has not been
         // passed to SetAddress yet.  If selectProducts has just been
         // called, we get here just after the branch object has been
         // deleted with a ResetBranchAddress() to prepare for the
         // OutputItem being replaced, and the OutputItem has just been
         // recreated.
         auto prod = reinterpret_cast<EDProduct*>(cls->New());
         pProd = prod;
         br->SetAddress(&pProd);
         pProd = nullptr;
         delete prod;
       }
       return;
     }
     auto bsize = pd.basketSize();
     if (bsize == BranchDescription::invalidBasketSize) {
       bsize = basketSize_;
     }
     auto splitlvl = pd.splitLevel();
     if (splitlvl == BranchDescription::invalidSplitLevel) {
       splitlvl = splitLevel_;
     }
     if (pProd != nullptr) {
       throw art::Exception(art::errors::FatalRootError)
         << "OutputItem product pointer is not nullptr!\n";
     }
     auto prod = reinterpret_cast<EDProduct*>(cls->New());
     pProd = prod;
     TBranch* branch = tree_->Branch(pd.branchName().c_str(),
                                     pd.wrappedName().c_str(),
                                     &pProd,
                                     bsize,
                                     splitlvl);
 
     // Note that root will have just allocated a dummy product as the
     // I/O buffer for the branch we have created.  We will replace
     // this I/O buffer in RootOutputFile::fillBranches() with the
     // actual product or our own dummy using
     // TBranchElement::SetAddress(), which will cause root to
     // automatically delete the dummy product it allocated here.
 
     pProd = nullptr;
     delete prod;
     if (pd.compression() != BranchDescription::invalidCompression) {
       branch->SetCompressionSettings(pd.compression());
     }
     if (nEntries_ > 0) {
       // Backfill the branch with dummy entries to match the number
       // of entries already written to the data tree.
       std::unique_ptr<EDProduct> dummy(static_cast<EDProduct*>(cls->New()));
       pProd = dummy.get();
       int bytesWritten{};
       for (auto i = nEntries_; i > 0; --i) {
         auto cnt = branch->Fill();
         if (cnt <= 0) {
           // FIXME: Throw a fatal error here!
         }
         bytesWritten += cnt;
         if ((saveMemoryObjectThreshold_ > -1) &&
             (bytesWritten > saveMemoryObjectThreshold_)) {
           branch->FlushBaskets();
           branch->DropBaskets("all");
         }
       }
     }
     if (pd.produced()) {
       producedBranches_.push_back(branch);
     } else {
       readBranches_.push_back(branch);
     }
   }

void art::RootOutputTree::beginInputFile ( bool fastCloning )

inline

Definition at line 117 of file RootOutputTree.h.

References fastCloningEnabled_.

     {
       fastCloningEnabled_ = fastCloning;
     }

bool art::RootOutputTree::checkSplitLevelAndBasketSize ( cet::exempt_ptr< TTree const > inputTree ) const

Definition at line 45 of file RootOutputTree.cc.

References GetBranch().

Referenced by RootOutputTree().

   {
     // Do the split level and basket size match in the input and output?
     if (inputTree == nullptr) {
       return false;
     }
     for (auto outputBranch : readBranches_) {
       if (outputBranch == nullptr) {
         continue;
       }
       TBranch* inputBranch =
         const_cast<TTree*>(inputTree.get())->GetBranch(outputBranch->GetName());
       if (inputBranch == nullptr) {
         continue;
       }
       if ((inputBranch->GetSplitLevel() != outputBranch->GetSplitLevel()) ||
           (inputBranch->GetBasketSize() != outputBranch->GetBasketSize())) {
         mf::LogInfo("FastCloning")
           << "Fast Cloning disabled because split level or basket size "
              "do not match";
         return false;
       }
     }
     return true;
   }

bool art::RootOutputTree::fastCloneTree ( cet::exempt_ptr< TTree const > intree )

Definition at line 94 of file RootOutputTree.cc.

Referenced by RootOutputTree().

   {
     unclonedReadBranches_.clear();
     unclonedReadBranchNames_.clear();
     if (!fastCloningEnabled_) {
       return false;
     }
 
     bool cloned{false};
     if (intree->GetEntries() != 0) {
       TTreeCloner cloner(const_cast<TTree*>(intree.get()),
                          tree_,
                          "",
                          TTreeCloner::kIgnoreMissingTopLevel |
                            TTreeCloner::kNoWarnings |
                            TTreeCloner::kNoFileCache);
       if (cloner.IsValid()) {
         tree_->SetEntries(tree_->GetEntries() + intree->GetEntries());
         cloner.Exec();
         cloned = true;
       } else {
         fastCloningEnabled_ = false;
         mf::LogInfo("fastCloneTree")
           << "INFO: Unable to fast clone tree " << intree->GetName() << '\n'
           << "INFO: ROOT reason is:\n"
           << "INFO: " << cloner.GetWarning() << '\n'
           << "INFO: Processing will continue, tree will be slow cloned.";
       }
     }
     for (auto const& val : readBranches_) {
       if (val->GetEntries() != tree_->GetEntries()) {
         unclonedReadBranches_.push_back(val);
         unclonedReadBranchNames_.insert(string(val->GetName()));
       }
     }
     return cloned;
   }

void art::RootOutputTree::fillTree ( )

Definition at line 148 of file RootOutputTree.cc.

References art::fillTreeBranches().

Referenced by RootOutputTree().

   {
     fillTreeBranches(
       metaTree_, metaBranches_, false, saveMemoryObjectThreshold_);
     bool saveMemory = (saveMemoryObjectThreshold_ > -1);
     fillTreeBranches(
       tree_, producedBranches_, saveMemory, saveMemoryObjectThreshold_);
     if (fastCloningEnabled_) {
       fillTreeBranches(
         tree_, unclonedReadBranches_, saveMemory, saveMemoryObjectThreshold_);
     } else {
       fillTreeBranches(
         tree_, readBranches_, saveMemory, saveMemoryObjectThreshold_);
     }
     ++nEntries_;
   }

bool art::RootOutputTree::isValid ( ) const

Referenced by RootOutputTree().

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

static

Definition at line 26 of file RootOutputTree.cc.

References art::errors::FatalRootError, and max.

Referenced by art::RootOutputFile::RootOutputFile(), and RootOutputTree().

   {
     auto tree = new TTree{name.c_str(), "", splitLevel};
     if (!tree) {
       throw art::Exception(art::errors::FatalRootError)
         << "Failed to create the tree: " << name << "\n";
     }
     if (tree->IsZombie()) {
       throw art::Exception(art::errors::FatalRootError)
         << "Tree: " << name << " is a zombie.\n";
     }
     tree->SetDirectory(filePtr);
     // Turn off autosave because it leaves too many deleted tree
     // keys in the output file.
     tree->SetAutoSave(numeric_limits<Long64_t>::max());
     return tree;
   }

TTree* art::RootOutputTree::metaTree ( ) const

inline

Definition at line 95 of file RootOutputTree.h.

References metaTree_.

     {
       return metaTree_;
     }

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

delete

Referenced by RootOutputTree().

void art::RootOutputTree::resetOutputBranchAddress ( BranchDescription const & pd )

Definition at line 166 of file RootOutputTree.cc.

References art::BranchDescription::branchName().

Referenced by RootOutputTree().

   {
     TBranch* br = tree_->GetBranch(pd.branchName().c_str());
     if (br == nullptr) {
       return;
     }
     tree_->ResetBranchAddress(br);
   }

void art::RootOutputTree::setEntries ( )

inline

Definition at line 101 of file RootOutputTree.h.

References metaTree_, and tree_.

     {
       // The member trees are filled by filling their
       // branches individually, which ends up not setting
       // the tree entry count.  Tell the trees to set their
       // entry count based on their branches (all branches
       // must have the same number of entries).
       if (tree_->GetNbranches() != 0) {
         tree_->SetEntries(-1);
       }
       if (metaTree_->GetNbranches() != 0) {
         metaTree_->SetEntries(-1);
       }
     }

void art::RootOutputTree::setOutputBranchAddress	(	BranchDescription const &	pd,
		void const *&	pProd
	)

Definition at line 176 of file RootOutputTree.cc.

References art::BranchDescription::branchName().

Referenced by RootOutputTree().

   {
     if (TBranch* br = tree_->GetBranch(pd.branchName().c_str())) {
       br->SetAddress(&pProd);
     }
   }

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

inline

Definition at line 89 of file RootOutputTree.h.

References tree_.

     {
       return tree_;
     }

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

inline

Definition at line 123 of file RootOutputTree.h.

References unclonedReadBranchNames_.

     {
       return unclonedReadBranchNames_.find(branchName) !=
              unclonedReadBranchNames_.end();
     }

void art::RootOutputTree::writeTree ( ) const

Definition at line 87 of file RootOutputTree.cc.

Referenced by RootOutputTree().

   {
     writeTTree(tree_);
     writeTTree(metaTree_);
   }

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

staticnoexcept

Definition at line 73 of file RootOutputTree.cc.

Referenced by art::RootOutputFile::writeEventHistory(), and art::RootOutputFile::writeTTrees().

   {
     // Update the tree-level entry count because we have been
     // using branch fill instead of tree fill.
     if (tree->GetNbranches() != 0) {
       tree->SetEntries(-1);
     }
     // Use auto save here instead of write because it deletes
     // the old tree key from the file, does not flush the
     // baskets, and writes out the streamer infos, unlike write.
     tree->AutoSave();
   }