Administers tasks that will be executed asynchronously. More...

#include <TPZThreadPool.h>

Collaboration diagram for TPZThreadPool:

Public Member Functions
std::shared_future< void >	run (const int priority, TPZAutoPointer< std::packaged_task< void(void) > > &task, TPZTaskGroup *taskGroup=NULL)
	submits a task to be executed by TPZThreadPool More...

void	run (TPZAutoPointer< TPZReschedulableTask > &task)

void	reschedule (const int priority, TPZAutoPointer< TPZReschedulableTask > &task)

std::shared_future< void >	runNow (TPZAutoPointer< TPZReschedulableTask > &task)

template<typename... Args>
std::shared_future< void >	run (const int priority, TPZTaskGroup *taskGroup, std::function< void(Args...) > func, Args... args)

template<typename... Args>
TPZAutoPointer< TPZReschedulableTask >	runReschedulable (const int priority, TPZTaskGroup *taskGroup, std::function< void(Args...) > func, Args... args)

void	SetNumThreads (const unsigned numThreads)
	sets the number of threads to be executed simultaneously More...

int	maxPriority () const

int	minPriority () const

int	threadCount () const

Static Public Member Functions
static TPZThreadPool &	globalInstance ()

Private Member Functions
	TPZThreadPool ()

int	ActualThreadCount () const

void	threadsLoop ()

void	updatePriorities ()

void	appendTaskToQueue (TPZAutoPointer< TPZTask > &task)

TPZAutoPointer< TPZTask >	appendTaskToQueue (const int priority, TPZAutoPointer< std::packaged_task< void(void) >> &task, const bool system_task, TPZTaskGroup *taskGroup=NULL)

void	checkForMaxAndMinPriority (const int priority)

	~TPZThreadPool ()

template<typename... Args>
std::shared_future< void >	runSystemTask (const int priority, std::function< void(Args...) > func, Args... args)
	Submits and processes a "maximum priority" system task. More...

Private Attributes
std::vector< std::thread >	mThreads
	vector of thread objects More...

std::mutex	mThreadsMutex
	one mutex to synchronize access to the data structures More...

unsigned int	mThreadsToDelete

unsigned int	mZombieThreads

bool	mStop

TPZPriorityQueue< TPZAutoPointer< TPZTask >, std::vector< TPZAutoPointer< TPZTask > >, TPZTaskOrdering >	mTasksQueue

std::condition_variable	mTaskAvailableCond

int	mMinPriority

int	mMaxPriority

Detailed Description

Administers tasks that will be executed asynchronously.

Definition at line 23 of file TPZThreadPool.h.

Constructor & Destructor Documentation

◆ TPZThreadPool()

TPZThreadPool::TPZThreadPool ( )

private

Definition at line 105 of file TPZThreadPool.cpp.

References appendTaskToQueue(), TPZTask::priority(), run(), and threadCount().

Referenced by runReschedulable().

◆ ~TPZThreadPool()

TPZThreadPool::~TPZThreadPool ( )

private

Definition at line 131 of file TPZThreadPool.cpp.

References TPZPriorityQueue< T, Container, Compare >::mMutex, mStop, mTaskAvailableCond, mTasksQueue, mThreads, and mThreadsMutex.

Referenced by runReschedulable().

Member Function Documentation

◆ ActualThreadCount()

int TPZThreadPool::ActualThreadCount ( ) const

private

Definition at line 159 of file TPZThreadPool.cpp.

References mThreads.

Referenced by runReschedulable(), threadCount(), and threadsLoop().

◆ appendTaskToQueue() [1/2]

void TPZThreadPool::appendTaskToQueue ( TPZAutoPointer< TPZTask > & task )

private

Definition at line 163 of file TPZThreadPool.cpp.

References TPZPriorityQueue< T, Container, Compare >::addItem(), TPZPriorityQueue< T, Container, Compare >::mMutex, TPZTask::mSystemTask, mTaskAvailableCond, mTasksQueue, and TPZTask::TPZTask().

Referenced by reschedule(), run(), runNow(), runReschedulable(), runSystemTask(), and TPZThreadPool().

◆ appendTaskToQueue() [2/2]

TPZAutoPointer<TPZTask> TPZThreadPool::appendTaskToQueue	(	const int	priority,
		TPZAutoPointer< std::packaged_task< void(void) >> &	task,
		const bool	system_task,
		TPZTaskGroup *	taskGroup = `NULL`
	)

private

◆ checkForMaxAndMinPriority()

void TPZThreadPool::checkForMaxAndMinPriority ( const int priority )

private

Definition at line 176 of file TPZThreadPool.cpp.

References mMaxPriority, mMinPriority, and TPZTask::priority().

Referenced by run(), runReschedulable(), and runSystemTask().

◆ globalInstance()

TPZThreadPool & TPZThreadPool::globalInstance ( )

static

Returns: a reference to the one and only instance of TPZThreadPool

Definition at line 238 of file TPZThreadPool.cpp.

Referenced by TPZRenumbering::ColorElements(), TPZStructMatrixGCTP::MultiThread_Assemble(), runNow(), and TPZStructMatrixBase::TPZStructMatrixBase().

◆ maxPriority()

int TPZThreadPool::maxPriority ( ) const

Definition at line 147 of file TPZThreadPool.cpp.

References mMaxPriority.

Referenced by runReschedulable().

◆ minPriority()

int TPZThreadPool::minPriority ( ) const

Definition at line 151 of file TPZThreadPool.cpp.

References mMinPriority.

Referenced by runReschedulable().

◆ reschedule()

void TPZThreadPool::reschedule	(	const int	priority,
		TPZAutoPointer< TPZReschedulableTask > &	task
	)

Definition at line 121 of file TPZThreadPool.cpp.

References appendTaskToQueue(), TPZPriorityQueue< T, Container, Compare >::mMutex, mTasksQueue, TPZTask::priority(), and TPZPriorityQueue< T, Container, Compare >::remove().

Referenced by runNow().

◆ run() [1/3]

std::shared_future<void> TPZThreadPool::run	(	const int	priority,
		TPZAutoPointer< std::packaged_task< void(void) > > &	task,
		TPZTaskGroup *	taskGroup = `NULL`
	)

submits a task to be executed by TPZThreadPool

Referenced by TPZRenumbering::ColorElements(), TPZStructMatrixGCTP::MultiThread_Assemble(), run(), runReschedulable(), and TPZThreadPool().

◆ run() [2/3]

void TPZThreadPool::run ( TPZAutoPointer< TPZReschedulableTask > & task )

Definition at line 214 of file TPZThreadPool.cpp.

References appendTaskToQueue(), TPZReschedulableTask::mCondition, TPZReschedulableTask::mFuture, TPZTask::mState, TPZReschedulableTask::mStateMutex, TPZTask::mTask, TPZReschedulableTask::startInternal(), and threadCount().

◆ run() [3/3]

template<typename... Args>

std::shared_future<void> TPZThreadPool::run	(	const int	priority,
		TPZTaskGroup *	taskGroup,
		std::function< void(Args...) >	func,
		Args...	args
	)

inline

Definition at line 38 of file TPZThreadPool.h.

References checkForMaxAndMinPriority(), and run().

◆ runNow()

std::shared_future< void > TPZThreadPool::runNow ( TPZAutoPointer< TPZReschedulableTask > & task )

Definition at line 185 of file TPZThreadPool.cpp.

References appendTaskToQueue(), TPZTask::FINISHED, globalInstance(), TPZReschedulableTask::mCondition, TPZReschedulableTask::mFuture, TPZTask::mPriority, TPZTask::mState, TPZReschedulableTask::mStateMutex, TPZTask::mTask, reschedule(), TPZTask::SCHEDULED, TPZTask::STARTED, TPZReschedulableTask::startInternal(), and threadCount().

◆ runReschedulable()

template<typename... Args>

TPZAutoPointer<TPZReschedulableTask> TPZThreadPool::runReschedulable	(	const int	priority,
		TPZTaskGroup *	taskGroup,
		std::function< void(Args...) >	func,
		Args...	args
	)