edm::WaitingTaskHolder Class Reference

#include <WaitingTaskHolder.h>

Public Member Functions
void	doneWaiting (std::exception_ptr iExcept)
oneapi::tbb::task_group *	group () const noexcept
bool	hasTask () const noexcept
WaitingTaskHolder &	operator= (const WaitingTaskHolder &iRHS)
WaitingTaskHolder &	operator= (WaitingTaskHolder &&iRHS)
void	presetTaskAsFailed (std::exception_ptr iExcept)
bool	taskHasFailed () const noexcept
	WaitingTaskHolder ()
	WaitingTaskHolder (oneapi::tbb::task_group &iGroup, edm::WaitingTask *iTask)
	WaitingTaskHolder (const WaitingTaskHolder &iHolder)
	WaitingTaskHolder (WaitingTaskHolder &&iOther)
	~WaitingTaskHolder ()

Private Member Functions
WaitingTask *	release_no_decrement () noexcept

Private Attributes
oneapi::tbb::task_group *	m_group
WaitingTask *	m_task

Friends
class	WaitingTaskList
class	WaitingTaskWithArenaHolder

Detailed Description

Definition at line 32 of file WaitingTaskHolder.h.

Constructor & Destructor Documentation

WaitingTaskHolder() [1/4]

edm::WaitingTaskHolder::WaitingTaskHolder ( )

inline

Definition at line 37 of file WaitingTaskHolder.h.

: m_task(nullptr), m_group(nullptr) {}

WaitingTaskHolder() [2/4]

edm::WaitingTaskHolder::WaitingTaskHolder ( oneapi::tbb::task_group &  iGroup, edm::WaitingTask *  iTask  )

inlineexplicit

Definition at line 39 of file WaitingTaskHolder.h.

References edm::TaskBase::increment_ref_count(), and m_task.

        : m_task(iTask), m_group(&iGroup) {
      m_task->increment_ref_count();
    }

~WaitingTaskHolder()

edm::WaitingTaskHolder::~WaitingTaskHolder ( )

inline

Definition at line 43 of file WaitingTaskHolder.h.

References doneWaiting(), and m_task.

                         {
      if (m_task) {
        doneWaiting(std::exception_ptr{});
      }
    }

WaitingTaskHolder() [3/4]

edm::WaitingTaskHolder::WaitingTaskHolder ( const WaitingTaskHolder &  iHolder )

inline

Definition at line 49 of file WaitingTaskHolder.h.

References edm::TaskBase::increment_ref_count(), and m_task.

                                                        : m_task(iHolder.m_task), m_group(iHolder.m_group) {
      m_task->increment_ref_count();
    }

WaitingTaskHolder() [4/4]

edm::WaitingTaskHolder::WaitingTaskHolder ( WaitingTaskHolder &&  iOther )

inline

Definition at line 53 of file WaitingTaskHolder.h.

                                                  : m_task(iOther.m_task), m_group(iOther.m_group) {
      iOther.m_task = nullptr;
    }

Member Function Documentation

doneWaiting()

void edm::WaitingTaskHolder::doneWaiting ( std::exception_ptr  iExcept )

inline

Definition at line 94 of file WaitingTaskHolder.h.

References edm::WaitingTask::dependentTaskFailed(), m_group, m_task, alignCSCRings::s, and TrackValidation_cff::task.

Referenced by edm::WaitingTaskList::add(), edm::EventProcessor::beginLumiAsync(), edm::EventProcessor::beginRunAsync(), edm::Worker::doTransformAsync(), edm::EventProcessor::endRunAsync(), edm::Worker::HandleExternalWorkExceptionTask::execute(), edm::StreamSchedule::finishedPaths(), edm::LuminosityBlockProcessingStatus::globalEndRunHolderDoneWaiting(), edm::EventProcessor::handleNextEventForStreamAsync(), edm::EventProcessor::handleNextItemAfterMergingRunEntries(), edm::WorkerT< T >::implDoTransformAsync(), edm::eventsetup::CallbackExternalWork< T, TAcquireFunc, TProduceFunc, TReturn, TRecord, TDecorator >::makeExceptionHandlerTask(), edm::eventsetup::CallbackBase< T, TProduceFunc, TReturn, TRecord, TDecorator >::prefetchAsyncImpl(), edm::StreamSchedule::processOneEventAsync(), edm::GlobalSchedule::processOneGlobalAsync(), edm::StreamSchedule::processOneStreamAsync(), edm::EventProcessor::streamBeginRunAsync(), edm::eventsetup::synchronousEventSetupForInstance(), edm::TransformerBase::transformImpAsync(), edm::OutputModuleCommunicatorT< T >::writeLumiAsync(), edm::OutputModuleCommunicatorT< T >::writeProcessBlockAsync(), edm::OutputModuleCommunicatorT< T >::writeRunAsync(), and ~WaitingTaskHolder().

                                               {
      if (iExcept) {
        m_task->dependentTaskFailed(iExcept);
      }
      //task_group::run can run the task before we finish
      // doneWaiting and some other thread might
      // try to reuse this object. Resetting
      // before spawn avoids problems
      auto task = m_task;
      m_task = nullptr;
      if (0 == task->decrement_ref_count()) {
        m_group->run([task]() {
          TaskSentry s{task};
          task->execute();
        });
      }
    }

group()

oneapi::tbb::task_group* edm::WaitingTaskHolder::group ( ) const

inlinenoexcept

since oneapi::tbb::task_group is thread safe, we can return it non-const from here since the object is not really part of the state of the holder

Definition at line 78 of file WaitingTaskHolder.h.

References m_group.

Referenced by edm::WaitingTaskList::add(), edm::EventProcessor::beginRunAsync(), evf::GlobalEvFOutputEventWriter::doOutputEventAsync(), edm::Worker::doTransformAsync(), edm::EventProcessor::handleNextEventForStreamAsync(), edm::waiting_task::detail::WaitingTaskChain< U >::lastTask(), edm::waiting_task::detail::WaitingTaskChain< U, T... >::lastTask(), edm::waiting_task::detail::WaitingTaskChain< Conditional< U >, T... >::lastTask(), edm::DelayedReaderInputProductResolver::prefetchAsync_(), edm::UnscheduledProductResolver::prefetchAsync_(), edm::TransformingProductResolver::prefetchAsync_(), edm::SwitchProducerProductResolver::prefetchAsync_(), edm::SwitchAliasProductResolver::prefetchAsync_(), edm::NoProcessProductResolver::prefetchAsync_(), edm::eventsetup::DataProxyTemplate< ESTestRecordJ, ESTestDataJ >::prefetchAsyncImpl(), edm::eventsetup::CallbackBase< T, TProduceFunc, TReturn, TRecord, TDecorator >::prefetchAsyncImpl(), edm::eventsetup::ESSourceDataProxyBase::prefetchAsyncImplTemplate(), edm::EventProcessor::processEventAsync(), edm::StreamSchedule::processOneEventAsync(), edm::GlobalSchedule::processOneGlobalAsync(), edm::Path::processOneOccurrenceAsync(), edm::StreamSchedule::processOneStreamAsync(), edm::EventProcessor::readAndMergeLumiEntriesAsync(), edm::EventProcessor::readAndMergeRunEntriesAsync(), edm::waiting_task::detail::WaitingTaskChain< U, T... >::runLast(), edm::waiting_task::detail::WaitingTaskChain< Conditional< U >, T... >::runLast(), edm::eventsetup::EventSetupsController::runOrQueueEventSetupForInstanceAsync(), edm::eventsetup::EventSetupRecordIOVQueue::startNewIOVAsync(), edm::EventProcessor::streamEndLumiAsync(), edm::EventProcessor::streamEndRunAsync(), edm::TransformerBase::transformImpAsync(), edm::OutputModuleCommunicatorT< T >::writeLumiAsync(), edm::OutputModuleCommunicatorT< T >::writeProcessBlockAsync(), and edm::OutputModuleCommunicatorT< T >::writeRunAsync().

{ return m_group; }

hasTask()

bool edm::WaitingTaskHolder::hasTask ( ) const

inlinenoexcept

Definition at line 74 of file WaitingTaskHolder.h.

References m_task.

Referenced by edm::eventsetup::EventSetupRecordIOVQueue::endIOVAsync().

{ return m_task != nullptr; }

operator=() [1/2]

WaitingTaskHolder& edm::WaitingTaskHolder::operator= ( const WaitingTaskHolder &  iRHS )

inline

Definition at line 57 of file WaitingTaskHolder.h.

References m_group, m_task, std::swap(), and createJobs::tmp.

                                                                {
      WaitingTaskHolder tmp(iRHS);
      std::swap(m_task, tmp.m_task);
      std::swap(m_group, tmp.m_group);
      return *this;
    }

operator=() [2/2]

WaitingTaskHolder& edm::WaitingTaskHolder::operator= ( WaitingTaskHolder &&  iRHS )

inline

Definition at line 64 of file WaitingTaskHolder.h.

References m_group, m_task, eostools::move(), std::swap(), and createJobs::tmp.

                                                           {
      WaitingTaskHolder tmp(std::move(iRHS));
      std::swap(m_task, tmp.m_task);
      std::swap(m_group, tmp.m_group);
      return *this;
    }

presetTaskAsFailed()

void edm::WaitingTaskHolder::presetTaskAsFailed ( std::exception_ptr  iExcept )

inline

Use in the case where you need to inform the parent task of a failure before some other child task which may be run later reports a different, but related failure. You must later call doneWaiting in the same thread passing the same exceptoin.

Definition at line 88 of file WaitingTaskHolder.h.

References edm::WaitingTask::dependentTaskFailed(), and m_task.

                                                      {
      if (iExcept) {
        m_task->dependentTaskFailed(iExcept);
      }
    }

release_no_decrement()

WaitingTask* edm::WaitingTaskHolder::release_no_decrement ( )

inlineprivatenoexcept

Definition at line 113 of file WaitingTaskHolder.h.

References m_task, and submitPVValidationJobs::t.

Referenced by edm::WaitingTaskList::add().

                                                 {
      auto t = m_task;
      m_task = nullptr;
      return t;
    }

taskHasFailed()

bool edm::WaitingTaskHolder::taskHasFailed ( ) const

inlinenoexcept

Definition at line 72 of file WaitingTaskHolder.h.

References edm::WaitingTask::exceptionPtr(), and m_task.

Referenced by edm::EventProcessor::beginRunAsync(), edm::EventProcessor::globalEndLumiAsync(), edm::EventProcessor::globalEndRunAsync(), edm::EventProcessor::handleEndLumiExceptions(), edm::EventProcessor::handleEndRunExceptions(), edm::EventProcessor::handleNextEventForStreamAsync(), edm::EventProcessor::handleNextItemAfterMergingRunEntries(), edm::EventProcessor::readNextEventForStream(), edm::EventProcessor::streamEndLumiAsync(), and edm::EventProcessor::streamEndRunAsync().

{ return static_cast<bool>(m_task->exceptionPtr()); }

Friends And Related Function Documentation

WaitingTaskList

friend class WaitingTaskList

friend

Definition at line 34 of file WaitingTaskHolder.h.

WaitingTaskWithArenaHolder

friend class WaitingTaskWithArenaHolder

friend

Definition at line 35 of file WaitingTaskHolder.h.

Member Data Documentation

m_group

oneapi::tbb::task_group* edm::WaitingTaskHolder::m_group

private

Definition at line 120 of file WaitingTaskHolder.h.

Referenced by doneWaiting(), group(), and operator=().

m_task

WaitingTask* edm::WaitingTaskHolder::m_task

private

Definition at line 119 of file WaitingTaskHolder.h.

Referenced by doneWaiting(), hasTask(), operator=(), presetTaskAsFailed(), release_no_decrement(), taskHasFailed(), WaitingTaskHolder(), and ~WaitingTaskHolder().