art::Scheduler Class Reference

#include "Scheduler.h"

Classes
struct	Config

Public Types
using	Parameters = fhicl::Table< Config >

Public Member Functions
	Scheduler (Parameters const &p)
ActionTable const &	actionTable () const noexcept
unsigned	num_threads () const noexcept
ScheduleID::size_type	num_schedules () const noexcept
bool	handleEmptyRuns () const noexcept
bool	handleEmptySubRuns () const noexcept
bool	errorOnMissingConsumes () const noexcept
bool	wantSummary () const noexcept
std::string const &	dataDependencyGraph () const noexcept
std::unique_ptr< GlobalTaskGroup >	global_task_group ()

Private Attributes
ActionTable	actionTable_
unsigned const	nThreads_
unsigned const	nSchedules_
unsigned const	stackSize_
bool const	handleEmptyRuns_
bool const	handleEmptySubRuns_
bool const	errorOnMissingConsumes_
bool const	wantSummary_
std::string const	dataDependencyGraph_

Detailed Description

Definition at line 15 of file Scheduler.h.

Member Typedef Documentation

using art::Scheduler::Parameters = fhicl::Table<Config>

Definition at line 69 of file Scheduler.h.

Constructor & Destructor Documentation

art::Scheduler::Scheduler ( Parameters const &  p )

explicit

Definition at line 49 of file Scheduler.cc.

References dataDependencyGraph_, errorOnMissingConsumes_, handleEmptyRuns_, handleEmptySubRuns_, art::Globals::instance(), nSchedules_, nThreads_, num_threads(), stackSize_, and wantSummary_.

    : actionTable_{ps().actionTable()}
    , nThreads_{adjust_num_threads(ps().num_threads())}
    , nSchedules_{ps().num_schedules()}
    , stackSize_{ps().stack_size()}
    , handleEmptyRuns_{ps().handleEmptyRuns()}
    , handleEmptySubRuns_{ps().handleEmptySubRuns()}
    , errorOnMissingConsumes_{ps().errorOnMissingConsumes()}
    , wantSummary_{ps().wantSummary()}
    , dataDependencyGraph_{ps().dataDependencyGraph()}
  {
    auto& globals = *Globals::instance();
    globals.setNThreads(nThreads_);
    globals.setNSchedules(nSchedules_);
  }

Member Function Documentation

ActionTable const& art::Scheduler::actionTable ( ) const

inlinenoexcept

Definition at line 73 of file Scheduler.h.

References actionTable_.

    {
      return actionTable_;
    }

std::string const& art::Scheduler::dataDependencyGraph ( ) const

inlinenoexcept

Definition at line 109 of file Scheduler.h.

References dataDependencyGraph_, and global_task_group().

    {
      return dataDependencyGraph_;
    }

bool art::Scheduler::errorOnMissingConsumes ( ) const

inlinenoexcept

Definition at line 99 of file Scheduler.h.

References errorOnMissingConsumes_.

    {
      return errorOnMissingConsumes_;
    }

std::unique_ptr< GlobalTaskGroup > art::Scheduler::global_task_group

(

)

Definition at line 66 of file Scheduler.cc.

References nThreads_, and stackSize_.

Referenced by dataDependencyGraph().

  {
    using tbb::global_control;
    auto value_of = [](auto const field) {
      return global_control::active_value(field);
    };
    auto group = std::make_unique<GlobalTaskGroup>(nThreads_, stackSize_);
    mf::LogInfo("MTdiagnostics")
      << "TBB has been configured to use:\n"
      << "  - a maximum of " << value_of(max_parallelism) << " threads\n"
      << "  - a stack size of " << value_of(thread_stack_size) << " bytes";
    return group;
  }

bool art::Scheduler::handleEmptyRuns ( ) const

inlinenoexcept

Definition at line 89 of file Scheduler.h.

References handleEmptyRuns_.

    {
      return handleEmptyRuns_;
    }

bool art::Scheduler::handleEmptySubRuns ( ) const

inlinenoexcept

Definition at line 94 of file Scheduler.h.

References handleEmptySubRuns_.

    {
      return handleEmptySubRuns_;
    }

ScheduleID::size_type art::Scheduler::num_schedules ( ) const

inlinenoexcept

Definition at line 84 of file Scheduler.h.

References nSchedules_.

    {
      return nSchedules_;
    }

unsigned art::Scheduler::num_threads ( ) const

inlinenoexcept

Definition at line 79 of file Scheduler.h.

References nThreads_.

Referenced by Scheduler().

    {
      return nThreads_;
    }

bool art::Scheduler::wantSummary ( ) const

inlinenoexcept

Definition at line 104 of file Scheduler.h.

References wantSummary_.

    {
      return wantSummary_;
    }

Member Data Documentation

ActionTable art::Scheduler::actionTable_

private

Definition at line 119 of file Scheduler.h.

Referenced by actionTable().

std::string const art::Scheduler::dataDependencyGraph_

private

Definition at line 127 of file Scheduler.h.

Referenced by dataDependencyGraph(), and Scheduler().

bool const art::Scheduler::errorOnMissingConsumes_

private

Definition at line 125 of file Scheduler.h.

Referenced by errorOnMissingConsumes(), and Scheduler().

bool const art::Scheduler::handleEmptyRuns_

private

Definition at line 123 of file Scheduler.h.

Referenced by handleEmptyRuns(), and Scheduler().

bool const art::Scheduler::handleEmptySubRuns_

private

Definition at line 124 of file Scheduler.h.

Referenced by handleEmptySubRuns(), and Scheduler().

unsigned const art::Scheduler::nSchedules_

private

Definition at line 121 of file Scheduler.h.

Referenced by num_schedules(), and Scheduler().

unsigned const art::Scheduler::nThreads_

private

Definition at line 120 of file Scheduler.h.

Referenced by global_task_group(), num_threads(), and Scheduler().

unsigned const art::Scheduler::stackSize_

private

Definition at line 122 of file Scheduler.h.

Referenced by global_task_group(), and Scheduler().

bool const art::Scheduler::wantSummary_

private

Definition at line 126 of file Scheduler.h.

Referenced by Scheduler(), and wantSummary().

---

The documentation for this class was generated from the following files:

• art/Framework/EventProcessor/Scheduler.h
• art/Framework/EventProcessor/Scheduler.cc