PTL::TaskRunManager Class Reference

#include <TaskRunManager.hh>

Inheritance diagram for PTL::TaskRunManager:

Public Types
typedef TaskRunManager *	pointer

Public Member Functions
virtual size_t	GetNumberActiveThreads () const
virtual int	GetNumberOfThreads () const
TaskManager *	GetTaskManager () const
ThreadPool *	GetThreadPool () const
int	GetVerbose () const
virtual void	Initialize (uint64_t n=std::thread::hardware_concurrency())
bool	IsInitialized () const
void	SetVerbose (int val)
	TaskRunManager (bool useTBB=false)
virtual void	Terminate ()
virtual	~TaskRunManager ()=default

Static Public Member Functions
static TaskRunManager *	GetInstance (bool useTBB=false)
static TaskRunManager *	GetMasterRunManager (bool useTBB=false)

Protected Attributes
bool	m_is_initialized = false
TaskManager *	m_task_manager = nullptr
VUserTaskQueue *	m_task_queue = nullptr
ThreadPool *	m_thread_pool = nullptr
int	m_verbose = 0
uint64_t	m_workers = 0

Static Private Member Functions
static pointer &	GetPrivateMasterRunManager (bool init, bool useTBB=false)

Detailed Description

Definition at line 44 of file TaskRunManager.hh.

Member Typedef Documentation

pointer

typedef TaskRunManager* PTL::TaskRunManager::pointer

Definition at line 47 of file TaskRunManager.hh.

Constructor & Destructor Documentation

TaskRunManager()

TaskRunManager::TaskRunManager ( bool  useTBB = false )

explicit

Definition at line 65 of file TaskRunManager.cc.

: m_workers(std::thread::hardware_concurrency())
{
    if(!GetPrivateMasterRunManager(false))
    {
        GetPrivateMasterRunManager(false) = this;
    }
 
#if defined(PTL_USE_TBB)
    auto _useTBB = GetEnv<bool>("PTL_FORCE_TBB", GetEnv<bool>("FORCE_TBB", useTBB));
    if(_useTBB)
        useTBB = true;
#endif
 
    // handle TBB
    ThreadPool::set_use_tbb(useTBB);
    m_workers = GetEnv<uint64_t>("PTL_NUM_THREADS", m_workers);
}

References GetPrivateMasterRunManager(), m_workers, and PTL::ThreadPool::set_use_tbb().

Referenced by GetPrivateMasterRunManager().

~TaskRunManager()

virtual PTL::TaskRunManager::~TaskRunManager ( )

virtualdefault

Member Function Documentation

GetInstance()

TaskRunManager * TaskRunManager::GetInstance ( bool  useTBB = false )

static

Definition at line 58 of file TaskRunManager.cc.

{
    return GetMasterRunManager(useTBB);
}

References GetMasterRunManager().

GetMasterRunManager()

TaskRunManager * TaskRunManager::GetMasterRunManager ( bool  useTBB = false )

static

Definition at line 49 of file TaskRunManager.cc.

{
    static pointer& _instance = GetPrivateMasterRunManager(true, useTBB);
    return _instance;
}

References GetPrivateMasterRunManager().

Referenced by PTL::internal::get_default_threadpool(), PTL::TaskManager::GetInstance(), GetInstance(), and PTL::VUserTaskQueue::VUserTaskQueue().

GetNumberActiveThreads()

virtual size_t PTL::TaskRunManager::GetNumberActiveThreads ( ) const

inlinevirtual

Reimplemented in G4TaskRunManager.

Definition at line 62 of file TaskRunManager.hh.

    {
        return (m_thread_pool) ? m_thread_pool->size() : 0;
    }

References m_thread_pool, and PTL::ThreadPool::size().

Referenced by G4TaskRunManager::GetNumberActiveThreads().

GetNumberOfThreads()

virtual int PTL::TaskRunManager::GetNumberOfThreads ( ) const

inlinevirtual

Reimplemented in G4TaskRunManager.

Definition at line 58 of file TaskRunManager.hh.

    {
        return (m_thread_pool) ? m_thread_pool->size() : 0;
    }

References m_thread_pool, and PTL::ThreadPool::size().

Referenced by G4TaskRunManager::GetNumberOfThreads(), and PTL::VUserTaskQueue::VUserTaskQueue().

GetPrivateMasterRunManager()

TaskRunManager::pointer & TaskRunManager::GetPrivateMasterRunManager ( bool  init, bool  useTBB = false  )

staticprivate

Definition at line 40 of file TaskRunManager.cc.

{
    static pointer _instance = (init) ? new TaskRunManager(useTBB) : nullptr;
    return _instance;
}

References TaskRunManager().

Referenced by GetMasterRunManager(), and TaskRunManager().

GetTaskManager()

TaskManager * PTL::TaskRunManager::GetTaskManager ( ) const

inline

Definition at line 72 of file TaskRunManager.hh.

{ return m_task_manager; }

References m_task_manager.

Referenced by G4TaskRunManagerKernel::ExecuteWorkerInit(), G4TaskRunManagerKernel::ExecuteWorkerTask(), and G4TaskRunManagerKernel::InitializeWorker().

GetThreadPool()

ThreadPool * PTL::TaskRunManager::GetThreadPool ( ) const

inline

Definition at line 71 of file TaskRunManager.hh.

{ return m_thread_pool; }

References m_thread_pool.

Referenced by PTL::internal::get_default_threadpool(), G4TaskRunManagerKernel::InitializeWorker(), and G4TaskRunManager::SetNumberOfThreads().

GetVerbose()

int PTL::TaskRunManager::GetVerbose ( ) const

inline

Definition at line 74 of file TaskRunManager.hh.

{ return m_verbose; }

References m_verbose.

Referenced by G4TaskRunManager::InitializeThreadPool().

Initialize()

void TaskRunManager::Initialize ( uint64_t  n = std::thread::hardware_concurrency() )

virtual

Reimplemented in G4TaskRunManager.

Definition at line 87 of file TaskRunManager.cc.

{
    m_workers = n;
 
    // create threadpool if needed + task manager
    if(!m_thread_pool)
    {
        if(m_verbose > 0)
            std::cout << "TaskRunManager :: Creating thread pool..." << std::endl;
        m_thread_pool = new ThreadPool(m_workers, m_task_queue);
        if(m_verbose > 0)
            std::cout << "TaskRunManager :: Creating task manager..." << std::endl;
        m_task_manager = new TaskManager(m_thread_pool);
    }
    // or resize
    else if(m_workers != m_thread_pool->size())
    {
        if(m_verbose > 0)
        {
            std::cout << "TaskRunManager :: Resizing thread pool from "
                      << m_thread_pool->size() << " to " << m_workers << " threads ..."
                      << std::endl;
        }
        m_thread_pool->resize(m_workers);
    }
 
    // create the joiners
    if(ThreadPool::using_tbb())
    {
        if(m_verbose > 0)
            std::cout << "TaskRunManager :: Using TBB..." << std::endl;
    }
    else
    {
        if(m_verbose > 0)
            std::cout << "TaskRunManager :: Using ThreadPool..." << std::endl;
    }
 
    m_is_initialized = true;
    if(m_verbose > 0)
        std::cout << "TaskRunManager :: initialized..." << std::endl;
}

References m_is_initialized, m_task_manager, m_task_queue, m_thread_pool, m_verbose, m_workers, CLHEP::detail::n, PTL::ThreadPool::resize(), PTL::ThreadPool::size(), and PTL::ThreadPool::using_tbb().

Referenced by G4TaskRunManager::Initialize(), and G4TaskRunManager::InitializeThreadPool().

IsInitialized()

bool PTL::TaskRunManager::IsInitialized ( ) const

inline

Definition at line 73 of file TaskRunManager.hh.

{ return m_is_initialized; }

References m_is_initialized.

SetVerbose()

void PTL::TaskRunManager::SetVerbose ( int  val )

inline

Definition at line 75 of file TaskRunManager.hh.

{ m_verbose = val; }

References m_verbose.

Referenced by G4TaskRunManager::InitializeThreadPool().

Terminate()

void TaskRunManager::Terminate ( )

virtual

Definition at line 133 of file TaskRunManager.cc.

{
    m_is_initialized = false;
    if(m_thread_pool)
        m_thread_pool->destroy_threadpool();
    delete m_task_manager;
    delete m_thread_pool;
    m_task_manager = nullptr;
    m_thread_pool  = nullptr;
}

References PTL::ThreadPool::destroy_threadpool(), m_is_initialized, m_task_manager, and m_thread_pool.

Referenced by G4TaskRunManager::~G4TaskRunManager().

Field Documentation

m_is_initialized

bool PTL::TaskRunManager::m_is_initialized = false

protected

Definition at line 87 of file TaskRunManager.hh.

Referenced by Initialize(), IsInitialized(), and Terminate().

m_task_manager

TaskManager* PTL::TaskRunManager::m_task_manager = nullptr

protected

Definition at line 92 of file TaskRunManager.hh.

Referenced by GetTaskManager(), Initialize(), and Terminate().

m_task_queue

VUserTaskQueue* PTL::TaskRunManager::m_task_queue = nullptr

protected

Definition at line 90 of file TaskRunManager.hh.

Referenced by Initialize().

m_thread_pool

ThreadPool* PTL::TaskRunManager::m_thread_pool = nullptr

protected

Definition at line 91 of file TaskRunManager.hh.

Referenced by GetNumberActiveThreads(), GetNumberOfThreads(), GetThreadPool(), Initialize(), and Terminate().

m_verbose

int PTL::TaskRunManager::m_verbose = 0

protected

Definition at line 88 of file TaskRunManager.hh.

Referenced by GetVerbose(), Initialize(), and SetVerbose().

m_workers

uint64_t PTL::TaskRunManager::m_workers = 0

protected

Definition at line 89 of file TaskRunManager.hh.

Referenced by Initialize(), and TaskRunManager().

---

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

• source/externals/ptl/include/PTL/TaskRunManager.hh
• source/externals/ptl/src/TaskRunManager.cc