再谈AbstractQueuedSynchronizer：独占模式
软件设计 2017-06-23
关于AbstractQueuedSynchronizer
JDK1.5之后引入了并发包java.util.concurrent，大大提高了Java程序的并发性能。关于java.util.concurrent包我总结如下：
- AbstractQueuedSynchronizer是并发类诸如ReentrantLock、CountDownLatch、Semphore的核心
- CAS算法是AbstractQueuedSynchronizer的核心
可以说AbstractQueuedSynchronizer是并发类的重中之重。其实之前在ReentrantLock实现原理深入探究一文中已经有结合ReentrantLock详细解读过AbstractQueuedSynchronizer，但限于当时水平原因，回看一年半前的此文，感觉对于AbstractQueuedSynchronizer的解读理解还不够深，因此这里更新一篇文章，再次解读AbstractQueuedSynchronizer的数据结构即相关源码实现，本文基于JDK1.7版本。
AbstactQueuedSynchronizer的基本数据结构
AbstractQueuedSynchronizer的基本数据结构为Node，关于Node，JDK作者写了详细的注释，这里我大致总结几点：
- AbstractQueuedSynchronizer的等待队列是CLH队列的变种，CLH队列通常用于自旋锁，AbstractQueuedSynchronizer的等待队列用于阻塞同步器
- 每个节点中持有一个名为"status"的字段用于是否一条线程应当阻塞的追踪，但是status字段并不保证加锁
- 一条线程如果它处于队列的头，那么他会尝试去acquire，但是成为头并不保证成功，它只是有权利去竞争
- 要进入队列，你只需要自动将它拼接在队列尾部即可；要从队列中移除，你只需要设置header字段
下面我用一张表格总结一下Node中持有哪些变量且每个变量的含义：
关于SIGNAL、CANCELLED、CONDITION、PROPAGATE四个状态，JDK源码的注释中同样有了详细的解读，再用一张表格总结一下：
AbstractQueuedSynchronizer供子类实现的方法
AbstractQueuedSynchzonizer是基于模板模式的实现，不过它的模板模式写法有点特别，整个类中没有任何一个abstract的抽象方法，取而代之的是，需要子类去实现的那些方法通过一个方法体抛出UnsupportedOperationException异常来让子类知道。
AbstractQueuedSynchronizer类中一共有五处方法供子类实现，用表格总结一下：
这里的acquire不好翻译，所以就直接原词放上来了，因为acquire是一个动词，后面并没有带宾语，因此不知道具体acquire的是什么。按照我个人理解，acquire的意思应当是根据状态字段state去获取一个执行当前动作的资格。
比如ReentrantLock的lock()方法最终会调用acquire方法，那么：
- 线程1去lock()，执行acquire，发现state=0，因此有资格执行lock()的动作，将state设置为1，返回true
- 线程2去lock()，执行acquire，发现state=1，因此没有资格执行lock()的动作，返回false
这种理解我认为应当是比较准确的。
独占模式acquire实现流程
有了上面的这些基础，我们看一下独占式acquire的实现流程，主要是在线程acquire失败后，是如何构建数据结构的，先看理论，之后再用一个例子画图说明。
看一下AbstractQuueuedSynchronizer的acquire方法实现流程，acquire方法是用于独占模式下进行操作的：
public final void acquire(int arg) {
if (!tryAcquire(arg) &&
acquireQueued(addWaiter(Node.EXCLUSIVE), arg))
selfInterrupt();
} tryAcquire方法前面说过了，是子类实现的一个方法，如果tryAcquire返回的是true（成功），即表明当前线程获得了一个执行当前动作的资格，自然也就不需要构建数据结构进行阻塞等待。
如果tryAcquire方法返回的是false，那么当前线程没有获得执行当前动作的资格，接着执行"acquireQueued(addWaiter(Node.EXCLUSIVE), arg))"这句代码，这句话很明显，它是由两步构成的：
- addWaiter，添加一个等待者
- acquireQueued，尝试从等待队列中去获取执行一次acquire动作
分别看一下每一步做了什么。
addWaiter
先看第一步，addWaiter做了什么，从传入的参数Node.EXCLUSIVE我们知道这是独占模式的：
private Node addWaiter(Node mode) {
Node node = new Node(Thread.currentThread(), mode);
// Try the fast path of enq; backup to full enq on failure
Node prev = tail;
if (prev != null) {
node.prev = prev;
if (compareAndSetTail(prev, node)) {
prev.next = node;
return node;
}
}
enq(node);
return node;
} 首先看第4行~第11行的代码，获得当前数据结构中的尾节点，如果有尾节点，那么先获取这个节点认为它是前驱节点prev，然后：
- 新生成的Node的前驱节点指向prev
- 并发下只有一条线程可以通过CAS算法让自己的Node成为尾节点，此时将此prev的next指向该线程对应的Node
因此在数据结构中有节点的情况下，所有新增节点都是作为尾节点插入数据结构。从注释上来看，这段逻辑的存在的意义是以最短路径O(1)的效果完成快速入队，以最大化减小开销。
假如当前节点没有被设置为尾节点，那么执行enq方法：
private Node enq(final Node node) {
for (;;) {
Node t = tail;
if (t == null) { // Must initialize
if (compareAndSetHead(new Node()))
tail = head;
} else {
node.prev = t;
if (compareAndSetTail(t, node)) {
t.next = node;
return t;
}
}
}
} 这段代码的逻辑为：
- 如果尾节点为空，即当前数据结构中没有节点，那么new一个不带任何状态的Node作为头节点
- 如果尾节点不为空，那么并发下使用CAS算法将当前Node追加成为尾节点，由于是一个for(;;)循环，因此所有没有成功acquire的Node最终都会被追加到数据结构中
看完了代码，用一张图表示一下AbstractQueuedSynchronizer的整体数据结构（比较简单，就不自己画了，网上随便找了一张图）：
acquireQueued
队列构建好了，下一步就是在必要的时候从队列里面拿出一个Node了，这就是acquireQueued方法，顾名思义，从队列里面acquire。看下acquireQueued方法的实现：
final boolean acquireQueued(final Node node, int arg) {
boolean failed = true;
try {
boolean interrupted = false;
for (;;) {
final Node p = node.prevecessor();
if (p == head && tryAcquire(arg)) {
setHead(node);
p.next = null; // help GC
failed = false;
return interrupted;
}
if (shouldParkAfterFailedAcquire(p, node) &&
parkAndCheckInterrupt())
interrupted = true;
}
} finally {
if (failed)
cancelAcquire(node);
}
} 这段代码描述了几件事：
- 从第6行的代码获取节点的前驱节点p，第7行的代码判断p是前驱节点并tryAcquire我们知道，只有当前第一个持有Thread的节点才会尝试acquire，如果节点acquire成功，那么setHead方法，将当前节点作为head、将当前节点中的thread设置为null、将当前节点的prev设置为null，这保证了数据结构中头结点永远是一个不带Thread的空节点
- 如果当前节点不是前驱节点或者tryAcquire失败，那么执行第13行~第15行的代码，做了两步操作，首先判断在acquie失败后是否应该park，其次park并检查中断状态
看一下第一步shouldParkAfterFailedAcquire代码做了什么：
private static boolean shouldParkAfterFailedAcquire(Node prev, Node node) {
int ws = prev.waitStatus;
if (ws == Node.SIGNAL)
/*
* This node has already set status asking a release
* to signal it, so it can safely park.
*/
return true;
if (ws > 0) {
/*
* prevecessor was cancelled. Skip over prevecessors and
* indicate retry.
*/
do {
node.prev = prev = prev.prev;
} while (prev.waitStatus > 0);
prev.next = node;
} else {
/*
* 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.
*/
compareAndSetWaitStatus(prev, ws, Node.SIGNAL);
}
return false;
} 这里每个节点判断它前驱节点的状态，如果：
- 它的前驱节点是SIGNAL状态的，返回true，表示当前节点应当park
- 它的前驱节点的waitStatus>0，相当于CANCELLED（因为状态值里面只有CANCELLED是大于0的），那么CANCELLED的节点作废，当前节点不断向前找并重新连接为双向队列，直到找到一个前驱节点waitStats不是CANCELLED的为止
- 它的前驱节点不是SIGNAL状态且waitStatus<=0，此时执行第24行代码，利用CAS机制，如果waitStatus的前驱节点是0那么更新为SIGNAL状态
如果判断判断应当park，那么parkAndCheckInterrupt方法：
private final boolean parkAndCheckInterrupt() {
LockSupport.park(this);
return Thread.interrupted();
} 利用LockSupport的park方法让当前线程阻塞。
独占模式release流程
上面整理了独占模式的acquire流程，看到了等待的Node是如何构建成一个数据结构的，下面看一下释放的时候做了什么，release方法的实现为：
public final boolean release(int arg) {
if (tryRelease(arg)) {
Node h = head;
if (h != null && h.waitStatus != 0)
unparkSuccessor(h);
return true;
}
return false;
} tryRelease同样是子类去实现的，表示当前动作我执行完了，要释放我执行当前动作的资格，讲这个资格让给其它线程，然后tryRelease释放成功，获取到head节点，如果head节点的waitStatus不为0的话，执行unparkSuccessor方法，顾名思义unparkSuccessor意为unpark头结点的继承者，方法实现为：
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.
*/
int ws = node.waitStatus;
if (ws < 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;
for (Node t = tail; t != null && t != node; t = t.prev)
if (t.waitStatus <= 0)
s = t;
}
if (s != null)
LockSupport.unpark(s.thread);
} 这段代码比较好理解，整理一下流程：
- 头节点的waitStatus<0，将头节点的waitStatus设置为0
- 拿到头节点的下一个节点s，如果s==null或者s的waitStatus>0（被取消了），那么从队列尾巴开始向前寻找一个waitStatus<=0的节点作为后继要唤醒的节点
最后，如果拿到了一个不等于null的节点s，就利用LockSupport的unpark方法让它取消阻塞。
实战举例：数据结构构建
上面的例子讲解地过于理论，下面利用ReentrantLock举个例子，但是这里不讲ReentrantLock实现原理，只是利用ReentrantLock研究AbstractQueuedSynchronizer的acquire和release。示例代码为：
/**
* @author 五月的仓颉http://www.cnblogs.com/xrq730/p/7056614.html
*/
public class AbstractQueuedSynchronizerTest {
@Test
public void testAbstractQueuedSynchronizer() {
Lock lock = new ReentrantLock();
Runnable runnable0 = new ReentrantLockThread(lock);
Thread thread0 = new Thread(runnable0);
thread0.setName("线程0");
Runnable runnable1 = new ReentrantLockThread(lock);
Thread thread1 = new Thread(runnable1);
thread1.setName("线程1");
Runnable runnable2 = new ReentrantLockThread(lock);
Thread thread2 = new Thread(runnable2);
thread2.setName("线程2");
thread0.start();
thread1.start();
thread2.start();
for (;;);
}
private class ReentrantLockThread implements Runnable {
private Lock lock;
public ReentrantLockThread(Lock lock) {
this.lock = lock;
}
@Override
public void run() {
try {
lock.lock();
for (;;);
} finally {
lock.unlock();
}
}
}
} 全部是死循环，相当于第一条线程（线程0）acquire成功之后，后两条线程（线程1、线程2）阻塞，下面的代码就不考虑后两条线程谁先谁后的问题，就一条线程（线程1）流程执行到底、另一条线程（线程2）流程执行到底这么分析了。
这里再把addWaiter和enq两个方法源码贴一下：
private Node addWaiter(Node mode) {
Node node = new Node(Thread.currentThread(), mode);
// Try the fast path of enq; backup to full enq on failure
Node prev = tail;
if (prev != null) {
node.prev = prev;
if (compareAndSetTail(prev, node)) {
prev.next = node;
return node;
}
}
enq(node);
return node;
}private Node enq(final Node node) {
for (;;) {
Node t = tail;
if (t == null) { // Must initialize
if (compareAndSetHead(new Node()))
tail = head;
} else {
node.prev = t;
if (compareAndSetTail(t, node)) {
t.next = node;
return t;
}
}
}
} 首先第一个acquire失败的线程1，由于此时整个数据结构中么没有任何数据，因此addWaiter方法第4行中拿到的prev=tail为空，执行enq方法，首先第3行获取tail，第4行判断到tail是null，因此头结点new一个Node出来通过CAS算法设置为数据结构的head，tail同样也是这个Node，此时数据结构为：
为了方便描述，prev和next，我给每个Node随便加了一个地址。接着继续enq，因为enq内是一个死循环，所以继续第3行获取tail，new了一个空的Node之后tail就有了，执行else判断，通过第8行~第10行代码将当前线程对应的Node追加到数据结构尾部，那么当前构建的数据结构为：
这样，线程1对应的Node被加入数据结构，成为数据结构的tail，而数据结构的head是一个什么都没有的空Node。
接着线程2也acquire失败了，线程2既然acquire失败，那也要准备被加入数据结构中，继续先执行addWaiter方法，由于此时已经有了tail，因此不需要执行enq方法，可以直接将当前Node添加到数据结构尾部，那么当前构建的数据结构为：
至此，两个阻塞的线程构建的三个Node已经全部归位。
实战举例：线程阻塞
上述流程只是描述了构建数据结构的过程，并没有描述线程1、线程2阻塞的流程，因此接着继续用实际例子看一下线程1、线程2如何阻塞。贴一下acquireQueued、shouldParkAfterFailedAcquire两个方法源码：
final boolean acquireQueued(final Node node, int arg) {
boolean failed = true;
try {
boolean interrupted = false;
for (;;) {
final Node p = node.prevecessor();
if (p == head && tryAcquire(arg)) {
setHead(node);
p.next = null; // help GC
failed = false;
return interrupted;
}
if (shouldParkAfterFailedAcquire(p, node) &&
parkAndCheckInterrupt())
interrupted = true;
}
} finally {
if (failed)
cancelAcquire(node);
}
}private static boolean shouldParkAfterFailedAcquire(Node prev, Node node) {
int ws = prev.waitStatus;
if (ws == Node.SIGNAL)
/*
* This node has already set status asking a release
* to signal it, so it can safely park.
*/
return true;
if (ws > 0) {
/*
* prevecessor was cancelled. Skip over prevecessors and
* indicate retry.
*/
do {
node.prev = prev = prev.prev;
} while (prev.waitStatus > 0);
prev.next = node;
} else {
/*
* 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.
*/
compareAndSetWaitStatus(prev, ws, Node.SIGNAL);
}
return false;
} 首先是线程1，它的前驱节点是head节点，在它tryAcquire成功的情况下，执行第8行~第11行的代码。做几件事情：
- head为线程1对应的Node
- 线程1对应的Node的thread置空
- 线程1对应的Node的prev置空
- 原head的next置空，这样原head中的prev、next、thread都为空，对象内没有引用指向其他地方，GC可以认为这个Node是垃圾，对这个Node进行回收，注释"Help GC"就是这个意思
- failed=false表示没有失败
因此，如果线程1执行tryAcquire成功，那么数据结构将变为：
从上述流程可以总结到：只有前驱节点为head的节点会尝试tryAcquire，其余都不会，结合后面的release选继承者的方式，保证了先acquire失败的线程会优先从阻塞状态中解除去重新acquire。这是一种公平的acquire方式，因为它遵循"先到先得"原则，但是我们可以动动手脚让这种公平变为非公平，比如ReentrantLock默认的非公平模式，这个留在后面说。
那如果线程1执行tryAcquire失败，那么要执行shouldParkAfterFailedAcquire方法了，shouldParkAfterFailedAcquire拿线程1的前驱节点也就是head节点的waitStatus做了一个判断，因为waitStatus=0，因此执行第18行~第20行的逻辑，将head的waitStatus设置为SIGNAL即-1，然后方法返回false，数据结构变为：
看到这里就一个变化：head的waitStatus从0变成了-1。既然shouldParkAfterFailedAcquire返回false，acquireQueued的第13行~第14行的判断自然不通过，继续走for(;;)循环，如果tryAcquire失败显然又来到了shouldParkAfterFailedAcquire方法，此时线程1对应的Node的前驱节点head节点的waitStatus已经变为了SIGNAL即-1，因此执行第4行~第8行的代码，直接返回true出去。
shouldParkAfterFailedAcquire返回true，parkAndCheckInterrupt直接调用LockSupport的park方法：
private final boolean parkAndCheckInterrupt() {
LockSupport.park(this);
return Thread.interrupted();
} 至此线程1阻塞，线程2阻塞的流程与线程1阻塞的流程相同，可以自己分析一下。
另外再提一个问题，不知道大家会不会想：
- 为什么线程1对应的Node构建完毕不直接调用LockSupport的park方法进行阻塞？
- 为什么不直接把head的waitStatus直接设置为Signal而要从0设置为Signal？
我认为这是AbstractQueuedSynchronizer开发人员做了类似自旋的操作。因为很多时候获取acquire进行操作的时间很短，阻塞会引起上下文的切换，而很短时间就从阻塞状态解除，这样相对会比较耗费性能。
因此我们看到线程1自构建完毕Node加入数据结构到阻塞，一共尝试了两次tryAcquire，如果其中有一次成功，那么线程1就没有必要被阻塞，提升了性能。
