org.HdrHistogram
Class WriterReaderPhaser

java.lang.Object
  org.HdrHistogram.WriterReaderPhaser

public class WriterReaderPhaser
extends Object

WriterReaderPhaser instances provide an asymmetric means for synchronizing the execution of wait-free "writer" critical sections against a "reader phase flip" that needs to make sure no writer critical sections that were active at the beginning of the flip are still active after the flip is done. Multiple writers and multiple readers are supported.

While a WriterReaderPhaser can be useful in multiple scenarios, a specific and common use case is that of safely managing "double buffered" data stream access in which writers can proceed without being blocked, while readers gain access to stable and unchanging buffer samples

NOTE: WriterReaderPhaser writers are wait-free on architectures that support wait-free atomic increment operations. They remain lock-free (but not wait-free) on architectures that do not support wait-free atomic increment operations.

WriterReaderPhaser "writers" are wait free, "readers" block for other "readers", and "readers" are only blocked by "writers" whose critical was entered before the reader's flipPhase() attempt.

When used to protect an actively recording data structure, the assumptions on how readers and writers act are:

1. There are two sets of data structures ("active" and "inactive")
2. Writing is done to the perceived active version (as perceived by the writer), and only within critical sections delineated by writerCriticalSectionEnter() and writerCriticalSectionExit(long)).
3. Only readers switch the perceived roles of the active and inactive data structures. They do so only while under readerLock(), and only before calling flipPhase().

When the above assumptions are met, WriterReaderPhaser guarantees that the inactive data structures are not being modified by any writers while being read while under readerLock() protection after a flipPhase() operation.

Constructor Summary

WriterReaderPhaser()

Method Summary

void	flipPhase() Flip a phase in the WriterReaderPhaser instance, flipPhase() can only be called while holding the readerLock().
void	flipPhase(long yieldTimeNsec) Flip a phase in the WriterReaderPhaser instance, flipPhase() can only be called while holding the readerLock().
void	readerLock() Enter to a critical section containing a read operation (mutually excludes against other readerLock calls).
void	readerUnlock() Exit from a critical section containing a read operation (relinquishes mutual exclusion against other readerLock calls).
long	writerCriticalSectionEnter() Indicate entry to a critical section containing a write operation.
void	writerCriticalSectionExit(long criticalValueAtEnter) Indicate exit from a critical section containing a write operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WriterReaderPhaser

public WriterReaderPhaser()

Method Detail

writerCriticalSectionEnter

public long writerCriticalSectionEnter()

Indicate entry to a critical section containing a write operation.

This call is wait-free on architectures that support wait free atomic increment operations, and is lock-free on architectures that do not.

writerCriticalSectionEnter() must be matched with a subsequent writerCriticalSectionExit(long) in order for CriticalSectionPhaser synchronization to function properly.

Returns:

an (opaque) value associated with the critical section entry, which MUST be provided to the matching writerCriticalSectionExit(long) call.

writerCriticalSectionExit

public void writerCriticalSectionExit(long criticalValueAtEnter)

Indicate exit from a critical section containing a write operation.

This call is wait-free on architectures that support wait free atomic increment operations, and is lock-free on architectures that do not.

writerCriticalSectionExit(long) must be matched with a preceding writerCriticalSectionEnter() call, and must be provided with the matching writerCriticalSectionEnter() call's return value, in order for CriticalSectionPhaser synchronization to function properly.

Parameters:

criticalValueAtEnter - the (opaque) value returned from the matching writerCriticalSectionEnter() call.

readerLock

public void readerLock()

Enter to a critical section containing a read operation (mutually excludes against other readerLock calls).

readerLock DOES NOT provide synchronization against writerCriticalSectionEnter() calls. Use flipPhase() to synchronize reads against writers.

readerUnlock

public void readerUnlock()

Exit from a critical section containing a read operation (relinquishes mutual exclusion against other readerLock calls).

flipPhase

public void flipPhase(long yieldTimeNsec)

Flip a phase in the WriterReaderPhaser instance, flipPhase() can only be called while holding the readerLock(). flipPhase() will return only after all writer critical sections (protected by writerCriticalSectionEnter() ()} and writerCriticalSectionExit(long) ()}) that may have been in flight when the flipPhase() call were made had completed.

No actual writer critical section activity is required for flipPhase() to succeed.

However, flipPhase() is lock-free with respect to calls to writerCriticalSectionEnter() and writerCriticalSectionExit(long). It may spin-wait for for active writer critical section code to complete.

Parameters:

yieldTimeNsec - The amount of time (in nanoseconds) to sleep in each yield if yield loop is needed.

flipPhase

public void flipPhase()

Flip a phase in the WriterReaderPhaser instance, flipPhase() can only be called while holding the readerLock(). flipPhase() will return only after all writer critical sections (protected by writerCriticalSectionEnter() ()} and writerCriticalSectionExit(long) ()}) that may have been in flight when the flipPhase() call were made had completed.

No actual writer critical section activity is required for flipPhase() to succeed.

However, flipPhase() is lock-free with respect to calls to writerCriticalSectionEnter() and writerCriticalSectionExit(long). It may spin-wait for for active writer critical section code to complete.