#include <WaitingTaskWithArenaHolder.h>

Public Member Functions
void	doneWaiting (std::exception_ptr iExcept)

tbb::task_group *	group () const

bool	hasTask () const noexcept

WaitingTaskHolder	makeWaitingTaskHolderAndRelease ()

WaitingTaskWithArenaHolder &	operator= (const WaitingTaskWithArenaHolder &iRHS)

WaitingTaskWithArenaHolder &	operator= (WaitingTaskWithArenaHolder &&iRHS)

bool	taskHasFailed () const noexcept

	WaitingTaskWithArenaHolder ()

	WaitingTaskWithArenaHolder (tbb::task_group &, WaitingTask *iTask)

	WaitingTaskWithArenaHolder (WaitingTaskHolder &&iTask)

	WaitingTaskWithArenaHolder (WaitingTaskWithArenaHolder &&iOther)

	WaitingTaskWithArenaHolder (WaitingTaskWithArenaHolder const &iHolder)

	~WaitingTaskWithArenaHolder ()

Private Attributes
std::shared_ptr< tbb::task_arena >	m_arena

tbb::task_group *	m_group

WaitingTask *	m_task

Detailed Description

Description: This holds a WaitingTask and can be passed to something the WaitingTask is waiting for. That allows that something to call doneWaiting to let the WaitingTask know it can run. The use of the arena allows one to call doneWaiting from a thread external to the arena where the task should run. The external thread might be a non-TBB thread.

Definition at line 34 of file WaitingTaskWithArenaHolder.h.

Constructor & Destructor Documentation

◆ WaitingTaskWithArenaHolder() [1/5]

edm::WaitingTaskWithArenaHolder::WaitingTaskWithArenaHolder ( )

Definition at line 16 of file WaitingTaskWithArenaHolder.cc.

16 : m_task(nullptr) {}

◆ WaitingTaskWithArenaHolder() [2/5]

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

explicit

Definition at line 21 of file WaitingTaskWithArenaHolder.cc.

       : m_task(iTask), m_group(&iGroup), m_arena(std::make_shared<tbb::task_arena>(tbb::task_arena::attach())) {
     m_task->increment_ref_count();
   }

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

◆ WaitingTaskWithArenaHolder() [3/5]

edm::WaitingTaskWithArenaHolder::WaitingTaskWithArenaHolder ( WaitingTaskHolder && iTask )

explicit

Definition at line 26 of file WaitingTaskWithArenaHolder.cc.

       : m_task(iTask.release_no_decrement()),
         m_group(iTask.group()),
         m_arena(std::make_shared<tbb::task_arena>(tbb::task_arena::attach())) {}

◆ ~WaitingTaskWithArenaHolder()

edm::WaitingTaskWithArenaHolder::~WaitingTaskWithArenaHolder ( )

Definition at line 31 of file WaitingTaskWithArenaHolder.cc.

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

References doneWaiting(), and m_task.

◆ WaitingTaskWithArenaHolder() [4/5]

edm::WaitingTaskWithArenaHolder::WaitingTaskWithArenaHolder ( WaitingTaskWithArenaHolder const & iHolder )

Definition at line 37 of file WaitingTaskWithArenaHolder.cc.

       : m_task(iHolder.m_task), m_group(iHolder.m_group), m_arena(iHolder.m_arena) {
     if (LIKELY(m_task != nullptr)) {
       m_task->increment_ref_count();
     }
   }

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

◆ WaitingTaskWithArenaHolder() [5/5]

edm::WaitingTaskWithArenaHolder::WaitingTaskWithArenaHolder ( WaitingTaskWithArenaHolder && iOther )

Definition at line 44 of file WaitingTaskWithArenaHolder.cc.

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

Member Function Documentation

◆ doneWaiting()

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

Definition at line 69 of file WaitingTaskWithArenaHolder.cc.

                                                                        {
     if (iExcept) {
       m_task->dependentTaskFailed(iExcept);
     }
     //enqueue can run the task before we finish
     // doneWaiting and some other thread might
     // try to reuse this object. Resetting
     // before enqueue avoids problems
     auto task = m_task;
     m_task = nullptr;
     if (0 == task->decrement_ref_count()) {
       // The enqueue call will cause a worker thread to be created in
       // the arena if there is not one already.
       m_arena->enqueue([task = task, group = m_group]() {
         group->run([task]() {
           TaskSentry s(task);
           task->execute();
         });
       });
     }
   }

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

Referenced by edm::Worker::runAcquireAfterAsyncPrefetch(), and ~WaitingTaskWithArenaHolder().

◆ group()

tbb::task_group* edm::WaitingTaskWithArenaHolder::group ( ) const

inline

since 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 83 of file WaitingTaskWithArenaHolder.h.

83 { return m_group; }

References m_group.

Referenced by doneWaiting(), and cms::cuda::impl::ScopedContextHolderHelper::pushNextTask().

◆ hasTask()

bool edm::WaitingTaskWithArenaHolder::hasTask ( ) const

noexcept

Definition at line 112 of file WaitingTaskWithArenaHolder.cc.

112 { return m_task != nullptr; }

References m_task.

◆ makeWaitingTaskHolderAndRelease()

WaitingTaskHolder edm::WaitingTaskWithArenaHolder::makeWaitingTaskHolderAndRelease ( )

Definition at line 103 of file WaitingTaskWithArenaHolder.cc.

                                                                                 {
     WaitingTaskHolder holder(*m_group, m_task);
     m_task->decrement_ref_count();
     m_task = nullptr;
     return holder;
   }

References edm::TaskBase::decrement_ref_count(), m_group, and m_task.

Referenced by evf::GlobalEvFOutputModule::acquire().

◆ operator=() [1/2]

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

Definition at line 49 of file WaitingTaskWithArenaHolder.cc.

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

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

◆ operator=() [2/2]

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

Definition at line 57 of file WaitingTaskWithArenaHolder.cc.

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