java.util.concurrent.locks
class ReentrantReadWriteLock

java.lang.Object java.util.concurrent.locks.ReentrantReadWriteLock

All Implemented Interfaces:

Serializable, ReadWriteLock

Most common way to construct:

ReentrantReadWriteLock lock = new ReentrantReadWriteLock();

Based on 861 examples

public class ReentrantReadWriteLock
extends Object
implements ReadWriteLock, Serializable

An implementation of {@link ReadWriteLock} supporting similar semantics to {@link ReentrantLock}.

This class has the following properties:

• Acquisition order

  This class does not impose a reader or writer preference ordering for lock access. However, it does support an optional fairness policy.

  Non-fair mode (default)

  When constructed as non-fair (the default), the order of entry to the read and write lock is unspecified, subject to reentrancy constraints. A nonfair lock that is continously contended may indefinitely postpone one or more reader or writer threads, but will normally have higher throughput than a fair lock.

  Fair mode

  When constructed as fair, threads contend for entry using an approximately arrival-order policy. When the currently held lock is released either the longest-waiting single writer thread will be assigned the write lock, or if there is a group of reader threads waiting longer than all waiting writer threads, that group will be assigned the read lock.

  A thread that tries to acquire a fair read lock (non-reentrantly) will block if either the write lock is held, or there is a waiting writer thread. The thread will not acquire the read lock until after the oldest currently waiting writer thread has acquired and released the write lock. Of course, if a waiting writer abandons its wait, leaving one or more reader threads as the longest waiters in the queue with the write lock free, then those readers will be assigned the read lock.

  A thread that tries to acquire a fair write lock (non-reentrantly) will block unless both the read lock and write lock are free (which implies there are no waiting threads). (Note that the non-blocking {@link ReadLock#tryLock()} and {@link WriteLock#tryLock()} methods do not honor this fair setting and will acquire the lock if it is possible, regardless of waiting threads.)

• Reentrancy

  This lock allows both readers and writers to reacquire read or write locks in the style of a {@link ReentrantLock}. Non-reentrant readers are not allowed until all write locks held by the writing thread have been released.

  Additionally, a writer can acquire the read lock, but not vice-versa. Among other applications, reentrancy can be useful when write locks are held during calls or callbacks to methods that perform reads under read locks. If a reader tries to acquire the write lock it will never succeed.

• Lock downgrading

  Reentrancy also allows downgrading from the write lock to a read lock, by acquiring the write lock, then the read lock and then releasing the write lock. However, upgrading from a read lock to the write lock is not possible.

• Interruption of lock acquisition

  The read lock and write lock both support interruption during lock acquisition.

• {@link Condition} support

  The write lock provides a {@link Condition} implementation that behaves in the same way, with respect to the write lock, as the {@link Condition} implementation provided by {@link ReentrantLock#newCondition} does for {@link ReentrantLock}. This {@link Condition} can, of course, only be used with the write lock.

  The read lock does not support a {@link Condition} and {@code readLock().newCondition()} throws {@code UnsupportedOperationException}.

• Instrumentation

  This class supports methods to determine whether locks are held or contended. These methods are designed for monitoring system state, not for synchronization control.

Serialization of this class behaves in the same way as built-in locks: a deserialized lock is in the unlocked state, regardless of its state when serialized.

Sample usages. Here is a code sketch showing how to exploit reentrancy to perform lock downgrading after updating a cache (exception handling is elided for simplicity):

 class CachedData {
   Object data;
   volatile boolean cacheValid;
   ReentrantReadWriteLock rwl = new ReentrantReadWriteLock();

   void processCachedData() {
     rwl.readLock().lock();
     if (!cacheValid) {
        // Must release read lock before acquiring write lock
        rwl.readLock().unlock();
        rwl.writeLock().lock();
        // Recheck state because another thread might have acquired
        //   write lock and changed state before we did.
        if (!cacheValid) {
          data = ...
          cacheValid = true;
        }
        // Downgrade by acquiring read lock before releasing write lock
        rwl.readLock().lock();
        rwl.writeLock().unlock(); // Unlock write, still hold read
     }

     use(data);
     rwl.readLock().unlock();
   }
 }
 

{@code
 class RWDictionary {
    private final Map m = new TreeMap();
    private final ReentrantReadWriteLock rwl = new ReentrantReadWriteLock();
    private final Lock r = rwl.readLock();
    private final Lock w = rwl.writeLock();

    public Data get(String key) {
        r.lock();
        try { return m.get(key); }
        finally { r.unlock(); }
    }
    public String[] allKeys() {
        r.lock();
        try { return m.keySet().toArray(); }
        finally { r.unlock(); }
    }
    public Data put(String key, Data value) {
        w.lock();
        try { return m.put(key, value); }
        finally { w.unlock(); }
    }
    public void clear() {
        w.lock();
        try { m.clear(); }
        finally { w.unlock(); }
    }
 }}

Implementation Notes

This lock supports a maximum of 65535 recursive write locks and 65535 read locks. Attempts to exceed these limits result in {@link Error} throws from locking methods.

ReentrantReadWriteLock

public ReentrantReadWriteLock()

Creates a new {@code ReentrantReadWriteLock} with default (nonfair) ordering properties.

ReentrantReadWriteLock

public ReentrantReadWriteLock(boolean fair)

Creates a new {@code ReentrantReadWriteLock} with the given fairness policy.

Parameters:

fair - {@code true} if this lock should use a fair ordering policy

getOwner

protected Thread getOwner()

Returns the thread that currently owns the write lock, or {@code null} if not owned. When this method is called by a thread that is not the owner, the return value reflects a best-effort approximation of current lock status. For example, the owner may be momentarily {@code null} even if there are threads trying to acquire the lock but have not yet done so. This method is designed to facilitate construction of subclasses that provide more extensive lock monitoring facilities.

Returns:

the owner, or {@code null} if not owned

getQueuedReaderThreads

protected Collection getQueuedReaderThreads()

Returns a collection containing threads that may be waiting to acquire the read lock. Because the actual set of threads may change dynamically while constructing this result, the returned collection is only a best-effort estimate. The elements of the returned collection are in no particular order. This method is designed to facilitate construction of subclasses that provide more extensive lock monitoring facilities.

Returns:

the collection of threads

getQueuedThreads

protected Collection getQueuedThreads()

Returns a collection containing threads that may be waiting to acquire either the read or write lock. Because the actual set of threads may change dynamically while constructing this result, the returned collection is only a best-effort estimate. The elements of the returned collection are in no particular order. This method is designed to facilitate construction of subclasses that provide more extensive monitoring facilities.

Returns:

the collection of threads

getQueuedWriterThreads

protected Collection getQueuedWriterThreads()

Returns a collection containing threads that may be waiting to acquire the write lock. Because the actual set of threads may change dynamically while constructing this result, the returned collection is only a best-effort estimate. The elements of the returned collection are in no particular order. This method is designed to facilitate construction of subclasses that provide more extensive lock monitoring facilities.

Returns:

the collection of threads

getQueueLength

public final int getQueueLength()

Returns an estimate of the number of threads waiting to acquire either the read or write lock. The value is only an estimate because the number of threads may change dynamically while this method traverses internal data structures. This method is designed for use in monitoring of the system state, not for synchronization control.

Returns:

the estimated number of threads waiting for this lock

getReadHoldCount

public int getReadHoldCount()

Queries the number of reentrant read holds on this lock by the current thread. A reader thread has a hold on a lock for each lock action that is not matched by an unlock action.

Returns:

the number of holds on the read lock by the current thread, or zero if the read lock is not held by the current thread

getReadLockCount

public int getReadLockCount()

Queries the number of read locks held for this lock. This method is designed for use in monitoring system state, not for synchronization control.

Returns:

the number of read locks held.

getWaitingThreads

protected Collection getWaitingThreads(Condition condition)

Returns a collection containing those threads that may be waiting on the given condition associated with the write lock. Because the actual set of threads may change dynamically while constructing this result, the returned collection is only a best-effort estimate. The elements of the returned collection are in no particular order. This method is designed to facilitate construction of subclasses that provide more extensive condition monitoring facilities.

Parameters:

condition - the condition

Returns:

the collection of threads

getWaitQueueLength

public int getWaitQueueLength(Condition condition)

Returns an estimate of the number of threads waiting on the given condition associated with the write lock. Note that because timeouts and interrupts may occur at any time, the estimate serves only as an upper bound on the actual number of waiters. This method is designed for use in monitoring of the system state, not for synchronization control.

Parameters:

condition - the condition

Returns:

the estimated number of waiting threads

getWriteHoldCount

public int getWriteHoldCount()

Queries the number of reentrant write holds on this lock by the current thread. A writer thread has a hold on a lock for each lock action that is not matched by an unlock action.

Returns:

the number of holds on the write lock by the current thread, or zero if the write lock is not held by the current thread

hasQueuedThread

public final boolean hasQueuedThread(Thread thread)

Queries whether the given thread is waiting to acquire either the read or write lock. Note that because cancellations may occur at any time, a {@code true} return does not guarantee that this thread will ever acquire a lock. This method is designed primarily for use in monitoring of the system state.

Parameters:

thread - the thread

Returns:

{@code true} if the given thread is queued waiting for this lock

hasQueuedThreads

public final boolean hasQueuedThreads()

Queries whether any threads are waiting to acquire the read or write lock. Note that because cancellations may occur at any time, a {@code true} return does not guarantee that any other thread will ever acquire a lock. This method is designed primarily for use in monitoring of the system state.

Returns:

{@code true} if there may be other threads waiting to acquire the lock

hasWaiters

public boolean hasWaiters(Condition condition)

Queries whether any threads are waiting on the given condition associated with the write lock. Note that because timeouts and interrupts may occur at any time, a {@code true} return does not guarantee that a future {@code signal} will awaken any threads. This method is designed primarily for use in monitoring of the system state.

Parameters:

condition - the condition

Returns:

{@code true} if there are any waiting threads

isFair

public final boolean isFair()

Returns {@code true} if this lock has fairness set true.

Returns:

{@code true} if this lock has fairness set true

isWriteLocked

public boolean isWriteLocked()

Queries if the write lock is held by any thread. This method is designed for use in monitoring system state, not for synchronization control.

Returns:

{@code true} if any thread holds the write lock and {@code false} otherwise

isWriteLockedByCurrentThread

public boolean isWriteLockedByCurrentThread()

Queries if the write lock is held by the current thread.

Returns:

{@code true} if the current thread holds the write lock and {@code false} otherwise

readLock

public ReentrantReadWriteLock.ReadLock readLock()

toString

public String toString()

Returns a string identifying this lock, as well as its lock state. The state, in brackets, includes the String {@code "Write locks ="} followed by the number of reentrantly held write locks, and the String {@code "Read locks ="} followed by the number of held read locks.

Overrides:

toString in class Object

Returns:

a string identifying this lock, as well as its lock state

writeLock

public ReentrantReadWriteLock.WriteLock writeLock()