edm::ProductProvenanceRetriever Class Reference

#include <ProductProvenanceRetriever.h>

Classes
class	ProducedProvenanceInfo

Public Member Functions
ProductProvenance const *	branchIDToProvenance (BranchID const &bid) const
ProductProvenance const *	branchIDToProvenanceForProducedOnly (BranchID const &bid) const
void	deepCopy (ProductProvenanceRetriever const &)
void	insertIntoSet (ProductProvenance provenanceProduct) const
void	mergeParentProcessRetriever (ProductProvenanceRetriever const &provRetriever)
void	mergeProvenanceRetrievers (std::shared_ptr< ProductProvenanceRetriever > other)
ProductProvenanceRetriever &	operator= (ProductProvenanceRetriever const &)=delete
	ProductProvenanceRetriever (std::unique_ptr< ProvenanceReaderBase > reader)
	ProductProvenanceRetriever (unsigned int iTransitionIndex)
	ProductProvenanceRetriever (unsigned int iTransitionIndex, edm::ProductRegistry const &)
void	readProvenanceAsync (WaitingTaskHolder task, ModuleCallingContext const *moduleCallingContext) const
void	reset ()
void	update (edm::ProductRegistry const &)
	~ProductProvenanceRetriever ()

Private Member Functions
void	readProvenance () const
void	setTransitionIndex (unsigned int transitionIndex)
void	setupEntryInfoSet (edm::ProductRegistry const &)

Private Attributes
std::vector< ProducedProvenanceInfo >	entryInfoSet_
edm::propagate_const< std::shared_ptr< ProductProvenanceRetriever > >	nextRetriever_
edm::propagate_const< ProductProvenanceRetriever const * >	parentProcessRetriever_
std::shared_ptr< const ProvenanceReaderBase >	provenanceReader_
std::atomic< const std::set< ProductProvenance > * >	readEntryInfoSet_
unsigned int	transitionIndex_

Detailed Description

Definition at line 56 of file ProductProvenanceRetriever.h.

Constructor & Destructor Documentation

ProductProvenanceRetriever() [1/3]

edm::ProductProvenanceRetriever::ProductProvenanceRetriever ( unsigned int  iTransitionIndex )

explicit

Definition at line 14 of file ProductProvenanceRetriever.cc.

      : entryInfoSet_(),
        readEntryInfoSet_(),
        nextRetriever_(),
        parentProcessRetriever_(nullptr),
        provenanceReader_(),
        transitionIndex_(iTransitionIndex) {}

ProductProvenanceRetriever() [2/3]

edm::ProductProvenanceRetriever::ProductProvenanceRetriever	(	unsigned int	iTransitionIndex,
		edm::ProductRegistry const &	iReg
	)

Definition at line 22 of file ProductProvenanceRetriever.cc.

      : entryInfoSet_(),
        readEntryInfoSet_(),
        nextRetriever_(),
        parentProcessRetriever_(nullptr),
        provenanceReader_(),
        transitionIndex_(iTransitionIndex) {
    setupEntryInfoSet(iReg);
  }

References setupEntryInfoSet().

ProductProvenanceRetriever() [3/3]

edm::ProductProvenanceRetriever::ProductProvenanceRetriever ( std::unique_ptr< ProvenanceReaderBase >  reader )

explicit

Definition at line 33 of file ProductProvenanceRetriever.cc.

      : entryInfoSet_(),
        readEntryInfoSet_(),
        nextRetriever_(),
        parentProcessRetriever_(nullptr),
        provenanceReader_(reader.release()),
        transitionIndex_(std::numeric_limits<unsigned int>::max()) {
    assert(provenanceReader_);
  }

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

~ProductProvenanceRetriever()

edm::ProductProvenanceRetriever::~ProductProvenanceRetriever

(

)

Definition at line 43 of file ProductProvenanceRetriever.cc.

{ delete readEntryInfoSet_.load(); }

References readEntryInfoSet_.

Member Function Documentation

branchIDToProvenance()

ProductProvenance const * edm::ProductProvenanceRetriever::branchIDToProvenance

(

BranchID const &

bid

)

const

Definition at line 146 of file ProductProvenanceRetriever.cc.

                                                                                                     {
    auto itFound = std::lower_bound(
        entryInfoSet_.begin(), entryInfoSet_.end(), bid, [](auto const& iEntry, edm::BranchID const& iValue) {
          return iEntry.branchID() < iValue;
        });
    if (itFound != entryInfoSet_.end() and itFound->branchID() == bid) {
      if (auto p = itFound->productProvenance()) {
        return p;
      }
    }
    if (parentProcessRetriever_) {
      return parentProcessRetriever_->branchIDToProvenance(bid);
    }
    //check in source
    readProvenance();
    auto ptr = readEntryInfoSet_.load();
    if (ptr) {
      ProductProvenance ei(bid);
      auto itRead = ptr->find(ei);
      if (itRead != ptr->end()) {
        return &*itRead;
      }
    }
    if (nextRetriever_) {
      return nextRetriever_->branchIDToProvenance(bid);
    }
    return nullptr;
  }

References entryInfoSet_, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, nextRetriever_, AlCaHLTBitMon_ParallelJobs::p, parentProcessRetriever_, readEntryInfoSet_, and readProvenance().

Referenced by edm::RootOutputFile::fillBranches(), edm::RootOutputFile::insertAncestors(), edm::Provenance::productProvenance(), and edm::ParentProcessProductResolver::productProvenancePtr_().

branchIDToProvenanceForProducedOnly()

ProductProvenance const * edm::ProductProvenanceRetriever::branchIDToProvenanceForProducedOnly

(

BranchID const &

bid

)

const

Definition at line 175 of file ProductProvenanceRetriever.cc.

                                                                                                                    {
    auto itFound = std::lower_bound(
        entryInfoSet_.begin(), entryInfoSet_.end(), bid, [](auto const& iEntry, edm::BranchID const& iValue) {
          return iEntry.branchID() < iValue;
        });
    if (itFound != entryInfoSet_.end() and itFound->branchID() == bid) {
      if (auto p = itFound->productProvenance()) {
        return p;
      }
    }
    if (parentProcessRetriever_) {
      return parentProcessRetriever_->branchIDToProvenanceForProducedOnly(bid);
    }
    if (nextRetriever_) {
      return nextRetriever_->branchIDToProvenanceForProducedOnly(bid);
    }
    return nullptr;
  }

References entryInfoSet_, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, nextRetriever_, AlCaHLTBitMon_ParallelJobs::p, and parentProcessRetriever_.

Referenced by edm::PoolOutputModule::updateBranchParentsForOneBranch().

deepCopy()

void edm::ProductProvenanceRetriever::deepCopy

(

ProductProvenanceRetriever const &

iFrom

)

Definition at line 86 of file ProductProvenanceRetriever.cc.

                                                                                   {
    if (iFrom.readEntryInfoSet_) {
      if (readEntryInfoSet_) {
        delete readEntryInfoSet_.exchange(nullptr);
      }
      readEntryInfoSet_ = new std::set<ProductProvenance>(*iFrom.readEntryInfoSet_);
    } else {
      if (readEntryInfoSet_) {
        delete readEntryInfoSet_.load();
        readEntryInfoSet_ = nullptr;
      }
    }
    assert(iFrom.entryInfoSet_.empty());
    provenanceReader_ = iFrom.provenanceReader_;
 
    if (iFrom.nextRetriever_) {
      if (not nextRetriever_) {
        nextRetriever_ = std::make_shared<ProductProvenanceRetriever>(transitionIndex_);
      }
      nextRetriever_->deepCopy(*(iFrom.nextRetriever_));
    }
  }

References cms::cuda::assert(), entryInfoSet_, nextRetriever_, provenanceReader_, readEntryInfoSet_, and transitionIndex_.

insertIntoSet()

void edm::ProductProvenanceRetriever::insertIntoSet

(

ProductProvenance

provenanceProduct

)

const

Definition at line 121 of file ProductProvenanceRetriever.cc.

                                                                                  {
    //NOTE:do not read provenance here because we only need the full
    // provenance when someone tries to access it not when doing the insert
    // doing the delay saves 20% of time when doing an analysis job
    //readProvenance();
    auto itFound =
        std::lower_bound(entryInfoSet_.begin(),
                         entryInfoSet_.end(),
                         entryInfo.branchID(),
                         [](auto const& iEntry, edm::BranchID const& iValue) { return iEntry.branchID() < iValue; });
    if UNLIKELY (itFound == entryInfoSet_.end() or itFound->branchID() != entryInfo.branchID()) {
      throw edm::Exception(edm::errors::LogicError) << "ProductProvenanceRetriever::insertIntoSet passed a BranchID "
                                                    << entryInfo.branchID().id() << " that has not been pre-registered";
    }
    itFound->threadsafe_set(entryInfo.moveParentageID());
  }

References edm::ProductProvenance::branchID(), entryInfoSet_, Exception, edm::BranchID::id(), edm::errors::LogicError, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, edm::ProductProvenance::moveParentageID(), or, and UNLIKELY.

Referenced by edm::EventPrincipal::put(), edm::EventPrincipal::putOnRead(), and edm::SwitchBaseProductResolver::unsafe_setWrapperAndProvenance().

mergeParentProcessRetriever()

void edm::ProductProvenanceRetriever::mergeParentProcessRetriever

(

ProductProvenanceRetriever const &

provRetriever

)

Definition at line 142 of file ProductProvenanceRetriever.cc.

                                                                                                              {
    parentProcessRetriever_ = &provRetriever;
  }

References parentProcessRetriever_.

mergeProvenanceRetrievers()

void edm::ProductProvenanceRetriever::mergeProvenanceRetrievers

(

std::shared_ptr< ProductProvenanceRetriever >

other

)

Definition at line 138 of file ProductProvenanceRetriever.cc.

                                                                                                            {
    nextRetriever_ = other;
  }

References nextRetriever_, and trackingPlots::other.

operator=()

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

delete

readProvenance()

void edm::ProductProvenanceRetriever::readProvenance ( ) const

private

Definition at line 45 of file ProductProvenanceRetriever.cc.

                                                        {
    if (nullptr == readEntryInfoSet_.load() && provenanceReader_) {
      auto temp =
          std::make_unique<std::set<ProductProvenance> const>(provenanceReader_->readProvenance(transitionIndex_));
      std::set<ProductProvenance> const* expected = nullptr;
      if (readEntryInfoSet_.compare_exchange_strong(expected, temp.get())) {
        temp.release();
      }
    }
  }

References provenanceReader_, readEntryInfoSet_, groupFilesInBlocks::temp, and transitionIndex_.

Referenced by branchIDToProvenance().

readProvenanceAsync()

void edm::ProductProvenanceRetriever::readProvenanceAsync	(	WaitingTaskHolder	task,
		ModuleCallingContext const *	moduleCallingContext
	)		const

Definition at line 76 of file ProductProvenanceRetriever.cc.

                                                                                                               {
    if (provenanceReader_ and nullptr == readEntryInfoSet_.load()) {
      provenanceReader_->readProvenanceAsync(task, moduleCallingContext, transitionIndex_, readEntryInfoSet_);
    }
    if (nextRetriever_) {
      nextRetriever_->readProvenanceAsync(task, moduleCallingContext);
    }
  }

References nextRetriever_, provenanceReader_, readEntryInfoSet_, TrackValidation_cff::task, and transitionIndex_.

reset()

void edm::ProductProvenanceRetriever::reset

(

void

)

Definition at line 109 of file ProductProvenanceRetriever.cc.

                                         {
    delete readEntryInfoSet_.load();
    readEntryInfoSet_ = nullptr;
    for (auto& e : entryInfoSet_) {
      e.resetParentage();
    }
    if (nextRetriever_) {
      nextRetriever_->reset();
    }
    parentProcessRetriever_ = nullptr;
  }

References MillePedeFileConverter_cfg::e, entryInfoSet_, nextRetriever_, parentProcessRetriever_, and readEntryInfoSet_.

setTransitionIndex()

void edm::ProductProvenanceRetriever::setTransitionIndex ( unsigned int  transitionIndex )

inlineprivate

Definition at line 138 of file ProductProvenanceRetriever.h.

{ transitionIndex_ = transitionIndex; }

References transitionIndex_.

setupEntryInfoSet()

void edm::ProductProvenanceRetriever::setupEntryInfoSet ( edm::ProductRegistry const &  iReg )

private

Definition at line 56 of file ProductProvenanceRetriever.cc.

                                                                                   {
    std::set<BranchID> ids;
    for (auto const& p : iReg.productList()) {
      if (p.second.branchType() == edm::InEvent) {
        if (p.second.produced() or p.second.isProvenanceSetOnRead()) {
          ids.insert(p.second.branchID());
        }
      }
    }
    entryInfoSet_.reserve(ids.size());
    for (auto const& b : ids) {
      entryInfoSet_.emplace_back(b);
    }
  }

References b, entryInfoSet_, edm::InEvent, or, AlCaHLTBitMon_ParallelJobs::p, and edm::ProductRegistry::productList().

Referenced by ProductProvenanceRetriever(), and update().

update()

void edm::ProductProvenanceRetriever::update

(

edm::ProductRegistry const &

iReg

)

Definition at line 71 of file ProductProvenanceRetriever.cc.

                                                                        {
    entryInfoSet_.clear();
    setupEntryInfoSet(iReg);
  }

References entryInfoSet_, and setupEntryInfoSet().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), dqm-mbProfile.Profile::finish(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

Member Data Documentation

entryInfoSet_

std::vector<ProducedProvenanceInfo> edm::ProductProvenanceRetriever::entryInfoSet_

private

Definition at line 141 of file ProductProvenanceRetriever.h.

Referenced by branchIDToProvenance(), branchIDToProvenanceForProducedOnly(), deepCopy(), insertIntoSet(), reset(), setupEntryInfoSet(), and update().

nextRetriever_

edm::propagate_const<std::shared_ptr<ProductProvenanceRetriever> > edm::ProductProvenanceRetriever::nextRetriever_

private

Definition at line 143 of file ProductProvenanceRetriever.h.

Referenced by branchIDToProvenance(), branchIDToProvenanceForProducedOnly(), deepCopy(), mergeProvenanceRetrievers(), readProvenanceAsync(), and reset().

parentProcessRetriever_

edm::propagate_const<ProductProvenanceRetriever const*> edm::ProductProvenanceRetriever::parentProcessRetriever_

private

Definition at line 144 of file ProductProvenanceRetriever.h.

Referenced by branchIDToProvenance(), branchIDToProvenanceForProducedOnly(), mergeParentProcessRetriever(), and reset().

provenanceReader_

std::shared_ptr<const ProvenanceReaderBase> edm::ProductProvenanceRetriever::provenanceReader_

private

Definition at line 145 of file ProductProvenanceRetriever.h.

Referenced by deepCopy(), ProductProvenanceRetriever(), readProvenance(), and readProvenanceAsync().

readEntryInfoSet_

std::atomic<const std::set<ProductProvenance>*> edm::ProductProvenanceRetriever::readEntryInfoSet_

mutableprivate

Definition at line 142 of file ProductProvenanceRetriever.h.

Referenced by branchIDToProvenance(), deepCopy(), readProvenance(), readProvenanceAsync(), reset(), and ~ProductProvenanceRetriever().

transitionIndex_

unsigned int edm::ProductProvenanceRetriever::transitionIndex_

private

Definition at line 146 of file ProductProvenanceRetriever.h.

Referenced by deepCopy(), readProvenance(), readProvenanceAsync(), and setTransitionIndex().