G4MTBarrier Class Reference

#include <G4MTBarrier.hh>

Public Member Functions
	G4MTBarrier ()
	G4MTBarrier (const G4MTBarrier &)=delete
	G4MTBarrier (unsigned int numThreads)
unsigned int	GetCounter ()
G4MTBarrier &	operator= (const G4MTBarrier &)=delete
void	ReleaseBarrier ()
void	ResetCounter ()
void	SetActiveThreads (unsigned int val)
void	ThisWorkerReady ()
void	Wait ()
void	Wait (unsigned int numt)
virtual void	WaitForReadyWorkers ()
virtual	~G4MTBarrier ()

Private Attributes
G4Condition	m_continue
unsigned int	m_counter = 0
G4Condition	m_counterChanged
G4Mutex	m_mutex
unsigned int	m_numActiveThreads = 0

Detailed Description

Definition at line 122 of file G4MTBarrier.hh.

Constructor & Destructor Documentation

G4MTBarrier() [1/3]

G4MTBarrier::G4MTBarrier ( )

inline

Definition at line 125 of file G4MTBarrier.hh.

    : G4MTBarrier(1)
  {}

~G4MTBarrier()

virtual G4MTBarrier::~G4MTBarrier ( )

inlinevirtual

Definition at line 128 of file G4MTBarrier.hh.

{}

G4MTBarrier() [2/3]

G4MTBarrier::G4MTBarrier ( const G4MTBarrier &  )

delete

G4MTBarrier() [3/3]

G4MTBarrier::G4MTBarrier

(

unsigned int

numThreads

)

Definition at line 35 of file G4MTBarrier.cc.

  : m_numActiveThreads(numThreads)
{}

Member Function Documentation

GetCounter()

unsigned int G4MTBarrier::GetCounter

(

)

Definition at line 97 of file G4MTBarrier.cc.

{
  G4AutoLock l(&m_mutex);
  const unsigned int result = m_counter;
  return result;
}

References m_counter, and m_mutex.

operator=()

G4MTBarrier & G4MTBarrier::operator= ( const G4MTBarrier &  )

delete

ReleaseBarrier()

void G4MTBarrier::ReleaseBarrier

(

)

Definition at line 72 of file G4MTBarrier.cc.

{
  // Step-4: re-aquire lock and re-set shared resource for future re-use
  G4AutoLock lock(&m_mutex);
  m_counter = 0;
  G4CONDITIONBROADCAST(&m_continue);
}

References G4CONDITIONBROADCAST, m_continue, m_counter, and m_mutex.

Referenced by G4MTRunManager::NewActionRequest(), G4MTRunManager::WaitForEndEventLoopWorkers(), WaitForReadyWorkers(), and G4MTRunManager::WaitForReadyWorkers().

ResetCounter()

void G4MTBarrier::ResetCounter

(

)

Definition at line 90 of file G4MTBarrier.cc.

{
  G4AutoLock l(&m_mutex);
  m_counter = 0;
}

References m_counter, and m_mutex.

Referenced by G4MTRunManager::WaitForEndEventLoopWorkers(), and G4MTRunManager::WaitForReadyWorkers().

SetActiveThreads()

void G4MTBarrier::SetActiveThreads ( unsigned int  val )

inline

Definition at line 140 of file G4MTBarrier.hh.

{ m_numActiveThreads = val; }

References m_numActiveThreads.

Referenced by G4MTRunManager::RequestWorkersProcessCommandsStack(), and Wait().

ThisWorkerReady()

void G4MTBarrier::ThisWorkerReady

(

)

Definition at line 40 of file G4MTBarrier.cc.

{
  // Step-1: Worker acquires lock on shared resource (the counter)
  G4AutoLock lock(&m_mutex);
  // Step-2: Worker increases counter
  ++m_counter;
  // Step-3: Worker broadcasts that the counter has changed
  G4CONDITIONBROADCAST(&m_counterChanged);
  // Step-4: Worker waits on condition to continue
  G4CONDITIONWAIT(&m_continue, &lock);
}

References G4CONDITIONBROADCAST, G4CONDITIONWAIT, m_continue, m_counter, m_counterChanged, and m_mutex.

Referenced by G4MTRunManager::ThisWorkerEndEventLoop(), G4MTRunManager::ThisWorkerProcessCommandsStackDone(), G4MTRunManager::ThisWorkerReady(), and G4MTRunManager::ThisWorkerWaitForNextAction().

Wait() [1/2]

void G4MTBarrier::Wait

(

)

Definition at line 53 of file G4MTBarrier.cc.

{
  while(true)
  {
    // Step-2: Acquires lock on shared resource (the counter)
    G4AutoLock lock(&m_mutex);
    // If the counter equals active threads, all threads are ready, exit the
    // loop
    if(m_counter == m_numActiveThreads)
    {
      break;
    }
    // Step-3: Not all workers are ready, wait for the number to change
    // before repeating the check
    G4CONDITIONWAIT(&m_counterChanged, &lock);
  }
}

References G4CONDITIONWAIT, m_counter, m_counterChanged, m_mutex, and m_numActiveThreads.

Referenced by G4MTRunManager::NewActionRequest(), Wait(), G4MTRunManager::WaitForEndEventLoopWorkers(), WaitForReadyWorkers(), and G4MTRunManager::WaitForReadyWorkers().

Wait() [2/2]

void G4MTBarrier::Wait ( unsigned int  numt )

inline

Definition at line 145 of file G4MTBarrier.hh.

  {
    SetActiveThreads(numt);
    Wait();
  }

References SetActiveThreads(), and Wait().

WaitForReadyWorkers()

void G4MTBarrier::WaitForReadyWorkers ( )

virtual

Definition at line 81 of file G4MTBarrier.cc.

{
  // Step-1: Master enters a loop to wait all workers to be ready
  Wait();
  // Done, all workers are ready, broadcast a continue signal
  ReleaseBarrier();
}

References ReleaseBarrier(), and Wait().

Referenced by G4MTRunManager::RequestWorkersProcessCommandsStack().

Field Documentation

m_continue

G4Condition G4MTBarrier::m_continue

private

Definition at line 156 of file G4MTBarrier.hh.

Referenced by ReleaseBarrier(), and ThisWorkerReady().

m_counter

unsigned int G4MTBarrier::m_counter = 0

private

Definition at line 153 of file G4MTBarrier.hh.

Referenced by GetCounter(), ReleaseBarrier(), ResetCounter(), ThisWorkerReady(), and Wait().

m_counterChanged

G4Condition G4MTBarrier::m_counterChanged

private

Definition at line 155 of file G4MTBarrier.hh.

Referenced by ThisWorkerReady(), and Wait().

m_mutex

G4Mutex G4MTBarrier::m_mutex

private

Definition at line 154 of file G4MTBarrier.hh.

Referenced by GetCounter(), ReleaseBarrier(), ResetCounter(), ThisWorkerReady(), and Wait().

m_numActiveThreads

unsigned int G4MTBarrier::m_numActiveThreads = 0

private

Definition at line 152 of file G4MTBarrier.hh.

Referenced by SetActiveThreads(), and Wait().

---

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

• source/global/management/include/G4MTBarrier.hh
• source/global/management/src/G4MTBarrier.cc