art::RootOutputTree Class Reference

#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	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_
std::atomic< TTree * >	tree_
std::atomic< TTree * >	metaTree_
std::vector< TBranch * >	producedBranches_ {}
std::vector< TBranch * >	metaBranches_ {}
std::vector< TBranch * >	readBranches_ {}
std::vector< TBranch * >	unclonedReadBranches_ {}
std::set< std::string >	unclonedReadBranchNames_ {}
std::atomic< bool >	fastCloningEnabled_
std::atomic< int >	basketSize_
std::atomic< int >	splitLevel_
std::atomic< int64_t >	saveMemoryObjectThreshold_
std::atomic< int >	nEntries_

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 34 of file RootOutputTree.h.

      : filePtr_{filePtr}
    {
      tree_ = makeTTree(
        filePtr.get(), BranchTypeToProductTreeName(branchType), splitLevel);
      metaTree_ =
        makeTTree(filePtr.get(), BranchTypeToMetaDataTreeName(branchType), 0);
      fastCloningEnabled_ = false;
      basketSize_ = bufSize;
      splitLevel_ = splitLevel;
      saveMemoryObjectThreshold_ = saveMemoryObjectThreshold;
      nEntries_ = 0;
      if (treeMaxVirtualSize >= 0) {
        tree_.load()->SetMaxVirtualSize(treeMaxVirtualSize);
      }
      auto auxBranch = tree_.load()->Branch(
        BranchTypeToAuxiliaryBranchName(branchType).c_str(), &pAux, bufSize, 0);
      delete pAux;
      pAux = nullptr;
      readBranches_.push_back(auxBranch);
      auto productProvenanceBranch = metaTree_.load()->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 &	bd,
		void const *&	pProd
	)

Definition at line 192 of file RootOutputTree.cc.

  {
    TClassRef cls = TClass::GetClass(bd.wrappedName().c_str());
    if (TBranch* br = tree_.load()->GetBranch(bd.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.
        EDProduct* prod = reinterpret_cast<EDProduct*>(cls->New());
        pProd = prod;
        br->SetAddress(&pProd);
        pProd = nullptr;
        delete prod;
      }
      return;
    }
    auto bsize = bd.basketSize();
    if (bsize == BranchDescription::invalidBasketSize) {
      bsize = basketSize_.load();
    }
    auto splitlvl = bd.splitLevel();
    if (splitlvl == BranchDescription::invalidSplitLevel) {
      splitlvl = splitLevel_.load();
    }
    if (pProd != nullptr) {
      throw art::Exception(art::errors::FatalRootError)
        << "OutputItem product pointer is not nullptr!\n";
    }
    EDProduct* prod = reinterpret_cast<EDProduct*>(cls->New());
    pProd = prod;
    TBranch* branch = tree_.load()->Branch(bd.branchName().c_str(),
                                           bd.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 (bd.compression() != BranchDescription::invalidCompression) {
      branch->SetCompressionSettings(bd.compression());
    }
    if (nEntries_.load() > 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_.load(); i > 0; --i) {
        auto cnt = branch->Fill();
        if (cnt <= 0) {
          // FIXME: Throw a fatal error here!
        }
        bytesWritten += cnt;
        if ((saveMemoryObjectThreshold_.load() > -1) &&
            (bytesWritten > saveMemoryObjectThreshold_.load())) {
          branch->FlushBaskets();
          branch->DropBaskets("all");
        }
      }
    }
    if (bd.produced()) {
      producedBranches_.push_back(branch);
    } else {
      readBranches_.push_back(branch);
    }
  }

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

inline

Definition at line 105 of file RootOutputTree.h.

    {
      fastCloningEnabled_ = fastCloning;
    }

bool art::RootOutputTree::checkSplitLevelAndBasketSize

(

cet::exempt_ptr< TTree const >

inputTree

)

const

Definition at line 49 of file RootOutputTree.cc.

  {
    // 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 98 of file RootOutputTree.cc.

  {
    unclonedReadBranches_.clear();
    unclonedReadBranchNames_.clear();
    if (!fastCloningEnabled_.load()) {
      return false;
    }

    bool cloned{false};
    if (intree->GetEntries() != 0) {
      TTreeCloner cloner(const_cast<TTree*>(intree.get()),
                         tree_.load(),
                         "",
                         TTreeCloner::kIgnoreMissingTopLevel |
                           TTreeCloner::kNoWarnings |
                           TTreeCloner::kNoFileCache);
      if (cloner.IsValid()) {
        tree_.load()->SetEntries(tree_.load()->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_.load()->GetEntries()) {
        unclonedReadBranches_.push_back(val);
        unclonedReadBranchNames_.insert(string(val->GetName()));
      }
    }
    return cloned;
  }

void art::RootOutputTree::fillTree

(

)

Definition at line 153 of file RootOutputTree.cc.

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

bool art::RootOutputTree::isValid

(

)

const

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

static

Definition at line 30 of file RootOutputTree.cc.

  {
    TTree* 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 85 of file RootOutputTree.h.

    {
      return metaTree_.load();
    }

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

delete

void art::RootOutputTree::resetOutputBranchAddress

(

BranchDescription const &

bd

)

Definition at line 179 of file RootOutputTree.cc.

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

void art::RootOutputTree::setEntries ( )

inline

Definition at line 90 of file RootOutputTree.h.

    {
      // 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_.load()->GetNbranches() != 0) {
        tree_.load()->SetEntries(-1);
      }
      if (metaTree_.load()->GetNbranches() != 0) {
        metaTree_.load()->SetEntries(-1);
      }
    }

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

inline

Definition at line 80 of file RootOutputTree.h.

    {
      return tree_.load();
    }

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

inline

Definition at line 110 of file RootOutputTree.h.

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

void art::RootOutputTree::writeTree

(

)

const

Definition at line 91 of file RootOutputTree.cc.

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

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

staticnoexcept

Definition at line 77 of file RootOutputTree.cc.

  {
    // 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();
  }

Member Data Documentation

std::atomic<int> art::RootOutputTree::basketSize_

private

Definition at line 130 of file RootOutputTree.h.

std::atomic<bool> art::RootOutputTree::fastCloningEnabled_

private

Definition at line 129 of file RootOutputTree.h.

cet::exempt_ptr<TFile> art::RootOutputTree::filePtr_

private

Definition at line 117 of file RootOutputTree.h.

std::vector<TBranch*> art::RootOutputTree::metaBranches_ {}

private

Definition at line 122 of file RootOutputTree.h.

std::atomic<TTree*> art::RootOutputTree::metaTree_

private

Definition at line 119 of file RootOutputTree.h.

std::atomic<int> art::RootOutputTree::nEntries_

private

Definition at line 133 of file RootOutputTree.h.

std::vector<TBranch*> art::RootOutputTree::producedBranches_ {}

private

Definition at line 121 of file RootOutputTree.h.

std::vector<TBranch*> art::RootOutputTree::readBranches_ {}

private

Definition at line 123 of file RootOutputTree.h.

std::atomic<int64_t> art::RootOutputTree::saveMemoryObjectThreshold_

private

Definition at line 132 of file RootOutputTree.h.

std::atomic<int> art::RootOutputTree::splitLevel_

private

Definition at line 131 of file RootOutputTree.h.

std::atomic<TTree*> art::RootOutputTree::tree_

private

Definition at line 118 of file RootOutputTree.h.

std::vector<TBranch*> art::RootOutputTree::unclonedReadBranches_ {}

private

Definition at line 124 of file RootOutputTree.h.

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

private

Definition at line 125 of file RootOutputTree.h.

---

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

• art/art/Framework/IO/Root/RootOutputTree.h
• art/art/Framework/IO/Root/RootOutputTree.cc