FWCore/Concurrency/interface/WaitingTaskHolder.h - master - githubmirror/cmssw

FWCore/Concurrency/interface/WaitingTaskHolder.h
124 строки4 KB
Matti Kortelainen
Avoid releasing WaitingTask too early in case of exception in WaitingThreadPool
08 июл 2024, 23:34
08 июл 2024, 23:34814bf9c
#ifndef FWCore_Concurrency_WaitingTaskHolder_h
#define FWCore_Concurrency_WaitingTaskHolder_h
// -*- C++ -*-
//
// Package:     FWCore/Concurrency
// Class  :     WaitingTaskHolder
//
/**\class WaitingTaskHolder WaitingTaskHolder.h "WaitingTaskHolder.h"

 Description: [one line class summary]

 Usage:
    <usage>

*/
//
// Original Author:  FWCore
//         Created:  Fri, 18 Nov 2016 20:30:42 GMT
//

// system include files
#include <cassert>
#include "oneapi/tbb/task_group.h"

// user include files
#include "FWCore/Concurrency/interface/WaitingTask.h"
#include "FWCore/Utilities/interface/thread_safety_macros.h"

// forward declarations

namespace edm {
  class WaitingTaskHolder {
  public:
    friend class WaitingTaskList;
    friend class WaitingTaskWithArenaHolder;

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

    explicit WaitingTaskHolder(oneapi::tbb::task_group& iGroup, edm::WaitingTask* iTask) noexcept
        : m_task(iTask), m_group(&iGroup) {
      m_task->increment_ref_count();
    }
    ~WaitingTaskHolder() noexcept {
      if (m_task) {
        doneWaiting(std::exception_ptr{});
      }
    }

    WaitingTaskHolder(const WaitingTaskHolder& iHolder) noexcept : m_task(iHolder.m_task), m_group(iHolder.m_group) {
      m_task->increment_ref_count();
    }

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

    WaitingTaskHolder& operator=(const WaitingTaskHolder& iRHS) noexcept {
      WaitingTaskHolder tmp(iRHS);
      std::swap(m_task, tmp.m_task);
      std::swap(m_group, tmp.m_group);
      return *this;
    }

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

    // ---------- const member functions ---------------------
    bool taskHasFailed() const noexcept { return static_cast<bool>(m_task->exceptionPtr()); }

    bool hasTask() const noexcept { return m_task != nullptr; }
    /** 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
     */
    CMS_SA_ALLOW oneapi::tbb::task_group* group() const noexcept { return m_group; }
    // ---------- static member functions --------------------

    // ---------- member functions ---------------------------

    /** 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 exception.
     */
    void presetTaskAsFailed(std::exception_ptr iExcept) noexcept {
      if (iExcept) {
        m_task->dependentTaskFailed(iExcept);
      }
    }

    void doneWaiting(std::exception_ptr iExcept) noexcept {
      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();
        });
      }
    }

  private:
    WaitingTask* release_no_decrement() noexcept {
      auto t = m_task;
      m_task = nullptr;
      return t;
    }
    // ---------- member data --------------------------------
    WaitingTask* m_task;
    oneapi::tbb::task_group* m_group;
  };
}  // namespace edm

#endif