G4MTBarrier Class Reference

#include <G4MTBarrier.hh>

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

Detailed Description

Definition at line 128 of file G4MTBarrier.hh.

Constructor & Destructor Documentation

G4MTBarrier::G4MTBarrier ( )

inline

Definition at line 131 of file G4MTBarrier.hh.

: G4MTBarrier(1) {}

virtual G4MTBarrier::~G4MTBarrier ( )

inlinevirtual

Definition at line 132 of file G4MTBarrier.hh.

{}

G4MTBarrier::G4MTBarrier ( const G4MTBarrier &  )

delete

G4MTBarrier::G4MTBarrier

(

unsigned int

numThreads

)

Definition at line 38 of file G4MTBarrier.cc.

                                                 :
  m_numActiveThreads(numThreads),
  m_counter(0),
  m_mutex(G4MUTEX_INITIALIZER),
  m_counterChanged(G4CONDITION_INITIALIZER),
  m_continue(G4CONDITION_INITIALIZER)
{
#if defined(WIN32)
  InitializeCriticalSection( &cs1 );
  InitializeCriticalSection( &cs2 );
#endif
}

Member Function Documentation

unsigned int G4MTBarrier::GetCounter

(

)

Definition at line 116 of file G4MTBarrier.cc.

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

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

delete

void G4MTBarrier::ReleaseBarrier

(

)

Definition at line 97 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);
}

Here is the caller graph for this function:

void G4MTBarrier::ResetCounter

(

)

Definition at line 111 of file G4MTBarrier.cc.

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

Here is the caller graph for this function:

void G4MTBarrier::SetActiveThreads ( unsigned int  val )

inline

Definition at line 142 of file G4MTBarrier.hh.

{ m_numActiveThreads = val; }

Here is the caller graph for this function:

void G4MTBarrier::ThisWorkerReady

(

)

Definition at line 51 of file G4MTBarrier.cc.

                                  {
  //Step-1: Worker acquires lock on shared resource (the counter)
#ifndef WIN32
  G4AutoLock lock(&m_mutex);
#else
  EnterCriticalSection( &cs1 );
#endif
  //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
#ifndef WIN32
  G4CONDITIONWAIT(&m_continue,&m_mutex);
#else
# ifdef G4MULTITHREADED
  G4CONDITIONWAIT(&m_continue,&cs1);
# endif
  LeaveCriticalSection(&cs1);
#endif
}

Here is the caller graph for this function:

void G4MTBarrier::Wait

(

)

Definition at line 73 of file G4MTBarrier.cc.

                       {
  while (true)
  {
      //Step-2: Acquires lock on shared resource (the counter)
#ifndef WIN32
      G4AutoLock lock(&m_mutex);
#else
      EnterCriticalSection(&cs2);
#endif
      //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
#ifdef WIN32
#     ifdef G4MULTITHREADED
      G4CONDITIONWAIT(&m_counterChanged,&cs2);
#     endif
      LeaveCriticalSection(&cs2);
#else
      G4CONDITIONWAIT(&m_counterChanged,&m_mutex);
#endif
  }
}

Here is the caller graph for this function:

void G4MTBarrier::Wait ( unsigned int  numt )

inline

Definition at line 147 of file G4MTBarrier.hh.

                                        {
    SetActiveThreads( numt );
    Wait();
  }

Here is the call graph for this function:

void G4MTBarrier::WaitForReadyWorkers ( )

virtual

Definition at line 104 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();
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• geant4.10.03.p01/source/global/management/include/G4MTBarrier.hh
• geant4.10.03.p01/source/global/management/src/G4MTBarrier.cc