DtParallelTickManager Class Reference

Enables parallelism in the main thread. More...

Inheritance diagram for DtParallelTickManager:

Classes
class	CallbackInterface
	Interface for defining callbacks. More...

Public Types
enum	AccessType { EXCLUSIVE, SHARED, UNLOCKED }
typedef boost::unordered_map < std::string, bool >	EnabledMap

Public Member Functions
	DtParallelTickManager (DtVrfSimOptionsInterface *options)
virtual	~DtParallelTickManager ()
virtual void	setCallbackQueue (DtVrfCallbackQueue *)
	Takes ownership.
virtual DtVrfCallbackQueue *	queue () const
	Access the callback queue object.
virtual bool	enabled (const std::string &, bool def) const
	Simple mechanism for controlling multiple parallel sections.
virtual bool	executeCommand (const std::string &, bool on)
	Execute a console command.
virtual void	printInfo (std::ostream &) const
	Print information about current state.
virtual ThreadLocalInfo &	threadLocalInfo ()
	ThreadLocalInfo (DtParallelTickManager *m)
DtParallelTickManager::AccessType	state () const
virtual void	flushQueue (bool useThisThread)
	Wait for all queued tasks to complete This function is called when you have added a bunch of tasks to the queue and need to make sure they are finished before proceeding.
virtual void	flushQueue ()
virtual bool	mainThreadWait () const
	Accessor/mutator for main thread participation in running callbacks.
virtual void	setMainThreadWait (bool)
virtual bool	active () const
	Accessorm/mutator for the entire parallel mechanism.
virtual void	setActive (bool)
virtual void	addCallback (CallbackInterface *, bool runNow=false)
	Add callbacks to the queue.
virtual void	addCallback (CallbackInterface &, bool runNow=false)
virtual void	addCallback (CallbackInterface *, const std::string &tag, bool def=true)
virtual void	addCallback (CallbackInterface &, const std::string &tag, bool def=true)
void	addCallback (CallbackInterface *, const char *tag, bool def=true)
void	addCallback (CallbackInterface &, const char *tag, bool def=true)
template<typename Container >
void	addCallbacks (Container &cont, bool runNow=false)
template<typename Container >
void	addCallbacks (Container &cont, const std::string &tag, bool def=true)
template<typename Container >
void	addCallbacks (Container &cont, const char *tag, bool def=true)
virtual void	lock ()
	Manipulate global mutex.
virtual void	unlock ()
virtual void	readLock ()
virtual void	readUnlock ()
virtual void	upgradeToWriter ()
virtual void	downgradeToReader ()
virtual void	changeAccess (AccessType from, AccessType to)

Private Types
typedef tbb::mutex	Mutex
typedef tbb::interface5::condition_variable	ConditionVariable
typedef tbb::interface5::unique_lock < Mutex >	ScopedLock
typedef tbb::cache_aligned_allocator < ThreadLocalInfo * >	ThreadLocalAllocator
typedef tbb::enumerable_thread_specific < ThreadLocalInfo *, ThreadLocalAllocator, tbb::ets_key_per_instance >	ThreadLocalContainer
	DtCriticalSection, ThreadLocalAllocator> ThreadLocalContainer;.
typedef std::vector < DtCriticalSection * >	Stack

Private Member Functions
virtual void	createCallbackQueue (bool force=false)
	Create the callback queue.
void	push (DtCriticalSection &cs)
void	pop (DtCriticalSection &cs)

Private Attributes
Mutex	myMutex
ConditionVariable	myReadCondition
ConditionVariable	myWriteCondition
bool	myWriteLock
unsigned	myNumWriters
unsigned	myNumReaders
unsigned	myNumWaitingReaders
ThreadLocalContainer	myThreadLocals
DtVrfSimOptionsInterface *	myOptions
DtVrfCallbackQueue *	myCallbackQueue
EnabledMap	myEnabledMap
bool	myWaitFlag
DtSubCommandManager *	myCommandManager
DtConsoleCommandOwner *	myCommandOwner
Stack	myLocks

Friends
class	DtCriticalSection

Detailed Description

Enables parallelism in the main thread.

This class wraps a mutex and a callback queue thread pool which are used to execute multiple functions in parallel in the sim main thread. The mutex protects the entire global state of VR-Forces.

There are two ways to execute a callback, normal (parallel) or serial. The normal method just executes the callback with no synchronization. If the callback needs to access any of the global VR-Forces state then it must use create a SerialScopeGuard around that section (just like a mutex scope lock). This will lock the global mutex and prevent any other threads from access the global state. The serial method locks the global mutex when the callback is called This means that all other threads accessing the global state will have to wait. A serial executed callback can use ParallelScopeGuard to unlock the global mutex around a section which does not access any global state.

By default DtVrfObjects are ticked in serial since they all access the global state. Individual actuators that have safe sections (like terrain intersections or feature queries) can then be modified as needed by inserting ParallelScopeGuards.

Users generally do not access this class directly, see DtCriticalSection.

Member Typedef Documentation

typedef boost::unordered_map<std::string, bool> DtParallelTickManager::EnabledMap

typedef tbb::mutex DtParallelTickManager::Mutex

private

typedef tbb::interface5::condition_variable DtParallelTickManager::ConditionVariable

private

typedef tbb::interface5::unique_lock<Mutex> DtParallelTickManager::ScopedLock

private

typedef tbb::cache_aligned_allocator<ThreadLocalInfo*> DtParallelTickManager::ThreadLocalAllocator

private

typedef tbb::enumerable_thread_specific< ThreadLocalInfo*, ThreadLocalAllocator, tbb::ets_key_per_instance> DtParallelTickManager::ThreadLocalContainer

private

DtCriticalSection, ThreadLocalAllocator> ThreadLocalContainer;.

typedef std::vector<DtCriticalSection*> DtParallelTickManager::Stack

private

Member Enumeration Documentation

enum DtParallelTickManager::AccessType

Enumerator:

EXCLUSIVE
SHARED
UNLOCKED

Constructor & Destructor Documentation

DtParallelTickManager::DtParallelTickManager ( DtVrfSimOptionsInterface *  options )

explicit

virtual DtParallelTickManager::~DtParallelTickManager ( )

virtual

Member Function Documentation

virtual void DtParallelTickManager::setCallbackQueue ( DtVrfCallbackQueue *  )

virtual

Takes ownership.

virtual DtVrfCallbackQueue* DtParallelTickManager::queue ( ) const

virtual

Access the callback queue object.

virtual void DtParallelTickManager::flushQueue ( bool  useThisThread )

virtual

Wait for all queued tasks to complete This function is called when you have added a bunch of tasks to the queue and need to make sure they are finished before proceeding.

Whether the calling thread waits or participates in calling the callbacks is controlled by the useThisThread parameter or DtVrfSimOptionsInterface::flushCallbackQueueInMainThread if not supplied.

virtual void DtParallelTickManager::flushQueue ( )

virtual

virtual bool DtParallelTickManager::mainThreadWait ( ) const

virtual

Accessor/mutator for main thread participation in running callbacks.

virtual void DtParallelTickManager::setMainThreadWait ( bool  )

virtual

virtual bool DtParallelTickManager::active ( ) const

virtual

Accessorm/mutator for the entire parallel mechanism.

Disabling will delete the queue and execute callbacks in the calling thread.

virtual void DtParallelTickManager::setActive ( bool  )

virtual

virtual bool DtParallelTickManager::enabled ( const std::string &  , bool  def  ) const

virtual

Simple mechanism for controlling multiple parallel sections.

This class is designed to be used by multiple sections of code to execute different sets of parallel callbacks. This function allows each of those sections to be named and then have their options controlled individually by this class. If you supply a tag in any of the add callback functions a record will be made of that that tag by this function.

Parameters

def	Default value to record if it's a new tag.

Referenced by addCallbacks().

virtual bool DtParallelTickManager::executeCommand ( const std::string &  , bool  on  )

virtual

Execute a console command.

virtual void DtParallelTickManager::printInfo ( std::ostream &  ) const

virtual

Print information about current state.

virtual void DtParallelTickManager::addCallback ( CallbackInterface *  , bool  runNow = false  )

virtual

Add callbacks to the queue.

The pointer versions take ownership of their callbacks. The reference versions do not and require the caller to keep them alive. The container versions add an STL-like container of callbacks.

Parameters

runNow	Execute the callback right now instead of adding it the queue.
tag	See enabled().
def	Default value for enabled().

Referenced by addCallbacks().

virtual void DtParallelTickManager::addCallback ( CallbackInterface &  , bool  runNow = false  )

virtual

virtual void DtParallelTickManager::addCallback ( CallbackInterface *  , const std::string &  tag, bool  def = true  )

virtual

virtual void DtParallelTickManager::addCallback ( CallbackInterface &  , const std::string &  tag, bool  def = true  )

virtual

void DtParallelTickManager::addCallback	(	CallbackInterface *	,
		const char *	tag,
		bool	def = true
	)

void DtParallelTickManager::addCallback	(	CallbackInterface &	,
		const char *	tag,
		bool	def = true
	)

template<typename Container >

void DtParallelTickManager::addCallbacks ( Container &  cont, bool  runNow = false  )

inline

References addCallback().

Referenced by addCallbacks().

template<typename Container >

void DtParallelTickManager::addCallbacks ( Container &  cont, const std::string &  tag, bool  def = true  )

inline

References addCallback(), and enabled().

template<typename Container >

void DtParallelTickManager::addCallbacks ( Container &  cont, const char *  tag, bool  def = true  )

inline

References addCallbacks().

virtual void DtParallelTickManager::lock ( )

virtual

Manipulate global mutex.

virtual void DtParallelTickManager::unlock ( )

virtual

virtual void DtParallelTickManager::readLock ( )

virtual

virtual void DtParallelTickManager::readUnlock ( )

virtual

virtual void DtParallelTickManager::upgradeToWriter ( )

virtual

virtual void DtParallelTickManager::downgradeToReader ( )

virtual

virtual void DtParallelTickManager::changeAccess ( AccessType  from, AccessType  to  )

virtual

virtual ThreadLocalInfo& DtParallelTickManager::threadLocalInfo ( )

virtual

virtual void DtParallelTickManager::createCallbackQueue ( bool  force = false )

privatevirtual

Create the callback queue.

DtParallelTickManager::ThreadLocalInfo ( DtParallelTickManager *  m )

explicit

DtParallelTickManager::AccessType DtParallelTickManager::state

(

)

const

void DtParallelTickManager::push ( DtCriticalSection &  cs )

private

void DtParallelTickManager::pop ( DtCriticalSection &  cs )

private

Friends And Related Function Documentation

friend class DtCriticalSection

friend

Member Data Documentation

Mutex DtParallelTickManager::myMutex

mutableprivate

ConditionVariable DtParallelTickManager::myReadCondition

mutableprivate

ConditionVariable DtParallelTickManager::myWriteCondition

mutableprivate

bool DtParallelTickManager::myWriteLock

private

unsigned DtParallelTickManager::myNumWriters

private

unsigned DtParallelTickManager::myNumReaders

private

unsigned DtParallelTickManager::myNumWaitingReaders

private

ThreadLocalContainer DtParallelTickManager::myThreadLocals

private

DtVrfSimOptionsInterface* DtParallelTickManager::myOptions

private

DtVrfCallbackQueue* DtParallelTickManager::myCallbackQueue

private

EnabledMap DtParallelTickManager::myEnabledMap

mutableprivate

bool DtParallelTickManager::myWaitFlag

private

DtSubCommandManager* DtParallelTickManager::myCommandManager

private

DtConsoleCommandOwner* DtParallelTickManager::myCommandOwner

private

Stack DtParallelTickManager::myLocks

private

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfcore/parallelTickManager.h