Package co.paralleluniverse.strands.concurrent

Class ReentrantLock

  • All Implemented Interfaces:
    java.io.Serializable, java.util.concurrent.locks.Lock
    public class ReentrantLock
extends java.lang.Object
implements java.util.concurrent.locks.Lock, java.io.Serializable
    A reentrant mutual exclusion Lock with the same basic behavior and semantics as the implicit monitor lock accessed using synchronized methods and statements, but with extended capabilities.

    A ReentrantLock is owned by the strand last successfully locking, but not yet unlocking it. A strand invoking lock will return, successfully acquiring the lock, when the lock is not owned by another strand. The method will return immediately if the current strand already owns the lock. This can be checked using methods isHeldByCurrentStrand(), and getHoldCount().

    The constructor for this class accepts an optional fairness parameter. When set true, under contention, locks favor granting access to the longest-waiting strand. Otherwise this lock does not guarantee any particular access order. Programs using fair locks accessed by many strands may display lower overall throughput (i.e., are slower; often much slower) than those using the default setting, but have smaller variances in times to obtain locks and guarantee lack of starvation. Note however, that fairness of locks does not guarantee fairness of strand scheduling. Thus, one of many strands using a fair lock may obtain it multiple times in succession while other active strands are not progressing and not currently holding the lock. Also note that the untimed tryLock method does not honor the fairness setting. It will succeed if the lock is available even if other strands are waiting.

    It is recommended practice to always immediately follow a call to lock with a try block, most typically in a before/after construction such as: 

     class X {
   private final ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
     lock.lock();  // block until condition holds
     try {
       // ... method body
     } finally {
       lock.unlock()
     }
   }
 }

    In addition to implementing the Lock interface, this class defines methods isLocked and getLockQueueLength, as well as some associated protected access methods that may be useful for instrumentation and monitoring.

    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.

    This lock supports a maximum of 2147483647 recursive locks by the same strand. Attempts to exceed this limit result in Error throws from locking methods.

    Since:
    1.5
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ReentrantLock()
      Creates an instance of ReentrantLock.
      ReentrantLock​(boolean fair)
      Creates an instance of ReentrantLock with the given fairness policy.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getHoldCount()
      Queries the number of holds on this lock by the current strand.
      protected Strand getOwner()
      Returns the strand that currently owns this lock, or null if not owned.
      protected java.util.Collection<Strand> getQueuedStrands()
      Returns a collection containing strands that may be waiting to acquire this lock.
      int getQueueLength()
      Returns an estimate of the number of strands waiting to acquire this lock.
      protected java.util.Collection<Strand> getWaitingStrands​(java.util.concurrent.locks.Condition condition)
      Returns a collection containing those strands that may be waiting on the given condition associated with this lock.
      int getWaitQueueLength​(java.util.concurrent.locks.Condition condition)
      Returns an estimate of the number of strands waiting on the given condition associated with this lock.
      boolean hasQueuedStrand​(Strand strand)
      Queries whether the given strand is waiting to acquire this lock.
      boolean hasQueuedStrands()
      Queries whether any strands are waiting to acquire this lock.
      boolean hasWaiters​(java.util.concurrent.locks.Condition condition)
      Queries whether any strands are waiting on the given condition associated with this lock.
      boolean isFair()
      Returns true if this lock has fairness set true.
      boolean isHeldByCurrentStrand()
      Queries if this lock is held by the current strand.
      boolean isLocked()
      Queries if this lock is held by any strand.
      void lock()
      Acquires the lock.
      void lockInterruptibly()
      Acquires the lock unless the current strand is interrupted.
      java.util.concurrent.locks.Condition newCondition()
      Returns a Condition instance for use with this Lock instance.
      java.lang.String toString()
      Returns a string identifying this lock, as well as its lock state.
      boolean tryLock()
      Acquires the lock only if it is not held by another strand at the time of invocation.
      boolean tryLock​(long timeout, java.util.concurrent.TimeUnit unit)
      Acquires the lock if it is not held by another strand within the given waiting time and the current strand has not been interrupted.
      void unlock()
      Attempts to release this lock.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReentrantLock

        public ReentrantLock()
        Creates an instance of ReentrantLock. This is equivalent to using ReentrantLock(false).

      • ReentrantLock

        public ReentrantLock​(boolean fair)
        Creates an instance of ReentrantLock with the given fairness policy.
        Parameters:
        fair - true if this lock should use a fair ordering policy

    • Method Detail

      • lock

        @Suspendable
public void lock()
        Acquires the lock.

        Acquires the lock if it is not held by another strand and returns immediately, setting the lock hold count to one.

        If the current strand already holds the lock then the hold count is incremented by one and the method returns immediately.

        If the lock is held by another strand then the current strand becomes disabled for strand scheduling purposes and lies dormant until the lock has been acquired, at which time the lock hold count is set to one.

        Specified by:
        lock in interface java.util.concurrent.locks.Lock

      • lockInterruptibly

        @Suspendable
public void lockInterruptibly()
                       throws java.lang.InterruptedException
        Acquires the lock unless the current strand is interrupted.

        Acquires the lock if it is not held by another strand and returns immediately, setting the lock hold count to one.

        If the current strand already holds this lock then the hold count is incremented by one and the method returns immediately.

        If the lock is held by another strand then the current strand becomes disabled for strand scheduling purposes and lies dormant until one of two things happens:

        • The lock is acquired by the current strand; or
        • Some other strand interrupts the current strand.

        If the lock is acquired by the current strand then the lock hold count is set to one.

        If the current strand:

        • has its interrupted status set on entry to this method; or
        • is interrupted while acquiring the lock,
        then InterruptedException is thrown and the current strand's interrupted status is cleared.

        In this implementation, as this method is an explicit interruption point, preference is given to responding to the interrupt over normal or reentrant acquisition of the lock.

        Specified by:
        lockInterruptibly in interface java.util.concurrent.locks.Lock
        Throws:
        java.lang.InterruptedException - if the current strand is interrupted

      • tryLock

        public boolean tryLock()
        Acquires the lock only if it is not held by another strand at the time of invocation.

        Acquires the lock if it is not held by another strand and returns immediately with the value true, setting the lock hold count to one. Even when this lock has been set to use a fair ordering policy, a call to tryLock() will immediately acquire the lock if it is available, whether or not other strands are currently waiting for the lock. This "barging" behavior can be useful in certain circumstances, even though it breaks fairness. If you want to honor the fairness setting for this lock, then use tryLock(0, TimeUnit.SECONDS) which is almost equivalent (it also detects interruption).

        If the current strand already holds this lock then the hold count is incremented by one and the method returns true.

        If the lock is held by another strand then this method will return immediately with the value false.

        Specified by:
        tryLock in interface java.util.concurrent.locks.Lock
        Returns:
        true if the lock was free and was acquired by the current strand, or the lock was already held by the current strand; and false otherwise

      • tryLock

        @Suspendable
public boolean tryLock​(long timeout,
                       java.util.concurrent.TimeUnit unit)
                throws java.lang.InterruptedException
        Acquires the lock if it is not held by another strand within the given waiting time and the current strand has not been interrupted.

        Acquires the lock if it is not held by another strand and returns immediately with the value true, setting the lock hold count to one. If this lock has been set to use a fair ordering policy then an available lock will not be acquired if any other strands are waiting for the lock. This is in contrast to the tryLock() method. If you want a timed tryLock that does permit barging on a fair lock then combine the timed and un-timed forms together: 

        if (lock.tryLock() || lock.tryLock(timeout, unit) ) { ... }

        If the current strand already holds this lock then the hold count is incremented by one and the method returns true.

        If the lock is held by another strand then the current strand becomes disabled for strand scheduling purposes and lies dormant until one of three things happens:

        • The lock is acquired by the current strand; or
        • Some other strand interrupts the current strand; or
        • The specified waiting time elapses

        If the lock is acquired then the value true is returned and the lock hold count is set to one.

        If the current strand:

        • has its interrupted status set on entry to this method; or
        • is interrupted while acquiring the lock,
        then InterruptedException is thrown and the current strand's interrupted status is cleared.

        If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

        In this implementation, as this method is an explicit interruption point, preference is given to responding to the interrupt over normal or reentrant acquisition of the lock, and over reporting the elapse of the waiting time.

        Specified by:
        tryLock in interface java.util.concurrent.locks.Lock
        Parameters:
        timeout - the time to wait for the lock
        unit - the time unit of the timeout argument
        Returns:
        true if the lock was free and was acquired by the current strand, or the lock was already held by the current strand; and false if the waiting time elapsed before the lock could be acquired
        Throws:
        java.lang.InterruptedException - if the current strand is interrupted
        java.lang.NullPointerException - if the time unit is null

      • unlock

        public void unlock()
        Attempts to release this lock.

        If the current strand is the holder of this lock then the hold count is decremented. If the hold count is now zero then the lock is released. If the current strand is not the holder of this lock then IllegalMonitorStateException is thrown.

        Specified by:
        unlock in interface java.util.concurrent.locks.Lock
        Throws:
        java.lang.IllegalMonitorStateException - if the current strand does not hold this lock

      • newCondition

        public java.util.concurrent.locks.Condition newCondition()
        Returns a Condition instance for use with this Lock instance.

        The returned Condition instance supports the same usages as do the Object monitor methods (wait, notify, and notifyAll) when used with the built-in monitor lock.

        • If this lock is not held when any of the Condition waiting or signalling methods are called, then an IllegalMonitorStateException is thrown.
        • When the condition waiting methods are called the lock is released and, before they return, the lock is reacquired and the lock hold count restored to what it was when the method was called.
        • If a strand is interrupted while waiting then the wait will terminate, an InterruptedException will be thrown, and the strand's interrupted status will be cleared.
        • Waiting strands are signalled in FIFO order.
        • The ordering of lock reacquisition for strands returning from waiting methods is the same as for strands initially acquiring the lock, which is in the default case not specified, but for fair locks favors those strands that have been waiting the longest.
        Specified by:
        newCondition in interface java.util.concurrent.locks.Lock
        Returns:
        the Condition object

      • getHoldCount

        public int getHoldCount()
        Queries the number of holds on this lock by the current strand.

        A strand has a hold on a lock for each lock action that is not matched by an unlock action.

        The hold count information is typically only used for testing and debugging purposes. For example, if a certain section of code should not be entered with the lock already held then we can assert that fact: 

         class X {
   ReentrantLock lock = new ReentrantLock();
   // ...
   public void m() {
     assert lock.getHoldCount() == 0;
     lock.lock();
     try {
       // ... method body
     } finally {
       lock.unlock();
     }
   }
 }
        Returns:
        the number of holds on this lock by the current strand, or zero if this lock is not held by the current strand

      • isHeldByCurrentStrand

        public boolean isHeldByCurrentStrand()
        Queries if this lock is held by the current strand.

        Analogous to the Thread.holdsLock(java.lang.Object) method for built-in monitor locks, this method is typically used for debugging and testing. For example, a method that should only be called while a lock is held can assert that this is the case: 

         class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert lock.isHeldByCurrentStrand();
       // ... method body
   }
 }

        It can also be used to ensure that a reentrant lock is used in a non-reentrant manner, for example: 

         class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert !lock.isHeldByCurrentStrand();
       lock.lock();
       try {
           // ... method body
       } finally {
           lock.unlock();
       }
   }
 }
        Returns:
        true if current strand holds this lock and false otherwise

      • isLocked

        public boolean isLocked()
        Queries if this lock is held by any strand. This method is designed for use in monitoring of the system state, not for synchronization control.
        Returns:
        true if any strand holds this lock and false otherwise

      • isFair

        public final boolean isFair()
        Returns true if this lock has fairness set true.
        Returns:
        true if this lock has fairness set true

      • getOwner

        protected Strand getOwner()
        Returns the strand that currently owns this lock, or null if not owned. When this method is called by a strand that is not the owner, the return value reflects a best-effort approximation of current lock status. For example, the owner may be momentarily null even if there are strands 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 null if not owned

      • hasQueuedStrands

        public final boolean hasQueuedStrands()
        Queries whether any strands are waiting to acquire this lock. Note that because cancellations may occur at any time, a true return does not guarantee that any other strand will ever acquire this lock. This method is designed primarily for use in monitoring of the system state.
        Returns:
        true if there may be other strands waiting to acquire the lock

      • hasQueuedStrand

        public final boolean hasQueuedStrand​(Strand strand)
        Queries whether the given strand is waiting to acquire this lock. Note that because cancellations may occur at any time, a true return does not guarantee that this strand will ever acquire this lock. This method is designed primarily for use in monitoring of the system state.
        Parameters:
        strand - the strand
        Returns:
        true if the given strand is queued waiting for this lock
        Throws:
        java.lang.NullPointerException - if the strand is null

      • getQueueLength

        public final int getQueueLength()
        Returns an estimate of the number of strands waiting to acquire this lock. The value is only an estimate because the number of strands 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 strands waiting for this lock

      • getQueuedStrands

        protected java.util.Collection<Strand> getQueuedStrands()
        Returns a collection containing strands that may be waiting to acquire this lock. Because the actual set of strands 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 strands

      • hasWaiters

        public boolean hasWaiters​(java.util.concurrent.locks.Condition condition)
        Queries whether any strands are waiting on the given condition associated with this lock. Note that because timeouts and interrupts may occur at any time, a true return does not guarantee that a future signal will awaken any strands. This method is designed primarily for use in monitoring of the system state.
        Parameters:
        condition - the condition
        Returns:
        true if there are any waiting strands
        Throws:
        java.lang.IllegalMonitorStateException - if this lock is not held
        java.lang.IllegalArgumentException - if the given condition is not associated with this lock
        java.lang.NullPointerException - if the condition is null

      • getWaitQueueLength

        public int getWaitQueueLength​(java.util.concurrent.locks.Condition condition)
        Returns an estimate of the number of strands waiting on the given condition associated with this 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 strands
        Throws:
        java.lang.IllegalMonitorStateException - if this lock is not held
        java.lang.IllegalArgumentException - if the given condition is not associated with this lock
        java.lang.NullPointerException - if the condition is null

      • getWaitingStrands

        protected java.util.Collection<Strand> getWaitingStrands​(java.util.concurrent.locks.Condition condition)
        Returns a collection containing those strands that may be waiting on the given condition associated with this lock. Because the actual set of strands 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 strands
        Throws:
        java.lang.IllegalMonitorStateException - if this lock is not held
        java.lang.IllegalArgumentException - if the given condition is not associated with this lock
        java.lang.NullPointerException - if the condition is null

      • toString

        public java.lang.String toString()
        Returns a string identifying this lock, as well as its lock state. The state, in brackets, includes either the String "Unlocked" or the String "Locked by" followed by the name of the owning strand.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string identifying this lock, as well as its lock state