Nektar::Thread::ThreadManagerBoost Class Reference

Implementation of ThreadManager using Boost threads. More...

#include <ThreadBoost.h>

Inheritance diagram for Nektar::Thread::ThreadManagerBoost:

Public Member Functions
	ThreadManagerBoost (unsigned int numWorkers)
	Constructs a ThreadManagerBoost. More...
virtual	~ThreadManagerBoost ()
	Shuts down threading. More...
Public Member Functions inherited from Nektar::Thread::ThreadManager
virtual	~ThreadManager ()
	Destructor. More...
void	QueueJobs (std::vector< ThreadJob * > &joblist)
	Pass a list of tasklets to the master queue. More...
void	QueueJob (ThreadJob *job)
	Pass a single job to the master queue. More...
unsigned int	GetNumWorkers ()
	Return the number of active workers. More...
unsigned int	GetWorkerNum ()
	Returns the worker number of the executing thread. More...
void	SetNumWorkers (const unsigned int num)
	Sets the number of active workers. More...
void	SetNumWorkers ()
	Sets the number of active workers to the maximum. More...
unsigned int	GetMaxNumWorkers ()
	Gets the maximum available number of threads. More...
void	Wait ()
	Waits until all queued jobs are finished. More...
void	SetChunkSize (unsigned int chnk)
	Controls how many jobs are sent to each worker at a time. More...
void	SetSchedType (SchedType s)
	Sets the current scheduling algorithm. More...
bool	InThread ()
	Indicates whether the code is in a worker thread or not. More...
void	Hold ()
	A calling threads holds until all active threads call this method. More...
const std::string &	GetType ()
	Returns a description of the type of threading. More...
bool	IsInitialised ()
	ThreadManager implementation. More...
int	GetThrFromPartition (int pPartition)
int	GetRankFromPartition (int pPartition)
int	GetPartitionFromRankThr (int pRank, unsigned int pThr)

Static Public Member Functions
static ThreadManagerSharedPtr	Create (unsigned int numT)
	Called by the factory method. More...

Protected Member Functions
virtual void	v_QueueJobs (std::vector< ThreadJob * > &joblist) override
virtual void	v_QueueJob (ThreadJob *job) override
virtual unsigned int	v_GetNumWorkers () override
virtual unsigned int	v_GetWorkerNum () override
virtual void	v_SetNumWorkers (const unsigned int num) override
virtual void	v_SetNumWorkers () override
virtual unsigned int	v_GetMaxNumWorkers () override
virtual void	v_Wait () override
virtual void	v_SetChunkSize (unsigned int chnk) override
virtual void	v_SetSchedType (SchedType s) override
virtual bool	v_InThread () override
virtual void	v_Hold () override
virtual const std::string &	v_GetType () const override
Protected Member Functions inherited from Nektar::Thread::ThreadManager
virtual bool	v_IsInitialised ()

Private Member Functions
	ThreadManagerBoost ()
	ThreadManagerBoost (const ThreadManagerBoost &)
bool	IsWorking ()
void	SetNumWorkersImpl (const unsigned int num)

Private Attributes
const unsigned int	m_numThreads
unsigned int	m_numWorkers
std::queue< ThreadJob * >	m_masterQueue
boost::mutex	m_masterQueueMutex
boost::mutex	m_masterActiveMutex
boost::condition_variable	m_masterQueueCondVar
boost::condition_variable	m_masterActiveCondVar
ThreadWorkerBoost **	m_threadList
boost::thread **	m_threadThreadList
boost::thread::id	m_masterThreadId
bool *	m_threadBusyList
bool *	m_threadActiveList
unsigned int	m_chunkSize
SchedType	m_schedType
boost::barrier *	m_barrier
std::map< boost::thread::id, unsigned int >	m_threadMap
std::string	m_type

Static Private Attributes
static std::string	className

Friends
class	ThreadWorkerBoost

Detailed Description

Implementation of ThreadManager using Boost threads.

Definition at line 58 of file ThreadBoost.h.

Constructor & Destructor Documentation

ThreadManagerBoost() [1/3]

Nektar::Thread::ThreadManagerBoost::ThreadManagerBoost

(

unsigned int

numT

)

Constructs a ThreadManagerBoost.

Parameters

numWorkers

The number of threads to start (including master thread).

Note

Do not use, use factory instead.

Definition at line 55 of file ThreadBoost.cpp.

    : m_numThreads(numT), m_numWorkers(numT), m_masterQueue(),
      m_masterQueueMutex(), m_masterActiveMutex(), m_masterQueueCondVar(),
      m_masterActiveCondVar(), m_chunkSize(1), m_schedType(e_dynamic),
      m_threadMap()
{
    using namespace std;
    try
    {
        m_threadList       = new ThreadWorkerBoost *[m_numThreads];
        m_threadThreadList = new boost::thread *[m_numThreads];
        m_threadBusyList   = new bool[m_numThreads];
        m_threadActiveList = new bool[m_numThreads];
    }
    catch (exception &e)
    {
        cerr << "Exception while allocating thread storage: " << e.what()
             << endl;
        abort();
    }
    unsigned int i = 0;
    while (i < m_numThreads)
    {
        ThreadWorkerBoost *tw;
        try
        {
            tw = new ThreadWorkerBoost(this, i);
        }
        catch (exception &e)
        {
            cerr << "Exception while allocating worker threads: " << e.what()
                 << endl;
            abort();
        }
 
        m_threadList[i]       = tw;
        m_threadBusyList[i]   = false;
        m_threadActiveList[i] = true;
 
        try
        {
            m_threadThreadList[i] = new boost::thread(boost::ref(*tw));
            boost::thread::id id  = m_threadThreadList[i]->get_id();
            m_threadMap[id]       = i;
        }
        catch (...)
        {
            std::cerr << "Exception while creating worker threads" << std::endl;
            abort();
        }
        i++;
    }
    m_masterThreadId = boost::this_thread::get_id();
    m_barrier        = new boost::barrier(m_numWorkers > 0 ? m_numWorkers : 1);
    m_type           = "Threading with Boost";
}

References m_barrier, m_masterThreadId, m_numThreads, m_numWorkers, m_threadActiveList, m_threadBusyList, m_threadList, m_threadMap, m_threadThreadList, m_type, and ThreadWorkerBoost.

~ThreadManagerBoost()

Nektar::Thread::ThreadManagerBoost::~ThreadManagerBoost ( )

virtual

Shuts down threading.

Terminates all running threads (they will finish their current job), releases resources and destructs.

Definition at line 116 of file ThreadBoost.cpp.

{
    // This is an immediate teardown.  We attempt to kill everything.
    // we daren't lock anything as we may cause a deadlock
    for (unsigned int i = 0; i < m_numThreads; i++)
    {
        m_threadList[i]->Stop();
    }
 
    m_masterQueueCondVar.notify_all();
    m_masterActiveCondVar.notify_all();
    for (unsigned int i = 0; i < m_numThreads; i++)
    {
        m_threadThreadList[i]->join();
        delete m_threadThreadList[i];
        delete m_threadList[i];
    }
 
    delete[] m_threadList;
    delete[] m_threadThreadList;
    delete[] m_threadActiveList;
    delete[] m_threadBusyList;
    delete m_barrier;
}

References m_barrier, m_masterActiveCondVar, m_masterQueueCondVar, m_numThreads, m_threadActiveList, m_threadBusyList, m_threadList, m_threadThreadList, and Nektar::Thread::ThreadWorkerBoost::Stop().

ThreadManagerBoost() [2/3]

Nektar::Thread::ThreadManagerBoost::ThreadManagerBoost ( )

private

Referenced by Create().

ThreadManagerBoost() [3/3]

Nektar::Thread::ThreadManagerBoost::ThreadManagerBoost ( const ThreadManagerBoost &  )

private

Member Function Documentation

Create()

static ThreadManagerSharedPtr Nektar::Thread::ThreadManagerBoost::Create ( unsigned int  numT )

inlinestatic

Called by the factory method.

Definition at line 72 of file ThreadBoost.h.

    {
        return std::shared_ptr<ThreadManager>(new ThreadManagerBoost(numT));
    }

References ThreadManagerBoost().

IsWorking()

bool Nektar::Thread::ThreadManagerBoost::IsWorking ( )

private

Definition at line 166 of file ThreadBoost.cpp.

{
    bool working = false;
    Lock masterActiveLock(m_masterActiveMutex);
    for (unsigned int i = 0; i < m_numWorkers; i++)
    {
        working = working || m_threadBusyList[i];
    }
    return working;
}

References m_masterActiveMutex, m_numWorkers, and m_threadBusyList.

Referenced by v_Wait().

SetNumWorkersImpl()

void Nektar::Thread::ThreadManagerBoost::SetNumWorkersImpl ( const unsigned int  num )

private

Definition at line 243 of file ThreadBoost.cpp.

{
    Lock masterActiveLock(m_masterActiveMutex); // locks the active
 
    if (m_numWorkers == num)
    {
        return;
    }
 
    delete m_barrier;
    m_barrier = new boost::barrier(num > 0 ? num : 1);
 
    m_numWorkers = num;
    for (unsigned int i = 0; i < m_numThreads; i++)
    {
        m_threadActiveList[i] = i < m_numWorkers ? true : false;
    }
    m_masterActiveCondVar.notify_all();
} // Lock on active released here

References m_barrier, m_masterActiveCondVar, m_masterActiveMutex, m_numThreads, m_numWorkers, and m_threadActiveList.

Referenced by v_SetNumWorkers().

v_GetMaxNumWorkers()

unsigned int Nektar::Thread::ThreadManagerBoost::v_GetMaxNumWorkers ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 285 of file ThreadBoost.cpp.

{
    return m_numThreads;
}

References m_numThreads.

v_GetNumWorkers()

unsigned int Nektar::Thread::ThreadManagerBoost::v_GetNumWorkers ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 226 of file ThreadBoost.cpp.

{
    return m_numWorkers;
}

References m_numWorkers.

v_GetType()

const std::string & Nektar::Thread::ThreadManagerBoost::v_GetType ( ) const

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 301 of file ThreadBoost.cpp.

{
    return m_type;
}

References m_type.

v_GetWorkerNum()

unsigned int Nektar::Thread::ThreadManagerBoost::v_GetWorkerNum ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 234 of file ThreadBoost.cpp.

{
    boost::thread::id id = boost::this_thread::get_id();
    return m_threadMap[id];
}

References m_threadMap.

v_Hold()

void Nektar::Thread::ThreadManagerBoost::v_Hold ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 293 of file ThreadBoost.cpp.

{
    m_barrier->wait();
}

References m_barrier.

v_InThread()

bool Nektar::Thread::ThreadManagerBoost::v_InThread ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 198 of file ThreadBoost.cpp.

{
    boost::thread::id id = boost::this_thread::get_id();
    return (id != m_masterThreadId);
}

References m_masterThreadId.

v_QueueJob()

void Nektar::Thread::ThreadManagerBoost::v_QueueJob ( ThreadJob *  job )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 156 of file ThreadBoost.cpp.

{
    Lock masterQueueLock(m_masterQueueMutex); // locks the queue
    m_masterQueue.push(job);
    m_masterQueueCondVar.notify_all(); // alert a waiting thread.
} // queue unlocked

References m_masterQueue, m_masterQueueCondVar, and m_masterQueueMutex.

v_QueueJobs()

void Nektar::Thread::ThreadManagerBoost::v_QueueJobs ( std::vector< ThreadJob * > &  joblist )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 144 of file ThreadBoost.cpp.

{
    std::vector<ThreadJob *>::iterator it;
    for (it = joblist.begin(); it < joblist.end(); ++it)
    {
        QueueJob(*it);
    }
}

References Nektar::Thread::ThreadManager::QueueJob().

v_SetChunkSize()

void Nektar::Thread::ThreadManagerBoost::v_SetChunkSize ( unsigned int  chnk )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 180 of file ThreadBoost.cpp.

{
    Lock masterQueueLock(m_masterQueueMutex); // locks the queue
    m_chunkSize = std::max(chnk, 1U);
}

References m_chunkSize, and m_masterQueueMutex.

v_SetNumWorkers() [1/2]

void Nektar::Thread::ThreadManagerBoost::v_SetNumWorkers ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 277 of file ThreadBoost.cpp.

{
    SetNumWorkersImpl(m_numThreads);
}

References m_numThreads, and SetNumWorkersImpl().

v_SetNumWorkers() [2/2]

void Nektar::Thread::ThreadManagerBoost::v_SetNumWorkers ( const unsigned int  num )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 266 of file ThreadBoost.cpp.

{
    unsigned int n;
    n = std::min(num, m_numThreads);
    n = std::max(n, static_cast<unsigned int>(0));
    SetNumWorkersImpl(n);
}

References m_numThreads, and SetNumWorkersImpl().

v_SetSchedType()

void Nektar::Thread::ThreadManagerBoost::v_SetSchedType ( SchedType  s )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 189 of file ThreadBoost.cpp.

{
    Lock masterQueueLock(m_masterQueueMutex); // locks the queue
    m_schedType = s;
}

References m_masterQueueMutex, and m_schedType.

v_Wait()

void Nektar::Thread::ThreadManagerBoost::v_Wait ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 207 of file ThreadBoost.cpp.

{
    bool working;
    Lock masterQueueLock(m_masterQueueMutex); // locks the queue
    working = IsWorking();
    m_masterActiveCondVar.notify_all();
    m_masterQueueCondVar.notify_all();
    while (!m_masterQueue.empty() || working)
    {
        // while waiting, master queue is unlocked
        m_masterQueueCondVar.wait(masterQueueLock);
        // on exiting wait master queue is locked again
        working = IsWorking();
    }
}

References IsWorking(), m_masterActiveCondVar, m_masterQueue, m_masterQueueCondVar, and m_masterQueueMutex.

Friends And Related Function Documentation

ThreadWorkerBoost

friend class ThreadWorkerBoost

friend

So the workers can access the master queue and locks.

Definition at line 63 of file ThreadBoost.h.

Referenced by ThreadManagerBoost().

Member Data Documentation

className

std::string Nektar::Thread::ThreadManagerBoost::className

staticprivate

Initial value:

=
    GetThreadManagerFactory().RegisterCreatorFunction(
        "ThreadManagerBoost", ThreadManagerBoost::Create,
        "Threading using Boost.")

Definition at line 115 of file ThreadBoost.h.

m_barrier

boost::barrier* Nektar::Thread::ThreadManagerBoost::m_barrier

private

Definition at line 113 of file ThreadBoost.h.

Referenced by SetNumWorkersImpl(), ThreadManagerBoost(), v_Hold(), and ~ThreadManagerBoost().

m_chunkSize

unsigned int Nektar::Thread::ThreadManagerBoost::m_chunkSize

private

Definition at line 111 of file ThreadBoost.h.

Referenced by Nektar::Thread::ThreadWorkerBoost::GetNumToLoad(), and v_SetChunkSize().

m_masterActiveCondVar

boost::condition_variable Nektar::Thread::ThreadManagerBoost::m_masterActiveCondVar

private

Definition at line 105 of file ThreadBoost.h.

Referenced by SetNumWorkersImpl(), v_Wait(), Nektar::Thread::ThreadWorkerBoost::WaitForActive(), and ~ThreadManagerBoost().

m_masterActiveMutex

boost::mutex Nektar::Thread::ThreadManagerBoost::m_masterActiveMutex

private

Definition at line 103 of file ThreadBoost.h.

Referenced by IsWorking(), Nektar::Thread::ThreadWorkerBoost::LoadJobs(), SetNumWorkersImpl(), and Nektar::Thread::ThreadWorkerBoost::WaitForActive().

m_masterQueue

std::queue<ThreadJob *> Nektar::Thread::ThreadManagerBoost::m_masterQueue

private

Definition at line 101 of file ThreadBoost.h.

Referenced by Nektar::Thread::ThreadWorkerBoost::GetNumToLoad(), Nektar::Thread::ThreadWorkerBoost::LoadJobs(), v_QueueJob(), and v_Wait().

m_masterQueueCondVar

boost::condition_variable Nektar::Thread::ThreadManagerBoost::m_masterQueueCondVar

private

Definition at line 104 of file ThreadBoost.h.

Referenced by Nektar::Thread::ThreadWorkerBoost::LoadJobs(), v_QueueJob(), v_Wait(), and ~ThreadManagerBoost().

m_masterQueueMutex

boost::mutex Nektar::Thread::ThreadManagerBoost::m_masterQueueMutex

private

Definition at line 102 of file ThreadBoost.h.

Referenced by Nektar::Thread::ThreadWorkerBoost::LoadJobs(), v_QueueJob(), v_SetChunkSize(), v_SetSchedType(), and v_Wait().

m_masterThreadId

boost::thread::id Nektar::Thread::ThreadManagerBoost::m_masterThreadId

private

Definition at line 108 of file ThreadBoost.h.

Referenced by ThreadManagerBoost(), and v_InThread().

m_numThreads

const unsigned int Nektar::Thread::ThreadManagerBoost::m_numThreads

private

Definition at line 99 of file ThreadBoost.h.

Referenced by SetNumWorkersImpl(), ThreadManagerBoost(), v_GetMaxNumWorkers(), v_SetNumWorkers(), and ~ThreadManagerBoost().

m_numWorkers

unsigned int Nektar::Thread::ThreadManagerBoost::m_numWorkers

private

Definition at line 100 of file ThreadBoost.h.

Referenced by Nektar::Thread::ThreadWorkerBoost::GetNumToLoad(), IsWorking(), SetNumWorkersImpl(), ThreadManagerBoost(), and v_GetNumWorkers().

m_schedType

SchedType Nektar::Thread::ThreadManagerBoost::m_schedType

private

Definition at line 112 of file ThreadBoost.h.

Referenced by Nektar::Thread::ThreadWorkerBoost::GetNumToLoad(), and v_SetSchedType().

m_threadActiveList

bool* Nektar::Thread::ThreadManagerBoost::m_threadActiveList

private

Definition at line 110 of file ThreadBoost.h.

Referenced by Nektar::Thread::ThreadWorkerBoost::LoadJobs(), SetNumWorkersImpl(), ThreadManagerBoost(), Nektar::Thread::ThreadWorkerBoost::WaitForActive(), and ~ThreadManagerBoost().

m_threadBusyList

bool* Nektar::Thread::ThreadManagerBoost::m_threadBusyList

private

Definition at line 109 of file ThreadBoost.h.

Referenced by IsWorking(), Nektar::Thread::ThreadWorkerBoost::LoadJobs(), ThreadManagerBoost(), and ~ThreadManagerBoost().

m_threadList

ThreadWorkerBoost** Nektar::Thread::ThreadManagerBoost::m_threadList

private

Definition at line 106 of file ThreadBoost.h.

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

m_threadMap

std::map<boost::thread::id, unsigned int> Nektar::Thread::ThreadManagerBoost::m_threadMap

private

Definition at line 114 of file ThreadBoost.h.

Referenced by ThreadManagerBoost(), and v_GetWorkerNum().

m_threadThreadList

boost::thread** Nektar::Thread::ThreadManagerBoost::m_threadThreadList

private

Definition at line 107 of file ThreadBoost.h.

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

m_type

std::string Nektar::Thread::ThreadManagerBoost::m_type

private

Definition at line 116 of file ThreadBoost.h.

Referenced by ThreadManagerBoost(), and v_GetType().