AbstractQueuedSynchronizer源码一
JDK版本：1.8
Java开发人员，想要迈向高级开发或者架构师级别，JDK中提供的AQS原理是必须要了解的。看源码并不是目的，学习并发编程大师Doug Lea的编程思想化为己用才是最重要的。
其次，还有一个重要的原因就是，其它一线大厂我可能没有那么了解，但阿里的面试AQS是必问的。
之前见过一道阿里
P9的面试题。请分别说一下volatile、synchronized、CAS、AQS越详细越好。
AQS源码准备分三个章节分析完，这里是第一个章节，初步了解AbstractQueuedSynchronizer中的一些基本内容。
如果有不了解CAS机制的，可以先了解一下CAS无锁编程。
请耐心看完下面Doug Lea提供的类头注释。
/**
* Provides a framework for implementing blocking locks and related
* synchronizers (semaphores, events, etc) that rely on
* first-in-first-out (FIFO) wait queues. This class is designed to
* be a useful basis for most kinds of synchronizers that rely on a
* single atomic {@code int} value to represent state. Subclasses
* must define the protected methods that change this state, and which
* define what that state means in terms of this object being acquired
* or released. Given these, the other methods in this class carry
* out all queuing and blocking mechanics. Subclasses can maintain
* other state fields, but only the atomically updated {@code int}
* value manipulated using methods {@link #getState}, {@link
* #setState} and {@link #compareAndSetState} is tracked with respect
* to synchronization.
*
* <p>Subclasses should be defined as non-public internal helper
* classes that are used to implement the synchronization properties
* of their enclosing class. Class
* {@code AbstractQueuedSynchronizer} does not implement any
* synchronization interface. Instead it defines methods such as
* {@link #acquireInterruptibly} that can be invoked as
* appropriate by concrete locks and related synchronizers to
* implement their public methods.
*
* <p>This class supports either or both a default <em>exclusive</em>
* mode and a <em>shared</em> mode. When acquired in exclusive mode,
* attempted acquires by other threads cannot succeed. Shared mode
* acquires by multiple threads may (but need not) succeed. This class
* does not "understand" these differences except in the
* mechanical sense that when a shared mode acquire succeeds, the next
* waiting thread (if one exists) must also determine whether it can
* acquire as well. Threads waiting in the different modes share the
* same FIFO queue. Usually, implementation subclasses support only
* one of these modes, but both can come into play for example in a
* {@link ReadWriteLock}. Subclasses that support only exclusive or
* only shared modes need not define the methods supporting the unused mode.
*
* <p>This class defines a nested {@link ConditionObject} class that
* can be used as a {@link Condition} implementation by subclasses
* supporting exclusive mode for which method {@link
* #isHeldExclusively} reports whether synchronization is exclusively
* held with respect to the current thread, method {@link #release}
* invoked with the current {@link #getState} value fully releases
* this object, and {@link #acquire}, given this saved state value,
* eventually restores this object to its previous acquired state. No
* {@code AbstractQueuedSynchronizer} method otherwise creates such a
* condition, so if this constraint cannot be met, do not use it. The
* behavior of {@link ConditionObject} depends of course on the
* semantics of its synchronizer implementation.
*
* <p>This class provides inspection, instrumentation, and monitoring
* methods for the internal queue, as well as similar methods for
* condition objects. These can be exported as desired into classes
* using an {@code AbstractQueuedSynchronizer} for their
* synchronization mechanics.
*
* <p>Serialization of this class stores only the underlying atomic
* integer maintaining state, so deserialized objects have empty
* thread queues. Typical subclasses requiring serializability will
* define a {@code readObject} method that restores this to a known
* initial state upon deserialization.
*
* <h3>Usage</h3>
*
* <p>To use this class as the basis of a synchronizer, redefine the
* following methods, as applicable, by inspecting and/or modifying
* the synchronization state using {@link #getState}, {@link
* #setState} and/or {@link #compareAndSetState}:
*
* <ul>
* <li> {@link #tryAcquire}
* <li> {@link #tryRelease}
* <li> {@link #tryAcquireShared}
* <li> {@link #tryReleaseShared}
* <li> {@link #isHeldExclusively}
* </ul>
*
* Each of these methods by default throws {@link
* UnsupportedOperationException}. Implementations of these methods
* must be internally thread-safe, and should in general be short and
* not block. Defining these methods is the <em>only</em> supported
* means of using this class. All other methods are declared
* {@code final} because they cannot be independently varied.
*
* <p>You may also find the inherited methods from {@link
* AbstractOwnableSynchronizer} useful to keep track of the thread
* owning an exclusive synchronizer. You are encouraged to use them
* -- this enables monitoring and diagnostic tools to assist users in
* determining which threads hold locks.
*
* <p>Even though this class is based on an internal FIFO queue, it
* does not automatically enforce FIFO acquisition policies. The core
* of exclusive synchronization takes the form:
*
* <pre>
* Acquire:
* while (!tryAcquire(arg)) {
* <em>enqueue thread if it is not already queued</em>;
* <em>possibly block current thread</em>;
* }
*
* Release:
* if (tryRelease(arg))
* <em>unblock the first queued thread</em>;
* </pre>
*
* (Shared mode is similar but may involve cascading signals.)
*
* <p id="barging">Because checks in acquire are invoked before
* enqueuing, a newly acquiring thread may <em>barge</em> ahead of
* others that are blocked and queued. However, you can, if desired,
* define {@code tryAcquire} and/or {@code tryAcquireShared} to
* disable barging by internally invoking one or more of the inspection
* methods, thereby providing a <em>fair</em> FIFO acquisition order.
* In particular, most fair synchronizers can define {@code tryAcquire}
* to return {@code false} if {@link #hasQueuedPredecessors} (a method
* specifically designed to be used by fair synchronizers) returns
* {@code true}. Other variations are possible.
*
* <p>Throughput and scalability are generally highest for the
* default barging (also known as <em>greedy</em>,
* <em>renouncement</em>, and <em>convoy-avoidance</em>) strategy.
* While this is not guaranteed to be fair or starvation-free, earlier
* queued threads are allowed to recontend before later queued
* threads, and each recontention has an unbiased chance to succeed
* against incoming threads. Also, while acquires do not
* "spin" in the usual sense, they may perform multiple
* invocations of {@code tryAcquire} interspersed with other
* computations before blocking. This gives most of the benefits of
* spins when exclusive synchronization is only briefly held, without
* most of the liabilities when it isn't. If so desired, you can
* augment this by preceding calls to acquire methods with
* "fast-path" checks, possibly prechecking {@link #hasContended}
* and/or {@link #hasQueuedThreads} to only do so if the synchronizer
* is likely not to be contended.
*
* <p>This class provides an efficient and scalable basis for
* synchronization in part by specializing its range of use to
* synchronizers that can rely on {@code int} state, acquire, and
* release parameters, and an internal FIFO wait queue. When this does
* not suffice, you can build synchronizers from a lower level using
* {@link java.util.concurrent.atomic atomic} classes, your own custom
* {@link java.util.Queue} classes, and {@link LockSupport} blocking
* support.
*
* <h3>Usage Examples</h3>
*
* <p>Here is a non-reentrant mutual exclusion lock class that uses
* the value zero to represent the unlocked state, and one to
* represent the locked state. While a non-reentrant lock
* does not strictly require recording of the current owner
* thread, this class does so anyway to make usage easier to monitor.
* It also supports conditions and exposes
* one of the instrumentation methods:
*
* <pre> {@code
* class Mutex implements Lock, java.io.Serializable {
*
* // Our internal helper class
* private static class Sync extends AbstractQueuedSynchronizer {
* // Reports whether in locked state
* protected boolean isHeldExclusively() {
* return getState() == 1;
* }
*
* // Acquires the lock if state is zero
* public boolean tryAcquire(int acquires) {
* assert acquires == 1; // Otherwise unused
* if (compareAndSetState(0, 1)) {
* setExclusiveOwnerThread(Thread.currentThread());
* return true;
* }
* return false;
* }
*
* // Releases the lock by setting state to zero
* protected boolean tryRelease(int releases) {
* assert releases == 1; // Otherwise unused
* if (getState() == 0) throw new IllegalMonitorStateException();
* setExclusiveOwnerThread(null);
* setState(0);
* return true;
* }
*
* // Provides a Condition
* Condition newCondition() { return new ConditionObject(); }
*
* // Deserializes properly
* private void readObject(ObjectInputStream s)
* throws IOException, ClassNotFoundException {
* s.defaultReadObject();
* setState(0); // reset to unlocked state
* }
* }
*
* // The sync object does all the hard work. We just forward to it.
* private final Sync sync = new Sync();
*
* public void lock() { sync.acquire(1); }
* public boolean tryLock() { return sync.tryAcquire(1); }
* public void unlock() { sync.release(1); }
* public Condition newCondition() { return sync.newCondition(); }
* public boolean isLocked() { return sync.isHeldExclusively(); }
* public boolean hasQueuedThreads() { return sync.hasQueuedThreads(); }
* public void lockInterruptibly() throws InterruptedException {
* sync.acquireInterruptibly(1);
* }
* public boolean tryLock(long timeout, TimeUnit unit)
* throws InterruptedException {
* return sync.tryAcquireNanos(1, unit.toNanos(timeout));
* }
* }}</pre>
*
* <p>Here is a latch class that is like a
* {@link java.util.concurrent.CountDownLatch CountDownLatch}
* except that it only requires a single {@code signal} to
* fire. Because a latch is non-exclusive, it uses the {@code shared}
* acquire and release methods.
*
* <pre> {@code
* class BooleanLatch {
*
* private static class Sync extends AbstractQueuedSynchronizer {
* boolean isSignalled() { return getState() != 0; }
*
* protected int tryAcquireShared(int ignore) {
* return isSignalled() ? 1 : -1;
* }
*
* protected boolean tryReleaseShared(int ignore) {
* setState(1);
* return true;
* }
* }
*
* private final Sync sync = new Sync();
* public boolean isSignalled() { return sync.isSignalled(); }
* public void signal() { sync.releaseShared(1); }
* public void await() throws InterruptedException {
* sync.acquireSharedInterruptibly(1);
* }
* }}</pre>
*
* @since 1.5
* @author Doug Lea
*/
public abstract class AbstractQueuedSynchronizer
extends AbstractOwnableSynchronizer
implements java.io.Serializable {
// ...
}
注释翻译：
提供了一个框架，依赖于
first-in-first-out (FIFO)等待队列实现了阻塞锁和相关的同步器。AbstractQueuedSynchronizer类旨在为大多数依赖于单个原子变量值来表示状态的同步器提供有用的基础。子类必须重写覆盖更改此状态的protected方法，并且定义该状态在获取或释放此状态的方法。此类中的所有其它方法用于实现所有队列排队和阻塞的机制。子类可以维护其它状态字段，但仅跟踪使用方法getState()、setState()、CompaoreAndSetState()操作的原子性更新state状态值以进行同步。 子类应定义非公共的内部类，用于实现器封闭类的同步属性。
AbstractQueuedSynchronizer类不实现任何同步接口。相反，它定义了诸如acquireInterruptibly()之类的方法，具体的锁和相关的同步器可以适当地调用这些方法来实现它们的公共方法。
AbstractQueuedSynchronizer支持独占模式和共享模式中的一种或两种，默认为独占模式。以独占模式获取锁时，其它线程尝试获取锁时不会成功。多个线程的共享模式获取锁可能（但不一定）成功。 此类不理解这些差异，除非从机械意义上来说，当共享模式获取锁成功时，下一个等待线程（如果存在）也必须确定它是否也可以获取锁。
不同模式下等待的线程共享同一个
FIFO同步队列。通常，子类实现仅支持其中一种模式。但两者都可以发挥作用，例如在ReadWriteLock中。仅支持独占或仅支持共享模式的子类不需要定义支持未使用模式的方法。
AbstractQueuedSynchronizer类内部定义了一个嵌套的ConditionObject类，它可以支持在独占模式的子类Condition中实现，其中方法isHeldExclusively()判断是否针对当前线程独占锁保持同步，release()方法用于完全释放getState()方法返回的状态值。当释放锁之后再次被唤醒获取锁时，acquire()方法会将此线程的状态值恢复到其释放锁之前的状态。否则AbstractQueuedSynchronizer中没有方法可以创造这样的Condition。因此如果无法满足此约束，请不要使用它。ConditionObject的行为要取决于其同步器实现的原语义。
AbstractQueuedSynchronizer为其内部的队列提供检查、检测和监视方法，以及用于条件对象的类似方法。这些可以根据使用需要在子类中重写AbstractQueuedSynchronizer中的方法，以实现它们的同步机制。
重上可以看出两点。
AbstractQueuedSynchronizer是个抽象类，就是提供给子类去继承的，AbstractQueuedSynchronizer提供了很多获取锁、释放锁的抽象模板方法，目的就是为了留给子类去实现具体的加锁解锁方法。AbstractQueuedSynchronizer继承自AbstractOwnableSynchronizer抽象类。AbstractOwnableSynchronizer抽象类提供了获取以及设置当前持有锁的线程的方法，方便监控。
1.AbstractOwnableSynchronizer源码
AbstractOwnableSynchronizer是为了方便跟踪当前持有锁的线程，可以帮助监控和诊断工具识别当前是哪个线程持有锁。AbstractOwnableSynchronizer源码如下：
/**
* A synchronizer that may be exclusively owned by a thread. This
* class provides a basis for creating locks and related synchronizers
* that may entail a notion of ownership. The
* {@code AbstractOwnableSynchronizer} class itself does not manage or
* use this information. However, subclasses and tools may use
* appropriately maintained values to help control and monitor access
* and provide diagnostics.
*
* @since 1.6
* @author Doug Lea
*/
public abstract class AbstractOwnableSynchronizer
implements java.io.Serializable {
/** Use serial ID even though all fields transient. */
private static final long serialVersionUID = 3737899427754241961L;
/**
* Empty constructor for use by subclasses.
*/
protected AbstractOwnableSynchronizer() { }
/**
* The current owner of exclusive mode synchronization.
*/
private transient Thread exclusiveOwnerThread;
/**
* Sets the thread that currently owns exclusive access.
* A {@code null} argument indicates that no thread owns access.
* This method does not otherwise impose any synchronization or
* {@code volatile} field accesses.
* @param thread the owner thread
*/
protected final void setExclusiveOwnerThread(Thread thread) {
exclusiveOwnerThread = thread;
}
/**
* Returns the thread last set by {@code setExclusiveOwnerThread},
* or {@code null} if never set. This method does not otherwise
* impose any synchronization or {@code volatile} field accesses.
* @return the owner thread
*/
protected final Thread getExclusiveOwnerThread() {
return exclusiveOwnerThread;
}
}
翻译注释：
AbstractOwnableSynchronizer可能由线程独占的同步器。此类为创建可能需要所有权概念的锁和相关同步器提供了基础。AbstractOwnableSynchronizer类本身部管理或使用此信息。但是，子类和工具可以使用适当维护的值来帮助控制和监视访问并提供诊断。
可以看到，AbstractOwnableSynchronizer抽象类非常简单。exclusiveOwnerThread成员变量代表当前持有锁的线程。同时针对该成员变量也向外提供了get() / set()方法，用于获取或设置当前持有锁的线程。
2.Node源码
在AbstractQueuedSynchronizer队列同步器中。Node是其内部的一个静态内部类，使用final修饰，所以该类不可被继承。其实外界也无需继承该类，因为Doug Lea已经帮助我们把最复杂的事情都做了。
AbstractQueuedSynchronizer被称作队列同步器，所以这里面肯定是与队列相关。Node就是队列中的节点。在AbstractQueuedSynchronizer中，其实维护的是一个虚拟队列，这里并没有维护一个容器用于保存队列中的所有节点。队列的实现是一个Node类型的双向链表。Node类源码如下：
/**
* Wait queue node class.
*
* <p>The wait queue is a variant of a "CLH" (Craig, Landin, and
* Hagersten) lock queue. CLH locks are normally used for
* spinlocks. We instead use them for blocking synchronizers, but
* use the same basic tactic of holding some of the control
* information about a thread in the predecessor of its node. A
* "status" field in each node keeps track of whether a thread
* should block. A node is signalled when its predecessor
* releases. Each node of the queue otherwise serves as a
* specific-notification-style monitor holding a single waiting
* thread. The status field does NOT control whether threads are
* granted locks etc though. A thread may try to acquire if it is
* first in the queue. But being first does not guarantee success;
* it only gives the right to contend. So the currently released
* contender thread may need to rewait.
*
* <p>To enqueue into a CLH lock, you atomically splice it in as new
* tail. To dequeue, you just set the head field.
* <pre>
* +------+ prev +-----+ +-----+
* head | | <---- | | <---- | | tail
* +------+ +-----+ +-----+
* </pre>
*
* <p>Insertion into a CLH queue requires only a single atomic
* operation on "tail", so there is a simple atomic point of
* demarcation from unqueued to queued. Similarly, dequeuing
* involves only updating the "head". However, it takes a bit
* more work for nodes to determine who their successors are,
* in part to deal with possible cancellation due to timeouts
* and interrupts.
*
* <p>The "prev" links (not used in original CLH locks), are mainly
* needed to handle cancellation. If a node is cancelled, its
* successor is (normally) relinked to a non-cancelled
* predecessor. For explanation of similar mechanics in the case
* of spin locks, see the papers by Scott and Scherer at
* http://www.cs.rochester.edu/u/scott/synchronization/
*
* <p>We also use "next" links to implement blocking mechanics.
* The thread id for each node is kept in its own node, so a
* predecessor signals the next node to wake up by traversing
* next link to determine which thread it is. Determination of
* successor must avoid races with newly queued nodes to set
* the "next" fields of their predecessors. This is solved
* when necessary by checking backwards from the atomically
* updated "tail" when a node's successor appears to be null.
* (Or, said differently, the next-links are an optimization
* so that we don't usually need a backward scan.)
*
* <p>Cancellation introduces some conservatism to the basic
* algorithms. Since we must poll for cancellation of other
* nodes, we can miss noticing whether a cancelled node is
* ahead or behind us. This is dealt with by always unparking
* successors upon cancellation, allowing them to stabilize on
* a new predecessor, unless we can identify an uncancelled
* predecessor who will carry this responsibility.
*
* <p>CLH queues need a dummy header node to get started. But
* we don't create them on construction, because it would be wasted
* effort if there is never contention. Instead, the node
* is constructed and head and tail pointers are set upon first
* contention.
*
* <p>Threads waiting on Conditions use the same nodes, but
* use an additional link. Conditions only need to link nodes
* in simple (non-concurrent) linked queues because they are
* only accessed when exclusively held. Upon await, a node is
* inserted into a condition queue. Upon signal, the node is
* transferred to the main queue. A special value of status
* field is used to mark which queue a node is on.
*
* <p>Thanks go to Dave Dice, Mark Moir, Victor Luchangco, Bill
* Scherer and Michael Scott, along with members of JSR-166
* expert group, for helpful ideas, discussions, and critiques
* on the design of this class.
*/
static final class Node {
/** Marker to indicate a node is waiting in shared mode */
// Node是共享锁模式
static final Node SHARED = new Node();
/** Marker to indicate a node is waiting in exclusive mode */
// Node是独占锁模式
static final Node EXCLUSIVE = null;
/** waitStatus value to indicate thread has cancelled */
// 取消等待的状态
static final int CANCELLED = 1;
/** waitStatus value to indicate successor's thread needs unparking */
// 后继节点需要被唤醒的状态
static final int SIGNAL = -1;
/** waitStatus value to indicate thread is waiting on condition */
// 节点处于条件队列的状态
static final int CONDITION = -2;
/**
* waitStatus value to indicate the next acquireShared should
* unconditionally propagate
*/
// 无条件传播, 共享模式下, 该状态的进程处于可运行状态
static final int PROPAGATE = -3;
/**
* Status field, taking on only the values:
* SIGNAL: The successor of this node is (or will soon be)
* blocked (via park), so the current node must
* unpark its successor when it releases or
* cancels. To avoid races, acquire methods must
* first indicate they need a signal,
* then retry the atomic acquire, and then,
* on failure, block.
* CANCELLED: This node is cancelled due to timeout or interrupt.
* Nodes never leave this state. In particular,
* a thread with cancelled node never again blocks.
* CONDITION: This node is currently on a condition queue.
* It will not be used as a sync queue node
* until transferred, at which time the status
* will be set to 0. (Use of this value here has
* nothing to do with the other uses of the
* field, but simplifies mechanics.)
* PROPAGATE: A releaseShared should be propagated to other
* nodes. This is set (for head node only) in
* doReleaseShared to ensure propagation
* continues, even if other operations have
* since intervened.
* 0: None of the above
*
* The values are arranged numerically to simplify use.
* Non-negative values mean that a node doesn't need to
* signal. So, most code doesn't need to check for particular
* values, just for sign.
*
* The field is initialized to 0 for normal sync nodes, and
* CONDITION for condition nodes. It is modified using CAS
* (or when possible, unconditional volatile writes).
*/
// 节点内部的等待状态变量
volatile int waitStatus;
/**
* Link to predecessor node that current node/thread relies on
* for checking waitStatus. Assigned during enqueuing, and nulled
* out (for sake of GC) only upon dequeuing. Also, upon
* cancellation of a predecessor, we short-circuit while
* finding a non-cancelled one, which will always exist
* because the head node is never cancelled: A node becomes
* head only as a result of successful acquire. A
* cancelled thread never succeeds in acquiring, and a thread only
* cancels itself, not any other node.
*/
// 指向前驱节点地址的指针
volatile Node prev;
/**
* Link to the successor node that the current node/thread
* unparks upon release. Assigned during enqueuing, adjusted
* when bypassing cancelled predecessors, and nulled out (for
* sake of GC) when dequeued. The enq operation does not
* assign next field of a predecessor until after attachment,
* so seeing a null next field does not necessarily mean that
* node is at end of queue. However, if a next field appears
* to be null, we can scan prev's from the tail to
* double-check. The next field of cancelled nodes is set to
* point to the node itself instead of null, to make life
* easier for isOnSyncQueue.
*/
// 指向后继节点地址的指针
volatile Node next;
/**
* The thread that enqueued this node. Initialized on
* construction and nulled out after use.
*/
// 节点内部包装的线程
volatile Thread thread;
/**
* Link to next node waiting on condition, or the special
* value SHARED. Because condition queues are accessed only
* when holding in exclusive mode, we just need a simple
* linked queue to hold nodes while they are waiting on
* conditions. They are then transferred to the queue to
* re-acquire. And because conditions can only be exclusive,
* we save a field by using special value to indicate shared
* mode.
*/
// 条件队列中的下一个等待节点
Node nextWaiter;
/**
* Returns true if node is waiting in shared mode.
*/
// 判断是否是共享模式
final boolean isShared() {
return nextWaiter == SHARED;
}
/**
* Returns previous node, or throws NullPointerException if null.
* Use when predecessor cannot be null. The null check could
* be elided, but is present to help the VM.
*
* @return the predecessor of this node
*/
// 获取当前节点的前驱节点
final Node predecessor() throws NullPointerException {
Node p = prev;
if (p == null)
throw new NullPointerException();
else
return p;
}
// 无参构造器
Node() { // Used to establish initial head or SHARED marker
}
// 有参构造器, 当向同步队列中添加新的节点时使用的构造器
Node(Thread thread, Node mode) { // Used by addWaiter
this.nextWaiter = mode;
this.thread = thread;
}
// 有参构造器, 当向天见队列中添加新节点时使用的构造器
Node(Thread thread, int waitStatus) { // Used by Condition
this.waitStatus = waitStatus;
this.thread = thread;
}
}
Node是AbstractQueuedSynchronizer实现阻塞队列与条件队列的基础，并且Node整个类的定义也并不复杂。弄明白Node类中每个成员变量的意义，对于后期整理读AbstractQueuedSynchronzier的源码来说是非常重要的。
SHARED：SHARED是一个Node实例，用于实现共享锁，例如JDK中ReentrantReadWriteLock中的ReadLock。EXCLUSIVE：EXCLUSIVE表明当前节点是独占模式，也就是排它锁。waitStatus：waitStatus代表节点的等待状态，使用volatile关键字修饰，保证该变量的内存可见性。它分别有五个取值，分别是0、CANCELLED、SIGNAL、CONDITION、PROPAGATE。分别代表Node在队列中的不同状态，后续在实现队列同步器时，也会大量的根据waitStatus的值做各种逻辑判断。prev：prev代表的是当前Node的前驱节点，使用volatile关键字修饰，保证该变量的内存可见性。next：next代表的时当前Node的后置节点，使用volatile关键字修饰，保证该变量的内存可见性。thread：代表当前Node中包装的线程，在多线程场景下，每个Node代表一个竞争锁的线程。这里使用Node对Thread进行包装。nextWaiter：代表条件队列中的下一个等待节点。在同步队列中，nextWaiter只是一个标识符，标识当前节点是共享还是排它模式。
3.Condition源码
AbstractQueuedSynchronizer中的ConditionObject内部类实现了Condition接口：
/**
* {@code Condition} factors out the {@code Object} monitor
* methods ({@link Object#wait() wait}, {@link Object#notify notify}
* and {@link Object#notifyAll notifyAll}) into distinct objects to
* give the effect of having multiple wait-sets per object, by
* combining them with the use of arbitrary {@link Lock} implementations.
* Where a {@code Lock} replaces the use of {@code synchronized} methods
* and statements, a {@code Condition} replaces the use of the Object
* monitor methods.
*
* <p>Conditions (also known as <em>condition queues</em> or
* <em>condition variables</em>) provide a means for one thread to
* suspend execution (to "wait") until notified by another
* thread that some state condition may now be true. Because access
* to this shared state information occurs in different threads, it
* must be protected, so a lock of some form is associated with the
* condition. The key property that waiting for a condition provides
* is that it <em>atomically</em> releases the associated lock and
* suspends the current thread, just like {@code Object.wait}.
*
* <p>A {@code Condition} instance is intrinsically bound to a lock.
* To obtain a {@code Condition} instance for a particular {@link Lock}
* instance use its {@link Lock#newCondition newCondition()} method.
*
* <p>As an example, suppose we have a bounded buffer which supports
* {@code put} and {@code take} methods. If a
* {@code take} is attempted on an empty buffer, then the thread will block
* until an item becomes available; if a {@code put} is attempted on a
* full buffer, then the thread will block until a space becomes available.
* We would like to keep waiting {@code put} threads and {@code take}
* threads in separate wait-sets so that we can use the optimization of
* only notifying a single thread at a time when items or spaces become
* available in the buffer. This can be achieved using two
* {@link Condition} instances.
* <pre>
* class BoundedBuffer {
* <b>final Lock lock = new ReentrantLock();</b>
* final Condition notFull = <b>lock.newCondition(); </b>
* final Condition notEmpty = <b>lock.newCondition(); </b>
*
* final Object[] items = new Object[100];
* int putptr, takeptr, count;
*
* public void put(Object x) throws InterruptedException {
* <b>lock.lock();
* try {</b>
* while (count == items.length)
* <b>notFull.await();</b>
* items[putptr] = x;
* if (++putptr == items.length) putptr = 0;
* ++count;
* <b>notEmpty.signal();</b>
* <b>} finally {
* lock.unlock();
* }</b>
* }
*
* public Object take() throws InterruptedException {
* <b>lock.lock();
* try {</b>
* while (count == 0)
* <b>notEmpty.await();</b>
* Object x = items[takeptr];
* if (++takeptr == items.length) takeptr = 0;
* --count;
* <b>notFull.signal();</b>
* return x;
* <b>} finally {
* lock.unlock();
* }</b>
* }
* }
* </pre>
*
* (The {@link java.util.concurrent.ArrayBlockingQueue} class provides
* this functionality, so there is no reason to implement this
* sample usage class.)
*
* <p>A {@code Condition} implementation can provide behavior and semantics
* that is
* different from that of the {@code Object} monitor methods, such as
* guaranteed ordering for notifications, or not requiring a lock to be held
* when performing notifications.
* If an implementation provides such specialized semantics then the
* implementation must document those semantics.
*
* <p>Note that {@code Condition} instances are just normal objects and can
* themselves be used as the target in a {@code synchronized} statement,
* and can have their own monitor {@link Object#wait wait} and
* {@link Object#notify notification} methods invoked.
* Acquiring the monitor lock of a {@code Condition} instance, or using its
* monitor methods, has no specified relationship with acquiring the
* {@link Lock} associated with that {@code Condition} or the use of its
* {@linkplain #await waiting} and {@linkplain #signal signalling} methods.
* It is recommended that to avoid confusion you never use {@code Condition}
* instances in this way, except perhaps within their own implementation.
*
* <p>Except where noted, passing a {@code null} value for any parameter
* will result in a {@link NullPointerException} being thrown.
*
* <h3>Implementation Considerations</h3>
*
* <p>When waiting upon a {@code Condition}, a "<em>spurious
* wakeup</em>" is permitted to occur, in
* general, as a concession to the underlying platform semantics.
* This has little practical impact on most application programs as a
* {@code Condition} should always be waited upon in a loop, testing
* the state predicate that is being waited for. An implementation is
* free to remove the possibility of spurious wakeups but it is
* recommended that applications programmers always assume that they can
* occur and so always wait in a loop.
*
* <p>The three forms of condition waiting
* (interruptible, non-interruptible, and timed) may differ in their ease of
* implementation on some platforms and in their performance characteristics.
* In particular, it may be difficult to provide these features and maintain
* specific semantics such as ordering guarantees.
* Further, the ability to interrupt the actual suspension of the thread may
* not always be feasible to implement on all platforms.
*
* <p>Consequently, an implementation is not required to define exactly the
* same guarantees or semantics for all three forms of waiting, nor is it
* required to support interruption of the actual suspension of the thread.
*
* <p>An implementation is required to
* clearly document the semantics and guarantees provided by each of the
* waiting methods, and when an implementation does support interruption of
* thread suspension then it must obey the interruption semantics as defined
* in this interface.
*
* <p>As interruption generally implies cancellation, and checks for
* interruption are often infrequent, an implementation can favor responding
* to an interrupt over normal method return. This is true even if it can be
* shown that the interrupt occurred after another action that may have
* unblocked the thread. An implementation should document this behavior.
*
* @since 1.5
* @author Doug Lea
*/
public interface Condition {
/**
* Causes the current thread to wait until it is signalled or
* {@linkplain Thread#interrupt interrupted}.
*
* <p>The lock associated with this {@code Condition} is atomically
* released and the current thread becomes disabled for thread scheduling
* purposes and lies dormant until <em>one</em> of four things happens:
* <ul>
* <li>Some other thread invokes the {@link #signal} method for this
* {@code Condition} and the current thread happens to be chosen as the
* thread to be awakened; or
* <li>Some other thread invokes the {@link #signalAll} method for this
* {@code Condition}; or
* <li>Some other thread {@linkplain Thread#interrupt interrupts} the
* current thread, and interruption of thread suspension is supported; or
* <li>A "<em>spurious wakeup</em>" occurs.
* </ul>
*
* <p>In all cases, before this method can return the current thread must
* re-acquire the lock associated with this condition. When the
* thread returns it is <em>guaranteed</em> to hold this lock.
*
* <p>If the current thread:
* <ul>
* <li>has its interrupted status set on entry to this method; or
* <li>is {@linkplain Thread#interrupt interrupted} while waiting
* and interruption of thread suspension is supported,
* </ul>
* then {@link InterruptedException} is thrown and the current thread's
* interrupted status is cleared. It is not specified, in the first
* case, whether or not the test for interruption occurs before the lock
* is released.
*
* <p><b>Implementation Considerations</b>
*
* <p>The current thread is assumed to hold the lock associated with this
* {@code Condition} when this method is called.
* It is up to the implementation to determine if this is
* the case and if not, how to respond. Typically, an exception will be
* thrown (such as {@link IllegalMonitorStateException}) and the
* implementation must document that fact.
*
* <p>An implementation can favor responding to an interrupt over normal
* method return in response to a signal. In that case the implementation
* must ensure that the signal is redirected to another waiting thread, if
* there is one.
*
* @throws InterruptedException if the current thread is interrupted
* (and interruption of thread suspension is supported)
*/
void await() throws InterruptedException;
/**
* Causes the current thread to wait until it is signalled.
*
* <p>The lock associated with this condition is atomically
* released and the current thread becomes disabled for thread scheduling
* purposes and lies dormant until <em>one</em> of three things happens:
* <ul>
* <li>Some other thread invokes the {@link #signal} method for this
* {@code Condition} and the current thread happens to be chosen as the
* thread to be awakened; or
* <li>Some other thread invokes the {@link #signalAll} method for this
* {@code Condition}; or
* <li>A "<em>spurious wakeup</em>" occurs.
* </ul>
*
* <p>In all cases, before this method can return the current thread must
* re-acquire the lock associated with this condition. When the
* thread returns it is <em>guaranteed</em> to hold this lock.
*
* <p>If the current thread's interrupted status is set when it enters
* this method, or it is {@linkplain Thread#interrupt interrupted}
* while waiting, it will continue to wait until signalled. When it finally
* returns from this method its interrupted status will still
* be set.
*
* <p><b>Implementation Considerations</b>
*
* <p>The current thread is assumed to hold the lock associated with this
* {@code Condition} when this method is called.
* It is up to the implementation to determine if this is
* the case and if not, how to respond. Typically, an exception will be
* thrown (such as {@link IllegalMonitorStateException}) and the
* implementation must document that fact.
*/
void awaitUninterruptibly();
/**
* Causes the current thread to wait until it is signalled or interrupted,
* or the specified waiting time elapses.
*
* <p>The lock associated with this condition is atomically
* released and the current thread becomes disabled for thread scheduling
* purposes and lies dormant until <em>one</em> of five things happens:
* <ul>
* <li>Some other thread invokes the {@link #signal} method for this
* {@code Condition} and the current thread happens to be chosen as the
* thread to be awakened; or
* <li>Some other thread invokes the {@link #signalAll} method for this
* {@code Condition}; or
* <li>Some other thread {@linkplain Thread#interrupt interrupts} the
* current thread, and interruption of thread suspension is supported; or
* <li>The specified waiting time elapses; or
* <li>A "<em>spurious wakeup</em>" occurs.
* </ul>
*
* <p>In all cases, before this method can return the current thread must
* re-acquire the lock associated with this condition. When the
* thread returns it is <em>guaranteed</em> to hold this lock.
*
* <p>If the current thread:
* <ul>
* <li>has its interrupted status set on entry to this method; or
* <li>is {@linkplain Thread#interrupt interrupted} while waiting
* and interruption of thread suspension is supported,
* </ul>
* then {@link InterruptedException} is thrown and the current thread's
* interrupted status is cleared. It is not specified, in the first
* case, whether or not the test for interruption occurs before the lock
* is released.
*
* <p>The method returns an estimate of the number of nanoseconds
* remaining to wait given the supplied {@code nanosTimeout}
* value upon return, or a value less than or equal to zero if it
* timed out. This value can be used to determine whether and how
* long to re-wait in cases where the wait returns but an awaited
* condition still does not hold. Typical uses of this method take
* the following form:
*
* <pre> {@code
* boolean aMethod(long timeout, TimeUnit unit) {
* long nanos = unit.toNanos(timeout);
* lock.lock();
* try {
* while (!conditionBeingWaitedFor()) {
* if (nanos <= 0L)
* return false;
* nanos = theCondition.awaitNanos(nanos);
* }
* // ...
* } finally {
* lock.unlock();
* }
* }}</pre>
*
* <p>Design note: This method requires a nanosecond argument so
* as to avoid truncation errors in reporting remaining times.
* Such precision loss would make it difficult for programmers to
* ensure that total waiting times are not systematically shorter
* than specified when re-waits occur.
*
* <p><b>Implementation Considerations</b>
*
* <p>The current thread is assumed to hold the lock associated with this
* {@code Condition} when this method is called.
* It is up to the implementation to determine if this is
* the case and if not, how to respond. Typically, an exception will be
* thrown (such as {@link IllegalMonitorStateException}) and the
* implementation must document that fact.
*
* <p>An implementation can favor responding to an interrupt over normal
* method return in response to a signal, or over indicating the elapse
* of the specified waiting time. In either case the implementation
* must ensure that the signal is redirected to another waiting thread, if
* there is one.
*
* @param nanosTimeout the maximum time to wait, in nanoseconds
* @return an estimate of the {@code nanosTimeout} value minus
* the time spent waiting upon return from this method.
* A positive value may be used as the argument to a
* subsequent call to this method to finish waiting out
* the desired time. A value less than or equal to zero
* indicates that no time remains.
* @throws InterruptedException if the current thread is interrupted
* (and interruption of thread suspension is supported)
*/
long awaitNanos(long nanosTimeout) throws InterruptedException;
/**
* Causes the current thread to wait until it is signalled or interrupted,
* or the specified waiting time elapses. This method is behaviorally
* equivalent to:
* <pre> {@code awaitNanos(unit.toNanos(time)) > 0}</pre>
*
* @param time the maximum time to wait
* @param unit the time unit of the {@code time} argument
* @return {@code false} if the waiting time detectably elapsed
* before return from the method, else {@code true}
* @throws InterruptedException if the current thread is interrupted
* (and interruption of thread suspension is supported)
*/
boolean await(long time, TimeUnit unit) throws InterruptedException;
/**
* Causes the current thread to wait until it is signalled or interrupted,
* or the specified deadline elapses.
*
* <p>The lock associated with this condition is atomically
* released and the current thread becomes disabled for thread scheduling
* purposes and lies dormant until <em>one</em> of five things happens:
* <ul>
* <li>Some other thread invokes the {@link #signal} method for this
* {@code Condition} and the current thread happens to be chosen as the
* thread to be awakened; or
* <li>Some other thread invokes the {@link #signalAll} method for this
* {@code Condition}; or
* <li>Some other thread {@linkplain Thread#interrupt interrupts} the
* current thread, and interruption of thread suspension is supported; or
* <li>The specified deadline elapses; or
* <li>A "<em>spurious wakeup</em>" occurs.
* </ul>
*
* <p>In all cases, before this method can return the current thread must
* re-acquire the lock associated with this condition. When the
* thread returns it is <em>guaranteed</em> to hold this lock.
*
*
* <p>If the current thread:
* <ul>
* <li>has its interrupted status set on entry to this method; or
* <li>is {@linkplain Thread#interrupt interrupted} while waiting
* and interruption of thread suspension is supported,
* </ul>
* then {@link InterruptedException} is thrown and the current thread's
* interrupted status is cleared. It is not specified, in the first
* case, whether or not the test for interruption occurs before the lock
* is released.
*
*
* <p>The return value indicates whether the deadline has elapsed,
* which can be used as follows:
* <pre> {@code
* boolean aMethod(Date deadline) {
* boolean stillWaiting = true;
* lock.lock();
* try {
* while (!conditionBeingWaitedFor()) {
* if (!stillWaiting)
* return false;
* stillWaiting = theCondition.awaitUntil(deadline);
* }
* // ...
* } finally {
* lock.unlock();
* }
* }}</pre>
*
* <p><b>Implementation Considerations</b>
*
* <p>The current thread is assumed to hold the lock associated with this
* {@code Condition} when this method is called.
* It is up to the implementation to determine if this is
* the case and if not, how to respond. Typically, an exception will be
* thrown (such as {@link IllegalMonitorStateException}) and the
* implementation must document that fact.
*
* <p>An implementation can favor responding to an interrupt over normal
* method return in response to a signal, or over indicating the passing
* of the specified deadline. In either case the implementation
* must ensure that the signal is redirected to another waiting thread, if
* there is one.
*
* @param deadline the absolute time to wait until
* @return {@code false} if the deadline has elapsed upon return, else
* {@code true}
* @throws InterruptedException if the current thread is interrupted
* (and interruption of thread suspension is supported)
*/
boolean awaitUntil(Date deadline) throws InterruptedException;
/**
* Wakes up one waiting thread.
*
* <p>If any threads are waiting on this condition then one
* is selected for waking up. That thread must then re-acquire the
* lock before returning from {@code await}.
*
* <p><b>Implementation Considerations</b>
*
* <p>An implementation may (and typically does) require that the
* current thread hold the lock associated with this {@code
* Condition} when this method is called. Implementations must
* document this precondition and any actions taken if the lock is
* not held. Typically, an exception such as {@link
* IllegalMonitorStateException} will be thrown.
*/
void signal();
/**
* Wakes up all waiting threads.
*
* <p>If any threads are waiting on this condition then they are
* all woken up. Each thread must re-acquire the lock before it can
* return from {@code await}.
*
* <p><b>Implementation Considerations</b>
*
* <p>An implementation may (and typically does) require that the
* current thread hold the lock associated with this {@code
* Condition} when this method is called. Implementations must
* document this precondition and any actions taken if the lock is
* not held. Typically, an exception such as {@link
* IllegalMonitorStateException} will be thrown.
*/
void signalAll();
}
翻译注释：
Condition接口将Object类中提供给synchronized关键字配套使用的wait()、notify()、notifyAll()分解为不同的对象以提供每个对象有多个等待集的效果，通过将它们与任意Lock实现的使用结合起来。Lock替代了synchronized方法和语句的使用，而Condition接口中方法则是替代了Object类中提供的监视器方法。
Condition提供了一种线程协作方式：当一个线程被暂停执行时，线程会被挂起，直到被其它线程唤醒。
Condtion实例是绑定在Lock上的，通过Lock接口中的newCondition()方法创建Condition实例。 除了特殊说明外，任意空值作为方法的入参，都会抛出空指针异常。
Condition接口提供了明确的语义和行为，这点和Object类提供的监控方法不同。
Condition接口中定义了一系列监控方法，这些方法奠定了条件队列的基础。
不带超时机制的可中断await()方法：
void await() throws InterruptedException;
调用await()方法会使当前线程一直等待，直到其它线程唤醒或中断。
当发生以下情况时，条件队列中的线程将会被唤醒：
- 有线程调用了
signal()方法，正好唤醒了条件队列中的当前线程。 - 有线程调用了
signalAll()方法，唤醒了条件队列中的所有线程。 - 其它线程中断了当前线程。
- 被虚假唤醒，即使没有满足以上三个条件，
wait()阻塞也是可能被偶尔唤醒。
条件队列中唤醒一个线程时，必须重新获得锁，线程才能正真被唤醒。
不带超时机制的不可中断await()方法：
void awaitUninterruptibly();
与void await() throws InterruptedException的不同点在于void awaitUninterruptibly()无法响应中断。
带超时机制的可中断await()方法：
long awaitNanos(long nanosTimeout) throws InterruptedException;
boolean await(long time, TimeUnit unit) throws InterruptedException;
long awaitNanos(long nanosTimeout) throws InterruptedException方法使用的是nanos时间。该方法的返回值为long类型，表示剩余的给定等待时间。如果返回的时间小于等于0，则说明等待时间已经过了。选择使用纳秒是为了避免计算剩余时间时的截断误差。
boolean await(long time, TimeUnit unit) throws InterruptedException方法的入参虽然可以是任意单位的时间，但其底层仍然会转化为纳秒。
唤醒线程的方法：
void signal();
void signalAll();
void signal()代表唤醒条件队列中任意一个阻塞的线程，在调用signal()方法之前必须先获取锁。
void signalAll()代表唤醒条件队列中所有阻塞的线程。
4.ConditionObject源码
在AbstractQueuedSynchronizer内部的ConditionObject实现了Condition接口。居于上面对Condition的分析，可以知道Condition接口中针对线程监控提供了明确的语义和行为，所以ConditionObject是其具体的实现。ConditionObject源码如下：
/**
* Condition implementation for a {@link
* AbstractQueuedSynchronizer} serving as the basis of a {@link
* Lock} implementation.
*
* <p>Method documentation for this class describes mechanics,
* not behavioral specifications from the point of view of Lock
* and Condition users. Exported versions of this class will in
* general need to be accompanied by documentation describing
* condition semantics that rely on those of the associated
* {@code AbstractQueuedSynchronizer}.
*
* <p>This class is Serializable, but all fields are transient,
* so deserialized conditions have no waiters.
*/
public class ConditionObject implements Condition, java.io.Serializable {
private static final long serialVersionUID = 1173984872572414699L;
/** First node of condition queue. */
// 条件队列中的头节点
private transient Node firstWaiter;
/** Last node of condition queue. */
// 条件队列中的尾节点
private transient Node lastWaiter;
/**
* Creates a new {@code ConditionObject} instance.
*/
public ConditionObject() { }
// Internal methods
/**
* Adds a new waiter to wait queue.
* @return its new wait node
*/
// 添加节点到条件队列中
private Node addConditionWaiter() {
// 获取条件队列的尾节点
Node t = lastWaiter;
// If lastWaiter is cancelled, clean out.
// 如果尾节点取消了等待
if (t != null && t.waitStatus != Node.CONDITION) {
// 将取消等待的节点从条件队列中移除
unlinkCancelledWaiters();
// 移除后从新获取条件队列的尾节点
t = lastWaiter;
}
// 将当前线程包装为Node, 注意这里Node的waitStatus默认为Node.CONDITION
Node node = new Node(Thread.currentThread(), Node.CONDITION);
// 如果条件队列为空
if (t == null)
// 那么当前节点就是条件队列的第一个节点
firstWaiter = node;
else
// 否则就将其放在条件队列的尾部
t.nextWaiter = node;
// 将新入队的节点设为条件队列新的尾节点
lastWaiter = node;
// 返回新入队的Node
return node;
}
/**
* Removes and transfers nodes until hit non-cancelled one or
* null. Split out from signal in part to encourage compilers
* to inline the case of no waiters.
* @param first (non-null) the first node on condition queue
*/
private void doSignal(Node first) {
do {
// 如果条件队列中只有一个节点
if ( (firstWaiter = first.nextWaiter) == null)
// 将条件队列的尾节点置为null
lastWaiter = null;
// 断开头节点与条件队列的关系
first.nextWaiter = null;
// transferForSignal(first) 使用CAS操作尝试修改当前节点的waitStatus
// CAS操作失败直接返回false, CAS操作成功则将条件队列中的头节点转移到
// 阻塞队列的尾部, 同时使用CAS操作尝试修改当前转移节点在阻塞队列中的前驱节点的waitStatus
// 如果CAS失败则或者前驱节点取消了等待, 则唤醒当前线程, 返回true
// (first = firstWaiter) != null方法则是依次遍历同步队列, 所以这里针对条件队列
// 中等待的线程而言, 从队列头部开始向尾部遍历, 如果CAS修改当前节点的waitStatus失败,
// 则依次往后遍历节点直到条件队列尾部为止, 如果CAS修改当前节点waitStatus成功并且节点
// 成功进入阻塞队列, 返回true, signal()方法也到此执行结束
} while (!transferForSignal(first) &&
(first = firstWaiter) != null);
}
/**
* Removes and transfers all nodes.
* @param first (non-null) the first node on condition queue
*/
private void doSignalAll(Node first) {
lastWaiter = firstWaiter = null;
do {
// 获取当前节点的后继节点
Node next = first.nextWaiter;
// 断开当前节点与条件队列的关系
first.nextWaiter = null;
// transferForSignal(first) 使用CAS操作尝试修改当前节点的waitStatus
// CAS操作失败直接返回false, CAS操作成功则将条件队列中的头节点转移到
// 阻塞队列的尾部, 同时使用CAS操作尝试修改当前转移节点在阻塞队列中的前驱节点的waitStatus
// 如果CAS失败则或者前驱节点取消了等待, 则唤醒当前线程, 返回true
transferForSignal(first);
first = next;
// 遍历整个条件队列, 对每个节点进行唤醒操作
} while (first != null);
}
/**
* Unlinks cancelled waiter nodes from condition queue.
* Called only while holding lock. This is called when
* cancellation occurred during condition wait, and upon
* insertion of a new waiter when lastWaiter is seen to have
* been cancelled. This method is needed to avoid garbage
* retention in the absence of signals. So even though it may
* require a full traversal, it comes into play only when
* timeouts or cancellations occur in the absence of
* signals. It traverses all nodes rather than stopping at a
* particular target to unlink all pointers to garbage nodes
* without requiring many re-traversals during cancellation
* storms.
*/
// 移除条件队列中取消等待的节点
private void unlinkCancelledWaiters() {
// 获取条件队列中的头节点
Node t = firstWaiter;
// trail可以理解为遍历条件队列中离当前节点最近的未被取消等待的节点
Node trail = null;
// 从前至后遍历条件队列中的节点
while (t != null) {
// 获取下一个节点
Node next = t.nextWaiter;
// 如果当前节点的waitStatus不为Node.CONDITION, 那么则证明该节点在条件队列中取消了等待
if (t.waitStatus != Node.CONDITION) {
// 将当前节点从条件队列中移除
// 断开当前节点与其后置节点之间的关系
t.nextWaiter = null;
// 如果trail为空
if (trail == null)
// 将后置节点设为等待队列的头节点
firstWaiter = next;
// trail不为空
else
// 将当前节点的后置节点设置为trail的nextWaiter
trail.nextWaiter = next;
// 如果遍历到条件队列的尾部了
if (next == null)
// 将trail设置为条件队列的尾节点
lastWaiter = trail;
}
// 当前节点没有取消等待状态
else
// 将当前节点设置为trail, 所以trail变量代表的也一定是未被取消等待节点
trail = t;
// 将当前节点的后置节点赋值给t, 进入下一个while循环
t = next;
}
}
// public methods
/**
* Moves the longest-waiting thread, if one exists, from the
* wait queue for this condition to the wait queue for the
* owning lock.
*
* @throws IllegalMonitorStateException if {@link #isHeldExclusively}
* returns {@code false}
*/
// 唤醒条件队列中某一个等待线程, 这里是随机唤醒条件队列中等待的线程, 所以从宏观意义上来说, 它其实也是做到了一个
public final void signal() {
// isHeldExclusively()模板方法, 判断当前线程是否持有锁
if (!isHeldExclusively())
// 如果当前线程不是持有锁的线程, 抛出异常
throw new IllegalMonitorStateException();
// 获取条件队列中的头节点
Node first = firstWaiter;
// 如果条件队列不为空
if (first != null)
// 执行唤醒
doSignal(first);
}
/**
* Moves all threads from the wait queue for this condition to
* the wait queue for the owning lock.
*
* @throws IllegalMonitorStateException if {@link #isHeldExclusively}
* returns {@code false}
*/
public final void signalAll() {
// isHeldExclusively()模板方法, 判断当前线程是否持有锁
if (!isHeldExclusively())
// 如果当前线程不是持有锁的线程, 抛出异常
throw new IllegalMonitorStateException();
// 获取条件队列中的头节点
Node first = firstWaiter;
// 如果条件队列不为空
if (first != null)
// 执行唤醒全部节点
doSignalAll(first);
}
/**
* Implements uninterruptible condition wait.
* <ol>
* <li> Save lock state returned by {@link #getState}.
* <li> Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails.
* <li> Block until signalled.
* <li> Reacquire by invoking specialized version of
* {@link #acquire} with saved state as argument.
* </ol>
*/
public final void awaitUninterruptibly() {
// 将当前线程包装成Node添加到条件队列中
Node node = addConditionWaiter();
// 将当前线程持有的锁彻底释放掉
int savedState = fullyRelease(node);
// 记录是否受到过中断的状态标识
boolean interrupted = false;
// isOnSyncQueue(node)用于判断当前节点是否转移到了阻塞队列中
// 这里是自旋, 退出自旋的方式就是当前节点从条件队列转移到阻塞队列中
while (!isOnSyncQueue(node)) {
// 进入这里证明当前节点还在条件队列中, 则自己将自己挂起, 然后阻塞在这里
LockSupport.park(this);
// Thread.interrupted()获取当前线程在挂起过程中是否收到过中断的信号, 如果收到则返回true, 并将true修改为false
if (Thread.interrupted())
// 记录当前线程在挂起过程中收到过中断状态
interrupted = true;
}
// 此时当前节点已成功进入阻塞队列中
// acquireQueued(node, savedState)使用自旋+CAS操作尝试获取锁, 如果获取锁失败, 则将当前线程挂起等待其它线程唤醒, 线程被唤醒之后再次尝试获取锁, 如果获取锁失败则继续将自己挂起, 直到当前线程成功获取到锁, 并记录当前线程挂起过程中是否收到过中断信号的状态, 并将其返回
if (acquireQueued(node, savedState) || interrupted)
// 如果在获取锁的过程中收到过中断信号 || 将节点从条件队列转移到阻塞队列的过程中收到过中断信号
// 此时自己将自己中断, 这里可以理解为补偿机制, 如果在上述的两个过程中收到线程中断的信号只记录,
// 并不会做出中断响应, 统一在这里做补偿机制。
selfInterrupt();
}
/*
* For interruptible waits, we need to track whether to throw
* InterruptedException, if interrupted while blocked on
* condition, versus reinterrupt current thread, if
* interrupted while blocked waiting to re-acquire.
*/
/** Mode meaning to reinterrupt on exit from wait */
private static final int REINTERRUPT = 1;
/** Mode meaning to throw InterruptedException on exit from wait */
private static final int THROW_IE = -1;
/**
* Checks for interrupt, returning THROW_IE if interrupted
* before signalled, REINTERRUPT if after signalled, or
* 0 if not interrupted.
*/
private int checkInterruptWhileWaiting(Node node) {
// 判断当前线程是否受到过中断的信号
return Thread.interrupted() ?
// 如果线程收到过中断, 使用CAS操作尝试修改当前节点的waitStatus,
// 如果CAS操作成功则将当前节点从条件队列转移到阻塞队列中返回true --> THROW_IE 则说明是在调用signal()方法唤醒线程之前收到的中断信号
// 如果CAS操作失败则判断当前节点是否在阻塞队列中, 如果在阻塞队列中则返回false --> REINTERRUPT 则说明是在调用signal()方法唤醒线程之后收到的中断信号
(transferAfterCancelledWait(node) ? THROW_IE : REINTERRUPT) :
0;
}
/**
* Throws InterruptedException, reinterrupts current thread, or
* does nothing, depending on mode.
*/
// 根据interruptMode做出相应的相应, 后续会详细分析, 这里只介绍代码逻辑
private void reportInterruptAfterWait(int interruptMode)
throws InterruptedException {
// 如果interruptMode为THROW_IE --> 在调用signal()方法之前收到了中断信号
if (interruptMode == THROW_IE)
// 抛出InterruptedException异常相应线程中断
throw new InterruptedException();
// 如果interruptMode为REINTERRUPT --> 在调用signal()方法之后收到了中断信号
else if (interruptMode == REINTERRUPT)
// 自己将自己中断
selfInterrupt();
}
/**
* Implements interruptible condition wait.
* <ol>
* <li> If current thread is interrupted, throw InterruptedException.
* <li> Save lock state returned by {@link #getState}.
* <li> Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails.
* <li> Block until signalled or interrupted.
* <li> Reacquire by invoking specialized version of
* {@link #acquire} with saved state as argument.
* <li> If interrupted while blocked in step 4, throw InterruptedException.
* </ol>
*/
// 阻塞当前线程, 调用await()方法的线程一定是已经成功获取锁的线程, 此时天然线程安全
public final void await() throws InterruptedException {
// 执行具体逻辑之前, 先判断当前线程是否收到过中断
if (Thread.interrupted())
// 如果收到过中断, 则立即抛出InterruptedException异常相应中断
throw new InterruptedException();
// 将当前线程包装成Node添加到同步队列中
Node node = addConditionWaiter();
// 在将线程挂起前完全释放当前线程持有的锁
int savedState = fullyRelease(node);
// 记录interruptMode
int interruptMode = 0;
// isOnSyncQueue(node)用于判断当前节点是否转移到了阻塞队列中
// 这里是自旋, 退出自旋的方式就是当前节点从条件队列转移到阻塞队列中
while (!isOnSyncQueue(node)) {
// 进入这里证明当前节点还在条件队列中, 则自己将自己挂起, 然后阻塞在这里
LockSupport.park(this);
// 线程被唤醒之后, 判断是否收到中断的信号, 如果未收到中断信号则进入下一次自旋并检查
// 当前节点是否已经被转移到阻塞队列中, 如果已经转移到阻塞队列中则不再执行自旋
// 如果节点还未被转移到阻塞队列中, 则继续自旋
if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
// 只有线程收到过中断信号, 才会进入这里退出自旋
break;
}
// 此时节点已经进入阻塞队列, 自旋尝试获取锁, 如果获取锁失败则将自己挂起, 直到成功获取锁为止, 返回
// 这个过程中是否受到中断的信号
// 如果收到过中断的信号 && 不是在调用signal()唤醒线程之前收到的中断信号
if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
// 修改interruptMode为REINTERRUPT
interruptMode = REINTERRUPT;
if (node.nextWaiter != null) // clean up if cancelled
unlinkCancelledWaiters();
// 如果收到过线程中断的信号
if (interruptMode != 0)
// 根据interruptMode相应中断
reportInterruptAfterWait(interruptMode);
}
/**
* Implements timed condition wait.
* <ol>
* <li> If current thread is interrupted, throw InterruptedException.
* <li> Save lock state returned by {@link #getState}.
* <li> Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails.
* <li> Block until signalled, interrupted, or timed out.
* <li> Reacquire by invoking specialized version of
* {@link #acquire} with saved state as argument.
* <li> If interrupted while blocked in step 4, throw InterruptedException.
* </ol>
*/
public final long awaitNanos(long nanosTimeout)
throws InterruptedException {
// 执行具体逻辑之前, 先判断当前线程是否收到过中断
if (Thread.interrupted())
// 如果收到过中断, 则立即抛出InterruptedException异常相应中断
throw new InterruptedException();
// 将当前线程包装成Node添加到同步队列中
Node node = addConditionWaiter();
// 在将线程挂起前完全释放当前线程持有的锁
int savedState = fullyRelease(node);
// 计算等待过期时间 = 当前时间 + 等待时间
final long deadline = System.nanoTime() + nanosTimeout;
// 记录interruptMode
int interruptMode = 0;
// 自旋, 如果当前节点还未转移到阻塞队列中
while (!isOnSyncQueue(node)) {
// 等待时间到了
if (nanosTimeout <= 0L) {
// 取消当前节点的等待
// transferAfterCancelledWait(node)返回true --> 节点被成功转移到阻塞队列,
// 返回false, 说明在等待时间到了之前, 已经有其它线程调用signal()唤醒了挂起的线程,
// signal()方法会使用CAS操作修改节点的waitStatus并将其转移到阻塞队列中
transferAfterCancelledWait(node);
break;
}
// 此时等待时间还未到, 那么此时做一个策略
// spinForTimeoutThreshold的值是1000纳秒, 也就是1毫秒
// 如果等待时间小于1毫秒, 就不选择LockSupport.parkNanos(this, nanosTimeout)将自己挂起,
// 此时选择自旋可能性能会更好
if (nanosTimeout >= spinForTimeoutThreshold)
LockSupport.parkNanos(this, nanosTimeout);
// 是否收到过中断信号
if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
// 如果收到了中断信号, 则break退出自旋
break;
// 重新计算等待时间
nanosTimeout = deadline - System.nanoTime();
}
if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
interruptMode = REINTERRUPT;
if (node.nextWaiter != null)
unlinkCancelledWaiters();
if (interruptMode != 0)
reportInterruptAfterWait(interruptMode);
return deadline - System.nanoTime();
}
/**
* Implements absolute timed condition wait.
* <ol>
* <li> If current thread is interrupted, throw InterruptedException.
* <li> Save lock state returned by {@link #getState}.
* <li> Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails.
* <li> Block until signalled, interrupted, or timed out.
* <li> Reacquire by invoking specialized version of
* {@link #acquire} with saved state as argument.
* <li> If interrupted while blocked in step 4, throw InterruptedException.
* <li> If timed out while blocked in step 4, return false, else true.
* </ol>
*/
public final boolean awaitUntil(Date deadline)
throws InterruptedException {
long abstime = deadline.getTime();
// 相应中断
if (Thread.interrupted())
throw new InterruptedException();
// 线程入条件队列
Node node = addConditionWaiter();
// 完全释放锁
int savedState = fullyRelease(node);
// 记录是否超时
boolean timedout = false;
int interruptMode = 0;
while (!isOnSyncQueue(node)) {
// 如果当前时间大于等待结束的时间点
if (System.currentTimeMillis() > abstime) {
// 取消当前节点的等待, 并尝试将其转移到阻塞队列中
// 返回true, 则代表在节点被成功转移到阻塞队列中, 等待超时
// 返回false, 则代表在此之前节点已经被signal()唤醒并转移到阻塞队列中
timedout = transferAfterCancelledWait(node);
// 退出自旋
break;
}
// 等待时间还未结束, 将线程挂起并指定deadline
LockSupport.parkUntil(this, abstime);
// 线程被唤醒之后检查是否收到中断的信号
if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
// 收到中断信号则退出自旋
break;
}
if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
interruptMode = REINTERRUPT;
if (node.nextWaiter != null)
unlinkCancelledWaiters();
if (interruptMode != 0)
reportInterruptAfterWait(interruptMode);
return !timedout;
}
/**
* Implements timed condition wait.
* <ol>
* <li> If current thread is interrupted, throw InterruptedException.
* <li> Save lock state returned by {@link #getState}.
* <li> Invoke {@link #release} with saved state as argument,
* throwing IllegalMonitorStateException if it fails.
* <li> Block until signalled, interrupted, or timed out.
* <li> Reacquire by invoking specialized version of
* {@link #acquire} with saved state as argument.
* <li> If interrupted while blocked in step 4, throw InterruptedException.
* <li> If timed out while blocked in step 4, return false, else true.
* </ol>
*/
public final boolean await(long time, TimeUnit unit)
throws InterruptedException {
// 可以看到, await()方法底层也是将时间转换为了nanos
long nanosTimeout = unit.toNanos(time);
// 检查中断信号
if (Thread.interrupted())
// 响应线程中断
throw new InterruptedException();
Node node = addConditionWaiter();
int savedState = fullyRelease(node);
final long deadline = System.nanoTime() + nanosTimeout;
boolean timedout = false;
int interruptMode = 0;
while (!isOnSyncQueue(node)) {
// 等待时间到了
if (nanosTimeout <= 0L) {
// 取消节点等待并将其尝试将其转移到阻塞队列中
timedout = transferAfterCancelledWait(node);
// 退出自旋
break;
}
// 选择合适的策略, 自旋或者挂起
if (nanosTimeout >= spinForTimeoutThreshold)
LockSupport.parkNanos(this, nanosTimeout);
if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
break;
nanosTimeout = deadline - System.nanoTime();
}
if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
interruptMode = REINTERRUPT;
if (node.nextWaiter != null)
unlinkCancelledWaiters();
if (interruptMode != 0)
reportInterruptAfterWait(interruptMode);
return !timedout;
}
// support for instrumentation
/**
* Returns true if this condition was created by the given
* synchronization object.
*
* @return {@code true} if owned
*/
final boolean isOwnedBy(AbstractQueuedSynchronizer sync) {
return sync == AbstractQueuedSynchronizer.this;
}
/**
* Queries whether any threads are waiting on this condition.
* Implements {@link AbstractQueuedSynchronizer#hasWaiters(ConditionObject)}.
*
* @return {@code true} if there are any waiting threads
* @throws IllegalMonitorStateException if {@link #isHeldExclusively}
* returns {@code false}
*/
// 判断当前条件队列中是否还有等待的节点
protected final boolean hasWaiters() {
// 判断当前线程是否持有锁
if (!isHeldExclusively())
// 如果当前线程没有持有锁, 则抛出异常
throw new IllegalMonitorStateException();
// 走到这, 证明只有当前持有锁的线程能进来, 天然线程安全, 无需担心多线程并发问题
for (Node w = firstWaiter; w != null; w = w.nextWaiter) {
// 当节点的状态为Node.CONDITION时, 证明此节点在条件队列中还在排队
if (w.waitStatus == Node.CONDITION)
// 返回ture, 条件队列中还存在等待的节点
return true;
}
// 返回false, 条件队列中不存在等待的节点
return false;
}
/**
* Returns an estimate of the number of threads waiting on
* this condition.
* Implements {@link AbstractQueuedSynchronizer#getWaitQueueLength(ConditionObject)}.
*
* @return the estimated number of waiting threads
* @throws IllegalMonitorStateException if {@link #isHeldExclusively}
* returns {@code false}
*/
// 获取条件队列中所有等待的节点个数
protected final int getWaitQueueLength() {
// 判断当前线程是否持有锁
if (!isHeldExclusively())
// 如果当前线程没有持有锁, 则抛出异常
throw new IllegalMonitorStateException();
// 走到这, 证明只有当前持有锁的线程能进来, 天然线程安全, 无需担心多线程并发问题
int n = 0;
for (Node w = firstWaiter; w != null; w = w.nextWaiter) {
// 当节点的状态为Node.CONDITION时, 证明此节点在条件队列中还在排队
if (w.waitStatus == Node.CONDITION)
// 累加
++n;
}
// 返回结果
return n;
}
/**
* Returns a collection containing those threads that may be
* waiting on this Condition.
* Implements {@link AbstractQueuedSynchronizer#getWaitingThreads(ConditionObject)}.
*
* @return the collection of threads
* @throws IllegalMonitorStateException if {@link #isHeldExclusively}
* returns {@code false}
*/
// 获取条件队列中所有等待的线程集合
protected final Collection<Thread> getWaitingThreads() {
// 判断当前线程是否持有锁
if (!isHeldExclusively())
// 如果当前线程没有持有锁, 则抛出异常
throw new IllegalMonitorStateException();
// 走到这, 证明只有当前持有锁的线程能进来, 天然线程安全, 无需担心多线程并发问题
ArrayList<Thread> list = new ArrayList<Thread>();
// 遍历条件队列
for (Node w = firstWaiter; w != null; w = w.nextWaiter) {
// 当节点的状态为Node.CONDITION时, 证明此节点在条件队列中还在排队
if (w.waitStatus == Node.CONDITION) {
// 获取当前节点包装的线程对象
Thread t = w.thread;
// 如果线程不为null
if (t != null)
// 加入结果集中
list.add(t);
}
}
// 返回当前条件队列中等待的线程集合
return list;
}
}
至此，ConditionObject中的所有方法均已分析完毕。ConditionObject针对线程监控提供了明确的语义和行为的具体实现，所以这是后面分析ReentrantLock以及其它锁的基础，后续的锁都是基于这些方法来实现等待或者唤醒操作的。
5.AbstractQueuedSynchronizer源码
现在已经分析了AbstractQueuedSynchronizer内部提供的两个重要的内部类，再来看看AbstractQueuedSynchronizer的其它成员方法以及属性，此处我将把上面分析过的Node以及ConditionObject省略掉，因为AbstractQueuedSynchronizer源码实在太长了。AbstractQueuedSynchronizer源码：
public abstract class AbstractQueuedSynchronizer
extends AbstractOwnableSynchronizer
implements java.io.Serializable {
private static final long serialVersionUID = 7373984972572414691L;
/**
* Creates a new {@code AbstractQueuedSynchronizer} instance
* with initial synchronization state of zero.
*/
protected AbstractQueuedSynchronizer() { }
/**
* Head of the wait queue, lazily initialized. Except for
* initialization, it is modified only via method setHead. Note:
* If head exists, its waitStatus is guaranteed not to be
* CANCELLED.
*/
// 阻塞队列的头节点
private transient volatile Node head;
/**
* Tail of the wait queue, lazily initialized. Modified only via
* method enq to add new wait node.
*/
// 阻塞队列的尾节点
private transient volatile Node tail;
/**
* The synchronization state.
*/
// volatile关键字修饰的共享遍历, 后续对于锁的操作都是基于state
private volatile int state;
/**
* Returns the current value of synchronization state.
* This operation has memory semantics of a {@code volatile} read.
* @return current state value
*/
// get()
protected final int getState() {
return state;
}
/**
* Sets the value of synchronization state.
* This operation has memory semantics of a {@code volatile} write.
* @param newState the new state value
*/
// set()
protected final void setState(int newState) {
state = newState;
}
/**
* Atomically sets synchronization state to the given updated
* value if the current state value equals the expected value.
* This operation has memory semantics of a {@code volatile} read
* and write.
*
* @param expect the expected value
* @param update the new value
* @return {@code true} if successful. False return indicates that the actual
* value was not equal to the expected value.
*/
// 封装对于state的CAS修改操作
protected final boolean compareAndSetState(int expect, int update) {
// See below for intrinsics setup to support this
// 底层调用Unsafe类提供的compareAndSwapInt()
return unsafe.compareAndSwapInt(this, stateOffset, expect, update);
}
// Queuing utilities
/**
* The number of nanoseconds for which it is faster to spin
* rather than to use timed park. A rough estimate suffices
* to improve responsiveness with very short timeouts.
*/
// 这个变量在调用超时等待的方法时, 会使用到这个变量对等待执行两种策略, 一种是自旋, 一种是挂起
static final long spinForTimeoutThreshold = 1000L;
/**
* Inserts node into queue, initializing if necessary. See picture above.
* @param node the node to insert
* @return node's predecessor
*/
// 将节点放到阻塞队列的尾部
private Node enq(final Node node) {
// 自旋
for (;;) {
// 获取当前阻塞队列的尾节点
Node t = tail;
// 如果尾节点为null, 则此时阻塞队列为空, 必须要进行初始化头节点
if (t == null) { // Must initialize
// 使用CAS操作初始化头节点, 注意此时初始化的头节点是直接new Node()
// 说明此时头节点中的waitStatus为默认值0, 这里需要留心, 后续有地方会使用到这个值
if (compareAndSetHead(new Node()))
// 将头节点同时也指向尾节点, 因为此时队列中只有一个节点, 初始化阻塞队列完成之后会进入下一个自旋, 将执行具体的节点入队逻辑
tail = head;
} else {
// 将当前要入队节点的前驱节点指向当前队列的尾节点
node.prev = t;
// 使用CAS操作尝试将当前要入队节点替换为队列尾节点
// 如果CAS操作失败则继续自旋直到入队成功为止
if (compareAndSetTail(t, node)) {
// 这里是绝对线程安全的, 请细品Doug Lea的代码
// CAS操作成功, 则将前驱节点的后置节点设置为当前入队的节点
t.next = node;
// 返回其前驱节点
return t;
}
}
}
}
/**
* Creates and enqueues node for current thread and given mode.
*
* @param mode Node.EXCLUSIVE for exclusive, Node.SHARED for shared
* @return the new node
*/
// 将节点添加到阻塞队列中
private Node addWaiter(Node mode) {
// 将当前线程以及当前锁模式包装成Node节点
Node node = new Node(Thread.currentThread(), mode);
// Try the fast path of enq; backup to full enq on failure
// 这里可以思考一下, 为什么要分两次入队? 可以细品一下。
// 获取阻塞队列尾节点
Node pred = tail;
// 如果队列不为空
if (pred != null) {
// 将当前入队节点的前驱节点指向当前队列的尾节点
node.prev = pred;
// 使用CAS操作尝试将当前入队节点替换为队列的尾节点
if (compareAndSetTail(pred, node)) {
// 天然的线程安全, 无需进行线程同步处理
// 将前驱节点的后置节点指向当前入队节点
pred.next = node;
// 返回其前驱节点
return node;
}
}
// 如果上面的CAS操作入队失败, 则在此进行自旋入队
enq(node);
// 返回当前入队节点
return node;
}
/**
* Sets head of queue to be node, thus dequeuing. Called only by
* acquire methods. Also nulls out unused fields for sake of GC
* and to suppress unnecessary signals and traversals.
*
* @param node the node
*/
// 设置队列头节点
private void setHead(Node node) {
head = node;
// 注意, 队列头节点的thread是null
node.thread = null;
// 应对头节点是从队列后面排队过来的
node.prev = null;
}
/**
* Wakes up node's successor, if one exists.
*
* @param node the node
*/
// 如果当前节点存在后继节点, 则唤醒后继节点
private void unparkSuccessor(Node node) {
/*
* If status is negative (i.e., possibly needing signal) try
* to clear in anticipation of signalling. It is OK if this
* fails or if status is changed by waiting thread.
*/
// 获取当前节点的waitStatus
int ws = node.waitStatus;
// 如果当前节点处于等待状态
if (ws < 0)
// 使用CAS操作尝试更新当前节点的waitStatus为初始值0
compareAndSetWaitStatus(node, ws, 0);
/*
* Thread to unpark is held in successor, which is normally
* just the next node. But if cancelled or apparently null,
* traverse backwards from tail to find the actual
* non-cancelled successor.
*/
// 获取后继节点
Node s = node.next;
// 如果后继节点为空 || 后继节点取消了等待
if (s == null || s.waitStatus > 0) {
s = null;
// 从后往前遍历阻塞队列, 找到最前的一个处于正常阻塞等待状态的节点, 并将其唤醒
// 可以思考一下, 为什么这里要从后往前找? 如果能够思考明白, 其实你真的会觉得Doug Lea的代码写的真好
for (Node t = tail; t != null && t != node; t = t.prev)
// 找到阻塞队列中最前的处于等待状态的节点
if (t.waitStatus <= 0)
s = t;
}
if (s != null)
// 唤醒找到的等待节点中的线程
LockSupport.unpark(s.thread);
}
/**
* Release action for shared mode -- signals successor and ensures
* propagation. (Note: For exclusive mode, release just amounts
* to calling unparkSuccessor of head if it needs signal.)
*/
// 共享模式下的锁释放操作 -- 唤醒后继节点并保证传播
// (注意：独占锁模式下, 如果需要信号, 释放就相当于调用head的unparkSuccessor())
private void doReleaseShared() {
/*
* Ensure that a release propagates, even if there are other
* in-progress acquires/releases. This proceeds in the usual
* way of trying to unparkSuccessor of head if it needs
* signal. But if it does not, status is set to PROPAGATE to
* ensure that upon release, propagation continues.
* Additionally, we must loop in case a new node is added
* while we are doing this. Also, unlike other uses of
* unparkSuccessor, we need to know if CAS to reset status
* fails, if so rechecking.
*/
// 自旋
for (;;) {
// 获取头节点
Node h = head;
// 头节点不为空 && 头节点不等于尾节点
if (h != null && h != tail) {
// 获取头节点的waitStatus
int ws = h.waitStatus;
// 如果头节点waitStatus为Node.SIGNAL, 则代表后继节点需要被唤醒
if (ws == Node.SIGNAL) {
// 使用CAS操作将头节点的waitStatus设置为默认值0
if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
// 如果CAS操作失败, 则进入下个自旋操作, 直到CAS
continue; // loop to recheck cases
// 此时头节点的waitStatus已经使用CAS操作更新为默认值0
// 唤醒后继节点
unparkSuccessor(h);
}
// 如果头节点的状态为0 && CAS尝试更新0为Node.PROPAGATE失败
else if (ws == 0 &&
!compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
// 自旋
continue; // loop on failed CAS
}
// 如此时头节点已经被替换, 则说明后继节点已经被唤醒
if (h == head) // loop if head changed
// 退出自旋
break;
}
}
/**
* Sets head of queue, and checks if successor may be waiting
* in shared mode, if so propagating if either propagate > 0 or
* PROPAGATE status was set.
*
* @param node the node
* @param propagate the return value from a tryAcquireShared
*/
// 设置队列头, 并检查后继节点是否可能处于共享模式下等待, 如果是
// 并且如果设置了传播>0或者传播状态, 则传播
// 入参的node所代表的一定是当前执行的线程, propagate代表的是tryAcquireShard的返回值,
// 在tryAcquireShard()方法中有if (r >= 0)的保证, 所以propagate必定大于等于0
// 这里大于等于0代表的是这次获取共享锁成功后, 还有剩余共享锁可以获取, 如果等于0, 则说明
// 在此次获取共享锁成功后, 没有剩余共享锁可以获取
private void setHeadAndPropagate(Node node, int propagate) {
// 获取旧的头节点
Node h = head; // Record old head for check below
// 设置node为阻塞队列的新头节点
setHead(node);
/*
* Try to signal next queued node if:
* Propagation was indicated by caller,
* or was recorded (as h.waitStatus either before
* or after setHead) by a previous operation
* (note: this uses sign-check of waitStatus because
* PROPAGATE status may transition to SIGNAL.)
* and
* The next node is waiting in shared mode,
* or we don't know, because it appears null
*
* The conservatism in both of these checks may cause
* unnecessary wake-ups, but only when there are multiple
* racing acquires/releases, so most need signals now or soon
* anyway.
*/
// h == null是判空
// h.waitStatus < 0是老的头节点的waitStatus
// (h = head) == null也是标准的判空
if (propagate > 0 || h == null || h.waitStatus < 0 ||
(h = head) == null || h.waitStatus < 0) {
// 获取后继节点
Node s = node.next;
// 后继节点不为null || 后继节点是共享模式
if (s == null || s.isShared())
// 释放共享锁, 唤醒后继节点
doReleaseShared();
}
}
// Utilities for various versions of acquire
/**
* Cancels an ongoing attempt to acquire.
*
* @param node the node
*/
// 取消获取锁 --> 间阻塞队列中取消等待的节点出队
private void cancelAcquire(Node node) {
// Ignore if node doesn't exist
// 如果节点为null
if (node == null)
// 直接返回
return;
// 将node中包装的thread置为null, 当前节点不再关联到任何线程
node.thread = null;
// Skip cancelled predecessors
// 获取前驱节点
Node pred = node.prev;
// 如果前驱节点waitStatus大于0, 则代表节点取消了获取锁
while (pred.waitStatus > 0)
// 找到一个有效的前驱节点
node.prev = pred = pred.prev;
// predNext is the apparent node to unsplice. CASes below will
// fail if not, in which case, we lost race vs another cancel
// or signal, so no further action is necessary.
// 获取找到的有效的前驱节点的后置节点
Node predNext = pred.next;
// Can use unconditional write instead of CAS here.
// After this atomic step, other Nodes can skip past us.
// Before, we are free of interference from other threads.
// 将节点的waitStatus置为Node.CANCELLED
node.waitStatus = Node.CANCELLED;
// If we are the tail, remove ourselves.
// 如果node是尾节点, 则使用CAS操作尝试将tail尾节点更新为pred
if (node == tail && compareAndSetTail(node, pred)) {
// 如果CAS修改尾节点成功, 则使用CAS操作将找到的有效前驱节点的后继节点更新为null
compareAndSetNext(pred, predNext, null);
} else {
// If successor needs signal, try to set pred's next-link
// so it will get one. Otherwise wake it up to propagate.
// 进入此分支代表当前节点不是尾节点tail
int ws;
// 如果既不是head头节点的后继节点 && (前驱节点的waitStatus为Node.SIGNAL || CAS设置前驱节点的的waitStatus为Node.SIGNAL) && 前驱节点的thread不为null
if (pred != head &&
((ws = pred.waitStatus) == Node.SIGNAL ||
(ws <= 0 && compareAndSetWaitStatus(pred, ws, Node.SIGNAL))) &&
pred.thread != null) {
// 将Node前驱节点的后置节点替换为Node的后置节点
Node next = node.next;
if (next != null && next.waitStatus <= 0)
compareAndSetNext(pred, predNext, next);
} else {
// 如果node是head的后继节点, 直接唤醒node的后继节点
unparkSuccessor(node);
}
node.next = node; // help GC
}
}
/**
* Checks and updates status for a node that failed to acquire.
* Returns true if thread should block. This is the main signal
* control in all acquire loops. Requires that pred == node.prev.
*
* @param pred node's predecessor holding status
* @param node the node
* @return {@code true} if thread should block
*/
private static boolean shouldParkAfterFailedAcquire(Node pred, Node node) {
// 获取前驱节点的waitStatus
int ws = pred.waitStatus;
// 如果前驱节点的waitStatus已经是Node.SIGNAL, 无需额外处理, 直接返回即可
if (ws == Node.SIGNAL)
/*
* This node has already set status asking a release
* to signal it, so it can safely park.
*/
return true;
// 如果前驱节点的waitStatus>0, 则前驱节点取消了等待
if (ws > 0) {
/*
* Predecessor was cancelled. Skip over predecessors and
* indicate retry.
*/
// 找到一个可靠的前驱节点
do {
node.prev = pred = pred.prev;
} while (pred.waitStatus > 0);
// 将这个可靠前驱节点的后置节点设置为当前节点
pred.next = node;
} else {
// 进入此分支说明ws < 0 && ws != Node.SIGNAL --> 那么只有可能是0或者PROPAGATE
/*
* waitStatus must be 0 or PROPAGATE. Indicate that we
* need a signal, but don't park yet. Caller will need to
* retry to make sure it cannot acquire before parking.
*/
// 使用CAS操作修改前驱节点的waitStatus
compareAndSetWaitStatus(pred, ws, Node.SIGNAL);
}
// 返回false
return false;
}
/**
* Convenience method to interrupt current thread.
*/
// 中断当前线程
static void selfInterrupt() {
Thread.currentThread().interrupt();
}
/**
* Convenience method to park and then check if interrupted
*
* @return {@code true} if interrupted
*/
// 将线程挂起, 当线程被唤醒之后, 检查是否受到过中断信号, 如果收到则将其修改false
private final boolean parkAndCheckInterrupt() {
LockSupport.park(this);
return Thread.interrupted();
}
/*
* Various flavors of acquire, varying in exclusive/shared and
* control modes. Each is mostly the same, but annoyingly
* different. Only a little bit of factoring is possible due to
* interactions of exception mechanics (including ensuring that we
* cancel if tryAcquire throws exception) and other control, at
* least not without hurting performance too much.
*/
/**
* Acquires in exclusive uninterruptible mode for thread already in
* queue. Used by condition wait methods as well as acquire.
*
* @param node the node
* @param arg the acquire argument
* @return {@code true} if interrupted while waiting
*/
// 以独占不中断模式获取已在队列中的线程, 以条件等待方式实现获取锁
final boolean acquireQueued(final Node node, int arg) {
// 是否失败的标识
boolean failed = true;
try {
// 是否收到中断信号
boolean interrupted = false;
// 自旋
for (;;) {
// 获取前驱节点
final Node p = node.predecessor();
// 如果前驱节点为头节点 && 尝试获取锁成功
if (p == head && tryAcquire(arg)) {
// 当前节点出阻塞队列, 将其设置为头节点
setHead(node);
// 断开旧头节点与队列之间的关系
p.next = null; // help GC
// 修改失败状态
failed = false;
// 返回中断信号标识
return interrupted;
}
// 如果当前节点不是头节点或者获取锁失败
// shouldParkAfterFailedAcquire(p, node)方法根据旧头节点的waitStatus状态判断是否需要将当前线程阻塞
// parkAndCheckInterrupt()阻塞, 并且在唤醒时检查中断
if (shouldParkAfterFailedAcquire(p, node) &&
parkAndCheckInterrupt())
// 收到过中断, 修改中断状态
interrupted = true;
}
} finally {
// 只有在上述代码尝试获取锁失败时抛出异常failed为true
if (failed)
// 取消等待获取锁
cancelAcquire(node);
}
}
/**
* Acquires in exclusive interruptible mode.
* @param arg the acquire argument
*/
// 以独占响应中断的模式获取已在队列中的线程
private void doAcquireInterruptibly(int arg)
throws InterruptedException {
// 独占模式入队
final Node node = addWaiter(Node.EXCLUSIVE);
boolean failed = true;
try {
for (;;) {
final Node p = node.predecessor();
if (p == head && tryAcquire(arg)) {
setHead(node);
p.next = null; // help GC
failed = false;
return;
}
if (shouldParkAfterFailedAcquire(p, node) &&
parkAndCheckInterrupt())
// 响应中断
throw new InterruptedException();
}
} finally {
if (failed)
cancelAcquire(node);
}
}
/**
* Acquires in exclusive timed mode.
*
* @param arg the acquire argument
* @param nanosTimeout max wait time
* @return {@code true} if acquired
*/
private boolean doAcquireNanos(int arg, long nanosTimeout)
throws InterruptedException {
// 如果等待时间小于0, 直接返回
if (nanosTimeout <= 0L)
return false;
// 计算等待时间 = 当前时间 + 等待时间
final long deadline = System.nanoTime() + nanosTimeout;
// 以独占模式入队
final Node node = addWaiter(Node.EXCLUSIVE);
boolean failed = true;
try {
for (;;) {
final Node p = node.predecessor();
if (p == head && tryAcquire(arg)) {
setHead(node);
p.next = null; // help GC
failed = false;
return true;
}
nanosTimeout = deadline - System.nanoTime();
// 如果时间到了
if (nanosTimeout <= 0L)
// 返回false, 代表已超时
return false;
// 如果等待时间小于spinForTimeoutThreshold则使用自旋而不是挂起线程
if (shouldParkAfterFailedAcquire(p, node) &&
nanosTimeout > spinForTimeoutThreshold)
LockSupport.parkNanos(this, nanosTimeout);
if (Thread.interrupted())
// 响应中断
throw new InterruptedException();
}
} finally {
if (failed)
cancelAcquire(node);
}
}
/**
* Acquires in shared uninterruptible mode.
* @param arg the acquire argument
*/
private void doAcquireShared(int arg) {
// 以共享模式入队
final Node node = addWaiter(Node.SHARED);
boolean failed = true;
try {
boolean interrupted = false;
for (;;) {
final Node p = node.predecessor();
if (p == head) {
int r = tryAcquireShared(arg);
if (r >= 0) {
setHeadAndPropagate(node, r);
p.next = null; // help GC
if (interrupted)
selfInterrupt();
failed = false;
return;
}
}
if (shouldParkAfterFailedAcquire(p, node) &&
parkAndCheckInterrupt())
interrupted = true;
}
} finally {
if (failed)
cancelAcquire(node);
}
}
/**
* Acquires in shared interruptible mode.
* @param arg the acquire argument
*/
private void doAcquireSharedInterruptibly(int arg)
throws InterruptedException {
final Node node = addWaiter(Node.SHARED);
boolean failed = true;
try {
for (;;) {
final Node p = node.predecessor();
if (p == head) {
int r = tryAcquireShared(arg);
if (r >= 0) {
setHeadAndPropagate(node, r);
p.next = null; // help GC
failed = false;
return;
}
}
if (shouldParkAfterFailedAcquire(p, node) &&
parkAndCheckInterrupt())
throw new InterruptedException();
}
} finally {
if (failed)
cancelAcquire(node);
}
}
/**
* Acquires in shared timed mode.
*
* @param arg the acquire argument
* @param nanosTimeout max wait time
* @return {@code true} if acquired
*/
private boolean doAcquireSharedNanos(int arg, long nanosTimeout)
throws InterruptedException {
if (nanosTimeout <= 0L)
return false;
final long deadline = System.nanoTime() + nanosTimeout;
final Node node = addWaiter(Node.SHARED);
boolean failed = true;
try {
for (;;) {
final Node p = node.predecessor();
if (p == head) {
int r = tryAcquireShared(arg);
if (r >= 0) {
setHeadAndPropagate(node, r);
p.next = null; // help GC
failed = false;
return true;
}
}
nanosTimeout = deadline - System.nanoTime();
if (nanosTimeout <= 0L)
return false;
if (shouldParkAfterFailedAcquire(p, node) &&
nanosTimeout > spinForTimeoutThreshold)
LockSupport.parkNanos(this, nanosTimeout);
if (Thread.interrupted())
throw new InterruptedException();
}
} finally {
if (failed)
cancelAcquire(node);
}
}
// Main exported methods
/**
* Attempts to acquire in exclusive mode. This method should query
* if the state of the object permits it to be acquired in the
* exclusive mode, and if so to acquire it.
*
* <p>This method is always invoked by the thread performing
* acquire. If this method reports failure, the acquire method
* may queue the thread, if it is not already queued, until it is
* signalled by a release from some other thread. This can be used
* to implement method {@link Lock#tryLock()}.
*
* <p>The default
* implementation throws {@link UnsupportedOperationException}.
*
* @param arg the acquire argument. This value is always the one
* passed to an acquire method, or is the value saved on entry
* to a condition wait. The value is otherwise uninterpreted
* and can represent anything you like.
* @return {@code true} if successful. Upon success, this object has
* been acquired.
* @throws IllegalMonitorStateException if acquiring would place this
* synchronizer in an illegal state. This exception must be
* thrown in a consistent fashion for synchronization to work
* correctly.
* @throws UnsupportedOperationException if exclusive mode is not supported
*/
// 模板方法, 尝试获取锁
protected boolean tryAcquire(int arg) {
throw new UnsupportedOperationException();
}
/**
* Attempts to set the state to reflect a release in exclusive
* mode.
*
* <p>This method is always invoked by the thread performing release.
*
* <p>The default implementation throws
* {@link UnsupportedOperationException}.
*
* @param arg the release argument. This value is always the one
* passed to a release method, or the current state value upon
* entry to a condition wait. The value is otherwise
* uninterpreted and can represent anything you like.
* @return {@code true} if this object is now in a fully released
* state, so that any waiting threads may attempt to acquire;
* and {@code false} otherwise.
* @throws IllegalMonitorStateException if releasing would place this
* synchronizer in an illegal state. This exception must be
* thrown in a consistent fashion for synchronization to work
* correctly.
* @throws UnsupportedOperationException if exclusive mode is not supported
*/
// 模板方法, 尝试释放锁
protected boolean tryRelease(int arg) {
throw new UnsupportedOperationException();
}
/**
* Attempts to acquire in shared mode. This method should query if
* the state of the object permits it to be acquired in the shared
* mode, and if so to acquire it.
*
* <p>This method is always invoked by the thread performing
* acquire. If this method reports failure, the acquire method
* may queue the thread, if it is not already queued, until it is
* signalled by a release from some other thread.
*
* <p>The default implementation throws {@link
* UnsupportedOperationException}.
*
* @param arg the acquire argument. This value is always the one
* passed to an acquire method, or is the value saved on entry
* to a condition wait. The value is otherwise uninterpreted
* and can represent anything you like.
* @return a negative value on failure; zero if acquisition in shared
* mode succeeded but no subsequent shared-mode acquire can
* succeed; and a positive value if acquisition in shared
* mode succeeded and subsequent shared-mode acquires might
* also succeed, in which case a subsequent waiting thread
* must check availability. (Support for three different
* return values enables this method to be used in contexts
* where acquires only sometimes act exclusively.) Upon
* success, this object has been acquired.
* @throws IllegalMonitorStateException if acquiring would place this
* synchronizer in an illegal state. This exception must be
* thrown in a consistent fashion for synchronization to work
* correctly.
* @throws UnsupportedOperationException if shared mode is not supported
*/
// 模板方法, 尝试获取共享锁
protected int tryAcquireShared(int arg) {
throw new UnsupportedOperationException();
}
/**
* Attempts to set the state to reflect a release in shared mode.
*
* <p>This method is always invoked by the thread performing release.
*
* <p>The default implementation throws
* {@link UnsupportedOperationException}.
*
* @param arg the release argument. This value is always the one
* passed to a release method, or the current state value upon
* entry to a condition wait. The value is otherwise
* uninterpreted and can represent anything you like.
* @return {@code true} if this release of shared mode may permit a
* waiting acquire (shared or exclusive) to succeed; and
* {@code false} otherwise
* @throws IllegalMonitorStateException if releasing would place this
* synchronizer in an illegal state. This exception must be
* thrown in a consistent fashion for synchronization to work
* correctly.
* @throws UnsupportedOperationException if shared mode is not supported
*/
// 模板方法, 尝试释放共享锁
protected boolean tryReleaseShared(int arg) {
throw new UnsupportedOperationException();
}
/**
* Returns {@code true} if synchronization is held exclusively with
* respect to the current (calling) thread. This method is invoked
* upon each call to a non-waiting {@link ConditionObject} method.
* (Waiting methods instead invoke {@link #release}.)
*
* <p>The default implementation throws {@link
* UnsupportedOperationException}. This method is invoked
* internally only within {@link ConditionObject} methods, so need
* not be defined if conditions are not used.
*
* @return {@code true} if synchronization is held exclusively;
* {@code false} otherwise
* @throws UnsupportedOperationException if conditions are not supported
*/
// 模板方法, 当前线程是否持有锁
protected boolean isHeldExclusively() {
throw new UnsupportedOperationException();
}
/**
* Acquires in exclusive mode, ignoring interrupts. Implemented
* by invoking at least once {@link #tryAcquire},
* returning on success. Otherwise the thread is queued, possibly
* repeatedly blocking and unblocking, invoking {@link
* #tryAcquire} until success. This method can be used
* to implement method {@link Lock#lock}.
*
* @param arg the acquire argument. This value is conveyed to
* {@link #tryAcquire} but is otherwise uninterpreted and
* can represent anything you like.
*/
// 获取锁, 如果获取锁失败则进入阻塞队列等待其它线程唤醒重新竞争锁
// 模板方法
public final void acquire(int arg) {
if (!tryAcquire(arg) &&
acquireQueued(addWaiter(Node.EXCLUSIVE), arg))
selfInterrupt();
}
/**
* Acquires in exclusive mode, aborting if interrupted.
* Implemented by first checking interrupt status, then invoking
* at least once {@link #tryAcquire}, returning on
* success. Otherwise the thread is queued, possibly repeatedly
* blocking and unblocking, invoking {@link #tryAcquire}
* until success or the thread is interrupted. This method can be
* used to implement method {@link Lock#lockInterruptibly}.
*
* @param arg the acquire argument. This value is conveyed to
* {@link #tryAcquire} but is otherwise uninterpreted and
* can represent anything you like.
* @throws InterruptedException if the current thread is interrupted
*/
// 获取锁并响应中断
public final void acquireInterruptibly(int arg)
throws InterruptedException {
if (Thread.interrupted())
throw new InterruptedException();
if (!tryAcquire(arg))
doAcquireInterruptibly(arg);
}
/**
* Attempts to acquire in exclusive mode, aborting if interrupted,
* and failing if the given timeout elapses. Implemented by first
* checking interrupt status, then invoking at least once {@link
* #tryAcquire}, returning on success. Otherwise, the thread is
* queued, possibly repeatedly blocking and unblocking, invoking
* {@link #tryAcquire} until success or the thread is interrupted
* or the timeout elapses. This method can be used to implement
* method {@link Lock#tryLock(long, TimeUnit)}.
*
* @param arg the acquire argument. This value is conveyed to
* {@link #tryAcquire} but is otherwise uninterpreted and
* can represent anything you like.
* @param nanosTimeout the maximum number of nanoseconds to wait
* @return {@code true} if acquired; {@code false} if timed out
* @throws InterruptedException if the current thread is interrupted
*/
public final boolean tryAcquireNanos(int arg, long nanosTimeout)
throws InterruptedException {
// 检查是否受到中断信号
if (Thread.interrupted())
// 如果收到了则相应中断
throw new InterruptedException();
// 先尝试获取锁, 如果获取锁失败则等待并指定时间
return tryAcquire(arg) ||
doAcquireNanos(arg, nanosTimeout);
}
/**
* Releases in exclusive mode. Implemented by unblocking one or
* more threads if {@link #tryRelease} returns true.
* This method can be used to implement method {@link Lock#unlock}.
*
* @param arg the release argument. This value is conveyed to
* {@link #tryRelease} but is otherwise uninterpreted and
* can represent anything you like.
* @return the value returned from {@link #tryRelease}
*/
public final boolean release(int arg) {
// 尝试释放锁
if (tryRelease(arg)) {
// 释放锁成功, 则获取当前阻塞队列头节点
Node h = head;
// 如果头节点不为null && 头节点waitStatus不为0
if (h != null && h.waitStatus != 0)
// 唤醒后继节点
unparkSuccessor(h);
// 返回true
return true;
}
// 尝试释放锁失败, 返回false
return false;
}
/**
* Acquires in shared mode, ignoring interrupts. Implemented by
* first invoking at least once {@link #tryAcquireShared},
* returning on success. Otherwise the thread is queued, possibly
* repeatedly blocking and unblocking, invoking {@link
* #tryAcquireShared} until success.
*
* @param arg the acquire argument. This value is conveyed to
* {@link #tryAcquireShared} but is otherwise uninterpreted
* and can represent anything you like.
*/
public final void acquireShared(int arg) {
if (tryAcquireShared(arg) < 0)
doAcquireShared(arg);
}
/**
* Acquires in shared mode, aborting if interrupted. Implemented
* by first checking interrupt status, then invoking at least once
* {@link #tryAcquireShared}, returning on success. Otherwise the
* thread is queued, possibly repeatedly blocking and unblocking,
* invoking {@link #tryAcquireShared} until success or the thread
* is interrupted.
* @param arg the acquire argument.
* This value is conveyed to {@link #tryAcquireShared} but is
* otherwise uninterpreted and can represent anything
* you like.
* @throws InterruptedException if the current thread is interrupted
*/
public final void acquireSharedInterruptibly(int arg)
throws InterruptedException {
if (Thread.interrupted())
throw new InterruptedException();
if (tryAcquireShared(arg) < 0)
doAcquireSharedInterruptibly(arg);
}
/**
* Attempts to acquire in shared mode, aborting if interrupted, and
* failing if the given timeout elapses. Implemented by first
* checking interrupt status, then invoking at least once {@link
* #tryAcquireShared}, returning on success. Otherwise, the
* thread is queued, possibly repeatedly blocking and unblocking,
* invoking {@link #tryAcquireShared} until success or the thread
* is interrupted or the timeout elapses.
*
* @param arg the acquire argument. This value is conveyed to
* {@link #tryAcquireShared} but is otherwise uninterpreted
* and can represent anything you like.
* @param nanosTimeout the maximum number of nanoseconds to wait
* @return {@code true} if acquired; {@code false} if timed out
* @throws InterruptedException if the current thread is interrupted
*/
public final boolean tryAcquireSharedNanos(int arg, long nanosTimeout)
throws InterruptedException {
if (Thread.interrupted())
throw new InterruptedException();
return tryAcquireShared(arg) >= 0 ||
doAcquireSharedNanos(arg, nanosTimeout);
}
/**
* Releases in shared mode. Implemented by unblocking one or more
* threads if {@link #tryReleaseShared} returns true.
*
* @param arg the release argument. This value is conveyed to
* {@link #tryReleaseShared} but is otherwise uninterpreted
* and can represent anything you like.
* @return the value returned from {@link #tryReleaseShared}
*/
public final boolean releaseShared(int arg) {
if (tryReleaseShared(arg)) {
doReleaseShared();
return true;
}
return false;
}
// Queue inspection methods
/**
* Queries whether any threads are waiting to acquire. Note that
* because cancellations due to interrupts and timeouts may occur
* at any time, a {@code true} return does not guarantee that any
* other thread will ever acquire.
*
* <p>In this implementation, this operation returns in
* constant time.
*
* @return {@code true} if there may be other threads waiting to acquire
*/
public final boolean hasQueuedThreads() {
// 判断队列中是否还有等待的线程
return head != tail;
}
/**
* Queries whether any threads have ever contended to acquire this
* synchronizer; that is if an acquire method has ever blocked.
*
* <p>In this implementation, this operation returns in
* constant time.
*
* @return {@code true} if there has ever been contention
*/
public final boolean hasContended() {
// 判断队列是否为空
return head != null;
}
/**
* Returns the first (longest-waiting) thread in the queue, or
* {@code null} if no threads are currently queued.
*
* <p>In this implementation, this operation normally returns in
* constant time, but may iterate upon contention if other threads are
* concurrently modifying the queue.
*
* @return the first (longest-waiting) thread in the queue, or
* {@code null} if no threads are currently queued
*/
public final Thread getFirstQueuedThread() {
// handle only fast path, else relay
return (head == tail) ? null : fullGetFirstQueuedThread();
}
/**
* Version of getFirstQueuedThread called when fastpath fails
*/
private Thread fullGetFirstQueuedThread() {
/*
* The first node is normally head.next. Try to get its
* thread field, ensuring consistent reads: If thread
* field is nulled out or s.prev is no longer head, then
* some other thread(s) concurrently performed setHead in
* between some of our reads. We try this twice before
* resorting to traversal.
*/
Node h, s;
Thread st;
if (((h = head) != null && (s = h.next) != null &&
s.prev == head && (st = s.thread) != null) ||
((h = head) != null && (s = h.next) != null &&
s.prev == head && (st = s.thread) != null))
return st;
/*
* Head's next field might not have been set yet, or may have
* been unset after setHead. So we must check to see if tail
* is actually first node. If not, we continue on, safely
* traversing from tail back to head to find first,
* guaranteeing termination.
*/
Node t = tail;
Thread firstThread = null;
while (t != null && t != head) {
Thread tt = t.thread;
if (tt != null)
firstThread = tt;
t = t.prev;
}
return firstThread;
}
/**
* Returns true if the given thread is currently queued.
*
* <p>This implementation traverses the queue to determine
* presence of the given thread.
*
* @param thread the thread
* @return {@code true} if the given thread is on the queue
* @throws NullPointerException if the thread is null
*/
// 判断当前线程是否在阻塞队列中
public final boolean isQueued(Thread thread) {
if (thread == null)
throw new NullPointerException();
// 从后往前遍历
for (Node p = tail; p != null; p = p.prev)
if (p.thread == thread)
return true;
return false;
}
/**
* Returns {@code true} if the apparent first queued thread, if one
* exists, is waiting in exclusive mode. If this method returns
* {@code true}, and the current thread is attempting to acquire in
* shared mode (that is, this method is invoked from {@link
* #tryAcquireShared}) then it is guaranteed that the current thread
* is not the first queued thread. Used only as a heuristic in
* ReentrantReadWriteLock.
*/
final boolean apparentlyFirstQueuedIsExclusive() {
Node h, s;
return (h = head) != null &&
(s = h.next) != null &&
!s.isShared() &&
s.thread != null;
}
/**
* Queries whether any threads have been waiting to acquire longer
* than the current thread.
*
* <p>An invocation of this method is equivalent to (but may be
* more efficient than):
* <pre> {@code
* getFirstQueuedThread() != Thread.currentThread() &&
* hasQueuedThreads()}</pre>
*
* <p>Note that because cancellations due to interrupts and
* timeouts may occur at any time, a {@code true} return does not
* guarantee that some other thread will acquire before the current
* thread. Likewise, it is possible for another thread to win a
* race to enqueue after this method has returned {@code false},
* due to the queue being empty.
*
* <p>This method is designed to be used by a fair synchronizer to
* avoid <a href="AbstractQueuedSynchronizer#barging">barging</a>.
* Such a synchronizer's {@link #tryAcquire} method should return
* {@code false}, and its {@link #tryAcquireShared} method should
* return a negative value, if this method returns {@code true}
* (unless this is a reentrant acquire). For example, the {@code
* tryAcquire} method for a fair, reentrant, exclusive mode
* synchronizer might look like this:
*
* <pre> {@code
* protected boolean tryAcquire(int arg) {
* if (isHeldExclusively()) {
* // A reentrant acquire; increment hold count
* return true;
* } else if (hasQueuedPredecessors()) {
* return false;
* } else {
* // try to acquire normally
* }
* }}</pre>
*
* @return {@code true} if there is a queued thread preceding the
* current thread, and {@code false} if the current thread
* is at the head of the queue or the queue is empty
* @since 1.7
*/
public final boolean hasQueuedPredecessors() {
// The correctness of this depends on head being initialized
// before tail and on head.next being accurate if the current
// thread is first in queue.
Node t = tail; // Read fields in reverse initialization order
Node h = head;
Node s;
return h != t &&
((s = h.next) == null || s.thread != Thread.currentThread());
}
// Instrumentation and monitoring methods
/**
* Returns an estimate of the number of threads waiting to
* acquire. 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 system state, not for synchronization
* control.
*
* @return the estimated number of threads waiting to acquire
*/
public final int getQueueLength() {
int n = 0;
for (Node p = tail; p != null; p = p.prev) {
if (p.thread != null)
++n;
}
return n;
}
/**
* Returns a collection containing threads that may be waiting to
* acquire. 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.
*
* @return the collection of threads
*/
public final Collection<Thread> getQueuedThreads() {
ArrayList<Thread> list = new ArrayList<Thread>();
for (Node p = tail; p != null; p = p.prev) {
Thread t = p.thread;
if (t != null)
list.add(t);
}
return list;
}
/**
* Returns a collection containing threads that may be waiting to
* acquire in exclusive mode. This has the same properties
* as {@link #getQueuedThreads} except that it only returns
* those threads waiting due to an exclusive acquire.
*
* @return the collection of threads
*/
public final Collection<Thread> getExclusiveQueuedThreads() {
ArrayList<Thread> list = new ArrayList<Thread>();
for (Node p = tail; p != null; p = p.prev) {
if (!p.isShared()) {
Thread t = p.thread;
if (t != null)
list.add(t);
}
}
return list;
}
/**
* Returns a collection containing threads that may be waiting to
* acquire in shared mode. This has the same properties
* as {@link #getQueuedThreads} except that it only returns
* those threads waiting due to a shared acquire.
*
* @return the collection of threads
*/
public final Collection<Thread> getSharedQueuedThreads() {
ArrayList<Thread> list = new ArrayList<Thread>();
for (Node p = tail; p != null; p = p.prev) {
if (p.isShared()) {
Thread t = p.thread;
if (t != null)
list.add(t);
}
}
return list;
}
/**
* Returns a string identifying this synchronizer, as well as its state.
* The state, in brackets, includes the String {@code "State ="}
* followed by the current value of {@link #getState}, and either
* {@code "nonempty"} or {@code "empty"} depending on whether the
* queue is empty.
*
* @return a string identifying this synchronizer, as well as its state
*/
public String toString() {
int s = getState();
String q = hasQueuedThreads() ? "non" : "";
return super.toString() +
"[State = " + s + ", " + q + "empty queue]";
}
// Internal support methods for Conditions
/**
* Returns true if a node, always one that was initially placed on
* a condition queue, is now waiting to reacquire on sync queue.
* @param node the node
* @return true if is reacquiring
*/
final boolean isOnSyncQueue(Node node) {
if (node.waitStatus == Node.CONDITION || node.prev == null)
return false;
if (node.next != null) // If has successor, it must be on queue
return true;
/*
* node.prev can be non-null, but not yet on queue because
* the CAS to place it on queue can fail. So we have to
* traverse from tail to make sure it actually made it. It
* will always be near the tail in calls to this method, and
* unless the CAS failed (which is unlikely), it will be
* there, so we hardly ever traverse much.
*/
return findNodeFromTail(node);
}
/**
* Returns true if node is on sync queue by searching backwards from tail.
* Called only when needed by isOnSyncQueue.
* @return true if present
*/
// 从队列尾部查找node是否在队列中
private boolean findNodeFromTail(Node node) {
// 获取尾节点
Node t = tail;
// 遍历
for (;;) {
// 如果当前节点在队列中存在
if (t == node)
// 放回true
return true;
// 如果当前队列在队列中不存在
if (t == null)
return false;
t = t.prev;
}
}
/**
* Transfers a node from a condition queue onto sync queue.
* Returns true if successful.
* @param node the node
* @return true if successfully transferred (else the node was
* cancelled before signal)
*/
final boolean transferForSignal(Node node) {
/*
* If cannot change waitStatus, the node has been cancelled.
*/
// 使用CAS操作修改条件队列中node的waitStatus
if (!compareAndSetWaitStatus(node, Node.CONDITION, 0))
return false;
/*
* Splice onto queue and try to set waitStatus of predecessor to
* indicate that thread is (probably) waiting. If cancelled or
* attempt to set waitStatus fails, wake up to resync (in which
* case the waitStatus can be transiently and harmlessly wrong).
*/
// 如果node节点的waitStatus成功修改为0
// 将node从条件队列中转移到阻塞队列中
Node p = enq(node);
int ws = p.waitStatus;
// 如果node的前驱节点的waitStatus > 0 || 使用CAS尝试修改node前驱节点的waitStatus为Node.SIGNAL失败
if (ws > 0 || !compareAndSetWaitStatus(p, ws, Node.SIGNAL))
// 唤醒当前线程
LockSupport.unpark(node.thread);
// 返回true
return true;
}
/**
* Transfers node, if necessary, to sync queue after a cancelled wait.
* Returns true if thread was cancelled before being signalled.
*
* @param node the node
* @return true if cancelled before the node was signalled
*/
final boolean transferAfterCancelledWait(Node node) {
// 使用CAS操作尝试修改node的waitStatus为0
if (compareAndSetWaitStatus(node, Node.CONDITION, 0)) {
// 修改成功则把node从条件队列转移到阻塞队列
enq(node);
// 返回true
return true;
}
/*
* If we lost out to a signal(), then we can't proceed
* until it finishes its enq(). Cancelling during an
* incomplete transfer is both rare and transient, so just
* spin.
*/
// 使用CAS操作尝试修改node的waitStatus为0失败
// 判断当前node是否被转移到阻塞队列中
while (!isOnSyncQueue(node))
// 可能此时还在转移过程中, 自旋等待一会, 退出CPU时间片, 不释放锁
Thread.yield();
// 返回false
return false;
}
/**
* Invokes release with current state value; returns saved state.
* Cancels node and throws exception on failure.
* @param node the condition node for this wait
* @return previous sync state
*/
// 完全释放锁, 进入到这个方法内部的线程必定已经获取锁
final int fullyRelease(Node node) {
boolean failed = true;
try {
// 获取当前state
int savedState = getState();
// 完全释放掉锁
if (release(savedState)) {
// 修改失败状态
failed = false;
// 返回当前线程重入锁次数
return savedState;
} else {
// 释放锁失败抛出异常
throw new IllegalMonitorStateException();
}
} finally {
// 如果上面操作抛出异常
if (failed)
// 将当前节点设为取消等待, 后续会将其移出阻塞队列
node.waitStatus = Node.CANCELLED;
}
}
// Instrumentation methods for conditions
/**
* Queries whether the given ConditionObject
* uses this synchronizer as its lock.
*
* @param condition the condition
* @return {@code true} if owned
* @throws NullPointerException if the condition is null
*/
public final boolean owns(ConditionObject condition) {
return condition.isOwnedBy(this);
}
/**
* Queries whether any threads are waiting on the given condition
* associated with this synchronizer. 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.
*
* @param condition the condition
* @return {@code true} if there are any waiting threads
* @throws IllegalMonitorStateException if exclusive synchronization
* is not held
* @throws IllegalArgumentException if the given condition is
* not associated with this synchronizer
* @throws NullPointerException if the condition is null
*/
public final boolean hasWaiters(ConditionObject condition) {
if (!owns(condition))
throw new IllegalArgumentException("Not owner");
return condition.hasWaiters();
}
/**
* Returns an estimate of the number of threads waiting on the
* given condition associated with this synchronizer. 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.
*
* @param condition the condition
* @return the estimated number of waiting threads
* @throws IllegalMonitorStateException if exclusive synchronization
* is not held
* @throws IllegalArgumentException if the given condition is
* not associated with this synchronizer
* @throws NullPointerException if the condition is null
*/
public final int getWaitQueueLength(ConditionObject condition) {
if (!owns(condition))
throw new IllegalArgumentException("Not owner");
return condition.getWaitQueueLength();
}
/**
* Returns a collection containing those threads that may be
* waiting on the given condition associated with this
* synchronizer. 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.
*
* @param condition the condition
* @return the collection of threads
* @throws IllegalMonitorStateException if exclusive synchronization
* is not held
* @throws IllegalArgumentException if the given condition is
* not associated with this synchronizer
* @throws NullPointerException if the condition is null
*/
public final Collection<Thread> getWaitingThreads(ConditionObject condition) {
if (!owns(condition))
throw new IllegalArgumentException("Not owner");
return condition.getWaitingThreads();
}
/**
* Setup to support compareAndSet. We need to natively implement
* this here: For the sake of permitting future enhancements, we
* cannot explicitly subclass AtomicInteger, which would be
* efficient and useful otherwise. So, as the lesser of evils, we
* natively implement using hotspot intrinsics API. And while we
* are at it, we do the same for other CASable fields (which could
* otherwise be done with atomic field updaters).
*/
private static final Unsafe unsafe = Unsafe.getUnsafe();
private static final long stateOffset;
private static final long headOffset;
private static final long tailOffset;
private static final long waitStatusOffset;
private static final long nextOffset;
// 使用反射获取类中后续会使用CAS操作的变量
static {
try {
stateOffset = unsafe.objectFieldOffset
(AbstractQueuedSynchronizer.class.getDeclaredField("state"));
headOffset = unsafe.objectFieldOffset
(AbstractQueuedSynchronizer.class.getDeclaredField("head"));
tailOffset = unsafe.objectFieldOffset
(AbstractQueuedSynchronizer.class.getDeclaredField("tail"));
waitStatusOffset = unsafe.objectFieldOffset
(Node.class.getDeclaredField("waitStatus"));
nextOffset = unsafe.objectFieldOffset
(Node.class.getDeclaredField("next"));
} catch (Exception ex) { throw new Error(ex); }
}
/**
* CAS head field. Used only by enq.
*/
private final boolean compareAndSetHead(Node update) {
return unsafe.compareAndSwapObject(this, headOffset, null, update);
}
/**
* CAS tail field. Used only by enq.
*/
private final boolean compareAndSetTail(Node expect, Node update) {
return unsafe.compareAndSwapObject(this, tailOffset, expect, update);
}
/**
* CAS waitStatus field of a node.
*/
private static final boolean compareAndSetWaitStatus(Node node,
int expect,
int update) {
return unsafe.compareAndSwapInt(node, waitStatusOffset,
expect, update);
}
/**
* CAS next field of a node.
*/
private static final boolean compareAndSetNext(Node node,
Node expect,
Node update) {
return unsafe.compareAndSwapObject(node, nextOffset, expect, update);
}
}
至此，AbstractQueuedSynchronizer中的内部类以及成员方法都已经分析清楚了。当然这里并没有对实际加锁、释放锁的流程进行一个完整的分析，这里只是为后续做这些分析做最基础的铺垫。
了解以上每个方法的作用，为后续具体分析java.util.concurrent包下的各种锁做铺垫。
熟悉了这些最基础的，后面会围绕java.util.concurrent包下具体的锁来进行分析。
备注：此文为笔者学习
Java的笔记，鉴于本人技术有限，文中难免出现一些错误，感谢大家批评指正。
219
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
