edm::SwitchBaseProductResolver Class Reference

#include <ProductResolvers.h>

Inheritance diagram for edm::SwitchBaseProductResolver:

Public Types
using	ProductStatus = DataManagingProductResolver::ProductStatus

Public Member Functions
void	connectTo (ProductResolverBase const &iOther, Principal const *iParentPrincipal) final
void	setupUnscheduled (UnscheduledConfigurator const &iConfigure) final
	SwitchBaseProductResolver (std::shared_ptr< BranchDescription const > bd, DataManagingOrAliasProductResolver &realProduct)
Public Member Functions inherited from edm::DataManagingOrAliasProductResolver
	DataManagingOrAliasProductResolver ()
Public Member Functions inherited from edm::ProductResolverBase
BranchDescription const &	branchDescription () const
std::string const &	moduleLabel () const
ProductResolverBase &	operator= (ProductResolverBase const &)=delete
void	prefetchAsync (WaitingTask *waitTask, Principal const &principal, bool skipCurrentProcess, ServiceToken const &token, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const
std::string const &	processName () const
ProductID const &	productID () const
std::string const &	productInstanceName () const
ProductProvenance const *	productProvenancePtr () const
bool	productResolved () const
	ProductResolverBase ()
	ProductResolverBase (ProductResolverBase const &)=delete
TypeID	productType () const
bool	productUnavailable () const
bool	productWasDeleted () const
bool	productWasFetchedAndIsValid (bool iSkipCurrentProcess) const
Provenance const *	provenance () const
bool	provenanceAvailable () const
void	putOrMergeProduct (std::unique_ptr< WrapperBase > edp, MergeableRunProductMetadata const *mergeableRunProductMetadata=nullptr) const
void	putProduct (std::unique_ptr< WrapperBase > edp) const
void	resetBranchDescription (std::shared_ptr< BranchDescription const > bd)
void	resetProductData ()
std::string const &	resolvedModuleLabel () const
Resolution	resolveProduct (Principal const &principal, bool skipCurrentProcess, SharedResourcesAcquirer *sra, ModuleCallingContext const *mcc) const
void	retrieveAndMerge (Principal const &principal, MergeableRunProductMetadata const *mergeableRunProductMetadata) const
void	setMergeableRunProductMetadata (MergeableRunProductMetadata const *mrpm)
void	setProcessHistory (ProcessHistory const &ph)
void	setProvenance (ProductProvenanceRetriever const *provRetriever, ProcessHistory const &ph, ProductID const &pid)
bool	singleProduct () const
StableProvenance const *	stableProvenance () const
void	unsafe_deleteProduct () const
bool	unscheduledWasNotRun () const
void	write (std::ostream &os) const
virtual	~ProductResolverBase ()

Protected Member Functions
std::atomic< bool > &	prefetchRequested () const
DataManagingOrAliasProductResolver const &	realProduct () const
Resolution	resolveProductImpl (Resolution) const
ProductStatus	status () const
WaitingTaskList &	waitingTasks () const
Worker *	worker () const

Private Member Functions
BranchDescription const &	branchDescription_ () const final
ProductProvenance const *	productProvenancePtr_ () const final
bool	productResolved_ () const final
bool	productWasDeleted_ () const final
bool	productWasFetchedAndIsValid_ (bool iSkipCurrentProcess) const final
Provenance const *	provenance_ () const final
void	putOrMergeProduct_ (std::unique_ptr< WrapperBase > edp, MergeableRunProductMetadata const *mergeableRunProductMetadata) const final
void	putProduct_ (std::unique_ptr< WrapperBase > edp) const final
void	resetBranchDescription_ (std::shared_ptr< BranchDescription const > bd) final
void	resetProductData_ (bool deleteEarly) final
std::string const &	resolvedModuleLabel_ () const final
void	setProcessHistory_ (ProcessHistory const &ph) final
void	setProvenance_ (ProductProvenanceRetriever const *provRetriever, ProcessHistory const &ph, ProductID const &pid) final
bool	singleProduct_ () const final

Private Attributes
ParentageID	parentageID_
std::atomic< bool >	prefetchRequested_
ProductData	productData_
DataManagingOrAliasProductResolver &	realProduct_
ProductStatus	status_
WaitingTaskList	waitingTasks_
Worker *	worker_ = nullptr

Static Private Attributes
static constexpr const ProductStatus	defaultStatus_ = ProductStatus::NotPut

Detailed Description

Definition at line 265 of file ProductResolvers.h.

Member Typedef Documentation

using edm::SwitchBaseProductResolver::ProductStatus = DataManagingProductResolver::ProductStatus

Definition at line 267 of file ProductResolvers.h.

Constructor & Destructor Documentation

edm::SwitchBaseProductResolver::SwitchBaseProductResolver	(	std::shared_ptr< BranchDescription const >	bd,
		DataManagingOrAliasProductResolver &	realProduct
	)

Definition at line 601 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), edm::Parentage::id(), edm::ParentageRegistry::insertMapped(), edm::ParentageRegistry::instance(), edm::BranchDescription::originalBranchID(), AlCaHLTBitMon_ParallelJobs::p, parentageID_, and edm::Parentage::setParents().

      : realProduct_(realProduct), productData_(std::move(bd)), prefetchRequested_(false), status_(defaultStatus_) {
    // Parentage of this branch is always the same by construction, so we can compute the ID just "once" here.
    Parentage p;
    p.setParents(std::vector<BranchID>{realProduct.branchDescription().originalBranchID()});
    parentageID_ = p.id();
    ParentageRegistry::instance()->insertMapped(p);
  }

Member Function Documentation

BranchDescription const& edm::SwitchBaseProductResolver::branchDescription_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 291 of file ProductResolvers.h.

                                                              {
      return *productData_.branchDescription();
      ;
    }

void edm::SwitchBaseProductResolver::connectTo ( ProductResolverBase const &  iOther, Principal const *  iParentPrincipal  )

finalvirtual

Implements edm::ProductResolverBase.

Definition at line 611 of file ProductResolvers.cc.

References Exception, and edm::errors::LogicError.

                                                                                                                {
    throw Exception(errors::LogicError)
        << "SwitchBaseProductResolver::connectTo() not implemented and should never be called.\n"
        << "Contact a Framework developer\n";
  }

std::atomic<bool>& edm::SwitchBaseProductResolver::prefetchRequested ( ) const

inlineprotected

Definition at line 280 of file ProductResolvers.h.

References edm::ProductResolverBase::productResolved_().

Referenced by edm::SwitchProducerProductResolver::prefetchAsync_().

{ return prefetchRequested_; }

ProductProvenance const* edm::SwitchBaseProductResolver::productProvenancePtr_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 304 of file ProductResolvers.h.

References edm::Provenance::productProvenance(), edm::ProductResolverBase::provenance(), and edm::DataManagingOrAliasProductResolver::resetProductData_().

{ return provenance()->productProvenance(); }

bool edm::SwitchBaseProductResolver::productResolved_ ( ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 629 of file ProductResolvers.cc.

                                                         {
    // SwitchProducer will never put anything in the event, and
    // "false" will make Event::commit_() to call putProduct() with
    // null unique_ptr<WrapperBase> to signal that the produce() was
    // run.
    return false;
  }

bool edm::SwitchBaseProductResolver::productWasDeleted_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 284 of file ProductResolvers.h.

{ return realProduct_.productWasDeleted(); }

bool edm::SwitchBaseProductResolver::productWasFetchedAndIsValid_ ( bool  iSkipCurrentProcess ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 285 of file ProductResolvers.h.

References edm::ProductResolverBase::putOrMergeProduct_(), and edm::ProductResolverBase::putProduct_().

                                                                            {
      return realProduct_.productWasFetchedAndIsValid(iSkipCurrentProcess);
    }

Provenance const* edm::SwitchBaseProductResolver::provenance_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 298 of file ProductResolvers.h.

{ return &productData_.provenance(); }

void edm::SwitchBaseProductResolver::putOrMergeProduct_ ( std::unique_ptr< WrapperBase >  edp, MergeableRunProductMetadata const *  mergeableRunProductMetadata  ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 652 of file ProductResolvers.cc.

References Exception, and edm::errors::LogicError.

                                                                                               {
    throw Exception(errors::LogicError)
        << "SwitchBaseProductResolver::putOrMergeProduct_(std::unique_ptr<WrapperBase> edp, "
           "MergeableRunProductMetadata const*) not implemented and should never be called.\n"
        << "Contact a Framework developer\n";
  }

void edm::SwitchBaseProductResolver::putProduct_ ( std::unique_ptr< WrapperBase >  edp ) const

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 637 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), edm::BranchDescription::branchName(), defaultStatus_, edm::WaitingTaskList::doneWaiting(), Exception, edm::errors::InsertFailure, prefetchRequested_, edm::DataManagingProductResolver::ResolveFailed, status_, and waitingTasks_.

                                                                                  {
    if (status_ != defaultStatus_) {
      throw Exception(errors::InsertFailure)
          << "Attempt to insert more than one product for a branch " << branchDescription().branchName()
          << "This makes no sense for SwitchBaseProductResolver.\nContact a Framework developer";
    }
    // Let's use ResolveFailed to signal that produce() was called, as
    // there is no real product in this resolver
    status_ = ProductStatus::ResolveFailed;
    bool expected = false;
    if (prefetchRequested_.compare_exchange_strong(expected, true)) {
      waitingTasks_.doneWaiting(std::exception_ptr());
    }
  }

DataManagingOrAliasProductResolver const& edm::SwitchBaseProductResolver::realProduct ( ) const

inlineprotected

Definition at line 279 of file ProductResolvers.h.

Referenced by edm::SwitchAliasProductResolver::prefetchAsync_(), edm::SwitchProducerProductResolver::productUnavailable_(), edm::SwitchProducerProductResolver::resolveProduct_(), and edm::SwitchAliasProductResolver::resolveProduct_().

{ return realProduct_; }

void edm::SwitchBaseProductResolver::resetBranchDescription_ ( std::shared_ptr< BranchDescription const >  bd )

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 295 of file ProductResolvers.h.

                                                                                  {
      productData_.resetBranchDescription(bd);
    }

void edm::SwitchBaseProductResolver::resetProductData_ ( bool  deleteEarly )

finalprivatevirtual

Implements edm::DataManagingOrAliasProductResolver.

Definition at line 668 of file ProductResolvers.cc.

References defaultStatus_, productData_, realProduct_, edm::ProductData::resetProductData(), edm::DataManagingOrAliasProductResolver::resetProductData_(), and status_.

                                                                    {
    productData_.resetProductData();
    realProduct_.resetProductData_(deleteEarly);
    if (not deleteEarly) {
      status_ = defaultStatus_;
    }
  }

std::string const& edm::SwitchBaseProductResolver::resolvedModuleLabel_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 299 of file ProductResolvers.h.

References edm::ProductResolverBase::moduleLabel(), sysUtil::pid, and edm::ProductResolverBase::setProvenance_().

{ return moduleLabel(); }

ProductResolverBase::Resolution edm::SwitchBaseProductResolver::resolveProductImpl ( Resolution  res ) const

protected

Definition at line 621 of file ProductResolvers.cc.

References edm::ProductResolverBase::Resolution::data(), productData_, Resolution, edm::ProductData::sharedConstWrapper(), and edm::ProductData::unsafe_setWrapper().

Referenced by edm::SwitchProducerProductResolver::resolveProduct_(), and edm::SwitchAliasProductResolver::resolveProduct_().

                                                                                                  {
    if (res.data() == nullptr)
      return res;
    // Use the Wrapper of the pointed-to resolver, but the provenance of this resolver
    productData_.unsafe_setWrapper(res.data()->sharedConstWrapper());
    return Resolution(&productData_);
  }

void edm::SwitchBaseProductResolver::setProcessHistory_ ( ProcessHistory const &  ph )

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 303 of file ProductResolvers.h.

{ productData_.setProcessHistory(ph); }

void edm::SwitchBaseProductResolver::setProvenance_ ( ProductProvenanceRetriever const *  provRetriever, ProcessHistory const &  ph, ProductID const &  pid  )

finalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 660 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), edm::ProductProvenanceRetriever::insertIntoSet(), parentageID_, productData_, and edm::ProductData::setProvenance().

                                                                       {
    // insertIntoSet is const, so let's exploit that to fake the getting of the "input" product
    provRetriever->insertIntoSet(ProductProvenance(branchDescription().branchID(), parentageID_));
    productData_.setProvenance(provRetriever, ph, pid);
  }

void edm::SwitchBaseProductResolver::setupUnscheduled ( UnscheduledConfigurator const &  iConfigure )

finalvirtual

Reimplemented from edm::ProductResolverBase.

Definition at line 617 of file ProductResolvers.cc.

References edm::ProductResolverBase::branchDescription(), edm::UnscheduledConfigurator::findWorker(), edm::ProductResolverBase::moduleLabel(), and worker_.

                                                                                            {
    worker_ = iConfigure.findWorker(branchDescription().moduleLabel());
  }

bool edm::SwitchBaseProductResolver::singleProduct_ ( ) const

inlinefinalprivatevirtual

Implements edm::ProductResolverBase.

Definition at line 306 of file ProductResolvers.h.

{ return true; }

ProductStatus edm::SwitchBaseProductResolver::status ( void  ) const

inlineprotected

Definition at line 278 of file ProductResolvers.h.

Referenced by edm::SwitchProducerProductResolver::productUnavailable_(), and edm::SwitchProducerProductResolver::resolveProduct_().

{ return status_; }

WaitingTaskList& edm::SwitchBaseProductResolver::waitingTasks ( ) const

inlineprotected

Definition at line 276 of file ProductResolvers.h.

Referenced by edm::SwitchProducerProductResolver::prefetchAsync_().

{ return waitingTasks_; }

Worker* edm::SwitchBaseProductResolver::worker ( ) const

inlineprotected

Definition at line 277 of file ProductResolvers.h.

Referenced by edm::SwitchProducerProductResolver::prefetchAsync_().

{ return worker_; }

Member Data Documentation

constexpr const ProductStatus edm::SwitchBaseProductResolver::defaultStatus_ = ProductStatus::NotPut

staticprivate

Definition at line 308 of file ProductResolvers.h.

Referenced by putProduct_(), and resetProductData_().

ParentageID edm::SwitchBaseProductResolver::parentageID_

private

Definition at line 318 of file ProductResolvers.h.

Referenced by setProvenance_(), and SwitchBaseProductResolver().

std::atomic<bool> edm::SwitchBaseProductResolver::prefetchRequested_

mutableprivate

Definition at line 316 of file ProductResolvers.h.

Referenced by putProduct_().

ProductData edm::SwitchBaseProductResolver::productData_

private

Definition at line 313 of file ProductResolvers.h.

Referenced by resetProductData_(), resolveProductImpl(), and setProvenance_().

DataManagingOrAliasProductResolver& edm::SwitchBaseProductResolver::realProduct_

private

Definition at line 311 of file ProductResolvers.h.

Referenced by resetProductData_().

ProductStatus edm::SwitchBaseProductResolver::status_

mutableprivate

Definition at line 320 of file ProductResolvers.h.

Referenced by putProduct_(), and resetProductData_().

WaitingTaskList edm::SwitchBaseProductResolver::waitingTasks_

mutableprivate

Definition at line 315 of file ProductResolvers.h.

Referenced by putProduct_().

Worker* edm::SwitchBaseProductResolver::worker_ = nullptr

private

Definition at line 314 of file ProductResolvers.h.

Referenced by setupUnscheduled().