Nektar::Thread::ThreadWorkerBoost Class Reference

Implementation class for ThreadManagerBoost. More...

#include <ThreadBoost.h>

Collaboration diagram for Nektar::Thread::ThreadWorkerBoost:

Public Member Functions
	ThreadWorkerBoost (ThreadManagerBoost *threadManager, unsigned int workerNum)
	Constructor. More...
	~ThreadWorkerBoost ()
	Destructor. More...
void	operator() ()
	This provides the interface that boost::thread uses to start the worker. More...
unsigned int	GetWorkerNum ()
	Return the index of the worker thread. More...
void	Stop ()
	A signal to shut down. More...

Private Member Functions
	ThreadWorkerBoost ()
	ThreadWorkerBoost (const ThreadWorkerBoost &)
void	MainLoop ()
void	LoadJobs ()
unsigned int	GetNumToLoad ()
void	WaitForActive ()
void	RunJobs ()

Private Attributes
ThreadManagerBoost *	m_threadManager
std::queue< ThreadJob * >	m_workerQueue
bool	m_keepgoing
unsigned int	m_threadNum

Detailed Description

Implementation class for ThreadManagerBoost.

Each instance of this class corresponds to a worker thread. Instances manage their own queue of jobs to run, grabbing new jobs from the master queue when it is exhausted.

Definition at line 127 of file ThreadBoost.h.

Constructor & Destructor Documentation

Nektar::Thread::ThreadWorkerBoost::ThreadWorkerBoost	(	ThreadManagerBoost *	tm,
		unsigned int	workerNum
	)

Constructor.

Parameters

threadManager	Pointer to the ThreadManagerBoost that is controlling this worker.
workerNum	Unique number from 0..(number_of_threads - 1)

Called by the ThreadManagerBoost instance.

Definition at line 330 of file ThreadBoost.cpp.

                                                    :
        m_threadManager(tm), m_workerQueue(),
        m_keepgoing(true), m_threadNum(workerNum)
{
    // Nothing to see here

}

Nektar::Thread::ThreadWorkerBoost::~ThreadWorkerBoost

(

)

Destructor.

Winds up this thread's execution. Jobs in its queue are lost.

Definition at line 343 of file ThreadBoost.cpp.

References m_keepgoing, and m_threadNum.

{
    if (m_keepgoing)
    {
        std::cerr << "Warning: ThreadWorker: " << m_threadNum
                  << "destroyed while running!" << std::endl;
    }
    // on destuction the m_workerQueue will be destructed and that
    // will destruct any ThreadJobs still in there.
}

Nektar::Thread::ThreadWorkerBoost::ThreadWorkerBoost ( )

private

Nektar::Thread::ThreadWorkerBoost::ThreadWorkerBoost ( const ThreadWorkerBoost &  )

private

Member Function Documentation

unsigned int Nektar::Thread::ThreadWorkerBoost::GetNumToLoad ( )

private

Definition at line 394 of file ThreadBoost.cpp.

References ASSERTL0, Nektar::Thread::e_dynamic, Nektar::Thread::e_guided, Nektar::Thread::ThreadManagerBoost::m_chunkSize, Nektar::Thread::ThreadManagerBoost::m_masterQueue, Nektar::Thread::ThreadManagerBoost::m_numWorkers, Nektar::Thread::ThreadManagerBoost::m_schedType, and m_threadManager.

Referenced by LoadJobs().

{
    unsigned int numToLoad;
    switch (m_threadManager->m_schedType)
    {
        case e_guided:
            numToLoad = std::max(
                static_cast<unsigned long>(m_threadManager->m_chunkSize),
                static_cast<unsigned long>(
                    m_threadManager->m_masterQueue.size()
                    / (2*m_threadManager->m_numWorkers +1)));
            break;

        case e_dynamic:
            numToLoad = m_threadManager->m_chunkSize;
            break;

        default:
            ASSERTL0(0, "Invalid value for SchedType.");
            break;
    }
    return numToLoad;
}

unsigned int Nektar::Thread::ThreadWorkerBoost::GetWorkerNum ( )

inline

Return the index of the worker thread.

Returns

Index of worker thread, an integer between 0 and (number_of_threads - 1)

Definition at line 143 of file ThreadBoost.h.

References m_threadNum.

{ return m_threadNum; };

void Nektar::Thread::ThreadWorkerBoost::LoadJobs ( )

private

Definition at line 358 of file ThreadBoost.cpp.

References GetNumToLoad(), m_keepgoing, Nektar::Thread::ThreadManagerBoost::m_masterActiveMutex, Nektar::Thread::ThreadManagerBoost::m_masterQueue, Nektar::Thread::ThreadManagerBoost::m_masterQueueCondVar, Nektar::Thread::ThreadManagerBoost::m_masterQueueMutex, Nektar::Thread::ThreadManagerBoost::m_threadActiveList, Nektar::Thread::ThreadManagerBoost::m_threadBusyList, m_threadManager, m_threadNum, and m_workerQueue.

Referenced by MainLoop().

{
    // Lock the master queue
    Lock masterQueueLock(m_threadManager->m_masterQueueMutex);
    m_threadManager->m_threadBusyList[m_threadNum] = false;
    m_threadManager->m_masterQueueCondVar.notify_all();
    while (m_threadManager->m_masterQueue.empty()
        && m_keepgoing)
    {
        // while waiting, master queue is unlocked
        m_threadManager->m_masterQueueCondVar.wait(masterQueueLock);
        // on exiting wait master queue is locked again
    }
    bool active;
    {
        Lock masterActiveLock(m_threadManager->m_masterActiveMutex);
        active = m_threadManager->m_threadActiveList[m_threadNum];
    }
    if (active && m_keepgoing)
    {
        unsigned int numToLoad = GetNumToLoad();
        while (m_workerQueue.size() < numToLoad
                && !m_threadManager->m_masterQueue.empty())
        {
            ThreadJob *tj = m_threadManager->m_masterQueue.front();
            m_workerQueue.push(tj);
            m_threadManager->m_masterQueue.pop();
        }
    }
    m_threadManager->m_threadBusyList[m_threadNum] = !m_workerQueue.empty();
} // lock on master queue released here

void Nektar::Thread::ThreadWorkerBoost::MainLoop ( )

private

Definition at line 439 of file ThreadBoost.cpp.

References LoadJobs(), m_keepgoing, RunJobs(), and WaitForActive().

Referenced by operator()().

{
    while (m_keepgoing)
    {
        WaitForActive();
        LoadJobs();
        RunJobs();
    }
} // exiting here should terminate the thread

void Nektar::Thread::ThreadWorkerBoost::operator() ( )

inline

This provides the interface that boost::thread uses to start the worker.

Definition at line 137 of file ThreadBoost.h.

References MainLoop().

{ MainLoop(); };

void Nektar::Thread::ThreadWorkerBoost::RunJobs ( )

private

Definition at line 453 of file ThreadBoost.cpp.

References m_keepgoing, m_threadNum, m_workerQueue, Nektar::Thread::ThreadJob::Run(), and Nektar::Thread::ThreadJob::SetWorkerNum().

Referenced by MainLoop().

{
    while (!m_workerQueue.empty() && m_keepgoing)
    {
        ThreadJob * tj;
        try
        {
            tj = m_workerQueue.front();
            tj->SetWorkerNum(m_threadNum);
            tj->Run();
            m_workerQueue.pop();
            delete tj;
        } catch(...)
        {
            // something bad happened, probably time to die
            // maybe signal ThreadManager
            throw;
        }
    }
}

void Nektar::Thread::ThreadWorkerBoost::Stop ( )

inline

A signal to shut down.

If this method is called the worker will shut down. Used by the ThreadManagerBoost to stop threading.

Definition at line 150 of file ThreadBoost.h.

References m_keepgoing.

Referenced by Nektar::Thread::ThreadManagerBoost::~ThreadManagerBoost().

{ m_keepgoing = false;} ;

void Nektar::Thread::ThreadWorkerBoost::WaitForActive ( )

private

Definition at line 422 of file ThreadBoost.cpp.

References m_keepgoing, Nektar::Thread::ThreadManagerBoost::m_masterActiveCondVar, Nektar::Thread::ThreadManagerBoost::m_masterActiveMutex, Nektar::Thread::ThreadManagerBoost::m_threadActiveList, m_threadManager, and m_threadNum.

Referenced by MainLoop().

{
    Lock masterActiveLock(m_threadManager->m_masterActiveMutex);

    while (!m_threadManager->m_threadActiveList[m_threadNum]
        && m_keepgoing)
    {
        // while waiting, master active is unlocked
        m_threadManager->m_masterActiveCondVar.wait(masterActiveLock);
        // on exiting wait master active is locked again
    }
}

Member Data Documentation

bool Nektar::Thread::ThreadWorkerBoost::m_keepgoing

private

Definition at line 164 of file ThreadBoost.h.

Referenced by LoadJobs(), MainLoop(), RunJobs(), Stop(), WaitForActive(), and ~ThreadWorkerBoost().

ThreadManagerBoost* Nektar::Thread::ThreadWorkerBoost::m_threadManager

private

Definition at line 162 of file ThreadBoost.h.

Referenced by GetNumToLoad(), LoadJobs(), and WaitForActive().

unsigned int Nektar::Thread::ThreadWorkerBoost::m_threadNum

private

Definition at line 165 of file ThreadBoost.h.

Referenced by GetWorkerNum(), LoadJobs(), RunJobs(), WaitForActive(), and ~ThreadWorkerBoost().

std::queue<ThreadJob *> Nektar::Thread::ThreadWorkerBoost::m_workerQueue

private

Definition at line 163 of file ThreadBoost.h.

Referenced by LoadJobs(), and RunJobs().