edm::LuminosityBlockProcessingStatus Class Reference

#include <LuminosityBlockProcessingStatus.h>

Public Types
enum	EventProcessingState { EventProcessingState::kProcessing, EventProcessingState::kPauseForFileTransition, EventProcessingState::kStopLumi }

Public Member Functions
bool	cleaningUpAfterException () const
bool	didGlobalBeginSucceed () const
WaitingTaskList &	endIOVWaitingTasks ()
EventProcessingState	eventProcessingState () const
EventSetupImpl const &	eventSetupImpl (unsigned subProcessIndex) const
std::vector< std::shared_ptr< const EventSetupImpl > > &	eventSetupImpls ()
std::vector< std::shared_ptr< const EventSetupImpl > > const &	eventSetupImpls () const
void	globalBeginDidSucceed ()
void	globalEndRunHolderDoneWaiting ()
bool	haveStartedNextLumiOrEndedRun () const
edm::Timestamp const &	lastTimestamp () const
	LuminosityBlockProcessingStatus (unsigned int iNStreams)
	LuminosityBlockProcessingStatus (LuminosityBlockProcessingStatus const &)=delete
std::shared_ptr< LuminosityBlockPrincipal > &	lumiPrincipal ()
LuminosityBlockProcessingStatus const &	operator= (LuminosityBlockProcessingStatus const &)=delete
void	resetResources ()
void	resumeGlobalLumiQueue ()
void	setCleaningUpAfterException (bool value)
void	setEndTime ()
void	setEventProcessingState (EventProcessingState val)
void	setGlobalEndRunHolder (WaitingTaskHolder)
void	setLumiPrincipal (std::shared_ptr< LuminosityBlockPrincipal > val)
void	setResumer (LimitedTaskQueue::Resumer iResumer)
void	startNextLumiOrEndRun ()
bool	streamFinishedLumi ()
void	updateLastTimestamp (edm::Timestamp const &iTime)
	~LuminosityBlockProcessingStatus ()

Private Attributes
bool	cleaningUpAfterException_ {false}
WaitingTaskList	endIOVWaitingTasks_
edm::Timestamp	endTime_ {}
std::atomic< char >	endTimeSetStatus_ {0}
EventProcessingState	eventProcessingState_ {EventProcessingState::kProcessing}
std::vector< std::shared_ptr< const EventSetupImpl > >	eventSetupImpls_
bool	globalBeginSucceeded_ {false}
edm::WaitingTaskHolder	globalEndRunHolder_
LimitedTaskQueue::Resumer	globalLumiQueueResumer_
std::shared_ptr< LuminosityBlockPrincipal >	lumiPrincipal_
std::atomic< unsigned int >	nStreamsStillProcessingLumi_ {0}
std::atomic< bool >	startedNextLumiOrEndedRun_ {false}

Detailed Description

Description: Keep status information about one LuminosityBlock transition

Usage: <usage>

Definition at line 40 of file LuminosityBlockProcessingStatus.h.

Member Enumeration Documentation

EventProcessingState

enum edm::LuminosityBlockProcessingStatus::EventProcessingState

strong

Enumerator
kProcessing
kPauseForFileTransition
kStopLumi

Definition at line 86 of file LuminosityBlockProcessingStatus.h.

{ kProcessing, kPauseForFileTransition, kStopLumi };

Constructor & Destructor Documentation

LuminosityBlockProcessingStatus() [1/2]

edm::LuminosityBlockProcessingStatus::LuminosityBlockProcessingStatus ( unsigned int  iNStreams )

inline

Definition at line 42 of file LuminosityBlockProcessingStatus.h.

: nStreamsStillProcessingLumi_(iNStreams) {}

LuminosityBlockProcessingStatus() [2/2]

edm::LuminosityBlockProcessingStatus::LuminosityBlockProcessingStatus ( LuminosityBlockProcessingStatus const &  )

delete

~LuminosityBlockProcessingStatus()

edm::LuminosityBlockProcessingStatus::~LuminosityBlockProcessingStatus ( )

inline

Definition at line 47 of file LuminosityBlockProcessingStatus.h.

References edm::WaitingTaskList::doneWaiting(), and endIOVWaitingTasks_.

{ endIOVWaitingTasks_.doneWaiting(std::exception_ptr{}); }

Member Function Documentation

cleaningUpAfterException()

bool edm::LuminosityBlockProcessingStatus::cleaningUpAfterException ( ) const

inline

Definition at line 96 of file LuminosityBlockProcessingStatus.h.

References cleaningUpAfterException_.

{ return cleaningUpAfterException_; }

didGlobalBeginSucceed()

bool edm::LuminosityBlockProcessingStatus::didGlobalBeginSucceed ( ) const

inline

Definition at line 93 of file LuminosityBlockProcessingStatus.h.

References globalBeginSucceeded_.

{ return globalBeginSucceeded_; }

endIOVWaitingTasks()

WaitingTaskList& edm::LuminosityBlockProcessingStatus::endIOVWaitingTasks ( )

inline

Definition at line 68 of file LuminosityBlockProcessingStatus.h.

References endIOVWaitingTasks_.

{ return endIOVWaitingTasks_; }

eventProcessingState()

EventProcessingState edm::LuminosityBlockProcessingStatus::eventProcessingState ( ) const

inline

Definition at line 87 of file LuminosityBlockProcessingStatus.h.

References eventProcessingState_.

Referenced by edm::EventProcessor::readNextEventForStream().

{ return eventProcessingState_; }

eventSetupImpl()

EventSetupImpl const& edm::LuminosityBlockProcessingStatus::eventSetupImpl ( unsigned  subProcessIndex ) const

inline

Definition at line 61 of file LuminosityBlockProcessingStatus.h.

References eventSetupImpls_.

                                                                         {
      return *eventSetupImpls_.at(subProcessIndex);
    }

eventSetupImpls() [1/2]

std::vector<std::shared_ptr<const EventSetupImpl> >& edm::LuminosityBlockProcessingStatus::eventSetupImpls ( )

inline

Definition at line 65 of file LuminosityBlockProcessingStatus.h.

References eventSetupImpls_.

{ return eventSetupImpls_; }

eventSetupImpls() [2/2]

std::vector<std::shared_ptr<const EventSetupImpl> > const& edm::LuminosityBlockProcessingStatus::eventSetupImpls ( ) const

inline

Definition at line 66 of file LuminosityBlockProcessingStatus.h.

References eventSetupImpls_.

{ return eventSetupImpls_; }

globalBeginDidSucceed()

void edm::LuminosityBlockProcessingStatus::globalBeginDidSucceed ( )

inline

Definition at line 94 of file LuminosityBlockProcessingStatus.h.

References globalBeginSucceeded_.

{ globalBeginSucceeded_ = true; }

globalEndRunHolderDoneWaiting()

void edm::LuminosityBlockProcessingStatus::globalEndRunHolderDoneWaiting ( )

inline

Definition at line 71 of file LuminosityBlockProcessingStatus.h.

References edm::WaitingTaskHolder::doneWaiting(), and globalEndRunHolder_.

{ globalEndRunHolder_.doneWaiting(std::exception_ptr{}); }

haveStartedNextLumiOrEndedRun()

bool edm::LuminosityBlockProcessingStatus::haveStartedNextLumiOrEndedRun ( ) const

inline

Definition at line 90 of file LuminosityBlockProcessingStatus.h.

References startedNextLumiOrEndedRun_.

{ return startedNextLumiOrEndedRun_.load(); }

lastTimestamp()

edm::Timestamp const& edm::LuminosityBlockProcessingStatus::lastTimestamp ( ) const

inline

Definition at line 81 of file LuminosityBlockProcessingStatus.h.

References endTime_.

{ return endTime_; }

lumiPrincipal()

std::shared_ptr<LuminosityBlockPrincipal>& edm::LuminosityBlockProcessingStatus::lumiPrincipal ( )

inline

Definition at line 58 of file LuminosityBlockProcessingStatus.h.

References lumiPrincipal_.

Referenced by edm::EventProcessor::clearLumiPrincipal(), edm::EventProcessor::readAndMergeLumi(), and edm::EventProcessor::readNextEventForStream().

{ return lumiPrincipal_; }

operator=()

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

delete

resetResources()

void edm::LuminosityBlockProcessingStatus::resetResources

(

)

Definition at line 17 of file LuminosityBlockProcessingStatus.cc.

References edm::WaitingTaskList::doneWaiting(), endIOVWaitingTasks_, eventSetupImpls_, and resumeGlobalLumiQueue().

                                                       {
    endIOVWaitingTasks_.doneWaiting(std::exception_ptr{});
    for (auto& iter : eventSetupImpls_) {
      iter.reset();
    }
    resumeGlobalLumiQueue();
  }

resumeGlobalLumiQueue()

void edm::LuminosityBlockProcessingStatus::resumeGlobalLumiQueue ( )

inline

Definition at line 50 of file LuminosityBlockProcessingStatus.h.

References globalLumiQueueResumer_, lumiPrincipal_, and edm::LimitedTaskQueue::Resumer::resume().

Referenced by resetResources().

                                 {
      //free lumi for next usage
      lumiPrincipal_.reset();
      globalLumiQueueResumer_.resume();
    }

setCleaningUpAfterException()

void edm::LuminosityBlockProcessingStatus::setCleaningUpAfterException ( bool  value )

inline

Definition at line 97 of file LuminosityBlockProcessingStatus.h.

References cleaningUpAfterException_, and relativeConstraints::value.

{ cleaningUpAfterException_ = value; }

setEndTime()

void edm::LuminosityBlockProcessingStatus::setEndTime

(

)

Definition at line 29 of file LuminosityBlockProcessingStatus.cc.

References endTime_, endTimeSetStatus_, kSet, and lumiPrincipal_.

                                                   {
    constexpr char kUnset = 0;
    constexpr char kSetting = 1;
    constexpr char kSet = 2;

    if (endTimeSetStatus_ != kSet) {
      //not already set
      char expected = kUnset;
      if (endTimeSetStatus_.compare_exchange_strong(expected, kSetting)) {
        lumiPrincipal_->setEndTime(endTime_);
        endTimeSetStatus_.store(kSet);
      } else {
        //wait until time is set
        while (endTimeSetStatus_.load() != kSet) {
        }
      }
    }
  }

setEventProcessingState()

void edm::LuminosityBlockProcessingStatus::setEventProcessingState ( EventProcessingState  val )

inline

Definition at line 88 of file LuminosityBlockProcessingStatus.h.

References eventProcessingState_, and heppy_batch::val.

Referenced by edm::EventProcessor::readNextEventForStream().

{ eventProcessingState_ = val; }

setGlobalEndRunHolder()

void edm::LuminosityBlockProcessingStatus::setGlobalEndRunHolder

(

WaitingTaskHolder

holder

)

Definition at line 25 of file LuminosityBlockProcessingStatus.cc.

References globalEndRunHolder_, and eostools::move().

                                                                                      {
    globalEndRunHolder_ = std::move(holder);
  }

setLumiPrincipal()

void edm::LuminosityBlockProcessingStatus::setLumiPrincipal ( std::shared_ptr< LuminosityBlockPrincipal >  val )

inline

Definition at line 59 of file LuminosityBlockProcessingStatus.h.

References lumiPrincipal_, eostools::move(), and heppy_batch::val.

{ lumiPrincipal_ = std::move(val); }

setResumer()

void edm::LuminosityBlockProcessingStatus::setResumer ( LimitedTaskQueue::Resumer  iResumer )

inline

Definition at line 49 of file LuminosityBlockProcessingStatus.h.

References globalLumiQueueResumer_, and eostools::move().

{ globalLumiQueueResumer_ = std::move(iResumer); }

startNextLumiOrEndRun()

void edm::LuminosityBlockProcessingStatus::startNextLumiOrEndRun ( )

inline

Definition at line 91 of file LuminosityBlockProcessingStatus.h.

References startedNextLumiOrEndedRun_.

{ startedNextLumiOrEndedRun_.store(true); }

streamFinishedLumi()

bool edm::LuminosityBlockProcessingStatus::streamFinishedLumi ( )

inline

Definition at line 73 of file LuminosityBlockProcessingStatus.h.

References nStreamsStillProcessingLumi_.

{ return 0 == (--nStreamsStillProcessingLumi_); }

updateLastTimestamp()

void edm::LuminosityBlockProcessingStatus::updateLastTimestamp ( edm::Timestamp const &  iTime )

inline

Definition at line 76 of file LuminosityBlockProcessingStatus.h.

References endTime_.

                                                        {
      if (iTime > endTime_) {
        endTime_ = iTime;
      }
    }

Member Data Documentation

cleaningUpAfterException_

bool edm::LuminosityBlockProcessingStatus::cleaningUpAfterException_ {false}

private

Definition at line 112 of file LuminosityBlockProcessingStatus.h.

Referenced by cleaningUpAfterException(), and setCleaningUpAfterException().

endIOVWaitingTasks_

WaitingTaskList edm::LuminosityBlockProcessingStatus::endIOVWaitingTasks_

private

Definition at line 104 of file LuminosityBlockProcessingStatus.h.

Referenced by endIOVWaitingTasks(), resetResources(), and ~LuminosityBlockProcessingStatus().

endTime_

edm::Timestamp edm::LuminosityBlockProcessingStatus::endTime_ {}

private

Definition at line 107 of file LuminosityBlockProcessingStatus.h.

Referenced by lastTimestamp(), setEndTime(), and updateLastTimestamp().

endTimeSetStatus_

std::atomic<char> edm::LuminosityBlockProcessingStatus::endTimeSetStatus_ {0}

private

Definition at line 108 of file LuminosityBlockProcessingStatus.h.

Referenced by setEndTime().

eventProcessingState_

EventProcessingState edm::LuminosityBlockProcessingStatus::eventProcessingState_ {EventProcessingState::kProcessing}

private

Definition at line 109 of file LuminosityBlockProcessingStatus.h.

Referenced by eventProcessingState(), and setEventProcessingState().

eventSetupImpls_

std::vector<std::shared_ptr<const EventSetupImpl> > edm::LuminosityBlockProcessingStatus::eventSetupImpls_

private

Definition at line 103 of file LuminosityBlockProcessingStatus.h.

Referenced by eventSetupImpl(), eventSetupImpls(), and resetResources().

globalBeginSucceeded_

bool edm::LuminosityBlockProcessingStatus::globalBeginSucceeded_ {false}

private

Definition at line 111 of file LuminosityBlockProcessingStatus.h.

Referenced by didGlobalBeginSucceed(), and globalBeginDidSucceed().

globalEndRunHolder_

edm::WaitingTaskHolder edm::LuminosityBlockProcessingStatus::globalEndRunHolder_

private

Definition at line 105 of file LuminosityBlockProcessingStatus.h.

Referenced by globalEndRunHolderDoneWaiting(), and setGlobalEndRunHolder().

globalLumiQueueResumer_

LimitedTaskQueue::Resumer edm::LuminosityBlockProcessingStatus::globalLumiQueueResumer_

private

Definition at line 101 of file LuminosityBlockProcessingStatus.h.

Referenced by resumeGlobalLumiQueue(), and setResumer().

lumiPrincipal_

std::shared_ptr<LuminosityBlockPrincipal> edm::LuminosityBlockProcessingStatus::lumiPrincipal_

private

Definition at line 102 of file LuminosityBlockProcessingStatus.h.

Referenced by lumiPrincipal(), resumeGlobalLumiQueue(), setEndTime(), and setLumiPrincipal().

nStreamsStillProcessingLumi_

std::atomic<unsigned int> edm::LuminosityBlockProcessingStatus::nStreamsStillProcessingLumi_ {0}

private

Definition at line 106 of file LuminosityBlockProcessingStatus.h.

Referenced by streamFinishedLumi().

startedNextLumiOrEndedRun_

std::atomic<bool> edm::LuminosityBlockProcessingStatus::startedNextLumiOrEndedRun_ {false}

private

Definition at line 110 of file LuminosityBlockProcessingStatus.h.

Referenced by haveStartedNextLumiOrEndedRun(), and startNextLumiOrEndRun().