edm::impl::WaitingThread Class Reference

#include <WaitingThreadPool.h>

Public Member Functions
WaitingThread &	operator= (WaitingThread &&)=delete
WaitingThread &	operator= (WaitingThread const &)=delete
template<typename F , typename G >
void	run (WaitingTaskWithArenaHolder holder, F &&func, G &&errorContextFunc, std::shared_ptr< WaitingThread > thisPtr)
	WaitingThread ()
	WaitingThread (WaitingThread const &)=delete
	WaitingThread (WaitingThread &&)=delete
	~WaitingThread () noexcept

Private Member Functions
void	stopThread ()
void	threadLoop () noexcept

Private Attributes
std::condition_variable	cond_
std::function< void()>	func_
std::mutex	mutex_
bool	stopThread_ = false
std::shared_ptr< WaitingThread >	thisPtr_
std::thread	thread_

Detailed Description

Definition at line 14 of file WaitingThreadPool.h.

Constructor & Destructor Documentation

WaitingThread() [1/3]

edm::impl::WaitingThread::WaitingThread

(

)

Definition at line 9 of file WaitingThreadPool.cc.

References cms::cuda::assert(), ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), submitPVResolutionJobs::err, thread_, and threadLoop().

                               {
    thread_ = std::thread(&WaitingThread::threadLoop, this);
    static constexpr auto poolName = "edm async pool";
    // pthread_setname_np() string length is limited to 16 characters,
    // including the null termination
    static_assert(std::string_view(poolName).size() < 16);

    int err = pthread_setname_np(thread_.native_handle(), poolName);
    // According to the glibc documentation, the only error
    // pthread_setname_np() can return is about the argument C-string
    // being too long. We already check above the C-string is shorter
    // than the limit was at the time of writing. In order to capture
    // if the limit shortens, or other error conditions get added,
    // let's assert() anyway (exception feels overkill)
    assert(err == 0);
  }

~WaitingThread()

edm::impl::WaitingThread::~WaitingThread ( )

noexcept

Definition at line 26 of file WaitingThreadPool.cc.

References CMS_SA_ALLOW, stopThread(), and thread_.

                                         {
    // When we are shutting down, we don't care about any possible
    // system errors anymore
    CMS_SA_ALLOW try {
      stopThread();
      thread_.join();
    } catch (...) {
    }
  }

WaitingThread() [2/3]

edm::impl::WaitingThread::WaitingThread ( WaitingThread const &  )

delete

WaitingThread() [3/3]

edm::impl::WaitingThread::WaitingThread ( WaitingThread &&  )

delete

Member Function Documentation

operator=() [1/2]

WaitingThread& edm::impl::WaitingThread::operator= ( WaitingThread &&  )

delete

operator=() [2/2]

WaitingThread& edm::impl::WaitingThread::operator= ( WaitingThread const &  )

delete

run()

template<typename F , typename G >

void edm::impl::WaitingThread::run ( WaitingTaskWithArenaHolder  holder, F &&  func, G &&  errorContextFunc, std::shared_ptr< WaitingThread >  thisPtr  )

inline

Definition at line 25 of file WaitingThreadPool.h.

References cond_, MillePedeFileConverter_cfg::e, EcalMonitorTask_cff::func, func_, eostools::move(), mutex_, edm::WaitingTaskWithArenaHolder::presetTaskAsFailed(), thisPtr_, and edm::convertException::wrap().

Referenced by Types.EventID::cppID(), and Types.LuminosityBlockID::cppID().

                                                     {
        std::unique_lock lk(mutex_);
        func_ = [holder = std::move(holder),
                 func = std::forward<F>(func),
                 errorContext = std::forward<G>(errorContextFunc)]() mutable {
          try {
            convertException::wrap([&func]() { func(); });
          } catch (cms::Exception& e) {
            e.addContext(errorContext());
            // doneWaiting() is intentionally not called here. The
            // reference count decrement must be done only in
            // threadLoop() (see the comment there)
            holder.presetTaskAsFailed(std::current_exception());
          }
        };
        thisPtr_ = std::move(thisPtr);
        cond_.notify_one();
      }

stopThread()

void edm::impl::WaitingThread::stopThread ( )

inlineprivate

Definition at line 48 of file WaitingThreadPool.h.

References cond_, mutex_, and stopThread_.

Referenced by ~WaitingThread().

                        {
        std::unique_lock lk(mutex_);
        stopThread_ = true;
        cond_.notify_one();
      }

threadLoop()

void edm::impl::WaitingThread::threadLoop ( )

privatenoexcept

Definition at line 36 of file WaitingThreadPool.cc.

References cms::cuda::assert(), cond_, func_, mutex_, or, stopThread_, edm::swap(), and thisPtr_.

Referenced by WaitingThread().

                                          {
    std::unique_lock lk(mutex_);

    while (true) {
      cond_.wait(lk, [this]() { return static_cast<bool>(func_) or stopThread_; });
      if (stopThread_) {
        // There should be no way to stop the thread when it as the
        // func_ assigned, but let's make sure
        assert(not thisPtr_);
        break;
      }
      func_();
      // Must return this WaitingThread to the ReusableObjectHolder in
      // the WaitingThreadPool before resettting func_ (that holds the
      // WaitingTaskWithArenaHolder, that enables the progress in the
      // TBB thread pool) in order to meet the requirement of
      // ReusableObjectHolder destructor that there are no outstanding
      // objects.
      thisPtr_.reset();
      decltype(func_)().swap(func_);
    }
  }

Member Data Documentation

cond_

std::condition_variable edm::impl::WaitingThread::cond_

private

Definition at line 58 of file WaitingThreadPool.h.

Referenced by run(), stopThread(), and threadLoop().

func_

std::function<void()> edm::impl::WaitingThread::func_

private

Definition at line 59 of file WaitingThreadPool.h.

Referenced by run(), and threadLoop().

mutex_

std::mutex edm::impl::WaitingThread::mutex_

private

Definition at line 57 of file WaitingThreadPool.h.

Referenced by run(), stopThread(), and threadLoop().

stopThread_

bool edm::impl::WaitingThread::stopThread_ = false

private

Definition at line 63 of file WaitingThreadPool.h.

Referenced by stopThread(), and threadLoop().

thisPtr_

std::shared_ptr<WaitingThread> edm::impl::WaitingThread::thisPtr_

private

Definition at line 62 of file WaitingThreadPool.h.

Referenced by run(), and threadLoop().

thread_

std::thread edm::impl::WaitingThread::thread_

private

Definition at line 56 of file WaitingThreadPool.h.

Referenced by WaitingThread(), and ~WaitingThread().