edm::WaitingTaskWithArenaHolder Class Reference

#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 const &iHolder)
	WaitingTaskWithArenaHolder (WaitingTaskWithArenaHolder &&iOther)
	~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

edm::WaitingTaskWithArenaHolder::WaitingTaskWithArenaHolder

(

)

Definition at line 16 of file WaitingTaskWithArenaHolder.cc.

: m_task(nullptr) {}

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

explicit

Definition at line 21 of file WaitingTaskWithArenaHolder.cc.

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

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

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())) {}

edm::WaitingTaskWithArenaHolder::~WaitingTaskWithArenaHolder

(

)

Definition at line 31 of file WaitingTaskWithArenaHolder.cc.

References doneWaiting(), and m_task.

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

edm::WaitingTaskWithArenaHolder::WaitingTaskWithArenaHolder

(

WaitingTaskWithArenaHolder const &

iHolder

)

Definition at line 37 of file WaitingTaskWithArenaHolder.cc.

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

      : 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();
    }
  }

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

void edm::WaitingTaskWithArenaHolder::doneWaiting

(

std::exception_ptr

iExcept

)

Definition at line 69 of file WaitingTaskWithArenaHolder.cc.

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

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

                                                                       {
    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();
        });
      });
    }
  }

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.

References m_group.

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

{ return m_group; }

bool edm::WaitingTaskWithArenaHolder::hasTask ( ) const

noexcept

Definition at line 112 of file WaitingTaskWithArenaHolder.cc.

References m_task.

{ return m_task != nullptr; }

WaitingTaskHolder edm::WaitingTaskWithArenaHolder::makeWaitingTaskHolderAndRelease

(

)

Definition at line 103 of file WaitingTaskWithArenaHolder.cc.

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

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

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

WaitingTaskWithArenaHolder & edm::WaitingTaskWithArenaHolder::operator=

(

const WaitingTaskWithArenaHolder &

iRHS

)

Definition at line 49 of file WaitingTaskWithArenaHolder.cc.

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

                                                                                                          {
    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;
  }

WaitingTaskWithArenaHolder & edm::WaitingTaskWithArenaHolder::operator=

(

WaitingTaskWithArenaHolder &&

iRHS

)

Definition at line 57 of file WaitingTaskWithArenaHolder.cc.

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

                                                                                                     {
    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;
  }

bool edm::WaitingTaskWithArenaHolder::taskHasFailed ( ) const

noexcept

Definition at line 110 of file WaitingTaskWithArenaHolder.cc.

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

{ return m_task->exceptionPtr() != nullptr; }

Member Data Documentation

std::shared_ptr<tbb::task_arena> edm::WaitingTaskWithArenaHolder::m_arena

private

Definition at line 89 of file WaitingTaskWithArenaHolder.h.

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

tbb::task_group* edm::WaitingTaskWithArenaHolder::m_group

private

Definition at line 88 of file WaitingTaskWithArenaHolder.h.

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

WaitingTask* edm::WaitingTaskWithArenaHolder::m_task

private

Definition at line 87 of file WaitingTaskWithArenaHolder.h.

Referenced by doneWaiting(), hasTask(), makeWaitingTaskHolderAndRelease(), operator=(), taskHasFailed(), WaitingTaskWithArenaHolder(), and ~WaitingTaskWithArenaHolder().