理解同步器框架AbstractQueuedSynchronizer

一、背景

Java 在 1.5 版本引入了 java.util.concurrent包,用以支持并发编程,降低并发编程的复杂性;而其中大部分的同步器(例如 lock, barriers 等等)都是基于 AbstractQueuedSynchronizer 类,一般我们称为AQS。 java.util.concurrent.locks.AbstractQueuedSynchronizer 出自 Doug Lea 带佬,他的 个人博客 上有一篇相关论文 《The java.util.concurrent Synchronizer Framework》,在我们深入研究 AQS 之前,有必要拜读一下该论文,翻译见笔者的另一篇博客《The java.util.concurrent Synchronizer Framework》原文翻译 之后结合相关源码实现进行分析。

二、AQS概述

AQS 是 j.u.c 包中用来构建同步组件(例如 ReentrantLock、Semaphore)的基础框架。从实现上来看,AQS 提供了原子的同步状态管理、线程的阻塞及唤醒以及存储队列管理模型。基于 AQS 提供的强大功能,我们可以很简单的构建属于自己的同步器组件。同时,AQS 也提供了任务取消、阻塞超时以及conditionObject提供的管程风格的 await/signal/signalAll操作。并且根据所需策略的不同,AQS 还提供了公平/非公平、独占/共享 等特性。

三、同步器框架原理

AQS 框架用来实现加锁和解锁的核心是基于 acquire 和 release 方法,通过这两个方法,从而去进行原子操作修改同步器状态变量,从而实现对共享资源的并发访问。在 《The java.util.concurrent Synchronizer Framework》 原文中有提到 AQS 的这两个核心操作实现的伪代码:

acquire 操作如下:

while(synchronization state does not allow acquire) {
  enqueue current thread if not already queued;
  possibly block current thread;
}
dequeue current thread if it was queued;

简单翻译一下:

while(同步器状态获取失败) {
  if (当前线程未进入等待队列) {
    将当前线程入队;
  }
  可能尝试阻塞当前线程;
}
if (如果当前线程已经入队) {
  当前线程出队;
}

release 操作如下:

update synchronization state;
if(state may permit a blocked thread to acquire) 
  unblock one or more queued threads;

简单翻译一下:

更新同步器状态;
if (同步器状态可以允许一个阻塞线程获取) {
  解除一个或多个队列线程的阻塞状态;
}

可以看到 AQS 的核心思想是,如果请求资源空闲(即同步器状态修改成功),将共享资源设置为锁定状态;如果共享资源被占用(即同步器状态修改失败),就需要对当前线程进行入队操作,之后通过阻塞等待唤醒机制来保证锁的分配。这个队列机制主要是通过 CLH 队列的变体来实现的。我们会在下文中对 CLH 队列进行讲述。

3.1同步器状态

AQS 类内部定义了一个volatile修饰的 32 位 int 类型的 state 变量用于维护同步器的状态:

    /**
     * 同步状态值
     */
    private volatile int state;

    /**
     * 返回同步状态的当前值。
     * 该操作的内存语义为{@code volatile} 读。
     * @return 当前同步状态值
     */
    protected final int getState() {
        return state;
    }

    /**
     * 设置同步状态的值。
     * 该操作具有 {@code volatile} 写的内存语义。
     * @param newState 新状态值
     */
    protected final void setState(int newState) {
        state = newState;
    }

    /**
     * 如果当前状态值等于预期值,则自动将同步状态设置为
     * 给定的更新值。该操作具有 {@code volatile} 读写
     * 的内存语义。
     *
     * @param expect 期望值
     * @param update 新值
     * @return 如果成功,返回{@code true}. 返回 false 表示实际值
     *	       与期望值不相等。
     */
    protected final boolean compareAndSetState(int expect, int update) {
        // 见下面的内部设置来支持这一点
        return unsafe.compareAndSwapInt(this, stateOffset, expect, update);
    }

同步器的状态 state 在不同的实现中会有不同的作用和意义,需要结合具体的使用进行分析(比如说 ReentrantReadWriteLock 中 state 的前 16 位记录读锁的数量(共享),后 16 位记录写锁的数量(独占))。另外,我们可以看到,上面关于 state 的几个方法都是 final 修饰的,说明子类无法重写它们。我们可以通过修改 state 字段来表示同步状态加锁的过程。

3.2 CLH 队列

CLH队列:Craig、Landin and Hagersten队列,基础的 CLH 对列是一个单向链表,而 AQS 中是用的队列是 CLH 队列的变体——虚拟双向队列(FIFO),因此,该框架是不支持基于优先级的同步。使用同步队列的原因是,它是一种不需要使用低级锁来构造非阻塞数据结构。

CLH 队列实际上并不是很像队列,因为它的入队和出队操作都与其用途(作为锁)紧密相关。他通过两个字段 tail 和 head 来存取,同时这两个字段支持原子更新,两者在初始化时都指向的空节点。

当一个新节点通过原子操作入队:

do {
  pred = tail;
} while (!tail.compareAndSet(pred, node));

同时, 每个节点的 release 状态都保存在其前驱结点中。因此,当前节点可以通过自旋,直到前驱节点释放锁(但是,从实际上来看,过度的自旋会带来大量的 CPU 性能损耗):

while (pred.status != RELEASED); // spin

自旋后的出队操作只需将 head 字段指向刚刚得到锁的节点:

head = node

CLH 的优点是:它的入队和出队操作是快速的、无锁的、无阻塞的(即使在竞争的情况下,也只会有一个线程赢得插入的机会,从而能进行下去)。检测是否有线程在等待也很快(只需要检测 head 和 tail 是否相等);同时,release 是分散的,避免了一些不必要的内存竞争。

AQS中的等待队列是 CLH 锁队列的变体。CLH 锁通常用于自旋锁。但是在 AQS 中将其作为阻塞同步器,但是根据其基本思想,即在其节点的前驱节点中保存有关线程的控制信息。每个节点的“状态”字段跟踪线程是否应该阻塞。节点在其前驱节点释放时发出 signal 。否则,队列中的每个节点都是持有单个线程的特定通知器。状态字段不用于控制线程是否持有锁。同时,线程可能会尝试获取队列中的第一个节点,但其并不保证一定成功,所以当前释放的竞争线程可能会重新被阻塞(如果没有获取到锁)。

AQS使用的 CLH 变体中的 "prev" 连接(指向前驱节点)主要用于处理取消。如果一个节点被取消,它的后继节点(通常)需要重新连接到一个未取消的前驱节点。

AQS 使用 CLH 的 "next" 连接(指向后继节点)来实现阻塞机制。每个节点的线程 id 保存在自身中,因此前驱节点通过遍历 next 连接来确定它是哪个线程来通知下一个节点的唤醒。设置当前节点的 next (后继节点)时,必须避免与新入队的节点竞争。当节点的后继节点为空时,通过从队列的 tail 向后检查来解决这个问题。("next" 本来就是一种优化,通常情况下是不需要向后扫描的。)

CLH 队列需要一个虚拟头节点。但是我们不会在构建时创建它们,因为如果从不存在竞争,那将是浪费精力。相反,在第一次出现竞争时构造节点并设置 head 和 tail 指针。

Condition 等待队列中的阻塞线程使用的是相同的 Node 结构,但是提供了另一个链表来存放,因此 Condition 等待队列的实现会更加复杂。

关于 CLH 队列的实现如下:

    static final class Node {
        /** 标记节点处于共享模式下的等待 */
        static final Node SHARED = new Node();
        /** 标记节点处于独占模式下的等待 */
        static final Node EXCLUSIVE = null;

        /** waitStatus 值,表示线程已经取消 */
        static final int CANCELLED =  1;
        /** waitStatus 值,表示后继线程需要唤醒 */
        static final int SIGNAL    = -1;
        /** waitStatus 值,表示线程需要等待条件 */
        static final int CONDITION = -2;
        /**
         * waitStatus 值,指示下一个 acquireShared 应该无条件传播
         */
        static final int PROPAGATE = -3;

        /**
         * Status 字段, 仅取以下值:
         *   SIGNAL:     该节点的后继节点被(或即将)阻塞(通过 park),因此当前
         *               节点在释放或取消时必须解除其后继节点的 park。为了避免
         *               竞争,acquire 方法必须首先表明它们需要 signal,然后重试
         *               原子获取,然后在失败时阻塞。
         *   CANCELLED:  由于超时或中断,该节点被取消。节点永远不会离开这个状态。
         *				 特别的是,被取消的节点的线程永远不会再次阻塞。
         *   CONDITION:  此节点当前位于条件队列中。在转换之前不会用作同步队列节点,
         *               此时状态将设置为 0。(此处使用此值与该字段的其他用途无关,但简化的机制)
         *   PROPAGATE:  releaseShared 应该传播到其他节点。这是在 doReleaseShared 中设置 
         *               的(仅针对头结点),以确保传播继续进行,即使其他操作已经介入。
         *   0:          以上都不是
         *
         * 这些值按数字排列以简化使用。非负值意味着节点不需要发出 signal。
         * 因此,大多数代码不需要检查特定值,只需检查 sign 即可。
         *
         * 对于正常同步节点,该字段初始化为 0,对于 CONDITION 节点,该字段初始化为 CONDITION。
         * 它使用 CAS 进行修改(或者在可能的情况下,无条件的 volatile 写入)
         */
        volatile int waitStatus;

        /**
         * 链接到当前节点/线程的前驱节点,用于检查 waitStatus。在入队时分配,
         * 并且仅在出队时设置为 null(为了 GC)。此外,在前驱节点取消时,我们短路,同时
         * 找到一个未取消的前驱节点(该前驱节点不会不存在),因为头结点不会被取消:一个节点
         * 只有在 acquire 成功时才会成为头结点。被取消的线程永远不会获取成功,同时
         * 一个线程只能取消自己,无法取消任何其他节点。
         */
        volatile Node prev;

        /**
         * 链接到当前节点/线程的后继节点,用于在 release 时 unpark 操作。在入队时分配,
         * 前驱节点取消时,会进行绕过调整,在出队时清空(为了 GC)。enq 操作在建立链接之前
         * 不会给前驱节点的 next 字段赋值,因此看到 next 字段为 null,并不一定意味着该节点在
         * 队尾。然而,如果 next 字段看起来是 null,我们可以从 tail 扫描 prev 节点,从而
         * 进行双重检查。取消的节点的 next 字段被设置为指向节点自身,而不是 null,
         * 从而使 isOnSyncQueue 的工作更容易。
         */
        volatile Node next;

        /**
         * 将 thread 放入当前节点。构造时初始化,使用后清空。
         */
        volatile Thread thread;

        /**
         * 链接到等待条件的下一个节点,或特定的 SHARED 值。因为条件队列只有在
         * 独占模式下被访问,所以我们只需要一个简单的链接队列来保存等待条件的节点。
         * 然后,它们被转移到队列中进行重新 acquire。因为条件只能是独占的,所以
         * 我们通过使用特殊值来保存特殊值,以表示共享模式。
         */
        Node nextWaiter;

        /**
         * 如果节点在共享模式下等待,则返回true。
         */
        final boolean isShared() {
            return nextWaiter == SHARED;
        }

        /**
         * 返回上一个节点,如果为空则抛出NullPointerException。
         * 当前驱节点不能为空时使用。null 检查可以省略,但它的存在是为了帮助 VM。
         *
         * @return 当前节点的前驱节点
         */
        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;
        }
    }

    /**
     * 等待队列的头部,延迟初始化。除此之外,只能通过 setHead 方法进行修改,
     * 注意:如果 head 存在,它的 waitStatus 保证不会被 CANCELLED。
     */
    private transient volatile Node head;

  /**
   * 等待队列的尾部,延迟初始化。仅通过方法 enq 修改以添加新的等待节点。
   */
  private transient volatile Node tail;

  /**
   * 设置以用于支持 compareAndSet. 我们需要在这里本地实现这一点:
   * 为了允许未来的功能增强,我们不能显式地继承 AtomicInteger,不然这将是高效和有用的。
   * 因此,作为少有的弊端,我们本地使用 hotspot 内在的 API 实现。但我们这样做的时候,
   * 我们队其他 CASable 字段做同样的事情(否则可以用原子字段更新器来完成)。
   */
    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;

    static {
        try {
            stateOffset = unsafe.objectFieldOffset
                (class.getDeclaredField("state"));
            headOffset = unsafe.objectFieldOffset
                (class.getDeclaredField("head"));
            tailOffset = unsafe.objectFieldOffset
                (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);
    }

下面介绍一下 Node 类中的几个属性:

  • waitStatus:当前 Node 的等待状态,共有五个可选值:
    • 0:初始值,当前节点如果没有指定初始值,则默认为 0。
    • CANCELLED(1):表示当前节点因为超时或线程中断被取消。当节点被取消后,不会再转换为其他状态,被取消的节点的线程实例也不会阻塞。
    • SIGNAL(-1):表示当前节点的后继节点通过 park() 被阻塞,当前节点释放或取消时,必须 unpark() 它的后继节点。
    • CONDITION(2):表示当前节点是条件队列中的一个节点,当它转换为同步队列中节点时,waitStatus 会被重新设置为 0。
    • PROPAGATE(3):当节点为头结点,调用 doReleaseShared() 时,确保 releaseShared() 可以传播到其他节点。
  • prev:当前节点的前驱节点,用于检查 waitStatus。当前驱节点被取消时,通过 prev 找到一个未取消的前驱节点。
  • next:当前节点的后继节点,当节点被取消或释放时,用于 unpark 取消后继节点的阻塞(会自动绕过取消的后继节点)。
  • thread:当前节点持有的线程实例引用。
  • nextWaiter:下一个等待节点,可能的取值有下面的几种情况:
    • 当前实例为独占模式时,取值为 Node.EXCLUSIVE (即 null)。
    • 当前实例为共享模式时,取值为 Node.SHARED。
    • 非上面两种情况时,代表条件队列中当前节点的下一个等待节点。

3.3 阻塞

在 JDK1.5 之前,线程的阻塞和唤醒只能依赖于 Object 类提供的 wait() 、notify()、notifyAll() 方法,它们都是由 JVM
提供实现,并且使用的时候需要获取监视器锁(即需要在 synchronized 代码块中),没有 Java API 可以阻塞和唤醒线程。唯一可以选择的是 Thread.suspend 和 Thread.resume
,但是他们都有无法解决的竟态问题:当一个非阻塞线程在一个正准备阻塞的线程调用 suspend 之前调用 resume,resume操作将不起作用。

j.u.c 包引入了 LockSupport 类,其底层是基于 Unsafe 类的 park() 和 unpark() 方法,LockSupport.park
阻塞当前线程,除非或直到发出 LockSupport.unpark(虚假唤醒是允许的)。park 方法同样支持可选的相对或绝对的超时设置,以及与
JVM 的 Thread.interrupt 结合 —— 可通过中断来 unpark 一个线程。

3.4 条件队列

在 AQS 中除了同步队列外,还提供了另一种更为复杂的条件队列,而条件队列是基于 Condition接口实现的,下面我们先浏览一下 Condition 接口的说明。

3.4.1 Condition 接口

Condition 将 Object 的监视器方法(wait、notify 和 notifyAll) 分解到不同的对象,通过将它们与任意的 Lock
实现相结合,可以使每个对象具有多个等待集合。Lock 代替的 synchronized 方法和语句的使用,Condition 代替了 Object
监视器方法的使用。

Condition(也称为 条件队列(condition queue) 或 条件变量(condition variable))为线程提供了一种暂停执行(“等待”)的方法,直到另外一个线程通知说某个状态条件现在可能为 true
。由于对这种共享状态信息的访问会发生在多个不同线程中,所以它必须受到保护,因此需要某种形式的锁与条件相关联。等待条件提供的关键属性是它以 *
原子* 方式释放关联的锁并挂起当前线程,就像 Object.wait 一样。

Condition 实例本质上是需要绑定到锁。需要获取特定 Lock 实例的 Condition 实例,请使用其 newCondition() 方法。

例如,假设我们有一个支持 put 和 take 方法的有界缓冲区。如果 take 在空缓冲区上尝试获取,则线程将阻塞,知道缓冲区变得可用;如果在一个满的缓冲区上调用 put,则线程将阻塞,直到有空间可用。我们希望
put 线程继续等待,并且与 take线程隔开在另一个等待集合中,以便当我们的缓冲区可用或有空间发生变化时通知对应的单个线程。这可以使用量 Condition 实例来实现。

class BoundedBuffer {
    final Lock lock = new ReentrantLock();
    final Condition notFull = lock.newCondition();
    final Condition notEmpty = lock.newCondition();
    
    final Object[] items = new Object[100];
    int putptr, takeptr, count;
    
    public void put(Object x) throws InterruptedException {
        lock.lock();
        try {
            while (count == items.length) 
                notFull.await();
            items[putptr] = x;
            if (++putptr == items.length) putptr = 0;
            ++count;
            notEmpty.signal();
        } finally {
            lock.unlock();
        }
    }
    
    public Object take() throws InterrputedException {
        lock.lock();
        try {
            while (count == 0) 
                notEmpty.await();
            Object x = items[takeptr];
            if (++takeptr == items.length) takeptr = 0;
            --count;
            notFull.signal();
            return x;
        } finally {
            lock.unlock;
        }
    }
}

(java.util.concurrent.ArrayBlockingQueue 类提供了这个功能,所以没有理由使用这个实例类。)

Condition 的实现可以提供与 object 监视器方法不同的行为和语义,例如保证通知的顺序,或者在执行通知时不需要持有锁。如果实现提供了这种专门的语义,那么实现必须记录这些语义。

请注意,Condition 实例只是普通对象,它们本身可以用作 synchronized 语句中的目标,并且可以调用它们自己的监视器 wait 和 notification 方法。获取 Condition 实例的监视器锁,或使用其监视器方法,与获取和该 Condition 关联的 Lock 或使用其 wait() 和 signal() 方法没有指定关系。为避免混淆,建议不要以这种方式使用 Condition 实例,除非在它们自己的实现中。

除非另有说明,否则为任何参数传递 null 值将导致 NullPointerException。

实现注意事项:

在等待 Condition 时,通常允许发生 ”虚假唤醒“
,作为对底层平台语义的让步。这对大多数应用程序几乎没有实际影响,因为应该始终在循环中等待 Condition
,测试正在等待的状态谓词是否为 true。一个实现可以自由地消除虚假唤醒的可能性,但建议应用程序的程序员总是假设它们可以发生,因此总是在循环中等待条件唤醒。

条件等待的三种形式(可中断、不可中断和定时)在某些平台上实现的难易程度和性能特征可能不同。特别是,可能难以提供这些功能并维护特定的语义,例如排序保证。此外,中断线程的实际挂起能力可能并不总是适用所有平台。

因次,实现不需要为所有三种等待形式定义完全相同的保证或语义,也不需要支持线程实际挂起的中断。

实现需要清楚地记录每个等待方法提供的语义和保证,并且当实现确实支持线程挂起的中断时,它必须遵守此接口中定义的中断语义。

由于中断通常意味着取消,并且对中断的检查通常不常见,因此实现可以倾向于响应中断而不是正常的方法返回。即使可以证明中断发生在另一个可能已经解除阻塞线程的操作之后也是如此。一个实现应该记录这个行为。

public interface Condition {

  /**
   * 使当前线程等待,直到它被 signal 或中断。
   *
   * 直到以下四种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程
   * 由于线程调度会被禁用并处于休眠状态:
   * - 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
   * - 其他一些线程为此 Condition 调用了 signalAll() 方法;
   * - 其他一些线程中断当前线程,支持中断线程挂起;
   * - 发生“虚假唤醒”。
   *
   * 在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。
   * 当前线程返回时,它保证持有这个锁。
   *
   * 如果当前线程:
   * - 在进入此方法时设置其中断状态;或者,
   * - 等待过程中被中断,支持线程挂起的中断。
   *
   * 然后抛出 InterruptedException 并清除当前线程的中断状态。在第一种情况下,没有规定是否
   * 在释放锁之前进行中断判断。
   *
   * 实现注意事项:
   *
   * 调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,
   * 如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且
   * 实现必须记录该事实。
   *
   * 与响应 signal 的正常方法返回相比,实现更倾向于响应中断。在这种情况下,实现必须确保将
   * 信号量重定向到另一个等待线程(如果有的话)。
   *
   * @throws InterruptedException - 如果当前线程被中断(并且支持线程挂起的中断)
   */
  void await() throws InterruptedException;

  /**
   * 使当前线程等待,直到它被 signal。
   *
   * 直到以下三种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程
   * 由于线程调度会被禁用并处于休眠状态:
   * - 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
   * - 其他一些线程为此 Condition 调用了 signalAll() 方法;
   * - 发生“虚假唤醒”。
   *
   * 在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。
   * 当前线程返回时,它保证持有这个锁。
   *
   * 如果当现场进入该方法时设置了中断状态,或者在等待过程中被中断,则继续等待直到被 signal 唤醒。
   * 当它最终从这个方法返回时,它的中断状态会依旧存在。
   *
   *
   * 实现注意事项:
   *
   * 调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,
   * 如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且
   * 实现必须记录该事实。
   *
   */
  void awaitUninterruptibly();

  /**
   * 使当前线程等待,直到它被 signal 或 中断,或者达到指定的等待时间。
   *
   * 直到以下五种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程
   * 由于线程调度会被禁用并处于休眠状态:
   * - 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
   * - 其他一些线程为此 Condition 调用了 signalAll() 方法;
   * - 其他一些线程中断当前线程,支持中断线程挂起;
   * - 到达指定的等待时间;
   * - 发生“虚假唤醒”。
   *
   * 在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。
   * 当前线程返回时,它保证持有这个锁。
   *
   * 如果当前线程:
   * - 在进入此方法时设置其中断状态;或者,
   * - 等待过程中被中断,支持线程挂起的中断。
   *
   * 然后抛出 InterruptedException 并清除当前线程的中断状态。在第一种情况下,没有规定是否
   * 在释放锁之前进行中断判断。
   *
   * 在返回时提供给定的 nanosTimeout 值,该方法返回对剩余等待纳秒数的预估,如果超时,则返回
   * 小于或等于零的值。在等待返回但是等待的条件仍不成立的情况下,此值可用于确定是否重新等待以及
   * 重新等待多长时间。此方法的典型用途如以下形式:
   *
   * 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();
   *     }
   * }
   *
   * 设计说明:此方法需要纳秒参数,以避免报告剩余时间时出现截断错误。这种精度损失将使程序员
   * 难以确保总等待时间不会系统地短于重新等待发生时指定的时间。
   *
   * 实现注意事项:
   *
   * 调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,
   * 如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且
   * 实现必须记录该事实。
   *
   * 与响应 signal 的正常方法返回相比,实现更倾向于响应中断。在这种情况下,实现必须确保将
   * 信号量重定向到另一个等待线程(如果有的话)。
   *
   * 参数: nanosTimeout - 等待的最长时间,以纳秒为单位。
   * 返回: nanosTimeout值减去从该方法返回时等待的时间的估计值。正值表示可以用作对该方法的
   *       后续调用以完成等待所需时间的参数。小于或等于零表示没有剩余的时间。
   * @throws InterruptedException - 如果当前线程被中断(并且支持线程挂起的中断)
   */
  long awaitNanos(long nanosTimeout) throws InterruptedException;

  /**
   * 使当前线程等待,直到它被 signal 或 中断,或者达到指定的等待时间。此方法在行为上等效于:
   *     awaitNanos(unit.toNanos(time)) > 0 
   *
   * 参数: time - 等待的最长时间
   *       unit - time 参数的时间单位
   * 返回: 如果从方法返回之前已经到达指定时间,则为 false,否则为 true。
   * @throws InterruptedException - 如果当前线程被中断(并且支持线程挂起的中断)
   */
  boolean await(long time, TimeUnit unit) throws InterruptedException;

  /**
   * 使当前线程等待,直到它被 signal 或 中断,或者达到指定的等待时间。
   *
   * 直到以下五种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程
   * 由于线程调度会被禁用并处于休眠状态:
   * - 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
   * - 其他一些线程为此 Condition 调用了 signalAll() 方法;
   * - 其他一些线程中断当前线程,支持中断线程挂起;
   * - 到达指定的等待时间;
   * - 发生“虚假唤醒”。
   *
   * 在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。
   * 当前线程返回时,它保证持有这个锁。
   *
   * 如果当前线程:
   * - 在进入此方法时设置其中断状态;或者,
   * - 等待过程中被中断,支持线程挂起的中断。
   *
   * 然后抛出 InterruptedException 并清除当前线程的中断状态。在第一种情况下,没有规定是否
   * 在释放锁之前进行中断判断。
   *
   * 返回值表示是否已经过了 deadline,可以如下使用:
   *
   * 实现注意事项:
   *
   * 调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,
   * 如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且
   * 实现必须记录该事实。
   *
   * 与响应 signal 的正常方法返回相比,实现更倾向于响应中断。在这种情况下,实现必须确保将
   * 信号量重定向到另一个等待线程(如果有的话)。
   * boolean aMethod(Date deadline) {
   *     boolean stillWaiting = true;
   *     lock.lock();
   *     try {
   *         while(!conditionBeingWaitedFor()) {
   *             if (!stillWaiting)
   *                 return false;
   *             stillWaiting = theCondition.awaitUntil(deadline);
   *         }
   *         // ...
   *     } finally {
   *         lock.unlock();
   *     }
   * }
   *
   * 参数: deadline - 等待的绝对时间。
   * 返回: 如果返回时已经超过最后期限,则为 false,否则为 true。
   * @throws InterruptedException - 如果当前线程被中断(并且支持线程挂起的中断)
   */
  boolean awaitUntil(Date deadline) throws InterruptedException;

  /**
   * 唤醒一个等待线程。
   *
   * 如果有任何线程在此 Condition 下等待,则选择一个用于唤醒。然后,该线程必须在从
   * await 返回之前重新获取锁。
   *
   * 实现注意事项
   *
   * 在调用此方法时,实现可能(并且通常确实)要求当前线程持有与此 Condition 关联的锁。
   * 实现必须记录此前提条件以及未持有锁时采取的任何操作。通常,会抛出 IllegalMonitorStateException。
   */
  void signal();

  /**
   * 唤醒所有等待线程。
   *
   * 如果有任何线程在此 Condition 下等待,则它们全部都会被唤醒。然后,每个线程必须在从
   * await 返回之前重新获取锁。
   *
   * 实现注意事项
   *
   * 在调用此方法时,实现可能(并且通常确实)要求当前线程持有与此 Condition 关联的锁。
   * 实现必须记录此前提条件以及未持有锁时采取的任何操作。通常,会抛出 IllegalMonitorStateException。
   */
  void signalAll();
}

Condition 接口提供了与 JAVA 原生的监视器相同风格的 API,但是其并不依赖于 JVM 的实现,用户可以自定义实现 Condition
接口,提供更加强大和更加灵活的功能,Condition 在说明中建议和 Lock
共同使用,可以使每个对象具有多个等待集合,我们下面了解一下 Lock 接口 。

3.4.2 Lock 接口

与使用 synchronized 方法和语句相比,Lock
实现提供了更广泛的锁定操作。它们允许更灵活的结构,可能具有完全不同的属性,并且可能支持多个关联的 Condition 对象。

Lock 是一种控制多线程访问共享资源的工具。通常,Lock
提供对共享资源的独占访问:一次只有一个线程可以获得锁,并且堆共享资源的所有访问都需要首先获取锁。但是,某些锁可能允许并发访问共享资源,例如 ReadWriteLock
的读锁。

synchronized 方法或语句的使用提供了对于每个对象关键的隐式监视器锁的访问,但强制所有锁的获取和释放必须在块结构内发生:当获取多个锁时,它们必须以相反的顺序释放,并且所有锁必须在获得它们的相同词法范围内释放。

虽然 synchronized
方法和语句的作用域机制让使用监视器锁编程变得更加容易,并且有助于避免许多设计锁的常见编程错误,但在某些情况下,您需要以更加灵活的方式使用锁。例如,一些遍历并发访问的数据结构的算法需要使用 hand-over-hand
或 chain locking:你获取节点 A 的锁,然后获取节点 B 的锁,然后释放 A 并获取 C,然后释放 B 并获取 D 等等。Lock
接口的实现通过允许在不同范围内获取和释放锁以及允许以任意顺序获取和释放多个锁,来启用此类技术。

随着这种灵活性的增加,额外的责任也随之而来。块结构锁定的缺失消除了 synchronized 方法和语句发生的锁定和自动释放。在大多数情况下,应使用以下语句:

Lock l=...;
l.lock();
try{
    // access the resource protected by this lock
}finally{
    l.unlock;
}

当锁定和解锁发生在不同范围内时,必须注意确保所有在持有锁时执行的代码都受到 try-finally 或 try-catch 的保护,以确保在必要时释放锁。

Lock 实现通过提供非阻塞获取锁定方式(tryLock())、获取可中断锁的尝试(lockInterruptibly()
,以及获取锁的尝试)、还提供了超过使用 synchronized 方法和语句的附加功能 —— 可以超时(tryLock(long, Timeunit))。

Lock 类还可以提供与隐式监视器锁完全不同的行为和语义,例如保证排序、不可重入使用或死锁检测。如果实现提供了这种专门的语义,那么实现必须用文档记录这些语义。

请注意,Lock 实例只是普通对象,它们本身可以用作 synchronized 语句中的目标。获取 Lock
实例的监视器锁与调用该实例的任何 lock()
方法没有指定关系。建议为避免混淆,除非在它们自己的实现中,否则不要以这种方式使用 Lock 实例。

除非另有说明,否则任何参数传递 null 将导致 NullPointerException。

内存同步:

所有 Lock 实现必须
强制执行与内置监视器锁提供的相同的内存同步语义。如 《The Java Language Specification (17.4 Memory Model) 》
中所述:

  • 成功的 Lock 动作与成功的 lock() 操作具有相同的内存同步效果。
  • 成功的 Unlock 动作与成功的 unlock() 操作具有相同的内存同步效果。

不成功的 lock 和 unlock 操作,以及重入 lock/unlock 操作,不需要任何内存同步效果。

实现注意事项:

三种形式的锁获取(可中断、不可中断和超时)可能在它们的性能特征、顺序保证或其他实现质量方面有所不同。此外,中断 正在进行
的锁获取的能力在给定的 Lock
类中可能不可用。因此,实现不需要为所有的三种形式的锁获取给定完全相同的保证或语义,也不需要支持正在进行的锁获取的中断。实现需要清楚地记录每个锁定方法提供的语义和保证。它们必须遵守此接口中定义的中断语义,一直吃获取锁的中断:完全或仅在方法入口上。

由于中断通常意味着取消,并且对中断的检查通常不常见,因此实现可以倾向于响应中断而不是正常的方法返回。即使可以证明在另一个操作可能已解除阻塞线程之后发生中断也是如此。实现应该用文档记录这个行为。

public interface Lock {

  /**
   * 获取锁。
   *
   * 如果锁不可用,则当前线程处于线程调度的目的,将被禁用并处于休眠状态,直到获得锁为止。
   *
   * 实现注意事项
   *
   * Lock 实现可能能够检测到锁的错误使用,例如会导致死锁的调用,并且在这种情况下可能会抛出
   * (未经检查)的异常。该 Lock 实现必须描述和记录情况以及异常类型。
   */
  void lock();

  /**
   * 除非当前线程被中断,否则获取锁。
   *
   * 如果可用,则获取锁并立即返回。
   *
   * 如果锁不可用,则当前线程处于线程调度的目的,将被禁用并处于休眠状态,直到发生以下两种情况之一:
   * - 锁被当前线程获取;
   * - 其他一些线程中断当前线程,当前线程支持获取锁的中断。
   *
   * 如果当前线程:
   * - 在进入此方法时设置其中断状态;
   * - 获取锁时中断,并支持获取锁中断。
   *
   * 然后会抛出 InterruptedException 并清除当前线程的中断状态。
   *
   *
   * 实现注意事项
   *
   * 在某些实现中中断锁获取的能力可能是无法实现的,并且如果可能的话会是一个非常昂贵的操作。
   * 程序员应该意识到可能是这种情况,并详细记录和描述这种情况。。
   *
   * 与正常方法返回相比,实现更倾向于响应中断。
   *
   * Lock 实现可能能够检测到锁的错误使用,例如会导致死锁的调用,并且在这种情况下可能会抛出
   * (未经检查的)异常。该 Lock 实现必须详细记录情况和异常类型。
   *
   * @throws InterruptedException - 如果当前线程在获取锁时被中断(并且支持获取锁的中断)
   */
  void lockInterruptibly() throws InterruptedException;

  /**
   * 仅当调用时是空闲的,才获取到锁。
   *
   * 如果锁可用,则获取锁并立即返回 true。如果锁不可用,则此方法立即返回 false。
   *
   * 该方法的典型用法是:
   *
   * Lock lock = ...;
   * if (lock.tryLock()) {
   *     try {
   *         // manipulate protected state
   *     } finally {
   *         lock.unlock();
   *     }
   * } else {
   *     // perform alternative actions
   * }
   *
   * 这种方法确保锁在获得的情况下才解锁,并且在未获得的时候不进行解锁操作。
   *
   * 返回: 如果获得了锁返回 true,否则为 false。
   */
  boolean tryLock();

  /**
   * 如果在给定的等待时间内锁空闲并且当前线程没有被中断,则获取锁。
   *
   * 如果锁可用,则获取锁并立即返回 true。如果锁不可用,则当前线程处于线程调度的目的,
   * 将被禁用并处于休眠状态,直到发生以下三种情况之一:
   * - 锁被当前线程获取;
   * - 其他一些线程中断当前线程,当前线程支持获取锁的中断;
   * - 指定的等待时间已过。
   *
   * 如果获得锁,则返回 true。
   *
   * 如果当前线程:
   * - 在进入此方法时设置其为中断状态;或
   * - 获取锁时中断,并支持获取锁中断。
   *
   * 然后会抛出 InterruptedException 并清除当前线程的中断状态。
   *
   * 如果经过了指定的等待时间,则返回 false。如果时间小于或等于 0,则该方法不会等待。
   *
   * 实现注意事项
   *
   * 在某些实现中中断锁获取的能力可能是无法实现的,并且如果可能的话会是一个非常昂贵的操作。
   * 程序员应该意识到可能是这种情况,并详细记录和描述这种情况。。
   *
   * 与正常方法返回相比,实现更倾向于响应中断。
   *
   * Lock 实现可能能够检测到锁的错误使用,例如会导致死锁的调用,并且在这种情况下可能会抛出
   * (未经检查的)异常。该 Lock 实现必须详细记录情况和异常类型。
   *
   * 参数: time - 等待锁的最长时间
   *       unit - time 参数的时间单位
   * 返回: 如果获得了锁,返回 true;如果在获得锁之前超过了等待时间,返回 false
   * @throws InterruptedException - 如果当前线程在获取锁时被中断(并且支持获取锁的中断)
   */
  boolean tryLock(long time, TimeUnit unit) throws InterruptedException;

  /**
   * 释放锁。
   *
   * 实现注意事项
   *
   * Lock 实现通常会对哪个线程可以释放锁施加限制(通常只有锁的持有者可以释放它),
   * 并且如果违反限制可能会抛出(未经检查的)异常。该 Lock 实现必须详细记录情况和异常类型。
   */
  void unlock();

  /**
   * 返回绑定到此 Lock 实例的新 Condition 实例。
   *
   * 在等待条件之前,锁必须由当前线程持有。调用 Condition.await() 将在等待之前自动释放
   * 锁,并在等待返回之前重新获取锁。
   *
   * 实现注意事项
   *
   * Condition 实例的确切操作取决于 Lock 实现,并且必须由该实现描述。
   *
   *
   * 返回:此 Lock 实例的新 Condition 实例
   * @throws UnsupportedOperationException - 如果 Lock 实现不支持 Condition
   */
  Condition newCondition();
}

四、AQS 的独占与共享

在 AQS 的设计中,为我们保留的扩展的能力,我们可以使用 ConditionObject 和 AQS
去实现共享资源的独占和共享,就和 ReadWriteLock 一样,下面我们根据 AQS 的源码来解析这两种模式是如何实现的。

4.1 独占模式

独占模式:意味着同一时刻,共享资源只有唯一的单个节点可以获取访问,此时获取到锁的节点的线程是独享的,获取到锁的线程也就从阻塞状态可以继续运行,而同步队列的其他节点则需要继续阻塞。

独占模式的实现主要由 AQS 在初始化时, status 值来确定允许申请资源的数量上限,而对共享资源的获取和释放主要由以下方法进行操作:

  • acquire(int) :获取 int 数量的资源,也就是原子修改 status。
  • acquireInterruptibly(int):获取 int 数量的资源,可以响应线程中断。
  • tryAcquireNanos(int, long) :在指定 long 时间内,获取 int 数量的资源。
  • release(int) :释放 int 数量的资源。

4.1.1 acquire

下面我们根据源码,了解一下独占模式是如何运行的,首先是 acquire:

/**
 * 以独占模式获取锁,忽略中断。  通过调用至少一次 tryAcquire() 方法来实现,成功就返回。
 * 否则线程排队,调用 tryAcquire() 成功之前,可能重复阻塞和解除阻塞。此方法可用于实现
 * Lock.lock()。
 *
 * 参数:arg - acquire 参数。这个值被传递给 tryAcquire,你可以用此代表你喜欢的任何东西。
 */
public final void acquire(int arg){
    // 只有当加锁成功或以独占类型节点入队(同步队列,非条件队列)成功时返回,
    if(!tryAcquire(arg) &&
       // 加锁失败,则进行入队操作
       acquireQueued(addWaiter(Node.EXCLUSIVE), arg))
         // 加锁失败,入队失败,则中断线程
         selfInterrupt();
}

/**
 * 尝试以独占模式 acquire。此方法应查询对象的状态,判断是否允许以独占模式获取它。
 *
 * 此方法始终由执行 acquire 的线程调用。如果此方法报告失败,且该线程尚未入队,
 * 则 acquire 方法可以将该线程排队,知道某个其他线程 release 并 signal。这
 * 可用于实现 Lock.tryLock 方法。
 *
 * 默认实现抛出 UnsupportedOperationException 。
 *
 * 参数:arg - acquire 参数.。该值始终是传递给 acquire 方法的值,或者是在进入条件等待时
 保存的值。该值可以表示你喜欢的任何东西。
 * 返回:如果成功,返回 true。成功后,该对象已 acquire。
 * @throws IllegalMonitorStateException  如果获取会将此同步器置于非法状态。
 *                                       必须以一致的方式抛出此异常,同步才能正常工作。
 * @throws UnsupportedOperationException 如果不支持独占模式
 */
protected boolean tryAcquire(int arg){
    throw new UnsupportedOperationException();
}


/**
 * 为当前线程和给定模式创建节点并入队节点。
 *
 * 参数:mode - Node.EXCLUSIVE 用于独占,Node.SHARED 用于共享
 * 返回:新节点
 */
private Node addWaiter(Node mode){
    // 创建当前线程和模式的新节点,此时 waitStatus 为 0
    Node node = new Node(Thread.currentThread(), mode);
    // 先尝试直接入队,当且仅当 tail 不为空时,直接将当前节点追加到 tail 后面
    Node pred = tail;
    if(pred != null){
        // 当前节点的前驱节点为 pred
        node.prev = pred;
        // 原子修改 tail 为当前节点
        if(compareAndSetTail(pred, node)){
            // pred 的后继节点指向当前节点
            pred.next = node;
            return node;
        }
    }
    // tail 为空,或入队失败,则进行自旋 enq 入队
    enq(node);
    return node;
}

/**
 * 将节点插入队列,必要时进行初始化。
 * 参数: node - 插入的节点
 * 返回: 节点的前驱节点
 */
private Node enq(final Node node){
    // 自旋进行插入操作
    for(;;){
        // 获取队列的 tail
        Node t = tail;
        // t 为空,说明队尾没有节点,说明还没有初始化
        if(t == null){ // Must initialize
            // 初始化操作,创建 head 节点
            if(compareAndSetHead(new Node()))
                // 将 tail 也指向 head
            tail = head;
        } else {
            // 将队尾指向当前节点的前驱节点
            node.prev = t;
            // 设置当前节点为队尾
            if(compareAndSetTail(t, node)){
                // 设置 t 的后继节点为当前节点
                t.next = node;
                return t;
            }
        }
    }
}


/**
 * 以独占模式且不中断,acquire 队列中的线程。由 condition 的 wait 和 acquire 方法使用。
 *
 * 参数:node - 节点
 *      arg - acquire 参数
 * 返回:如果在等待时被中断,返回 true
 */
final boolean acquireQueued(final Node node,int arg){
    // acquire 是否失败
    boolean failed = true;
    try {
        // 是否中断
        boolean interrupted = false;
        // 自旋尝试获取资源,每次自旋都会调用 tryAcquire 尝试获取资源,获取资源失败,则进入阻塞状态
        // 成功则跳出自旋
        for(;;){
            // 当前新入队节点的前驱节点
            final Node p = node.predecessor();
            // 前驱节点为头节点时,尝试获取资源。
            if(p == head && tryAcquire(arg)){
                // 获取资源成功,将当前节点设置为头结点
                setHead(node);
                // 断开前一个节点的链接,帮助 GC
                p.next = null; // help GC
                // 获取成功
                failed = false;
                // 返回是否中断
                return interrupted;
            }
            // 判断在 acquire 失败后是否需要阻塞当前节点中的线程
            if(shouldParkAfterFailedAcquire(p,node)&&
                parkAndCheckInterrupt())
                interrupted =true;
            }
    } finally {
        if(failed)
            cancelAcquire(node);
    }
}

/**
 * 检查并更新 acquire 失败的节点的状态。如果线程应该阻塞,则返回 true。
 * 这是所有循环 acquire 获取资源的主要 signal 控制方法。要求 pred == node.prev。
 *
 * 参数:pred - 节点的前驱节点持有的状态
 *      node - 当前节点
 * 返回:如果线程应该阻塞,返回 true。
 */
private static boolean shouldParkAfterFailedAcquire(Node pred,Node node){
    // 前驱节点的等待状态
    int ws=pred.waitStatus;
    // 前驱结点状态为 SIGNAL,说明当前节点可以阻塞,pred 在完成后需要调用 release
    if(ws == Node.SIGNAL)
        /*
         * 前驱节点状态设置为 Node.SIGNAL,等待被 release 调用释放,后继节点可以安全地进入阻塞。
         */
        return true;
    if(ws > 0) {
        /*
         * 前驱节点为 CANCELLED,尝试把所有 CANCELLED 的前驱节点移除,找到一个
         * 非取消的前驱节点。
         */
        do {
            node.prev = pred = pred.prev;
        } while (pred.waitStatus > 0);
        pred.next=node;
    } else {
        /*
         * waitStatus 为 0 或 PROPAGATE.  表示我们需要一个 signal,
         * 而不是阻塞。调用者需要重试以确保在阻塞前无法 acquire。
         */
        compareAndSetWaitStatus(pred,ws,Node.SIGNAL);
    }
    return false;
}

/**
 * park 后检查是否中断的便捷方法
 *
 * 返回:如果中断,返回true
 */
private final boolean parkAndCheckInterrupt(){
    // park 当前线程
    LockSupport.park(this);
    // 判断是否中断
    return Thread.interrupted();
}


/**
 * 将队列 head 设置为 node,从而使之前的节点出队。仅由 acquire 方法调用。
 * 为了 GC 和抑制不必要的 signal 和遍历,同时也清空无用的字段。
 *
 * 参数:node - 节点
 */
private void setHead(Node node){
    head=node;
    node.thread=null;
    node.prev=null;
}

依旧使用上面的例子,当 thread-1 入队时,此时队列为空,需要初始化一个空节点,之后将调用 addWaiter() 将 thread-1 入队:

aqs-thread-1-enq

此时,在 thread-1 等待过程中,将 thread-2 进行入队操作:

aqs-thread-2-enq

以上就是 tryAcquire 失败后的入队逻辑,可以看到,在节点进行入队时,会修改前驱节点的 waitStatus,当前驱节点 release
时,会进行哪些操作呢?下面我们对 release 操作进行解析。

4.1.2 release

在独占模式中,release() 用来释放资源,下面我们根据源码来解读 AQS 如何进行释放操作。

/**
 * 释放独占模式。如果 tryRelease 返回 true,则通过解锁一个或多个线程实现。此方法可以
 * 用来实现方法 Lock.unlock.
 *
 * 参数:arg - release 参数。这个值被传递给 tryRelease,你可以用它表示任何你喜欢的东西。
 * 返回:tryRelease 返回的值
 */
public final boolean release(int arg){
    // 尝试释放资源
    if(tryRelease(arg)){
        Node h=head;
        // head 不为空,且 waitStatus 不为 0 的情况下,唤醒后继节点
        if(h!=null&&h.waitStatus!=0)
        // 后继节点解除阻塞
        unparkSuccessor(h);
        return true;
    }
    return false;
}

/**
 * 尝试设置状态,以体现独占模式下的 release。
 *
 * 该方法总是由执行 release 的线程调用。
 *
 * 默认实现抛出 UnsupportedOperationException。
 *
 * 参数:arg - release 参数。此值始终是传递给 release 方法的值,或者是进入条件等待时的
 *            当前状态值。该值是未解释的,可以表示任何你想要的内容。
 * 返回:如果当前对象现在完全释放,则返回 true,以便任何等待的线程都可以尝试 acquire;否则 false。
 * @throws IllegalMonitorStateException - 如果 release 会将此同步器置于非法状态。
 *                                        必须以一致的方式抛出此异常,同步器才能正常工作。
 * @throws UnsupportedOperationException - 如果不支持独占模式
 */
protected boolean tryRelease(int arg){
    throw new UnsupportedOperationException();
}

/**
 * 如果节点存在后继节点,则唤醒后继节点。
 *
 * 参数:node - 节点
 */
private void unparkSuccessor(Node node){
    /*
     * 如果状态为负数(即可能需要 signal),尝试 clear 以等待 signal。
     * 允许失败或等待线程更改状态。
     */
    int ws = node.waitStatus;
    if(ws < 0)
        // 将当前节点的 waitStatus 置为 0
        compareAndSetWaitStatus(node, ws, 0);

    /*
     * 当前线程的后继节点 unpark ,通常只是下一个节点。但如果下个节点为空或
     * 已经取消,则从 tail 向后遍历以找到实际未取消的后继节点。
     */
    Node s=node.next;
    // 后继节点为空,或后继节点是 CANCELLED
    if(s == null || s.waitStatus > 0){
        s = null;
    // 从 tail 开始,向 head 遍历,找到最接近 当前节点的不为空且未取消的节点
    for(Node t = tail;t != null && t != node; t = t.prev)
        if(t.waitStatus <= 0)
            s = t;
    }
    // 找到之后,unpark 节点线程阻塞状态
    if(s != null)
        LockSupport.unpark(s.thread);
}

当 release 操作成功 unpark 一个线程后,该线程在通过 acquireQueued 进行 tryAcquire
成功后,就会将头结点设置为当前节点,并将之前的头结点以及线程字段置空,以方便 GC 回收,thread-1 获取到锁在执行过程中,状态如下:

aqs-thread-1-release

thread-1 执行完成后,对 thread-2 进行 unpark 后,状态如下:

aqs-thread-2-release

4.1.3 acquireInterruptibly

下面我们对 acquire 的变体,即带有响应中断版本的 acquireInterruptibly 方法进行解析:

/**
 * 以独占模式 acquire,如果线程中断则终止操作。通过首先检查中断状态,然后
 * 至少调用一次 tryAcquire,成功则直接返回。否则线程排队,可能会在 tryAcquire
 * 成功或线程被中断之前,多次重复阻塞和解除阻塞。该方法可用于实现 
 * Lock.lockInterruptibly 方法。
 *
 * 参数:arg - acquire 参数。这个值被传递给 tryAcquire,但并没有进行解释,
 *            你可以将其表示为任何你想要的值。  
 * @throws InterruptedException - 如果当前线程被中断
 */
public final void acquireInterruptibly(int arg)
        throws InterruptedException{
     // 判断当前线程是否中断,并清空线程中断标记位,中断直接抛出异常
    if(Thread.interrupted())
        throw new InterruptedException();
    // 尝试加锁,加锁失败则进行自旋阻塞 acquire
    if(!tryAcquire(arg))
        doAcquireInterruptibly(arg);
}

/**
 * 以独占且可中断模式 acquire。
 * 参数:arg - acquire 参数
 */
private void doAcquireInterruptibly(long arg)
        throws InterruptedException {
    // 新增当前线程节点并入队
    final Node node = addWaiter(Node.EXCLUSIVE);
    boolean failed = true;
    try {
        for (;;) {
            // 前驱节点
            final Node p = node.predecessor();
            // 前驱节点为头节点,且 acquire 成功,则将当前节点置为头节点
            if (p == head && tryAcquire(arg)) {
                setHead(node);
                p.next = null; // help GC
                failed = false;
                return;
            }
            // 获取资源失败则进入阻塞状态
            if (shouldParkAfterFailedAcquire(p, node) &&
                    // park 当前线程,并判断是否中断
                    parkAndCheckInterrupt())
                throw new InterruptedException();
        }
    } finally {
        if (failed)
            cancelAcquire(node);
    }
}

可以看到,acquireInterruptibly 方法与 acquire 方法基本一致,区别在于在线程中断时是否抛出 InterruptedException。

4.1.4 tryAcquireNanos

/**
 * 尝试以独占模式进行 acquire, 如果线程中断则终止操作, 如果超过给定的超时时间
 * 则返回 false。通过首先检查线程中断状态,然后至少调用一次 tryAcquire 方法,
 * 成功则返回 true。否则,线程排队,在调用 tryAcquire 直到成功、或线程被中断、
 * 或到达超时时间,可能重复多次阻塞和解除阻塞。此方法可用于实现 Lock.tryLock(long, TimeUnit)。
 *
 * 参数:arg - release 参数。此值始终是传递给 release 方法的值,或者是进入条件等待时的
 *            当前状态值。该值是未解释的,可以表示任何你想要的内容。
 *      nanosTimeout - 等待的最大纳秒数
 * 返回:如果成功 acquire,则返回 true;如果超时则返回 false
 * @throws InterruptedException 如果线程被中断
 */
public final boolean tryAcquireNanos(long arg, long nanosTimeout)
        throws InterruptedException {
    // 如果当前线程中断,清除中断状态,并抛出异常
    if (Thread.interrupted())
        throw new InterruptedException();
    // 首次先尝试获取资源,失败后以指定超时时间阻塞获取
    return tryAcquire(arg) ||
            doAcquireNanos(arg, nanosTimeout);
}

/**
 * 以独占且支持超时模式进行 acquire。
 *
 * 参数:arg - acquire 参数
 *      nanosTimeout - 最大等待时间
 * 返回:如果 acquire 成功,返回 true
 */
private boolean doAcquireNanos(long 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 {
        // 自旋进行 acquire 操作
        for (;;) {
            // 当前节点的前驱节点
            final Node p = node.predecessor();
            // 前驱节点为 head,尝试 acquire 操作,成功后,将当前节点设为 head,并清空节点无用字段
            if (p == head && tryAcquire(arg)) {
                setHead(node);
                p.next = null; // help GC
                failed = false;
                return true;
            }
            // 获取本次循环的超时时间
            nanosTimeout = deadline - System.nanoTime();
            // 本次自旋超时到达,直接返回
            if (nanosTimeout <= 0L)
                return false;
            // 当前节点在 acquire 失败后如果需要阻塞,且
            if (shouldParkAfterFailedAcquire(p, node) &&
                    // 当前超时时间大于 1000 纳秒,小于等于 1000 纳秒将会进入下一轮自旋获取锁
                    nanosTimeout > spinForTimeoutThreshold)
                // 指定超时时间并 park
                LockSupport.parkNanos(this, nanosTimeout);
            // 如果线程中断,则抛出异常
            if (Thread.interrupted())
                throw new InterruptedException();
        }
    } finally {
        if (failed)
            cancelAcquire(node);
    }
}

tryAcquireNanos 方法与 doAcquireInterruptibly 方法在对超时中断处理上是保持一致的,都会在线程中断后抛出 InterruptedException。tryAcquireNanos 在每轮的自旋加锁失败后,都会重新计算超时时间,当超时时间小于 spinForTimeoutThreshold 后,则会进入自旋进行 acquire 操作。

4.1.5 独占模式的实现

基于上述对独占模式的源码的解析,在 j.u.c 包中提供的独占模式的同步器有:

  • ReentrantLock可重入锁;
  • ReentrantReadWriteLock 中的 WriteLock;
  • ThreadPoolExecutor 中的 Worker。

4.2 共享模式

共享模式:即同一时刻,共享资源可以被多个线程获取,status 的状态大于或等于 0。共享模式在 AQS 中的体现为,如果有一个节点持有的线程 acquire 操作 status 成功,那么它会被解除阻塞,并且会把解除阻塞状态 PROPAGATE 给所有有效的后继节点。

共享模式的功能主要由以下四个方法提供,与独占模式相比,在方法命名上由 Shared 区分:

  • acquireShared(int) :获取 int 数量的资源,也就是原子修改 status。
  • acquireSharedInterruptibly(int):获取 int 数量的资源,可以响应线程中断。
  • tryAcquireSharedNanos(int, long) :在指定 long 时间内,获取 int 数量的资源。
  • releaseShared(int) :释放 int 数量的资源。

4.2.1 acquireShared

/**
 * 以共享模式 acquire,并忽略线程中断。通过首先最少调用一次 tryAcquireShared 实现,
 * 成功则直接返回。否则线程排队,在调用 tryAcquireShared 成功之前,可能会多次重复
 * 阻塞和解除阻塞。
 *
 * 参数:arg - acquire 参数。该值被传递给 tryAcquireShared,但并没有进行解释,
 *            你可以将其表示为任何你想要的值。  
 */
public final void acquireShared(long arg) {
    // 获取失败,返回负值;此时需要加入同步等待队列
    if (tryAcquireShared(arg) < 0)
        doAcquireShared(arg);
}

/**
 * 尝试以共享模式 acquire。此方法应查询对象的状态是否允许以共享模式获取它,
 * 如果允许,则可以获取。
 *
 * 此方法始终由执行 acquire 的线程调用。如果此方法返回失败,且该线程尚未排队,
 * 则 acquire 方法可以将该线程入队,直到某个其他线程释放发出 signal。
 *
 * 默认实现抛出 UnsupportedOperationException。
 *
 * 参数:arg - acquire 参数。该值始终是传递给 acquire 方法的值,或者是在进入条件等待
 *            时保存的值。该值并没有进行解释,你可以将其表示为任何你想要的值。  
 * 返回:失败返回负值;如果以共享模式获取成功但后续的共享模式 acquire 不能成功,则为 0;
 *      如果在共享模式下获取成功并且后续共享模式也可能成功,则为正值,在这种情况下,后续等待
 *      线程必须检查可用性。(对于三种不同返回值的支持使此方法可以仅在 acquire 可用时的独占上下文中使用。)
 *      成功后,此对象已被获取。
 * @throws IllegalMonitorStateException - 如果 acquire 会将此同步器置于非法状态。
 *                                        必须以一致的方式抛出此异常,同步器才能正常工作。
 * @throws UnsupportedOperationException - 如果不支持共享模式
 */
protected long tryAcquireShared(long arg) {
    throw new UnsupportedOperationException();
}

/**
 * 以共享且不中断模式进行 acquire。
 * 参数:arg - acquire 的参数
 */
private void doAcquireShared(long arg) {
    // 为当前线程创建一个新的共享节点并入队
    final Node node = addWaiter(Node.SHARED);
    boolean failed = true;
    try {
        boolean interrupted = false;
        for (;;) {
            // 该节点的前驱节点
            final Node p = node.predecessor();
            // 如果前驱节点为 head
            if (p == head) {
                // 调用 tryAcquireShared 获取资源,只有在大于等于 0 时,才获取到资源,此时唤醒其他节点 
                long r = tryAcquireShared(arg);
                if (r >= 0) {
                    // 设置头结点,并设置 `PROPAGATE 状态,确保唤醒传播到可用的后继节点
                    // 当任意等待节点晋升为 head,也会进行此操作,以此来进行链式唤醒
                    setHeadAndPropagate(node, r);
                    p.next = null; // help GC
                    if (interrupted)
                        selfInterrupt();
                    failed = false;
                    return;
                }
            }
            // acquire 失败判断是否需要 park,并校验线程中断
            if (shouldParkAfterFailedAcquire(p, node) &&
                    parkAndCheckInterrupt())
                interrupted = true;
        }
    } finally {
        if (failed)
            cancelAcquire(node);
    }
}

/**
 * 设置队列的 head,并检查后继节点是否可能在共享模式下等待,如果是这样,且设置了
 * propagate > 0,则进行传播。
 *
 * 参数:node - 节点
 *      propagate - tryAcquireShared 的返回值
 *
 * 如果是共享模式下,在设置头结点后,会判断 propagate > 0 || head.waiteStatus < 0 情况下,
 * 进行共享模式下的资源释放操作。
 */
private void setHeadAndPropagate(Node node, long propagate) {
    Node h = head; // 记录旧 head 以供检查
    // 设置当前处理节点为 head
    setHead(node);
    /*
     * 如果出现以下情况,请尝试 signal 下一个排队节点:
     *  - 调用着指定了传播;
     *  - or 有先前的操作记录(在 setHead 之前或之后作为 h.waitStatus)(注意:这是用了 waitStatus 的符号检查,因为 PROPAGATE 状态可能会转换为 SIGNAL)。
     * and
     *  - 下一个节点在共享模式中等待,或者我们并不清楚,因为它显示为 null
     * 
     *
     * 这两种检查的保守性可能会导致不必要的唤醒,但只有在多个竞争的 acquires 和 releases 时才会这样,
     * 所以大多数节点无论如何都需要现在或很快得到 signal。
     */
    // 入参 propagate > 0 || head 为 null || head 的状态为非 CANCELLED 和 0 || 再次校验 head 为空 || 再次校验 head 状态不为 CANCELLED 和 0
    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();
    }
}

/**
 * 共享模式的 release 操作 -- signal 后继节点并保证 propagation。
 * (在独占模式下,如果需要 signal,release 就相当于调用 head 的 unparkSuccessor)。
 */
private void doReleaseShared() {
    /*
     * 确保 release 可以传播,即使还有其他正在进行的 acquire/release。
     * 如果需要 signal,这会以常用的方式尝试对 head 进行 unparkSuccessor。
     * 但如果没没有,则将状态设置为 "PROPAGATE" 确保在 release 时继续传播。
     * 此外,我们必须在循环中进行,以防止在我们执行此操作时,链表中添加新节点。
     * 此外,与 unparkSuccessor 的其他用法不同,我们需要知道 CAS 重置状态
     * 是否失败,如果是则重新检查。
     */
    for (;;) {
        Node h = head;
        // 头节点不为空,且头节点同时不是尾结点
        if (h != null && h != tail) {
            // 头节点的 waitStatus
            int ws = h.waitStatus;
            // 如果为 SIGNAL,则 CAS 将其更新为 0,更新成功后唤醒其后继节点的阻塞
            if (ws == Node.SIGNAL) {
                // 更新失败,是因为会有并发情况,唤醒的线程也会调用 doReleaseShared
                // 如果更新失败,则跳过进行重新检查
                if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
                    continue;            // loop to recheck cases
                unparkSuccessor(h);
            }
            // 头节点 waitStatus 已经为 0,则 CAS 将其更新为 -3
            // 此时可以分析 waitStatus 值为 0 的情况如下:
            // 1. 如果 head 节点没有及时被更新,另一个线程被唤醒后获得锁,此时另一个线程已经执行了
            // setHead,将头节点更新为了自己,(因为如果在下面的 h == head 判断中,头节点没有变化,
            // 会直接跳出循环);此时,通过 unparkSuccessor 将 waitStatus 更新为 0。
            else if (ws == 0 &&
                    !compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
                continue;                // loop on failed CAS
        }
        // 1. head 没有变更,说明被唤醒的线程还没有执行完 setHead 操作,跳出循环。
        // 等新的节点执行 setHeadAndPropagate 操作后,也会调用 doReleaseShared
        // 2. 如果 head  变更了,那就可能会有多个线程(在当前循环被唤醒)都来执行
        // doReleaseShared,此时这个方法的 compareAndSetWaitStatus 就可能
        // 修改失败(当然,也可能会因为其他线程的 acquire/release 的竞争),那此时会
        // 自旋做重新检查。
        if (h == head)                   // loop if head changed
            break;
    }
}

我们对 doReleaseShared 进行一个说明:

  1. 首先,该方法是一个死循环,每次循环中都会重新获取 head,只有当 h == head 时,才会跳出循环。而 head 发生变化一定是由于队列中的节点在 acquire 阻塞过程中被唤醒,之后成功获得锁资源,然后在调用 setHeadAndPropagate 方法中的 setHead 方法修改 head。

  2. 判断 h != null && h != tail 说明队列中至少要存在两个节点,如果队列并没有因为竞争而初始化为 head 设置过值(head 为 null),或队列仅有一个节点(head 和 tail 指向同一个节点),那么将不进行操作,直接到最后去判断 head 是否发生了变化。

  3. 如果步骤 2 中的条件满足,说明队列有两个及以上节点,那么此时会根据 h 的 waitStatus 字段判断:

    1. 如果状态为 signal,说明 h 节点的后继节点需要被通知,此时进行 CAS 操作 compareAndSetWaitStatus(h, Node.SIGNAL, 0):
      1. 如果 CAS 操作成功,即将 h 的状态由 SIGNAL 改为 0,此时通过 unparkSuccessor 方法唤醒后继节点。
      2. 如果 CAS 操作失败,说明当前线程在修改时存在竞争(可能其他线程也在进行 release/acquire 操作,或者同样在进行 doReleaseShared),此时我们进行重新检查。
    2. 如果状态为 0 ,说明 h 节点的后继节点已经被唤醒或在唤醒的过程中了,因为当前为共享模式的释放,所以我们使用 CAS 操作将状态更新为 PROPAGATE传播唤醒其他节点。

下面我们分析一下 h 的 waitStatus 为 0 的情况:

  • 如果队列中只有一个节点,那么它的状态肯定为 0,此时 head 和 tail 都指向这个节点。
  • 如果队列中有一个节点(它的状态为 0),此时另外一个线程由于 acquire 失败,那么失败线程会调用 addWaiter 方法将自己入队,此时队列中有两个节点,此时还没有来得及执行 shouldParkAfterFailedAcquire 中的 compareAndSetWaitStatus(pred, ws, Node.SIGNAL); 将第一个节点的状态改为 signal
  • 队列中有多个节点,此时,刚好有线程释放了锁,调用了 releaseShared() -> doReleaseShared() -> unparkSuccessor() 方法的 compareAndSetWaitStatus(node, ws, 0) 一行,将节点状态设置为了 0,之后唤醒 head 节点的后继节点,head 的后继节点将自己设置为队列的 head 的过程中(还没有设置为 head),当前 head 节点的状态为 0。

综上,如果在释放共享锁的过程中,会执行 doReleaseShared 方法,而此时会对 PROPAGATE 状态进行传播,唤醒其后继节点,而后继节点唤醒后,也会执行相同的步骤,如果在 if(h == head) 判断前后继节点调用 setHeadAndPropagte 方法将 head 修改为自己,那就会可能有多个线程同时并发执行 doReleaseShared 方法,以此达到传播的目的,当 head 不发生变化时,唤醒的后继节点也会对后续的各个节点进行唤醒,直到全部唤醒完成或无共享资源可用(此时 head 节点不再发生变化)。

与独占模式的 acquire 方法相比,共享模式在当前节点获取资源成功后,除了会将自身设置为 head 之外,还会通过 CAS 将自身的 waitStatus 设置为 PROPAGATE,从而传播去唤醒其他等待节点。

4.2.2 releaseShared

/**
 * 以共享模式进行 release 操作。如果 tryReleaseShared 返回 true,则通过解锁一个或
 * 多个线程来实现。
 *
 * 参数:arg - release 参数。该值被传递给 tryReleaseShared,但并没有进行解释,
 *            你可以将其表示为任何你想要的值。 
 * 返回:tryReleaseShared 的返回值
 */
public final boolean releaseShared(int arg) {
    // 尝试释放资源
    if (tryReleaseShared(arg)) {
        // 进行 doReleaseShared 以传播方式唤醒其他节点
        doReleaseShared();
        return true;
    }
    return false;
}

/**
 * 尝试设置状态,以体现共享模式下的 release。
 *
 * 该方法总是由执行 release 的线程调用。
 *
 * 默认实现抛出 UnsupportedOperationException。
 *
 * 参数:arg - release 参数。此值始终是传递给 release 方法的值,或者是进入条件等待时的
 *            当前状态值。该值是未解释的,可以表示任何你想要的内容。
 * 返回:如果此共享模式的 release 可能允许等待 acquire 的其他线程成功(共享或独占);否则 false。
 * @throws IllegalMonitorStateException - 如果 release 会将此同步器置于非法状态。
 *                                        必须以一致的方式抛出此异常,同步器才能正常工作。
 * @throws UnsupportedOperationException - 如果不支持独占模式
 */
protected boolean tryReleaseShared(int arg) {
    throw new UnsupportedOperationException();
}

可以看到,releaseShared 其实就是在 tryReleaseShared 返回 true 后,去调用 doReleaseShared 传播唤醒状态。

4.2.3 acquireSharedInterruptibly

/**
 * 以共享模式 acquire,如果线程中断则终止操作。通过首先检查中断状态,然后
 * 至少调用一次 tryAcquireShared,成功则直接返回。否则线程排队,可能会在 
 * tryAcquireShared 成功或线程被中断之前,多次重复阻塞和解除阻塞。
 *
 * 参数:arg - acquire 参数。这个值被传递给 tryAcquire,但并没有进行解释,
 *            你可以将其表示为任何你想要的值。  
 * @throws InterruptedException - 如果当前线程被中断
 */
public final void acquireSharedInterruptibly(int arg)
        throws InterruptedException {
    // 判断线程中断并清除中断标志,如果中断,直接抛出异常终止
    if (Thread.interrupted())
        throw new InterruptedException();
    // 尝试加锁,小于 0 说明加锁失败,需要入队操作
    if (tryAcquireShared(arg) < 0)
        doAcquireSharedInterruptibly(arg);
}

/**
 * 以共享且可中断模式 acquire。
 * 参数:arg - acquire 参数
 */
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);
    }
}

4.2.4 tryAcquireSharedNanos

/**
 * 尝试以共享模式进行 acquire, 如果线程中断则终止操作, 如果超过给定的超时时间
 * 则返回 false。通过首先检查线程中断状态,然后至少调用一次 tryAcquireShared 方法,
 * 成功则返回 true。否则,线程排队,在调用 tryAcquireShared 直到成功、或线程被中断、
 * 或到达超时时间,可能重复多次阻塞和解除阻塞。
 *
 * 参数:arg - release 参数。此值始终是传递给 release 方法的值,或者是进入条件等待时的
 *            当前状态值。该值是未解释的,可以表示任何你想要的内容。
 *      nanosTimeout - 等待的最大纳秒数
 * 返回:如果成功 acquire,则返回 true;如果超时则返回 false
 * @throws InterruptedException 如果线程被中断
 */
public final boolean tryAcquireSharedNanos(int arg, long nanosTimeout)
        throws InterruptedException {
    if (Thread.interrupted())
        throw new InterruptedException();
    // 首次尝试,如果 tryAcquireShared >= 0 说明加锁成功,可以直接返回
    return tryAcquireShared(arg) >= 0 ||
            // 需要入队操作
            doAcquireSharedNanos(arg, nanosTimeout);
}

/**
 * 以共享且支持超时模式进行 acquire。
 *
 * 参数:arg - acquire 参数
 *      nanosTimeout - 最大等待时间
 * 返回:如果 acquire 成功,返回 true
 */
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 {
        // 自旋并休眠,这段代码和 doAcquireShared 一致
        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();
            // 超时则直接跳出,返回 false
            if (nanosTimeout <= 0L)
                return false;
             // 当前节点在 acquire 失败后如果需要阻塞,且
            if (shouldParkAfterFailedAcquire(p, node) &&
                    // 当前超时时间大于 1000 纳秒,小于等于 1000 纳秒将会进入下一轮自旋获取锁
                    nanosTimeout > spinForTimeoutThreshold)
                // 以自旋过程中计算的 nanosTimeout 阻塞
                LockSupport.parkNanos(this, nanosTimeout);
            // 线程中断直接退出
            if (Thread.interrupted())
                throw new InterruptedException();
        }
    } finally {
        if (failed)
            // 加锁失败,退出节点
            cancelAcquire(node);
    }
}

4.2.5 共享模式的实现

  • ReentrantReadWriteLock 中的 ReadLock;
  • 信号量 Semaphore;
  • 闭锁 CountDownLatch。

五、条件队列之 ConditionObject

在 AQS 内部也存在这 Condition 接口的实现类,即 ConditionObject,它是 AQS的共有内部类,并且它是 Lock
实现的基础。ConditionObject 提供的条件队列的入队的方法如下。

5.1 条件队列的入队和出队

public class ConditionObject implements Condition, java.io.Serializable {
    private static final long serialVersionUID = 1173984872572414699L;
    /**
     * 条件队列的第一个节点
     */
    private transient Node firstWaiter;
    /**
     * 条件队列的最后一个节点
     */
    private transient Node lastWaiter;

    /**
     * Creates a new {@code ConditionObject} instance.
     */
    public ConditionObject() {
    }

    /**
     * 为等待队列添加一个新的等待节点
     *
     * @return 新的等待节点
     */
    private Node addConditionWaiter() {
        // 本地变量保存 lastWaiter
        Node t = lastWaiter;
        // 如果 lastWaiter 不为条件等待状态,则说明 lastWaiter 是取消状态,清理
        if (t != null && t.waitStatus != Node.CONDITION) {
            // 解除所有取消的等待节点的连接
            unlinkCancelledWaiters();
            t = lastWaiter;
        }
        // 创建当前线程的新节点,类型为 CONDITION
        Node node = new Node(Thread.currentThread(), Node.CONDITION);
        // 在首次创建 Condition 时,lastWaiter 为 null,则把当前节点设置为 firstWaiter 
        if (t == null)
            firstWaiter = node;
        else
            // lastWaiter 不为空,则连接新节点
            t.nextWaiter = node;
        // 当前新增节点为 lastWaiter
        lastWaiter = node;
        return node;
    }

    /**
     * 从条件队列中取消连接已取消的等待节点。仅在持有锁时调用。当前方法会在条件等待期间
     * 发生取消时被调用,并且在 lastWaiter 已被取消时插入新的等待节点时调用。需要这种
     * 方法来避免在没有 signal 的情况下保留垃圾。因此,即使它可能需要完全遍历,它也只有
     * 在没有被 signal 的情况下发生超时或取消时才发挥作用。它遍历所有节点,而不是在特定
     * 目标处停止以取消连接到垃圾节点的所有指针,因此不会在取消风暴期间进行多次重新遍历。
     * <p>
     * 简单来说,此方法就是更新队列,移除所有 CANCELLED 的节点,期间会 firstWaiter 和
     * lastWaiter 的引用
     */
    private void unlinkCancelledWaiters() {
        // 保存当前的 firstWaiter 
        Node t = firstWaiter;
        // 跟踪节点,用于最后找到 lastWaiter
        Node trail = null;
        while (t != null) {
            // 从 firstWaiter 开始往后遍历
            Node next = t.nextWaiter;
            // 当前节点不是 CONDITION,那么就是 CANCELLED
            if (t.waitStatus != Node.CONDITION) {
                // 取消当前节点的引用
                t.nextWaiter = null;
                // trail 为空,说明当前还未遇到第一个 CONDITION 状态的节点
                if (trail == null)
                    // 将 firstWaiter 暂时设置为 下个节点
                    firstWaiter = next;
                else
                    // 将 next 链接到追踪节点
                    trail.nextWaiter = next;
                // 遍历结束
                if (next == null)
                    // lastWaiter 即 trail 的最后一个节点
                    lastWaiter = trail;
            } else
                // CONDITION 节点,记录当前节点
                trail = t;
            // 更新当前节点为 next
            t = next;
        }
    }
}

我们在观察 ConditionObject 类后可以发现,所有的 await 方法及其变体都会调用 addConditionWaiter()
方法,将阻塞线程添加到添加队列中。我们下面演示一下条件队列入队的情况下,假设存在两个线程 thread-1 和 thread-2
需要阻塞入队,首先是 thread-1 入队:

thread-1-enq

在 thread-1 入队后等待过程中,thread-2 入队:

thread-2-enq

之后线程入队就如上面操作一样,只需修改 lastWaiter 和 nextWaiter 指向新节点即可。

5.2 Condition 之 await

实现 Condition 接口的 await 方法,主要用于条件等待操作。下面是关于接口中方法的说明:

使当前线程等待,直到它被 signal 或中断。

直到以下四种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程由于线程调度会被禁用并处于休眠状态:

  • 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
  • 其他一些线程为此 Condition 调用了 signalAll() 方法;
  • 其他一些线程中断当前线程,支持中断线程挂起;
  • 发生“虚假唤醒”。

在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。当前线程返回时,它保证持有这个锁。

如果当前线程:

  • 在进入此方法时设置其中断状态;或者,
  • 等待过程中被中断,支持线程挂起的中断。

然后抛出 InterruptedException 并清除当前线程的中断状态。在第一种情况下,没有规定是否在释放锁之前进行中断判断。

实现注意事项:

调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且实现必须记录该事实。

与响应 signal 的正常方法返回相比,实现更倾向于响应中断。在这种情况下,实现必须确保将信号量重定向到另一个等待线程(如果有的话)。

throws InterruptedException - 如果当前线程被中断(并且支持线程挂起的中断)

/** 该模式意味着退出等待时重新中断 */
private static final int REINTERRUPT =  1;
/** 该模式意味着在退出等待时抛出 InterruptedException */
private static final int THROW_IE    = -1;


/**
 * 实现支持中断的条件等待。
 * 1. 如果当前线程被中断,抛出 InterruptedException。
 * 2. 保存 getState 返回的锁状态。
 * 3. 使用保存状态作为参数调用 release,如果失败抛出 IllegalMonitorStateException。
 * 4. 线程入队阻塞,直到 signal 或 线程中断
 * 5. 通过使用保存状态作为参数调用特定的 acquire 方法来重新加锁。
 * 6. 如果在步骤 4 中被阻塞过程中被其他线程中断,则抛出 IntrrputedException。
 */
public final void await() throws InterruptedException {
    // 判断线程中断,清理中断标志
    if (Thread.interrupted())
        throw new InterruptedException();
    // 新增条件等待节点并进入条件等待队列
    Node node = addConditionWaiter();
    // 释放当前 AQS 的所有资源,并返回资源的 state
    int savedState = fullyRelease(node);
    // 中断模式
    int interruptMode = 0;
    // 如果新增节点不在同步队列,对当前节点线程进行阻塞。
    // 这里是个循环判断,当前节点被唤醒后,会将节点从条件队列转换到同步队列,
    // 所以在节点被唤醒后,如果加锁成功,将会被放入同步队列跳出循环
    while (!isOnSyncQueue(node)) {
        LockSupport.park(this);
        // 线程中断,转移当前节点
        if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
            break;
    }
    // 节点进入同步队列后,如果此时线程没有中断,则以独占方式进入同步队列阻塞
    // 这里在 acquireQueued 中进行 tryAcquire 时使用的参数为 savedState
    if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
        interruptMode = REINTERRUPT;
    // 当前节点的 nextWaiter 不为空,则从等待队列中移除所有 CANCELLED 节点
    if (node.nextWaiter != null) // clean up if cancelled
        unlinkCancelledWaiters();
    // 根据 interruptMode 对中断进行对应处置
    if (interruptMode != 0)
        reportInterruptAfterWait(interruptMode);
}

/**
 * 使用当前的状态值调用 release;返回保存的状态值。
 * 失败则取消节点,并抛出异常。
 * 
 * 参数:node - 当前等待的条件节点
 * 返回:之前的同步状态
 */
final int fullyRelease(Node node) {
    boolean failed = true;
    try {
        int savedState = getState();
        // 释放资源,也就是解锁
        if (release(savedState)) {
            failed = false;
            return savedState;
        } else {
            throw new IllegalMonitorStateException();
        }
    } finally {
        if (failed)
            // 失败则取消节点
            node.waitStatus = Node.CANCELLED;
    }
}

/**
 * 如果一个节点(从最初就是放在条件队列中的节点)现在正在同步队列中等待 acquire 操作,
 * 则返回 true。
 * 
 * 参数:node - 节点
 * 返回:如果在同步队列中 acquire,返回 true
 */
final boolean isOnSyncQueue(Node node) {
    // 在同步队列,则说明当前节点肯定不是条件等待节点
    // 如果不是条件等待节点,但是节点的 prev 为空,说明节点可能在同步队列已出队
    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 可以是非空的,但尚未在队列中,因为将其放入队列的 CAS 可能会失败。
     * 所以我们必须从队列 tail 遍历,以确保它确实成功了。在调用这个方法时,它总是在
     * tail 附近,除非 CAS 失败(这不太可能),所以我们几乎不会有太多的遍历。
     */
    // 从同步队列往前遍历查找节点
    return findNodeFromTail(node);
}

/**
 * 如果节点通过从 tail 向前搜索,出现在了同步队列上,则返回 true。
 * 仅在 isOnSyncQueue 需要调用。
 * 
 * 返回:如果存在,返回 true
 */
private boolean findNodeFromTail(Node node) {
    Node t = tail;
    for (;;) {
        if (t == node)
            return true;
        if (t == null)
            return false;
        t = t.prev;
    }
}

/**
 * 检查线程中断,如果在 signal 之前中断,则返回 THROW_IE,
 * 如果在 signal 之后中断,返回 REINTERRUPT,如果没有中断,
 * 返回 0。
 */
private int checkInterruptWhileWaiting(Node node) {
    return Thread.interrupted() ?
            // 如果是当前入队成功了,当前线程抛出异常
            (transferAfterCancelledWait(node) ? THROW_IE : REINTERRUPT) :
            // 线程未中断
            0;
}

/**
 * 如果有必要,在取消等待后将节点转移到同步队列。如果是在 signal 之前被
 * 取消等待,则返回 true。
 *
 * 参数:node - 节点。
 * 返回:如果在 signal 之前取消等待,返回 true。
 */
final boolean transferAfterCancelledWait(Node node) {
    // CAS 尝试将当前节点状态修改为 0
    if (compareAndSetWaitStatus(node, Node.CONDITION, 0)) {
        // 修改成功,转移到同步队列
        enq(node);
        return true;
    }
    /*
     * 如果我们由于竞争 CAS 修改失败,那在它完成 enq() 入队之前,我们不能继续。
     * 在传输未完成之前取消,这个很少见也很短暂,所以我们只需要自旋。
     */
    // 等待其他线程将节点加入同步队列
    while (!isOnSyncQueue(node))
        // 让出 CPU
        Thread.yield();
    return false;
}

/**
 * 根据 interruptMode 选择抛出 InterruptedException、重新中断、或不执行任何操作。
 */
private void reportInterruptAfterWait(int interruptMode)
        throws InterruptedException {
    // 抛出异常
    if (interruptMode == THROW_IE)
        throw new InterruptedException();
    else if (interruptMode == REINTERRUPT)
        selfInterrupt();
}

可以看到,当一个节点加入条件队列时,如果当前节点是同步队列的节点,首先会释放 AQS 同步队列的资源(此时线程是独占模式,因此不存在竞争),只有持有锁的线程可以进行 fullyRelease,此时这个节点就从同步队列转移到了条件队列(其实本质是将节点从同步队列移除,然后在条件队列新增一个节点)。之后,该节点就会在条件队列上阻塞,直到有其他线程调用 signal 或 signal 唤醒当前线程,当前线程就会从条件队列转移到同步队列中,当 await 方法被唤醒,并且当前节点成功转移到同步队列中,之后的操作就属于 AQS 中的同步队列阻塞及唤醒操作。

5.3 Condtion 之 signal/signalAll

Condition 接口的 signal 方法,主要用来唤醒阻塞的条件队列中的线程,其方法说明如下:

唤醒一个等待线程。

如果有任何线程在此 Condition 下等待,则选择一个用于唤醒。然后,该线程必须在从await 返回之前重新获取锁。

实现注意事项:

在调用此方法时,实现可能(并且通常确实)要求当前线程持有与此 Condition 关联的锁。实现必须记录此前提条件以及未持有锁时采取的任何操作。通常,会抛出 IllegalMonitorStateException。

/*
 * 将等待时间最长的线程(如果存在)从该条件队列转换到拥有锁的等待队列。
 *
 * @throws IllegalMonitorStateException 如果 isHeldExclusively 返回 false
 */
public final void signal() {
  // 当前同步器持有的线程是否是当前线程
  if (!isHeldExclusively())
    throw new IllegalMonitorStateException();
  // 等待时间最长的就是第一个入队的 fistWaiter
  Node first = firstWaiter;
  if (first != null)
    // 唤醒节点
    doSignal(first);
}

/**
 * 删除并转换节点,直到命中未取消的节点或 null。从 signal 中分离出来部分是为了
 * 编译器内联没有等待节点的情况。
 *
 * 参数:first - (非空) 条件队列中的第一个节点
 */
// 该方法目的就是唤醒成功一个节点,或条件队列为空时,执行结束
private void doSignal(Node first) {
  do {
    // 第一个节点的 nextWaiter 为空,说明目前只有一个等待节点
    if ((firstWaiter = first.nextWaiter) == null)
      lastWaiter = null;
    // 将当前处理节点从条件队列移除
    first.nextWaiter = null;
    // 转换当前节点
  } while (!transferForSignal(first) &&
          // 转换失败,此时的 firstWaiter 是 first 的 nextWaiter 节点
          (first = firstWaiter) != null);
}

下面是 signalAll 方法,与 signal 不同的是,signalAll 方法会唤醒所有等待节点:

/**
 * 将所有线程从该条件等待队列转换到拥有锁的等待队列。
 *
 * @throws IllegalMonitorStateException 如果 isHeldExclusively 返回 false
 */
public final void signalAll() {
  // // 当前同步器持有的线程是否是当前线程
    if (!isHeldExclusively())
      throw new IllegalMonitorStateException();
    Node first = firstWaiter;
    if (first != null)
        // 唤醒所有节点
        doSignalAll(first);
}

/**
 * 移除并转换所有节点
 * @param first (非空) 条件队列中的第一个节点
 */
private void doSignalAll(Node first) {
    // 全部转换,则将 lastWaiter 和 firstWaiter 置空
    lastWaiter = firstWaiter = null;
    do {
        // 获取下一个等待节点
        Node next = first.nextWaiter;
        // 下一个等待节点移除
        first.nextWaiter = null;
        // 处理当前节点
        transferForSignal(first);
        // 更新下个节点为处理节点
        first = next;
    } while (first != null);
}

可以看到,signal 和 signalAll 方法会将节点转换到同步队列,并将节点的状态修改为 SINGAL,之后解除节点线程阻塞状态。唯一不同的地方是,signal 方法只唤醒单个节点,而 signalAll 方法会唤醒全部节点。

5.4 await 方法的几种变体

下面我们简单看一下 await 方法的几种变体。

5.4.1 awaitUninterruptibly

使当前线程等待,直到它被 signal。

直到以下三种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程由于线程调度会被禁用并处于休眠状态:

  • 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
  • 其他一些线程为此 Condition 调用了 signalAll() 方法;
  • 发生“虚假唤醒”。

在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。当前线程返回时,它保证持有这个锁。

如果当现场进入该方法时设置了中断状态,或者在等待过程中被中断,则继续等待直到被 signal 唤醒。当它最终从这个方法返回时,它的中断状态会依旧存在。

实现注意事项:

调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且实现必须记录该事实。

/**
 * 实现非中断的条件等待。
 *
 * 1. 保存 getStatus() 返回的锁定状态。
 * 2. 使用保存的状态作为参数调用 release(),如果失败抛出 IllegalMonitorStateException。
 * 3. 阻塞直到 signal。
 * 4. 将保存的状态作为参数调用特定版本的 acquire() 来重新获取锁。
 */
public final void awaitUninterruptibly() {
    // 添加新的等待节点
    Node node = addConditionWaiter();
    // release 当前 AQS 的所有资源,并返回资源的 state
    int savedState = fullyRelease(node);
    // 是否中断
    boolean interrupted = false;
    // 判断当前节点是否是同步队列节点,理论上新增的应当是不在同步队列,当被唤醒时,如果加锁成功则会在同步队列
    while (!isOnSyncQueue(node)) {
        // 阻塞当前节点
        LockSupport.park(this);
        // 判断当前线程是否中断
        if (Thread.interrupted())
            interrupted = true;
    }
    // 如果当前线程被中断,或在加锁过程中中断,则对当前线程进行中断操作
    if (acquireQueued(node, savedState) || interrupted)
        selfInterrupt();
}

5.4.2 awaitNanos

使当前线程等待,直到它被 signal 或 中断,或者达到指定的等待时间。

直到以下五种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程由于线程调度会被禁用并处于休眠状态:

  • 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
  • 其他一些线程为此 Condition 调用了 signalAll() 方法;
  • 其他一些线程中断当前线程,支持中断线程挂起;
  • 到达指定的等待时间;
  • 发生“虚假唤醒”。

在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。当前线程返回时,它保证持有这个锁。

如果当前线程:

  • 在进入此方法时设置其中断状态;或者,
  • 等待过程中被中断,支持线程挂起的中断。

然后抛出 InterruptedException 并清除当前线程的中断状态。在第一种情况下,没有规定是否在释放锁之前进行中断判断。

在返回时提供给定的 nanosTimeout 值,该方法返回对剩余等待纳秒数的预估,如果超时,则返回小于或等于零的值。在等待返回但是等待的条件仍不成立的情况下,此值可用于确定是否重新等待以及重新等待多长时间。此方法的典型用途如以下形式:

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();
    }
}

设计说明:此方法需要纳秒参数,以避免报告剩余时间时出现截断错误。这种精度损失将使程序员难以确保总等待时间不会系统地短于重新等待发生时指定的时间。

实现注意事项:

调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且实现必须记录该事实。

与响应 signal 的正常方法返回相比,实现更倾向于响应中断。在这种情况下,实现必须确保将信号量重定向到另一个等待线程(如果有的话)。

/**
 * 实现超时条件等待。
 * 1. 如果当前线程被中断,抛出 InterruptedException。
 * 2. 保存 getState 返回的锁状态。
 * 3. 使用保存状态作为参数调用 release,如果失败抛出 IllegalMonitorStateException。
 * 4. 线程入队阻塞,直到 signal、线程中断或超时。
 * 5. 通过使用保存状态作为参数调用特定的 acquire 方法来重新加锁。
 * 6. 如果在步骤 4 中被阻塞过程中被其他线程中断,则抛出 IntrrputedException。
 */
public final long awaitNanos(long nanosTimeout)
        throws InterruptedException {
    if (Thread.interrupted())
        throw new InterruptedException();
    // 增加条件等待节点,并加入条件等待队列
    Node node = addConditionWaiter();
    // 是否 AQS 中的全部资源
    int savedState = fullyRelease(node);
    // 计算超时的时间线
    final long deadline = System.nanoTime() + nanosTimeout;
    int interruptMode = 0;
    // 阻塞直到超时,或中断抛出异常、或同步入队成功
    while (!isOnSyncQueue(node)) {
        // 节点超时
        if (nanosTimeout <= 0L) {
            // 移除条件等待队列,放入同步队列中
            transferAfterCancelledWait(node);
            break;
        }
        // 如果当前实现剩余比较多,这里是 1000 纳秒,那么阻塞
        if (nanosTimeout >= spinForTimeoutThreshold)
            LockSupport.parkNanos(this, nanosTimeout);
        // 中断则跳出循环
        if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
            break;
        // 重新计算剩余时间
        nanosTimeout = deadline - System.nanoTime();
    }
    // 节点在超时、中断、或 signal 出队后,会加入同步队列,这里在同步队列操作
    if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
        interruptMode = REINTERRUPT;
    // 下个节点不为空,则断开取消的节点
    if (node.nextWaiter != null)
        unlinkCancelledWaiters();
    // 根据中断模式进行中断处理
    if (interruptMode != 0)
        reportInterruptAfterWait(interruptMode);
    // 返回剩余时间
    return deadline - System.nanoTime();
}

5.4.3 awaitUntil

使当前线程等待,直到它被 signal 或 中断,或者达到指定的等待时间。

直到以下五种情况之一发生时,与此 Condition 关联的锁会被自动释放,并且当前线程由于线程调度会被禁用并处于休眠状态:

  • 其他某个线程为此 Condition 调用了 signal() 方法,而当前线程恰好被选为要被唤醒的线程;
  • 其他一些线程为此 Condition 调用了 signalAll() 方法;
  • 其他一些线程中断当前线程,支持中断线程挂起;
  • 到达指定的等待时间;
  • 发生“虚假唤醒”。

在所有情况下,在此方法可以返回之前,当前线程必须重新获取获取与此 Condition 关联的锁。当前线程返回时,它保证持有这个锁。

如果当前线程:

  • 在进入此方法时设置其中断状态;或者,
  • 等待过程中被中断,支持线程挂起的中断。

然后抛出 InterruptedException 并清除当前线程的中断状态。在第一种情况下,没有规定是否在释放锁之前进行中断判断。

返回值表示是否已经过了 deadline,可以如下使用:

实现注意事项:

调用此方法时,假定当前线程持有与此 Condition 关联的锁。由实现决定是否是这种情况,如果不是,如何响应。通常,将抛出异常(例如,IllegalMonitorStateException)并且实现必须记录该事实。

与响应 signal 的正常方法返回相比,实现更倾向于响应中断。在这种情况下,实现必须确保将信号量重定向到另一个等待线程(如果有的话)。

boolean aMethod(Date deadline) {
    boolean stillWaiting = true;
    lock.lock();
    try {
        while(!conditionBeingWaitedFor()) {
            if (!stillWaiting)
                return false;
            stillWaiting = theCondition.awaitUntil(deadline);
        }
        // ...
    } finally {
        lock.unlock();
    }
}

参数: deadline - 等待的绝对时间。

返回: 如果返回时已经超过最后期限,则为 false,否则为 true。

@throws InterruptedException - 如果当前线程被中断(并且支持线程挂起的中断)

/**
 * 实现绝对超时时间的条件等待。
 * 1. 如果当前线程被中断,抛出 InterruptedException。
 * 2. 保存 getState 返回的锁状态。
 * 3. 使用保存状态作为参数调用 release,如果失败抛出 IllegalMonitorStateException。
 * 4. 线程入队阻塞,直到 signal、线程中断或超时。
 * 5. 通过使用保存状态作为参数调用特定的 acquire 方法来重新加锁。
 * 6. 如果在步骤 4 中被阻塞过程中被其他线程中断,则抛出 IntrrputedException。
 * 7. 如果在步骤 4 中被阻塞过程中超时,则返回 false,否则返回 true。
 */
public final boolean awaitUntil(Date deadline)
        throws InterruptedException {
    // 获取绝对时间的时间戳
    long abstime = deadline.getTime();
    if (Thread.interrupted())
        throw new InterruptedException();
    // 当前线程加入添加条件队列
    Node node = addConditionWaiter();
    // 释放 AQS 的全部资源
    int savedState = fullyRelease(node);
    boolean timedout = false;
    int interruptMode = 0;
    // 阻塞直到超时,或中断抛出异常、或同步入队成功
    while (!isOnSyncQueue(node)) {
        // 判断当前循环是否超时
        if (System.currentTimeMillis() > abstime) {
            // 取消条件等待,跳出循环
            timedout = transferAfterCancelledWait(node);
            break;
        }
        // 阻塞
        LockSupport.parkUntil(this, abstime);
        // 中断则跳出循环
        if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
            break;
    }
    // 节点在超时、中断、或 signal 出队后,会加入同步队列,这里在同步队列操作
    if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
        interruptMode = REINTERRUPT;
    if (node.nextWaiter != null)
        unlinkCancelledWaiters();
    if (interruptMode != 0)
        reportInterruptAfterWait(interruptMode);
    return !timedout;
}

5.4.4 await(long time, TimeUnit unit)

使当前线程等待,直到它被 signal 或 中断,或者达到指定的等待时间。此方法在行为上等效于:awaitNanos(unit.toNanos(time)) > 0 。

/**
 * 实现超时条件等待。
 * 1. 如果当前线程被中断,抛出 InterruptedException。
 * 2. 保存 getState 返回的锁状态。
 * 3. 使用保存状态作为参数调用 release,如果失败抛出 IllegalMonitorStateException。
 * 4. 线程入队阻塞,直到 signal、线程中断或超时。
 * 5. 通过使用保存状态作为参数调用特定的 acquire 方法来重新加锁。
 * 6. 如果在步骤 4 中被阻塞过程中被其他线程中断,则抛出 IntrrputedException。
 * 7. 如果在步骤 4 中被阻塞过程中超时,则返回 false,否则返回 true。
 */
public final boolean await(long time, TimeUnit unit)
        throws InterruptedException {
    // 转为纳秒书剑
    long nanosTimeout = unit.toNanos(time);
    // 判断线程中断,并清空状态,中断则抛出异常
    if (Thread.interrupted())
        throw new InterruptedException();
    // 当前线程加入添加条件队列
    Node node = addConditionWaiter();
    // 释放所有 AQS 资源
    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;
}

七、AQS 中的 cancelAcquire

当节点在下列几种状态时,会触发 AQS 进行 cancelAcquire 操作,具体如下:

  • 节点在队列自旋 acquire 过程中触发异常,如 acquireQueue、doAcquireShared 等方法;
  • 节点在队列自旋 acquire 过程中触发线程中断,如 doAcquireInterruptibly、doAcquireNanos 、doAcquireSharedInterruptibly、doAcquireSharedNanos 等方法
  • 节点在带有超时参数的 acquire 变体方法调用中,到达超时时间,且未成功 acquire,如 doAcquireNanos 、doAcquireSharedNanos 等方法。

总的来说,当线程在 acquire 过程中触发各种异常,或带超时的接口调用触发超时时,就会在 finally 中调用 cancelAcquire 方法,用于取消该节点,将该节点从队列中移除。

/**
* 取消正在进行尝试的 acquire。
*
* 参数:node - 节点
*/
private void cancelAcquire(Node node) {
    // 当前节点不存在,直接忽略
    if (node == null)
        return;
	// 将当前节点持有的线程置空,释放资源
    node.thread = null;

    // 跳过取消的前驱节点,将当前节点的前驱节点和 pred 指向一个未被 CANCELLED 的节点
    Node pred = node.prev;
    // 从当前节点到找到节点之前,都为 CANCELLED 节点,全部需要断开
    // 此后,当前节点的前驱节点为非 CANCELLED 节点
    while (pred.waitStatus > 0)
        node.prev = pred = pred.prev;

    // 很明显 predNext 是要断开链接的节点。如果不是,下面 CAS 将失败,
    // 在这种情况下,我们可能在竞争中输给了另一个 cancel 或 signal,
    // 我们不需要采取其他行动。
    Node predNext = pred.next;

    // 可以在这里使用无条件写入,而不是 CAS 操作。
    // 在这个原子步骤之后,其他节点可以跳过我们。
    // 在此之前,我们不受其他线程影响。
    // 将当前节点状态设置为 CANCELLED
    node.waitStatus = Node.CANCELLED;

    // 如果当前节点为 tail,直接移除当前节点,将 tail 置为 pred(当前节点的前驱节点,非CANCELLED)
    if (node == tail && compareAndSetTail(node, pred)) {
        compareAndSetNext(pred, predNext, null);
    } else {
        // 当前节点的前驱节点非 head,需要将当前节点从同步队列中移除
        int ws;
        if (pred != head &&
                // 前驱节点状态为 SIGNAL
                ((ws = pred.waitStatus) == Node.SIGNAL ||
                        // 前驱节点状态为 0,将其置为 SIGNAL
                        (ws <= 0 && compareAndSetWaitStatus(pred, ws, Node.SIGNAL))) &&
                pred.thread != null) {
            Node next = node.next;
            // 将当前节点从队列移除,即将 pred 节点(当前节点的前驱节点)的 next 指向当前节点的后继节点
            if (next != null && next.waitStatus <= 0)
                compareAndSetNext(pred, predNext, next);
        } else {
            // 当前节点的前驱节点为 head,则说明从 head 到 当前节点之间全部为 CANCELLED 节点,
            // 直接唤醒当前节点的后继节点
            unparkSuccessor(node);
        }

        // 断开当前节点引用
        node.next = node; // help GC
    }
}

八、AQS 的锁实现

AQS 作为同步器框架,其提供的基础的功能给并发组件,下面我们将根据 j.u.c 包内置的同步组件,来了解 AQS 的使用。

8.1 ReentrantLock

一种可重入的互斥 Lock,其基本行为和语义与使用 synchronized 方法和语句访问的隐式监视器锁相同,但具有扩展功能。

ReentrantLock 被上次成功锁定但尚未解锁的线程 持有。当锁不被另一个线程持有时,调用 lock 的线程将返回,并成功获取锁。如果当前线程已经持有锁,该方法将立即返回。这可以使用方isHeldByCurrentThread 和 getHoldCount 方法来检查。

此类的构造函数接受一个可选的 fair 番薯。当设置为 true 时,在竞争情况下,锁会优先授予给等待时间最长的线程的访问。否则,锁将无法保证获得顺序。如果在多线程情况下使用公平锁,可能会比非公平锁的吞吐量低(即,会更慢;通常情况下会慢得多),但在获得锁和确保不会出现线程饥饿的情况会有更好的效果。但是请注意,锁的公平性并不能保证线程调度的公平性。因此,使用公平锁的多线程中,可能会有单个线程连续多次获得它,而其他活动线程无法获得锁,因此也无法执行。另请注意,没有超时参数的 tryLock() 方法不遵守公平设置。如果锁可用,即使其他线程正在等待,他也会成功。

推荐的做法是在 lock 加锁之后立即调用try 块,最常见的用法如下:

class X {
    private final ReentrantLock lock = new ReentrantLock();
    // ...
    
    public void m() {
        lock.lock(); // block until condition holds
        try {
            // ... method body
        } finally {
            lock.unlock();
        }
    }
}

除了实现 Lock 接口之外,该类还定义了许多 public 和 protected 的方法来检查锁的状态。其中一些方法仅对 instrumentation 和 monitoring 有用。

此类的序列化与内置锁的行为方式相同:反序列化锁处于未锁定状态,无论其在序列化时的状态如何。

此锁最多支持同一线程的 2147483647 个递归锁。尝试超过此限制会导致锁定方法抛出 Error 。

8.1.1 Sync

ReentratLock 的抽象类 Sync 作为 AQS框架实现类,用于同步控制的基础。可用于实现公平锁和非公平锁。主要通过使用 AQS 的状态来表示持有锁的次数,当 AQS 状态为 0,说明当前可能没有其他线程持有锁,ReentrantLock的每次获取锁都会讲 AQS 状态加一。下面是 Sync 的源码:

/**
 * 此锁的同步控制的基础。下面分为公平和非公平版本。使用 AQS 状态来表示
 * 持有锁的次数。
 */
abstract static class Sync extends AbstractQueuedSynchronizer {
    private static final long serialVersionUID = -5179523762034025860L;

    /**
     * 执行 Lock.lock。抽象方法的原因主要是非公平版本提供快速路径。
     */
    abstract void lock();

    /**
     * 执行非公平的 tryLock。tryAcquire 在子类中实现,但两者都需要对
     * tryLock 方法进行非公平尝试。
     */
    final boolean nonfairTryAcquire(int acquires) {
        // 获取当前执行线程
        final Thread current = Thread.currentThread();
        // 获取 AQS 当前状态
        int c = getState();
        // 当前状态为 0,说明锁可能没有被其他线程获取
        if (c == 0) {
            // cas 尝试加锁,将 AQS 状态修改为 acquires,成功后直接返回
            if (compareAndSetState(0, acquires)) {
                // 设置当前线程为独占
                setExclusiveOwnerThread(current);
                return true;
            }
        }
        // 如果当前线程已经持有了锁,即当前线程就是独占锁的线程
        else if (current == getExclusiveOwnerThread()) {
            // 将状态直接加上 acquires
            int nextc = c + acquires;
            // 状态溢出
            if (nextc < 0) // overflow
                throw new Error("Maximum lock count exceeded");
            // 当前线程就是持有锁的线程,所以直接设置 AQS 状态
            setState(nextc);
            return true;
        }
        // 既不是独占线程,状态也不为 0,说明当前锁被其他线程持有
        return false;
    }

    /**
     * 释放资源操作
     */
    protected final boolean tryRelease(int releases) {
        // 计算释放后的状态值
        int c = getState() - releases;
        // 当前线程不是锁的持有者,抛出异常
        if (Thread.currentThread() != getExclusiveOwnerThread())
            throw new IllegalMonitorStateException();
        // 是否完全释放
        boolean free = false;
        // 释放后状态值为 0,说明当前线程已经完全释放资源
        // 如果不为 0,说明当前线程是重入操作的释放,还需要等执行完再次释放
        if (c == 0) {
            // 设置释放 flag
            free = true;
            // 取消当前线程的独占
            setExclusiveOwnerThread(null);
        }
        // 设置 AQS 状态值
        setState(c);
        return free;
    }

    /**
     * 当前线程是否是该独占锁的持有者
     */
    protected final boolean isHeldExclusively() {
        // 虽然我们通常必须在拥有锁之前读取状态值,但是我们不需要
        // 检查这样检查当前线程是否是持有者
        return getExclusiveOwnerThread() == Thread.currentThread();
    }

    /**
     * Condition 实例,用于和 Lock 一起使用
     */
    final ConditionObject newCondition() {
        return new ConditionObject();
    }

// 从外部类中集成的方法

    // 获取当前锁的独占线程
    final Thread getOwner() {
        return getState() == 0 ? null : getExclusiveOwnerThread();
    }

    // 获取当前 AQS 的状态值
    final int getHoldCount() {
        return isHeldExclusively() ? getState() : 0;
    }

    // 是否被锁定
    final boolean isLocked() {
        return getState() != 0;
    }

    /**
     * 从流中重构实例(即反序列化)。
     * 返回的实例为非锁定状态
     */
    private void readObject(java.io.ObjectInputStream s)
            throws java.io.IOException, ClassNotFoundException {
        s.defaultReadObject();
        setState(0); // reset to unlocked state
    }
}

8.1.2 公平锁和非公平锁

公平锁和非公平锁在源码的实现中,差异很小,唯一的区别是公平锁会在加锁时,判断在自己之前是否有其他线程在等待,只有当自己是头结点(等待时间最长),之后才会尝试加锁。下面我们通过源码来了解一下,以下是非公平锁的实现:

/**
 * Sync 对象的非公平锁
 */
static final class NonfairSync extends Sync {
    private static final long serialVersionUID = 7316153563782823691L;

    /**
     * 执行锁定操作。尝试直接修改 AQS 状态加锁(快速路径),失败时恢复正常 acquire。
     */
    final void lock() {
        // CAS 尝试直接加锁,成功后将当前线程设置为独占线程
        if (compareAndSetState(0, 1))
            setExclusiveOwnerThread(Thread.currentThread());
        else
            // CAS 操作失败,正常进行 acquire 操作 
            acquire(1);
    }

    /**
     * tryAcquire 进行加锁操作,实现自 AQS,调用 Sync 进行非公平 tryAcquire
     */
    protected final boolean tryAcquire(int acquires) {
        return nonfairTryAcquire(acquires);
    }
}

下面是公平锁的实现:

/**
 * Sync 对象的公平锁
 */
static final class FairSync extends Sync {
    private static final long serialVersionUID = -3000897897090466540L;

    // 公平锁,直接 acquire,不尝试快速路径
    final void lock() {
        acquire(1);
    }

    /**
     * tryAcquire 的公平锁版本。除非递归调用,或者在没有等待节点时是第一个,否则不应该具有访问锁权限。
     */
    protected final boolean tryAcquire(int acquires) {
        // 获取当前线程
        final Thread current = Thread.currentThread();
        // 获取 AQS 状态
        int c = getState();
        // 可能没有加锁
        if (c == 0) {
            // 先判断队列中是否有在自己之前的节点
            if (!hasQueuedPredecessors() &&
                    // 自己就是第一个节点,CAS 尝试加锁
                    compareAndSetState(0, acquires)) {
                // 设置独占
                setExclusiveOwnerThread(current);
                return true;
            }
        }
        else if (current == getExclusiveOwnerThread()) {
            int nextc = c + acquires;
            if (nextc < 0)
                throw new Error("Maximum lock count exceeded");
            setState(nextc);
            return true;
        }
        return false;
    }
}

可以看到,在 tryAcquire 时,公平锁会调用 hasQueuedPredecessors() 方法,先判断自己是否是头结点(头结点没有前驱节点),我们看下这个方法的源码:

/**
 * 查询是否有任何线程其他线程在队列中的等待时间大于当前线程。
 *
 * 调用此方法等效于(但是可能有更高效):
 * getFirstQueuedThread() != Thread.currentThread() &&
 * hasQueuedThreads()
 *
 * 请注意,由于中断和超时可能随时会发生,从而导致节点取消,因此返回 true 并不代表着
 * 某些其他线程会在当前线程之获取到锁。同样,由于队列为空,在此方法返回 false 时,
 * 另一个线程可能会在竞争中先入队成功。
 *
 * 本方法目的在于供公平同步器的使用,从而避免”闯入“。如果一个同步器的 tryAcquire 
 * 方法应该返回 false,并且他的 tryAcquireShared 方法应该返回一个负值,这个方法
 * 返回 true(除非是可重入的获取)。
 *
 * 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
 *   }
 * }
 *
 * @return 如果当前线程之前有一个排队线程,则为true ,如果当前线程位于队列的头部或队列为空,则为false
 * @since 1.7
 */
public final boolean hasQueuedPredecessors() {
    // 之所以这么做是因为 head 在 tail 之前被初始化,
    // 先 tail 后 head,h.next 操作一定能获取到值。
    // 如果按照先 h 再 t 的方式取值,可能会发生这样的情况:
    // 此时队列为空 head 为 null,在 h 赋值完成后,其他线程
    // 入队,此时 head 和 tail 都不为空,就造成了 h 不存在,
    // 但是 t 却存在的情况。这种情况 h.next 就会抛出空指针了
    Node t = tail; // 以相反的顺序读取字段
    Node h = head;
    Node s;
    return h != t &&
            ((s = h.next) == null || s.thread != Thread.currentThread());
}

8.1.3 ReentrantLock 类的其他方法

除了核心的加锁和解锁方法外,ReentrantLock 还提供了其他的一些监控手段的方法,如下说明:

public class ReentrantLock implements Lock, java.io.Serializable {
    private static final long serialVersionUID = 7373984872572414699L;
    /** 提供实现所有机制的同步器 */
    private final Sync sync;

    /**
     * 创建 ReentrantLock 的实例。这相当于 ReentrantLock(false)。
     */
    public ReentrantLock() {
        sync = new NonfairSync();
    }

    /**
     * 使用给定的公平策略创建 ReentrantLock 实例。
     *
     * 参数:fair - 如果当前锁应该使用公平排序策略,则为 true
     */
    public ReentrantLock(boolean fair) {
        sync = fair ? new FairSync() : new NonfairSync();
    }

    /**
     * 获取锁。
     *
     * 如果没有被另一个线程持有,则获取锁并立即返回,将锁持有计数设置为 1。
     *
     * 如果当前线程已经持有锁,则持有次数加 1 并立即返回。
     *
     * 如果锁被另一个线程持有,那么当前线程出于线程调度的目的,将会被禁用并处于休眠状态,
     * 直到当前线程获得锁为止,此时锁持有计数设置为 1.
     */
     public void lock() {
         sync.lock();
     }

    /**
     * 除非当前线程被中断,否则一直 acquire 直到获取锁。
     *
     * 如果没有被另一个线程持有,则获取锁并立即返回,将锁持有计数设置为 1。
     *
     * 如果当前线程已经持有锁,则持有次数加 1 并立即返回。
     *
     * 如果锁被另一个线程持有,那么当前线程出于线程调度的目的,将会被禁用并处于休眠状态,
     * 直到发生以下两种情况之一:
     * - 当前线程获取锁成功;或者
     * - 其他线程中断当前线程。
     *
     * 如果当前线程获取到了锁,则锁持有计数设置为 1。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 在获取锁过程中被中断,
     * 然后会抛出 InterruptedException 并清除当前线程的中断状态。
     *
     * 在此实现中,由于此方法明显表示出中断能力,因此优先响应中断而不是
     * 正常执行或可重入获取锁。
     *
     * @throws InterruptedException - 如果当前线程被中断
     */
    public void lockInterruptibly() throws InterruptedException {
        sync.acquireInterruptibly(1);
    }

    /**
     * 仅当调用时没有另一个线程持有时才获取锁。
     *
     * 如果锁没有被另一个线程持有,则获取锁,并立即返回 true,将锁持有计数设置为 1。
     * 即使此锁已设置为使用公平排队策略,调用 tryLock() 也会立即获取锁(如果可用),
     * 无论其他线程当前是否正在等待该锁。这种 “闯入” 行为在某些情况下可能很有用,
     * 即使它破坏了公平性。如果您想完全遵循公平设置,请使用几乎等效的 tryLock(9, TimeUnit.SECONDS)
     * (它也检测中断)。
     *
     * 如果当前线程已经持有了锁,那么持有计数加 1 并返回 true。
     * 
     * 如果锁被其他线程持有,则此方法立即返回 false。
     *
     * 返回:如果锁空闲并被当前线程获取成功,或锁已经被当前线程持有,则返回 true,否则返回 false。
     */
    public boolean tryLock() {
        return sync.nonfairTryAcquire(1);
    }

    /**
     * 如果在给定的等待时间内没有被其他线程持有锁,且当前线程没有被中断,则获取锁。
     *
     * 如果锁没有被另一个线程持有,则获取锁,并立即返回 true,且会将锁持有的计数设置为 1。如果
     * 此锁已设置为使用公平排序策略,则在该线程之前排队任何其他线程正在等待该锁,则不会获取到锁。
     * 这与 tryLock() 方法形成对比。如果你想要一个允许 “闯入” 公平锁的可超时 tryLock,则可以
     * 将超时和非超时方法相结合使用:
     *
     * if (lock.tryLock() ||
     *     lock.tryLock(timeout, unit)) {
     *     ...
     * }
     *
     *
     * 如果没有被另一个线程持有,则获取锁并立即返回,将锁持有计数设置为 1。
     *
     * 如果当前线程已经持有锁,则持有次数加 1 并立即返回。
     *
     * 如果锁被另一个线程持有,那么当前线程出于线程调度的目的,将会被禁用并处于休眠状态,
     * 直到发生以下三种情况之一:
     * - 当前线程获取锁成功;或者
     * - 其他线程中断当前线程;或者
     * - 达到了指定的超时等待时间。
     *
     * 如果当前线程获取到了锁,则锁持有计数设置为 1。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 在获取锁过程中被中断,
     * 然后会抛出 InterruptedException 并清除当前线程的中断状态。
     *
     * 如果到达了指定的超时时间,则返回 false。如果时间小于或等于零,则该方法不会等待。
     *
     * 在此实现中,由于此方法明显表示出中断能力,因此优先响应中断而不是
     * 正常执行或可重入获取锁,同时也优先于报告超过等待时间。
     *
     *
     * 参数:timeout - 等待锁的时间
     *      unit - timeout 参数的时间单位
     * 返回:如果锁是空闲的并被当前线程获取到,或者锁已经被当前线程持有,则返回true;
     *      如果在获得锁之前达到了超时时间,则返回 false
     * @throws InterruptedException - 如果当前线程被中断
     * @throws NullPointerException - 如果时间单位为空
     */
    public boolean tryLock(long timeout, TimeUnit unit)
            throws InterruptedException {
        return sync.tryAcquireNanos(1, unit.toNanos(timeout));
    }

    /**
     * 尝试释放此锁。
     *
     * 如果当前线程是这个锁的持有者,那么持有计数就会递减。如果持有计数现在为 0,则直接释放锁。
     * 如果当前线程不是该锁的持有者,则抛出 IllegalMonitorStateException。
     *
     * @throws IllegalMonitorStateException - 如果当前线程没有持有这个锁。
     */
    public void unlock() {
        sync.release(1);
    }

    /**
     * 返回与当前 Lock 实例一起使用的 Condition 实例。
     *
     * 当与内置的监视器锁一起使用时,返回的 Condition 实例支持与 Object 监视器方法
     * (wait、notify 和 notifyAll) 相同的用法。
     *
     * - 如果在调用任何 Condition 的 await 和 signal 方法时,未持有锁,则会引发 
     *   IllegalMonitorStateException。
     * - 当 Condition 的 await 方法被调用时,锁被释放,在该线程返回前,锁会被其他线程
     *   重新获得,锁持有计数会恢复到调用方法时的状态。
     * - 如果线程在等待过程中被中断,则等待终止,并抛出 InterruptedException,并清除
     *   线程的中断状态。
     * - 以 FIFO 顺序 signal 等待线程。
     * - 从 await 方法返回的线程重新获取锁的顺序与最初获取锁的线程顺序相同,在默认情况下,
     *   非公平锁,未指定顺序;但对于公平锁,优先考虑那些等待时间长的线程。
     *
     * 返回:Condition 对象
     */
    public Condition newCondition() {
        return sync.newCondition();
    }

    /**
     * 查询当前线程持有该锁的次数。
     *
     * 如果解锁的次数和加锁的次数不匹配,那么该线程会持有该锁。
     *
     * 持有计数信息通常仅用于测试和调试目的。例如,如果某段代码不应该在已经持有锁的情况下输入,
     * 那么我们可以断言这个事实:
     * 
     * class X {
     *     ReentrantLock lock = new ReentrantLock();
     *     // ...
     *     public void m() {
     *         assert lock.getHoldCount() == 0;
     *         lock.lock();
     *         try {
     *             // ... method body
     *         } finally {
     *             lock.unlock();
     *         }
     *     }
     * }
     *
     * 返回:当前线程持有锁的次数,如果当前线程未持有锁,则为零
     */
    public int getHoldCount() {
        return sync.getHoldCount();
    }

    /**
     * 查询当前线程是否持有该锁。
     *
     * 类似于内置监视器锁的 Thread.holdsLock(Object) 方法,此方法通常用于调试和测试。
     * 例如,如果一个线程只有在持有锁时,才调用该方法,可以这样断言:
     *
     * class X{
     *     ReentrantLock lock = new ReentrantLock();
     *     // ...
     *     
     *     public void m(){
     *         assert lock.isHeldByCurrentThread();
     *         // ... method body
     *     }
     * }
     *
     * 它还可以用于确保以不可重入方式使用可重入锁,例如:
     *
     * class X{
     *     ReentrantLock lock = new ReentrantLock();
     *     // ...
     *     
     *     public void m(){
     *         assert !lock.isHeldByCurrentThread();
     *         lock.lock();
     *         try {
     *             // ... method body
     *         } finally {
     *             lock.unlock;
     *         }
     *     }
     * }
     *
     * 返回:如果当前线程持有该锁,返回 true;否则返回 false
     */
    public boolean isHeldByCurrentThread() {
        return sync.isHeldExclusively();
    }

    /**
     * 查询当前锁是否被持有。此方法设计用于监控系统状态,而不用于同步控制。
     *
     * 返回:任何线程持有此锁,返回 true;否则返回 false。
     */
    public boolean isLocked() {
        return sync.isLocked();
    }

    /**
     * 如果此锁的公平性设置为 true,则返回 true。
     *
     * 返回:如果此锁的公平性设置为 true,则返回 true。
     */
    public final boolean isFair() {
        return sync instanceof FairSync;
    }

    /**
     * 返回拥有此锁的线程,如果锁没有被持有,返回 null。如果当前线程不是锁的持有者,
     * 调用此方法会返回当前锁定状态的近似值。例如,即使有线程在尝试获取锁,但还没有
     * 获取成功,所有者也可能暂时为 null。此方法主要目的在于促进提供更广泛的锁监视
     * 设施的子类的构建。
     *
     * 返回:锁的持有者,如果没有,返回 null。
     */
    protected Thread getOwner() {
        return sync.getOwner();
    }

    /**
     * 查询是否有线程正在等待获取此锁。请注意,由于取消可能随时发生,因此返回 true,
     * 并不意味着其他线程就会获取锁。此方法主要设计用于监控系统状态。
     *
     * 返回:如果可能有其他线程等待获取锁,则为true。
     */
    public final boolean hasQueuedThreads() {
        return sync.hasQueuedThreads();
    }

    /**
     * 查询给定线程是否正在等待获取此锁。请注意,由于取消可能随时发生,因此返回 true,
     * 并不意味着该线程就会获取锁。此方法主要设计用于监控系统状态。
     *
     * 参数:thread - 线程
     * 返回:如果给定线程可能等待获取锁,则为true。
     * @throws NullPointerException thread 为 null
     */
    public final boolean hasQueuedThread(Thread thread) {
        return sync.isQueued(thread);
    }

    /**
     * 返回等待获取该锁的线程数的近似值。该值为一个预估值,因为在该方法遍历内部
     * 数据结构时,线程数可能会动态发生变化。此方法主要设计用于监控系统状态,而不
     * 是用于同步控制。
     *
     * 返回:等待此锁的预估线程数
     */
    public final int getQueueLength() {
        return sync.getQueueLength();
    }

    /**
     * 返回一个集合,其中包含正在等待获取此锁的线程。因为在构造这个结果时,实际的
     * 线程集合可能会动态变化,所以返回的集合只是预估值。返回集合的元素没有特定顺序。
     * 此方法主要目的在于促进提供更广泛的锁监视设施的子类的构建。
     *
     * 返回:线程集合。
     */
    protected Collection<Thread> getQueuedThreads() {
        return sync.getQueuedThreads();
    }

    /**
     * 查询是否有线程正在等待与当前锁关联的 Condition。请注意,
     * 由于超时和中断可能随时发生,因此返回 true,并不意味着将来 signal 无法唤醒等待线程。
     * 此方法主要设计用于监控系统状态。
     * 
     * 参数:condition - condition
     * 返回:如果有任何等待线程,返回 true
     * @throws IllegalMonitorStateException - 如果没有持有这个锁
     * @throws IllegalArgumentException - 如果给定条件与此锁没有关联
     * @throws NullPointerException - condition 为 null
     */
    public boolean hasWaiters(Condition condition) {
        if (condition == null)
            throw new NullPointerException();
        if (!(condition instanceof AbstractQueuedSynchronizer.ConditionObject))
            throw new IllegalArgumentException("not owner");
        // 判断当前 condition 是否存在等待节点
        return sync.hasWaiters((AbstractQueuedSynchronizer.ConditionObject)condition);
    }

    /**
     * 返回等待与当前锁关联的给定 condtion 的线程数的估计值。请注意,
     * 由于超时和中断可能随时发生,因此此值进作为实际等待节点的上限。
     * 此方法主要设计用于监控系统状态,不用来做同步控制。
     * 
     * 参数:condition - condition
     * 返回:预估的等待线程数
     * @throws IllegalMonitorStateException - 如果没有持有这个锁
     * @throws IllegalArgumentException - 如果给定条件与此锁没有关联
     * @throws NullPointerException - condition 为 null
     */
    public int getWaitQueueLength(Condition condition) {
        if (condition == null)
            throw new NullPointerException();
        if (!(condition instanceof AbstractQueuedSynchronizer.ConditionObject))
            throw new IllegalArgumentException("not owner");
        return sync.getWaitQueueLength((AbstractQueuedSynchronizer.ConditionObject)condition);
    }

    /**
     * 返回线程集合,其中包含可能正在等待与此锁相关联的指定 condition 的线程。因为在
     * 构造这个结果时,实际的线程集合可能会动态变化,所以该集合返回的只是一个近似值。
     * 返回集合的元素没有特定顺序。此方法主要目的在于促进提供更广泛的锁监视设施的子类的构建。
     *
     * 参数:condition - condition
     * 返回:线程集合
     * @throws IllegalMonitorStateException - 如果没有持有这个锁
     * @throws IllegalArgumentException - 如果给定条件与此锁没有关联
     * @throws NullPointerException - condition 为 null
     */
    protected Collection<Thread> getWaitingThreads(Condition condition) {
        if (condition == null)
            throw new NullPointerException();
        if (!(condition instanceof AbstractQueuedSynchronizer.ConditionObject))
            throw new IllegalArgumentException("not owner");
        return sync.getWaitingThreads((AbstractQueuedSynchronizer.ConditionObject)condition);
    }

    /**
     * 返回标识此锁的字符串及其锁状态。。括号中的状态包括字符串 "Unlocked" 或字符串
     * "Locked by" 后跟拥有锁的线程的名称。
     *
     * 返回:一个标识这个锁的字符串,以及它的锁状态
     */
    public String toString() {
        Thread o = sync.getOwner();
        return super.toString() + ((o == null) ?
                                   "[Unlocked]" :
                                   "[Locked by thread " + o.getName() + "]");
    }
}

8.2 ReentantReadWriteLock

该锁实现了 ReadWriteLock 接口,并支持和 ReentrantLock 相似的语义。

此类具有以下属性:

  • 顺序加锁

    此类不会为读锁和写锁的访问强加优先级顺序。但是,它支持可选的 公平 策略。

    • 非公平模式(默认)

      当构造非公平(默认)锁时,进入读写锁的顺序是未指定的,并受到重入的约束。一直存在竞争的非公平锁可能会无限期地推迟一个或多个读锁或写锁线程,但通常比公平锁具有更高的吞吐量。

    • 公平模式

      当构造为公平锁时,线程使用近似到达顺序策略竞争入队。如果当前持有的锁被释放,要么为等待时间最长的单个写入线程分配写锁,要么如果有一组读取线程等待时间比写入线程长,则为读取线程分配读锁。

      如果持有写锁或存在等待写入线程,则尝试获取公平锁(不可重入)的线程将阻塞。直到当前等待时间最长的写入线程获得写锁并释放之后,该线程才会获得读锁。当然,在没有线程获取写锁的情况下,如果一个等待的写入线程放弃等待,剩下的一个或多个读取线程将作为队列中等待时间最长的,被分配读锁。

      除非读锁和写锁都空闲(这意味着没有等待的线程),否则试图获取公平写锁(不可重入)的线程将阻塞。(请注意,非阻塞 ReentrantReadWriteLock.ReadLock.tryLock() 和 ReentrantReadWriteLock.WriteLock.tryLock() 方法不遵守此公平设置,如果可能,将立即获取锁,而不管等待线程。)

  • 重入

    此锁允许读取线程和写入线程以 ReentrantLock 一样的方式重新获取读锁或写锁。在写入线程持有的所有写锁都被释放之前,不允许非重入的读取线程。

    此外,写入线程可以获取读锁,但反之则不行。在其他应用程序中,当对在读锁下执行读取操作的方法在调用或回调期间持有写锁时,可重入性可能很有用。如果一个读取线程试图获得写锁,它将永远不会成功。

  • 锁降级

    重入还允许从写锁降级为读锁,方法是获取写锁,然后获取读锁,然后释放写锁。但是,无法 从读锁升级为写锁。

  • 锁获取中断

    读锁和写锁都支持获取锁过程中的中断。

  • Condition 支持

    写锁提供了一个 Condition 实现,就写锁而言,它的行为方式与 ReentrantLock.newCondition 提供的实现的行为方式相同。当然,这个 Condition 只能与写锁一起使用。读锁不支持 Condition 并且 readLock().newCondition() 抛出 UnsupportedOperationException。

  • Instrumentation

    此类支持确定锁是否被持有或竞争的方法。这些方法是为监控系统状态而设计的,而不是为同步控制而设计的。

此类的序列化与内置锁的行为方式相同:反序列化锁将处于未锁定状态,无论其在序列化时的状态如何。

示例用法。这是一个代码草图,展示了如果在更新缓存后执行锁降级(以非嵌套方式处理多个锁时,异常处理特别棘手):

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

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

ReentrantReadWriteLock 可以用于在某些集合的某些用途中提高并发性能。通常,只有当集合预计很大、被很多线程读取,但对写入很少时,并且开销要超过同步开销的操作时,才值得这么做。例如,这里有一个使用 TreeMap 的类,该类预计会很大,并且可以并发访问。

class RWDictionary {
    private final Map<String, Data> m = new TreeMap<String, Data>();
    private final ReentrantReadWriteLock rwl = new ReentrantReadWriteLock();
    private final Lock r = rwl.readLock();
    private final Lock w = rwl.writeLock();

    public Data get(String key) {
        r.lock();
        try {
            return m.get(key);
        } finally {
            r.unlock();
        }
    }

    public String[] allKeys() {
        r.lock();
        try {
            return m.keySet().toArray();
        } finally {
            r.unlock();
        }
    }

    public Data put(String key, Data value) {
        w.lock();
        try {
            return m.put(key, value);
        } finally {
            w.unlock();
        }
    }

    public void clear() {
        w.lock();
        try {
            m.clear();
        } finally {
            w.unlock();
        }
    }
}

实现注意事项

该锁最多支持 65535 个重入写锁和 65535 个读锁。如果超出这些限制会导致 lock 方法引发 Error。

8.2.1 Sync

和 ReentrantLock 相似,在 ReentrantReadWriteLock 类中同样有基于 AQS 框架实现的内部类 Sync。

/**
 * ReentrantReadWriteLock 的同步实现。
 * 分为公平和非公平版本。
 */
abstract static class Sync extends AbstractQueuedSynchronizer {
    private static final long serialVersionUID = 6317671515068378041L;

    /*
     * 读锁和写锁计数提取常量和函数。
     * 锁的状态在逻辑上分为两个无符号 short:
     * 较低的表示独占(写锁)锁持有计数,
     * 较高的表示共享(读锁)锁持有计数。
     */

    // 共享锁(读锁)的偏移量
    static final int SHARED_SHIFT   = 16;
    /**
     * 我们每次在进行读锁数量增加 +1 时,只需直接将 SHARED_UNIT 加上 state 即可。
     * 举个例子,在十进制中,如果我们只有四位,读锁只能操作高位的2个数字,写锁只能操作
     * 低位的两个数字,那么如果想要让读锁加一,那我们就需要加上 100,此时数字就是 01 | 00。
     * 如果我们还想要再次加一,此时同样是加上 100,就是 02 | 00,这样就实现了读锁加一的效果,
     * 而写锁,只需要直接加一即可。而这个 100 其实就是我们位数的偏移量,100 就是 1 左移 2 位即可,
     * 因为写锁占了低位,所以我们要偏移后,这个 SHARED_UNIT 就是我们每次增减的值。
     */
    static final int SHARED_UNIT    = (1 << SHARED_SHIFT);
    // 读/写锁的最大数量,为什么减一,以上面的例子来说,两位只能是 00 ~ 99,
    // 也就是 1 << SJARED_SHIFT - 1,因为再加的话,就溢出到高位了
    static final int MAX_COUNT      = (1 << SHARED_SHIFT) - 1;
    // 低 16 位全部为 1,高 16 位全部是 0,当我们想要计算独占锁(读锁,占低 16 位)
    // 的数量时(因为可能会有重入),将 state & EXCLUSIVE_MARK,进行 & 操作,
    // (都为 1 才保留,其余全部为 0),高位数字会被清掉,所以就计算出了低 16 位.
    // 也就是写锁的数量
    static final int EXCLUSIVE_MASK = (1 << SHARED_SHIFT) - 1;

    /** 返回读锁的数量  */
    static int sharedCount(int c)    { return c >>> SHARED_SHIFT; }
    /** 返回写锁的数量  */
    static int exclusiveCount(int c) { return c & EXCLUSIVE_MASK; }

    /**
     * 每个线程的读锁持有数量,维护为 ThreadLocal,缓存在 cachedHoldCounter
     */
    static final class HoldCounter {
        int count = 0;
        // 使用线程 id,而不是引用,避免垃圾滞留
        final long tid = getThreadId(Thread.currentThread());
    }

    /**
     * ThreadLocal 子类,为了反序列化,使用最简单明确的定义。
     */
    static final class ThreadLocalHoldCounter
        extends ThreadLocal<HoldCounter> {
        public HoldCounter initialValue() {
            return new HoldCounter();
        }
    }

    /**
     * 当前线程持有的可重入读锁数量。仅在构造函数和 readObject 中初始化。
     * 每当线程的读取计数减为 0 时删除。
     */
    private transient ThreadLocalHoldCounter readHolds;

    /**
     * 最后一个线程成功获取 readLock 的持有计数。这节省了 ThreadLocal
     * 查找,在通常情况下,下一个要 release 的线程是最后一个 acquire 的线程。
     * 这是非 volatile 的,因为它只是作为一种试探,对线程进行缓存有利。
     *
     * 该读取计数缓存的生命周期可能比线程更长,因为内部使用线程 id,而不是
     * 线程引用,来避免垃圾回收保留。
     *
     * 通过良性数据竞争访问;依赖于内存模型的 final 字段和 out-of-thin-air 的保证。
     */
    private transient HoldCounter cachedHoldCounter;

    /**
     * firstReader 是第一个获得读锁的线程。firstReaderHoldCount 是 first
     * 的持有计数。
     *
     * 更准确的说,firstReader 是最后一次将共享计数从 0 改为 1 的唯一线程,
     * 此后一直没有释放读锁;如果没有这样的线程,则为 null。
     *
     * 除非线程在没有放弃读锁的情况下终止,否则不会导致垃圾保留,因为 tryReleaseShared
     * 会将其设置为 null。
     *
     * 通过良性数据竞争访问;依赖于内存模型对引用的 out-of-thin-air 保证。
     *
     * 这使得对非竞争读锁的持有计数保存跟踪非常简单。
     */
    private transient Thread firstReader = null;
    private transient int firstReaderHoldCount;

    Sync() {
        // 初始化读锁的持有计数 ThreadLocal
        readHolds = new ThreadLocalHoldCounter();
        setState(getState()); // 确保 readHolds 的内存可见性
    }

    /*
     * 公平锁和非公平锁使用相同的 acquires 和 releases 代码,但在队列非空时,
     * 它们在是否允许插入方面会有所不同。
     */

    /**
     * 该方法返回当前线程请求获得读锁是否应该被阻塞,在公平和非公平策略下实现不同。
     * 在公平锁中,如果队列中当前线程之前 有 其他线程排队,则返回 true,当在队列头部
     * 或者队列为空则返回 false。
     * 在非公平锁中,如果队列头部的等待节点是写入线程,则返回 true,避免写入线程无限等待;
     * 如果写入线程不在队头,则返回 false,不影响其他线程进行读取。
     */
    abstract boolean readerShouldBlock();

    /**
     * 返回当前线程请求获得写锁是否应该被阻塞,在公平锁中,行为和 reader 一样,都会检查在
     * 自己之前是否有其他线程排队;在非公平锁中,总是返回 false,不阻塞。
     */
    abstract boolean writerShouldBlock();

    /*
     * 注意 tryRelease 和 tryAcquire 可以被 Condition 调用。因此,
     * 它们的参数可能会是包含所有的读锁计数和写锁计数,在条件等待期间全部释放并
     * tryAcquire 重新建立读锁和写锁持有计数。
     */
    // 读锁释放
    protected final boolean tryRelease(int releases) {
        // 判断当前线程是否是独占线程
        if (!isHeldExclusively())
            throw new IllegalMonitorStateException();
        // 读锁模式下是单线程,计算释放后的值
        int nextc = getState() - releases;
        // 判断是否全部释放
        boolean free = exclusiveCount(nextc) == 0;
        if (free)
            // 清空独占线程
            setExclusiveOwnerThread(null);
        // 写入新的 state
        setState(nextc);
        return free;
    }

    // 读锁获取
    protected final boolean tryAcquire(int acquires) {
        /*
         * 步骤:
         * 1. 如果读锁计数不为 0 或写锁计数不为 0,且当前线程不是锁持有者,失败。
         * 2. 如果计数饱和(溢出),失败(只有在计数不为 0 时才会出现)。
         * 3. 否则,如果该线程是可重入加锁或队列策略允许(非公平锁可以抢占,
         * 即 writerShouldBlock 返回 false),则该线程有资格获取锁。如果是这样,
         * CAS更新状态并设置独占线程。
         */
        Thread current = Thread.currentThread();
        int c = getState();
        // 独占(写)锁数量
        int w = exclusiveCount(c);
        // c 不为零,即存在读锁或写锁被持有(也可能是自己)
        if (c != 0) {
            // (注意: 如果 c != 0 且 w == 0 那么共享(读)锁数量不为 0)
            // 如果 w == 0 说明读锁不为零,读锁有则加锁失败。
            // 如果 w == 0 没有满足,说明现在写锁不为零,判断当前线程是不是
            // 独占线程,如果是,则尝试重入,如果不是则失败
            if (w == 0 || current != getExclusiveOwnerThread())
                return false;
            // 独占线程重入,检查是否超过最大重入数量
            if (w + exclusiveCount(acquires) > MAX_COUNT)
                throw new Error("Maximum lock count exceeded");
            // 重入计数
            setState(c + acquires);
            return true;
        }
        // 判断当前写锁是否需要阻塞,如果需要阻塞,失败
        // 如果不需要阻塞,则 CAS 修改持有计数,加锁并设置独占线程
        if (writerShouldBlock() ||
                !compareAndSetState(c, c + acquires))
            return false;
        setExclusiveOwnerThread(current);
        return true;
    }

    // 共享(写)锁释放
    protected final boolean tryReleaseShared(int unused) {
        Thread current = Thread.currentThread();
        // 当前线程是否是 firstReader,在没有竞争的情况下,这个变量可以帮助我们
        // 更加简单快速的去确认读取所的持有数量
        if (firstReader == current) {
            // assert firstReaderHoldCount > 0;
            // 如果只有一个读取锁持有数量,直接释放锁,并将 firstReader 置空
            if (firstReaderHoldCount == 1)
                firstReader = null;
            else
                // 将持有数量 -1
                firstReaderHoldCount--;
        } else {
            // 如果不是当前线程,说明现在有多个线程持有读锁
            // 如果缓存是 null 或者 缓存线程不是当前线程,说明当前线程不是最后一次获取
            // 持有读锁的线程,则从 threadLocal 读取
            HoldCounter rh = cachedHoldCounter;
            if (rh == null || rh.tid != getThreadId(current))
                rh = readHolds.get();
            // 当前的读锁计数
            int count = rh.count;
            // 如果当前持有的读锁计数小于等于 1,直接删除 ThreadLocal 值
            if (count <= 1) {
                readHolds.remove();
                // 如果还没开始释放就 <= 0,这说明有逻辑问题,抛出异常
                if (count <= 0)
                    throw unmatchedUnlockException();
            }
            // 计数器减一
            --rh.count;
        }
        // 自旋 CAS 修改共享锁计数
        for (;;) {
            int c = getState();
            // c - SHARED_UNIT(共享锁的一个单元),也就是对高 16 位进行减一操作
            int nextc = c - SHARED_UNIT;
            if (compareAndSetState(c, nextc))
                // 释放读锁对写锁没有影响,但如果读锁和写锁都空闲(nextc 为 0),
                // 则表示可以唤醒后面等待的线程
                return nextc == 0;
        }
    }

    private IllegalMonitorStateException unmatchedUnlockException() {
        return new IllegalMonitorStateException(
                "attempt to unlock read lock, not locked by current thread");
    }

    // 共享(写)锁的获取
    protected final int tryAcquireShared(int unused) {
        /*
         * 步骤:
         * 1. 如果写锁被另一个线程持有,则失败。
         * 2. 否则,该线程有资格获得锁定状态,因此请询问它是否应该
         *    因为队列策略而阻塞。如果没有,请尝试通过 CAS 更新 state
         *    并更新计数。注意,该步骤不检查可重入 acquire,它被推迟
         *    在 fullTryAcquireShared 中,从而避免在更典型的
         *    不可重入的场景下,检查持有计数。
         * 3. 如果由于线程不符合条件或 CAS 失败或计数已经饱和,
         *    则步骤 2 失败,然后将会进行 fullTryAcquireShared 方法。
         */
        Thread current = Thread.currentThread();
        int c = getState();
        // 写锁数量不为 0,并且当前线程不为独占线程
        // 这一步就是我们进行锁降级时,持有写锁然后去获取读锁的基础
        if (exclusiveCount(c) != 0 &&
                getExclusiveOwnerThread() != current)
            return -1;
        // 获取读锁数量
        int r = sharedCount(c);
        // 判断读锁是否应该阻塞
        if (!readerShouldBlock() &&
                // 判断当前是否溢出
                r < MAX_COUNT &&
                // CAS 尝试加锁
                compareAndSetState(c, c + SHARED_UNIT)) {
            // 加锁成功后,判断是否是首个获取读锁的线程
            if (r == 0) {
                // 将 firstReader 和 firstReaderHoldCount 赋值
                firstReader = current;
                firstReaderHoldCount = 1;
              // 当前线程是否是首个获取读锁的线程重入了
            } else if (firstReader == current) {
                // 持有计数递增
                firstReaderHoldCount++;
            } else {
                // 非首个线程,判断自己是否是上次来访问 AQS 加锁的线程
                HoldCounter rh = cachedHoldCounter;
                // 当自己也不是上次加锁的线程,那只能从 threadLocal 中读取
                if (rh == null || rh.tid != getThreadId(current))
                    // 更新 rh 和 cachedHoldCounter,因为自己是最后一次获取
                    // 读锁成功的线程
                    cachedHoldCounter = rh = readHolds.get();
                else if (rh.count == 0)
                    // 读锁数量为零,说明是同一个线程之前全部释放后,再次加锁
                    // 由于当线程释放完后,会清空 threadLocal,但是并不会清理
                    // cachedHoldCounter,所以,当同一个线程释放完,再次过来
                    // 获取(中间没有其他线程过来加锁),那 cachedHoldCounter 持有的
                    // 计数是仍然存在的,所以只需要将计数重新放回 threadLocal 即可
                    readHolds.set(rh);
                // 持有计数递增
                rh.count++;
            }
            return 1;
        }
        // 需要阻塞,或读锁移除,或 CAS 失败
        return fullTryAcquireShared(current);
    }

    /**
     * 读锁进行 acquire 的完整版本,它处理 CAS 失败和在 tryAcquireShared
     * 中未处理的重入获取
     */
    final int fullTryAcquireShared(Thread current) {
        /*
         * 此代码与 tryAcquireShared 中的代码部分冗余,但总体上更简单,
         * 因为不会使 tryAcquireShared 与重试和延迟读取持有计数之间的交互
         * 复杂化。
         */
        HoldCounter rh = null;
        // 自旋加锁
        for (;;) {
            int c = getState();
            // 独占锁数量不为零,则判断当前线程是否是独占线程,非独占则失败
            if (exclusiveCount(c) != 0) {
                if (getExclusiveOwnerThread() != current)
                    return -1;
                // 否则我们持有独占锁;如果我们在持有写锁的情况下,在这里阻塞会导致死锁。
                // 所以我们直接放行
              
              // 下面判断没有线程持有写锁,排队的情况
            } else if (readerShouldBlock()) {
                // 在这里面说明我们获取 readLock 需要阻塞的,说明在我们之前可能有其他排队线程
                // 确保我们没有以可重入的方式获取读锁
                // 如果当前线程是已经获取过读锁,再次重入的,直接放行
                if (firstReader == current) {
                    // assert firstReaderHoldCount > 0;
                } else {
                    // 到这里,我们不是首次获取读锁的
                    // 首次自旋 rh 是 null,那需要给 rh 赋值
                    if (rh == null) {
                        // 先给 rh 赋为 cachedHoldCounter,即假设我们是最后一个获取的
                        rh = cachedHoldCounter;
                        // 如果 rh 为空,或者 rh 的线程并不是自己,则从 threadLocal 查找
                        if (rh == null || rh.tid != getThreadId(current)) {
                            // 查找获取 threadLocal 的值,如果我们没有持有锁,是首次获取
                            // 那这一步会导致 threadLocal 实例化 HoldCounter,实例化后
                            // 的 count 为 0,由于我们需要阻塞,所以肯定是失败的,目的就是
                            // 检查我们是不是重入,重入的话就成功,失败需要把 threadLocal
                            // 值清理掉
                            rh = readHolds.get();
                            // threadLocal 中的持有计数,如果为空,则移除 threadLocal
                            if (rh.count == 0)
                                readHolds.remove();
                        }
                    }
                    // 如果我们没有持有锁,并且需要阻塞,则失败
                    if (rh.count == 0)
                        return -1;
                }
            }
            // 如果限制持有锁数量达到最大,则失败
            if (sharedCount(c) == MAX_COUNT)
                throw new Error("Maximum lock count exceeded");
            // CAS 尝试加写锁
            if (compareAndSetState(c, c + SHARED_UNIT)) {
                // 加锁成功,判断加锁前读锁数量是不是为 0,为 0 说明自己是第一个加锁的
                if (sharedCount(c) == 0) {
                    // 设置 firstReader 和 firstReaderHoldCount 主要为了提高性能
                    firstReader = current;
                    firstReaderHoldCount = 1;
                // 不为零,判断当前线是否是 firstReader 重入
                } else if (firstReader == current) {
                    // 持有计数增加
                    firstReaderHoldCount++;
                } else {
                    // 如果非 firstReader,则获取 threadLocal 值
                    if (rh == null)
                        // 先假设我们是最后一个加锁的
                        rh = cachedHoldCounter;
                    // 如果我们不是最后一个加锁的,则从 threadLocal 查找
                    if (rh == null || rh.tid != getThreadId(current))
                        rh = readHolds.get();
                    // 我们是最后一个加锁的,则设置一下 threadLocal,因为
                    // 随时会有其他线程在加锁成功后将 cachedHoldCounter 更新掉,
                    // 这时候我们的计数就丢失了
                    else if (rh.count == 0)
                        readHolds.set(rh);
                    // 增加持有读锁计数
                    rh.count++;
                    // 将自己更新为最后一个获取读锁的线程,缓存下来,提高性能
                    cachedHoldCounter = rh; // cache for release
                }
                return 1;
            }
        }
    }

    /**
     * 对写锁执行 tryLock,在两种策略(公平和非公平)下都会“闯入”。
     * 这在效果上与 tryAcquire 相同,只是缺少对 writeShouldBlock
     * 的调用。
     */
    final boolean tryWriteLock() {
        Thread current = Thread.currentThread();
        int c = getState();
        // 说明有线程持有读/写锁
        if (c != 0) {
            // 判断读锁数量是否为 0,为 0 说明有其他线程持有写锁,那我们肯定失败
            // 不为 0,则判断当前线程是否是重入,非重入,则直接失败
            int w = exclusiveCount(c);
            if (w == 0 || current != getExclusiveOwnerThread())
                return false;
            if (w == MAX_COUNT)
                throw new Error("Maximum lock count exceeded");
        }
        // CAS 加锁
        if (!compareAndSetState(c, c + 1))
            return false;
        // 成功后更新独占线程
        setExclusiveOwnerThread(current);
        return true;
    }

    /**
     * 对读锁执行 tryLock,在两种策略下都会“闯入”。这在效果上与 
     * tryAcquireShared 相同,只是缺少对 readerShouldBlock 的调用。
     */
    final boolean tryReadLock() {
        Thread current = Thread.currentThread();
        // 自旋尝试获取读锁
        for (;;) {
            int c = getState();
            // 独占锁数量不为空,并且当前线程不是独占线程,则直接失败
            if (exclusiveCount(c) != 0 &&
                    getExclusiveOwnerThread() != current)
                return false;
            // 获取写锁数量
            int r = sharedCount(c);
            // 判断写锁数量是否已满
            if (r == MAX_COUNT)
                throw new Error("Maximum lock count exceeded");
            // CAS 尝试加锁
            if (compareAndSetState(c, c + SHARED_UNIT)) {
                // 加锁成功,判断当前线程是不是首个获得读锁的
                if (r == 0) {
                    // 设置 firstReader 和 firstReaderCount
                    firstReader = current;
                    firstReaderHoldCount = 1;
                // 读锁不为空,看看当前线程是否是 firstReader 重入,是的话直接增加计数
                } else if (firstReader == current) {
                    firstReaderHoldCount++;
                } else {
                    // 先从缓存中找,如果不是,则从 threadLocal 找
                    HoldCounter rh = cachedHoldCounter;
                    if (rh == null || rh.tid != getThreadId(current))
                        cachedHoldCounter = rh = readHolds.get();
                    else if (rh.count == 0)
                        readHolds.set(rh);
                    // 计数
                    rh.count++;
                }
                return true;
            }
        }
    }

    // 是否是独占线程
    protected final boolean isHeldExclusively() {
        // While we must in general read state before owner,
        // we don't need to do so to check if current thread is owner
        return getExclusiveOwnerThread() == Thread.currentThread();
    }

    // Methods relayed to outer class

    // 获取 condition
    final ConditionObject newCondition() {
        return new ConditionObject();
    }

    // 获取独占线程
    final Thread getOwner() {
        // Must read state before owner to ensure memory consistency
        return ((exclusiveCount(getState()) == 0) ?
                null :
                getExclusiveOwnerThread());
    }

    // 获取读锁数量
    final int getReadLockCount() {
        return sharedCount(getState());
    }

    // 写锁是否被占有
    final boolean isWriteLocked() {
        return exclusiveCount(getState()) != 0;
    }

    // 获取当前线程持有的写锁数量
    final int getWriteHoldCount() {
        return isHeldExclusively() ? exclusiveCount(getState()) : 0;
    }

    // 获取当前线程持有读锁数量
    final int getReadHoldCount() {
        if (getReadLockCount() == 0)
            return 0;

        // 先从 firstReader 里面找
        Thread current = Thread.currentThread();
        if (firstReader == current)
            return firstReaderHoldCount;

        // 再从 cachedHoldCounter 找,没有则从 threadLocal 找
        HoldCounter rh = cachedHoldCounter;
        if (rh != null && rh.tid == getThreadId(current))
            return rh.count;

        int count = readHolds.get().count;
        if (count == 0) readHolds.remove();
        return count;
    }

    /**
     * 从流中读取对象(即反序列化)
     */
    private void readObject(java.io.ObjectInputStream s)
            throws java.io.IOException, ClassNotFoundException {
        s.defaultReadObject();
        readHolds = new ThreadLocalHoldCounter();
        setState(0); // reset to unlocked state
    }

    // 获取全部计数
    final int getCount() { return getState(); }
}

8.2.2 公平锁和非公平锁

非公平锁:

static final class NonfairSync extends Sync {
    private static final long serialVersionUID = -8159625535654395037L;
    final boolean writerShouldBlock() {
        return false; // 非公平锁写入不需要阻塞
    }
    // 
    final boolean readerShouldBlock() {
        /* 作为避免写入线程饿死的启发式方法,如果队列头部暂时显示为写入线程,则阻塞。
         * 这只是一种概率效应,引入如果在写入线程之前有其他读取线程没有超时,则
         * 读取线程不会阻塞。
         */
        // 判断队列头部线程是否是独占线程
        return apparentlyFirstQueuedIsExclusive();
    }
}

公平锁:

static final class FairSync extends Sync {
    private static final long serialVersionUID = -2274990926593161451L;
    final boolean writerShouldBlock() {
        return hasQueuedPredecessors();
    }
    final boolean readerShouldBlock() {
        return hasQueuedPredecessors();
    }
}

8.2.3 读锁和写锁

8.2.3.1 ReadLock
public static class ReadLock implements Lock, java.io.Serializable {
    private static final long serialVersionUID = -5992448646407690164L;
    private final Sync sync;

    /**
     * 子类使用的构造器
     *
     * 参数:lock - 外部锁对象
     * 参数:NullPointerException - 如果 lock 为空
     */
    protected ReadLock(ReentrantReadWriteLock lock) {
        sync = lock.sync;
    }

    /**
     * 获取读锁。
     *
     * 如果写锁没有被另一个线程持有,则获取读锁并立即返回。
     *
     * 如果写锁被另一个线程持有,那么当前线程处于调度目的将被禁用并处于休眠状态,
     * 直到获得读锁为止。
     */
    public void lock() {
        sync.acquireShared(1);
    }

    /**
     * 获取读锁,线程中断则终止。
     *
     * 如果写锁没有被另一个线程持有,则获取读锁并立即返回。
     *
     * 如果写锁被另一个线程持有,那么出于调度的目的,该线程将被禁用并
     * 进入休眠状态,直到发生以下两种状态之一:
     * - 该线程获取到读锁;或者
     * - 其他一些线程中断当前线程。
     *
     * 如果当前线程:
     * - 进入此方法时设置中断状态;或者
     * - 在线程获取读锁时被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     *
     * 在此实现中,由于此方法明显表示出中断能力,因此优先响应中断而不是
     * 正常执行或可重入获取锁。
     *
     * @throws InterruptedException - 如果当前线程被中断
     */
    public void lockInterruptibly() throws InterruptedException {
        sync.acquireSharedInterruptibly(1);
    }

    /**
     * 仅当调用时另一个线程未持有写锁时才获取锁。
     *
     * 如果写锁没有被另一个线程持有,则获取读锁,并返回 true。即使此锁已设置为
     * 使用公平排序策略,调用 tryLock() 将立即获取读锁(如果可用),无论其他
     * 线程当前是否正在等待。这种“闯入”行为在某些情况下可能很有用,即便它会破坏
     * 公平性。如果您想要要求此锁保证公平性设置,请使用与此几乎等效的 
     * tryLock(0, TimeUnit.SECONDS)(它也会检测线程中断)。
     *
     * 如果写锁被另一个线程持有,则此方法立即返回 false。
     *
     * 返回:如果获得了锁,则返回 true
     */
    public boolean tryLock() {
        return sync.tryReadLock();
    }

    /**
     * 如果在给定的等待时间内获取写锁没有超时、或当前线程没有中断,则获取读锁。
     *
     * 如果写锁没有被另一个线程持有,则获取读锁,并返回 true。如果此锁已设置为
     * 使用公平排序策略,则在此线程之前有任何其他线程等待锁,则不会获取锁。这与
     * tryLock() 方法形成对比。如果你想要一个允许 “闯入” 公平锁的可超时 tryLock
     * ,则可以将超时和非超时方法相结合使用:
     *
     * if (lock.tryLock() ||
     *     lock.tryLock(timeout, unit)) {
     *   ...
     * }
     *
     * 如果写锁被另一个线程持有,那么出于调度的目的,该线程将被禁用并
     * 进入休眠状态,直到发生以下三种状态之一:
     * - 该线程获取到读锁;或者
     * - 其他一些线程中断当前线程;或者
     * - 超过指定的等待时间。
     *
     * 如果当前线程:
     * - 进入此方法时设置中断状态;或者
     * - 在线程获取读锁时被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     *
     * 在此实现中,由于此方法明显表示出中断能力,因此优先响应中断而不是
     * 正常执行或可重入获取锁,以及报告等待超时。
     *
     * 参数:timeout - 等待读锁的时间
     *      unit - timeout 参数的时间单位
     * 返回:如果获得了读锁,则为 true
     * @throws InterruptedException - 如果当前线程被中断
     * @throws NullPointerException - 如果时间单位为空
     */
    public boolean tryLock(long timeout, TimeUnit unit)
            throws InterruptedException {
        return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
    }

    /**
     * 尝试释放此锁。
     *
     * 如果读锁的数量为零,则写锁可以尝试获取。
     */
    public void unlock() {
        sync.releaseShared(1);
    }

    /**
     * 抛出 UnsupportedOperationException,因为 ReadLock 不支持 Cindition。
     *
     * @throws UnsupportedOperationException 总是
     */
    public Condition newCondition() {
        throw new UnsupportedOperationException();
    }

    /**
     * 返回标识此锁的字符串及其锁状态。括号中的状态包括字符串"Read locks =" ,后跟持有的读锁数。
     *
     * 返回:一个标识这个锁的字符串,以及它的锁状态
     */
    public String toString() {
        int r = sync.getReadLockCount();
        return super.toString() +
                "[Read locks = " + r + "]";
    }
}
8.2.3.2 WriteLock
public static class WriteLock implements Lock, java.io.Serializable {
    private static final long serialVersionUID = -4992448646407690164L;
    private final Sync sync;

    /**
     * 子类使用的构造器
     *
     * 参数:lock - 外部锁对象
     * 参数:NullPointerException - 如果 lock 为空
     */
    protected WriteLock(ReentrantReadWriteLock lock) {
        sync = lock.sync;
    }

    /**
     * 获取写锁。
     * 
     * 如果其他线程既没有持有读锁也没有持有写锁,则获取写锁并立即返回,将写锁持有
     * 计数设置为 1。
     * 
     * 如果当前线程已经持有写锁,则持有计数加一并立即返回。
     *
     * 如果锁被另一个线程持有,那么当前线程处于调度目的将被禁用并处于休眠状态,
     * 直到获得写锁为止,此时写锁持有计数设置为 1。
     */
    public void lock() {
        sync.acquire(1);
    }

    /**
     * 获取写锁,线程中断则终止。
     *
     * 如果其他线程既没有持有读锁也没有持有写锁,则获取写锁并立即返回,
     * 将写锁持有计数设置为 1。
     *
     * 如果当前线程已经持有写锁,则持有计数加一并立即返回。
     *
     * 如果锁被另一个线程持有,那么出于调度的目的,该线程将被禁用并
     * 进入休眠状态,直到发生以下两种情况之一:
     * - 该线程获取到写锁;或者
     * - 其他一些线程中断当前线程。
     *
     * 如果当前线程获取到了写锁,则锁持有计数设置为 1。
     *
     * 如果当前线程:
     * - 进入此方法时设置中断状态;或者
     * - 在线程获取读锁时被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     *
     * 在此实现中,由于此方法明显表示出中断能力,因此优先响应中断而不是
     * 正常执行或可重入获取锁。
     *
     * @throws InterruptedException - 如果当前线程被中断
     */
    public void lockInterruptibly() throws InterruptedException {
        sync.acquireInterruptibly(1);
    }

    /**
     * 仅当调用时没有其他线程未持有锁时才获取写锁。
     *
     * 如果其他线程既没有持有读锁也没有持有写锁,则获取写锁并立即返回,将写锁持有
     * 计数设置为 1。即使此锁已设置为使用公平排序策略,调用 tryLock() 将立即获
     * 取该锁(如果可用),无论其他线程当前是否正在等待。这种“闯入”行为在某些情况
     * 下可能很有用,即便它会破坏公平性。如果您想要要求此锁保证公平性设置,请使用
     * 与此几乎等效的  tryLock(0, TimeUnit.SECONDS)(它也会检测线程中断)。
     *
     * 如果当前线程已经持有写锁,则持有计数加一并立即返回。
     * 
     * 如果锁被另一个线程持有,则此方法立即返回 false。
     *
     * 返回:如果获得了锁,则返回 true
     */
    public boolean tryLock( ) {
        return sync.tryWriteLock();
    }

    /**
     *
     * 如果在给定的等待时间内获取锁没有超时、或当前线程没有中断,则获取读锁。
     *
     * 如果其他线程既没有持有读锁也没有持有写锁,则获取写锁并立即返回,将写锁持有
     * 计数设置为 1。如果此锁已设置为使用公平排序策略,则在此线程之前有任何其他
     * 线程等待锁,则不会获取锁。这与 tryLock() 方法形成对比。如果你想要一个
     * 允许 “闯入” 公平锁的可超时 tryLock,则可以将超时和非超时方法相结合使用:
     *
     * if (lock.tryLock() ||
     *     lock.tryLock(timeout, unit)) {
     *   ...
     * }
     *
     * 如果当前线程已经持有写锁,则持有计数加一并立即返回。
     * 
     * 如果锁被另一个线程持有,那么出于调度的目的,该线程将被禁用并
     * 进入休眠状态,直到发生以下三种状态之一:
     * - 该线程获取到读锁;或者
     * - 其他一些线程中断当前线程;或者
     * - 超过指定的等待时间。
     *
     * 如果当前线程获取到了写锁,则锁持有计数设置为 1。
     *
     * 如果当前线程:
     * - 进入此方法时设置中断状态;或者
     * - 在线程获取读锁时被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     *
     * 在此实现中,由于此方法明显表示出中断能力,因此优先响应中断而不是
     * 正常执行或可重入获取锁,以及报告等待超时。
     *
     * 参数:timeout - 等待读锁的时间
     *      unit - timeout 参数的时间单位
     * 返回:如果获得了读锁,则为 true
     * @throws InterruptedException - 如果当前线程被中断
     * @throws NullPointerException - 如果时间单位为空
     */
    public boolean tryLock(long timeout, TimeUnit unit)
            throws InterruptedException {
        return sync.tryAcquireNanos(1, unit.toNanos(timeout));
    }

    /**
     * 尝试释放此锁。
     *
     * 如果当前线程是这个锁的持有者,那么持有计数就会递减。如果持有计数为零,
     * 则释放锁。如果当前线不是该锁的持有者,则抛出 IllegalMonitorStateException。
     *
     * @throws IllegalMonitorStateException - 如果当前线程没有持有该锁
     */
    public void unlock() {
        sync.release(1);
    }

    /**
     * 返回与此 Lock 实例一起使用的 Condition 实例。
     *
     * 当与内置监视器锁一起使用时,返回的 Condition 实例支持与 Object 监视器
     * 方法(wait、notify 和 notifyAll)相同的用法。
     *
     * - 如果在调用任何 Condition 方法时未持有此锁的写锁,则会抛出 
     *   IllegalMonitorStateException。(写锁和读锁持有是独立的,因此不会被
     *   检查或影响。但是,当前线程在持有写锁时,又获取读锁,同时调用条件等待方法本质上
     *   是错误的,因为其他可以解除阻塞的线程无法获取写锁。)
     * - 当 condition await 方法被调用时,写锁将被释放,在它们返回之前,写锁
     *   将被重新获得,所持有计数恢复到调用方法时的状态。
     * - 如果线程在等待过程中被中断,则等待将终止,将抛出 InterruptedException,
     *   并清除线程的中断状态。
     * - 等待线程以 FIFO 顺序 signal。
     * - 从 await 方法返回的线程重新获取锁的顺序与最初获取锁的线程顺序相同,在默认情况下
     *   未指定,但对于公平锁,会优先考虑哪些等待时间最长的线程。
     *
     * 返回:condition 对象
     */
    public Condition newCondition() {
        return sync.newCondition();
    }

    /**
     * 返回标识此锁的字符串及其锁状态。括号中的状态包括字符串"Unlocked"或
     * 字符串"Locked by"后跟拥有线程的名称。
     *
     * 返回:一个标识这个锁的字符串,以及它的锁状态
     */
    public String toString() {
        Thread o = sync.getOwner();
        return super.toString() + ((o == null) ?
                "[Unlocked]" :
                "[Locked by thread " + o.getName() + "]");
    }

    /**
     * 查询当前线程是否持有该写锁。与 ReentrantReadWriteLock#isWriteLockedByCurrentThread 
     * 效果相同。
     *
     * 返回:如果当前线程持有此锁,则为true;否则为 false。
     * @since 1.6
     */
    public boolean isHeldByCurrentThread() {
        return sync.isHeldExclusively();
    }

    /**
     * 查询当前线程持有该写锁的次数。对于解锁操作不匹配的每个锁定操作,
     * 线程都持有一个锁。与 ReentrantReadWriteLock#getWriteHoldCount 的效果相同。
     *
     * 返回:当前线程持有此锁的次数,如果当前线程未持有此锁,则为零
     * @since 1.6
     */
    public int getHoldCount() {
        return sync.getWriteHoldCount();
    }
}

8.2.3 其他方法

下面我们看一下 ReentrantReadWriteLock 中使用的线程 id 如何获取:

/**
 * 返回给定线程的 thread ID。我们必须直接访问它,因为通过方法 Thread.getId() 返回的
 * 并不是最终的,并且已知会以不保留唯一映射的方式被覆盖。
 */
static final long getThreadId(Thread thread) {
    return UNSAFE.getLongVolatile(thread, TID_OFFSET);
}

// Unsafe mechanics
private static final sun.misc.Unsafe UNSAFE;
private static final long TID_OFFSET;
static {
    try {
        UNSAFE = sun.misc.Unsafe.getUnsafe();
        Class<?> tk = Thread.class;
        TID_OFFSET = UNSAFE.objectFieldOffset
                (tk.getDeclaredField("tid"));
    } catch (Exception e) {
        throw new Error(e);
    }
}

其他一些关于 ReentrantReadWriteLock 的基础监控方法,这里不在做描述。

8.3 Samphora

计数信号量。从概念上讲,信号量维护一组 permit(许可)。如果需要,每个 acquire 都会阻塞,直到 permit 可用,然后获得它。每个 release 都会添加一个 permit,可能会释放一个阻塞的获取者。但是,没有使用实际的 permit 对象;Semaphore 只是对可用数量进行计数并采取相应的措施。

Semaphore 通常用于限制可以访问某些(物理或逻辑)资源的线程数。例如,这是一个使用 Semaphore 来控制对资源池访问的类:

class Pool {
  private static final int MAX_AVAILABLE = 100;
  private final Semaphore available = new Semaphore(MAX_AVAILABLE, true);
  
  public Object getItem() throws InterruptedException {
    available.acquire();
    return getNextAvailableItem();
  }
  
  public void putItem(Object x) {
    if (markAsUnused(x)) {
      available.release();
    }
  }
  
  // Not a particularly efficient data structure; just for demo
  
  protected Object[] items = ... whatever kinds of items being managed
  protected boolean[] used = new boolean[MAX_AVAILABLE];
  
  protected synchronized Object getNextAvailableItem(){
    for (int i = 0; i < MAX_AVAILABLE; ++i) {
      if (!used[i]) {
        used[i] = true;
        return items[i];
      }
    }
    return null;// not reached
  }
  
  protected synchronized boolean markAsUnused(Object item) {
    for (int i = 0; i < MAX_AVAILABLE; ++i) {
      if (item == items[i]) {
        if (used[i]) {
          used[i] = false;
          return true;
        } else {
          return false;
        }
      }
    }
    return false;
  }
}

在获取一个 item 之前,每个线程必须从 Semaphore 中获得一个 permit,保证一个 item 可供使用。当线程处理完该 tiem 时,它被返回到池中,一个 permit 返回给 Semaphore,允许另一个线程获取该 item。请注意,当调用 acquire 时,不会持有同步锁,因为这将阻塞 item 返回池中。Semaphore 封装了限制对池的访问所需的同步,与维护池本身的一致性所需的同步是分开的。

初始化为 1 的 Semaphore,使用时最多只有一个 permit 可用,可以作为互斥锁。这通常称为二进制信号量(binary semaphore),因为它只有两种状态:1 个 permit 可用,或 0 个 permit 可用。当以这种方式使用时,二进制信号量具有这样的属性(与许多 java.util.concurrent.locks.Lock 实现不同),即 “锁” 可以由所有者以外的线程释放(因为信号量没有所有权的概念)。这在一些专门的上下文中很有用,比如死锁恢复。

此类的构造函数可以选择接受一个 公平 参数。当设置为 false 时,此类不保证线程获取 permit 的顺序。特别是,允许“闯入”,也就是说,调用 acquire 的线程可以在一个一直等待的线程之前被允许分配一个 permit —— 从逻辑上来说,就是新线程将自己置于等待队列的头部。当 fairness 设置为 true时,信号量保证调用任何 acquire 方法的线程会按照这些线程被 acquire 方法处理的顺序获得 permit(先进先出;FIFO)。请注意,FIFO 排序必然适用于这些方法中的特定内部执行点。因此,一个线程可以在另一个线程之前调用 acquire,但在另一个线程之后到达排序点,并且从方法返回时类似。另外请注意,没有超时参数的 tryAcquire 方法不遵循公平设置,会直接获取任何可用的 permit。

通常,用于控制资源访问的信号量应该被初始化公平的,以确保没有线程因访问资源而被饿死。当使用信号量进行其他类型的同步控制时,非公平排序的吞吐量优势通常超过公平性考虑。

该类还提供了一次获取和释放多个 permit 的方便方法。当使用这些方法且不设置公平性时,要注意线程有无限延迟被饿死的风险会增加。

内存一致性影响:线程中调用“释放”方法(比如 release())之前的操作 happen-before 另一线程中紧跟在成功的“获取”方法(比如 acquire())之后的操作。

8.3.1 Sync

信号量的同步实现。使用 AQS 的 state 来表示 permit。分为公平和非公平版本。

abstract static class Sync extends AbstractQueuedSynchronizer {
    private static final long serialVersionUID = 1192457210091910933L;

    Sync(int permits) {
        setState(permits);
    }

    final int getPermits() {
        return getState();
    }

    // 非公平尝试获取资源,注意此方法会自旋直到获取成功,或可用资源不够用,直接返回相减后的数量
    final int nonfairTryAcquireShared(int acquires) {
        // 自旋获取 permit
        for (;;) {
            // 获取当前可用的 permit 数量
            int available = getState();
            // 获取后的剩余数量
            int remaining = available - acquires;
            // remaining 大于等于 0 时,尝试 CAS 获取,成功则直接返回
            if (remaining < 0 ||
                    compareAndSetState(available, remaining))
                return remaining;
        }
    }

    // 归还资源,同样,此方法会自旋直至成功
    protected final boolean tryReleaseShared(int releases) {
        // 自旋释放 permit
        for (;;) {
            // 获取当前的 permit 数量
            int current = getState();
            // 归还 permit
            int next = current + releases;
            // 判断归还后是否溢出
            if (next < current) // overflow
                throw new Error("Maximum permit count exceeded");
            // CAS 归还
            if (compareAndSetState(current, next))
                return true;
        }
    }

    // 获取资源,注意此方法在 CAS 修改后直接返回。
    // 此方法在使用信号量来跟踪那些变为不可用资源的子类中很有用。
    // 此方法与 acquire 的不同之处在于它不会阻塞,等待 permit 可用。
    final void reducePermits(int reductions) {
        // 自旋减少 permit 
        for (;;) {
            int current = getState();
            int next = current - reductions;
            if (next > current) // underflow
                throw new Error("Permit count underflow");
            if (compareAndSetState(current, next))
                return;
        }
    }

    // 获取全部可用资源
    final int drainPermits() {
        for (;;) {
            int current = getState();
            if (current == 0 || compareAndSetState(current, 0))
                return current;
        }
    }
}

8.3.2 公平和非公平

非公平版:

static final class NonfairSync extends Semaphore.Sync {
    private static final long serialVersionUID = -2694183684443567898L;

    NonfairSync(int permits) {
        super(permits);
    }

    protected int tryAcquireShared(int acquires) {
        return nonfairTryAcquireShared(acquires);
    }
}

公平版:

static final class FairSync extends Sync {
    private static final long serialVersionUID = 2014338818796000944L;

    FairSync(int permits) {
        super(permits);
    }

    // 返回负数说明资源不够用
    protected int tryAcquireShared(int acquires) {
        // 自旋获取资源
        for (;;) {
            // 先判断队列中是否有等待阻塞的前驱节点
            if (hasQueuedPredecessors())
                return -1;
            int available = getState();
            int remaining = available - acquires;
            if (remaining < 0 ||
                    compareAndSetState(available, remaining))
                return remaining;
        }
    }
}

8.3.3 acquire & release

public class Semaphore implements java.io.Serializable {
    private static final long serialVersionUID = -3222578661600680210L;
    /** All mechanics via AbstractQueuedSynchronizer subclass */
    private final Sync sync;

    /**
     * 使用给定数量的 permit 创建信号量,并设置为非公平。
     *
     * 参数:permits - 可用的 permit 的初始数量。该值可能为负数,在
     *                这种情况下,必须在任何 acquire 之前进行 release。
     */
    public Semaphore(int permits) {
        sync = new NonfairSync(permits);
    }

    /**
     * 创建具有给定 permit 数量和给定公平设置的 Semaphore 。
     *
     * 参数:permits - 可用的 permit 的初始数量。该值可能为负数,在
     *                这种情况下,必须在任何 acquire 之前进行 release。
     *      fair - 此信号量保证竞争 permit 的 acquire 为先进先出,则为 true;否则为 false
     */
    public Semaphore(int permits, boolean fair) {
        sync = fair ? new FairSync(permits) : new NonfairSync(permits);
    }

    /**
     * 从信号量获取一个 permit,阻塞直到获取一个可用,线程被中断则终止。
     * 
     * 获得一个 permit,如果有可用则立即返回,并将可用 permit 数量减一。
     *
     * 如果没有可用的 permit,则处于线程调度目的,当前线程将被禁用并处于休眠状态,直到
     * 发生以下两种情况下之一:
     * - 其他一些线程调用此信号量的 release 方法,并且当前线接下来获得一个 permit;或者
     * - 其他线程中断当前线程。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 在等待过程中被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     *
     * @throws InterruptedException - 如果当前线程被中断。
     */
    public void acquire() throws InterruptedException {
        sync.acquireSharedInterruptibly(1);
    }

    /**
     * 从信号量获取一个 permit,阻塞直至获取一个可用。
     *
     * 获取一个 permit,如果存在可用会立即返回,并将可用 permit 减一。
     *
     * 如果没有可用的 permit,则处于线程调度目的,当前线程将被禁用并处于休眠状态,直到
     * 某个其他线程调用此信号量的 release 方法并且当前线程被分配到可用的 permit。
     *
     * 如果当前线程在等待 permit 时发生中断,那么它将继续等待,但线程被分配 permit 的
     * 时间与它在没有中断发生时收到 permit 的时间相比可能会发生变化。当线程从此方法返回
     * 时,将设置其中断状态。
     */
    public void acquireUninterruptibly() {
        sync.acquireShared(1);
    }

    /**
     * 仅当在调用时有可用的 permit 时,才从此信号量获取 permit。
     *
     * 获取一个 permit,如果存在一个可用则立即返回 true,并将可用 permit 的数量减一。
     *
     * 如果没有可用的 permit,则此方法将立即返回 false。
     *
     * 即使次信号量已设置为公平排序策略,对于 tryAcquire() 的调用也会立即获得
     * permit(如果可用),无论其他线程当前是否正在等待。这种“闯入”行为在某些情况下
     * 可能很有用,即使它破坏了公平性。如果要尊重公平设置,请使用几乎等效的
     * tryAcquire(0, TimeUnit.SECONDS)(它也会检测中断)。
     *
     * 返回:如果获得了 permit,则为 true;否则为 false。
     */
    public boolean tryAcquire() {
        return sync.nonfairTryAcquireShared(1) >= 0;
    }

    /**
     * 如果在给定超时时间内没有中断,且 permit 可用,则从信号量中获取一个 permit。
     *
     * 获取一个 permit,如果存在一个可用则立即返回 true,并将可用 permit 的数量减一。
     *
     * 如果没有可用的 permit,则处于线程调度目的,当前线程将被禁用并处于休眠状态,直到
     * 发生以下三种情况下之一:
     * - 其他一些线程调用此信号量的 release 方法,并且当前线接下来获得一个 permit;或者
     * - 其他线程中断当前线程;或者
     * - 超过指定的超时时间。
     *
     * 如果获得 permit,则返回 true。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 在等待过程中被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     *
     * 如果经过指定的等待时间,则返回 false。如果时间小于等于零,则该方法不会等待。
     * 参数:timeout - 等待 permit 的最大时间
     *      unit - timeout 参数的时间单位
     * 返回:如果已经获得 permit,则为 true;如果获得之前超过等待时间,则为 false。
     * @throws InterruptedException - 如果当前线程被中断
     */
    public boolean tryAcquire(long timeout, TimeUnit unit)
            throws InterruptedException {
        return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
    }

    /**
     * 释放 permit,将其返回给信号量。
     *
     * 释放 permit,将可用 permit 数量加一。如果任何线程试图获取 permit,则选择一个
     * 线程给予刚释放的 permit。出于线程调度目的,该线程(重新)启用。
     *
     * 不要求线程必须先调用 acquire 获得 permit,之后才能 release 释放 permit。
     * 信号量的正确使用是通过应用程序中的编程约定建立的。
     */
    public void release() {
        sync.releaseShared(1);
    }

    /**
     * 从信号量中获取给定数量的 permits,阻塞直到有足够数量的 permits 可用,线程中断
     * 则终止。
     *
     * 获取给定数量的 permits,如果可用则立即返回 true,并将可用 permits 的数量减去
     * 给定的数量。
     *
     * 如果没有可用的 permits,或可用 permits 数量不足,则处于线程调度目的,当前线程将
     * 被禁用并处于休眠状态,直到发生以下量种情况下之一:
     * - 其他一些线程调用此信号量的 release 方法,并且当前线接下来获得足够数量的 permits;或者
     * - 其他线程中断当前线程。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 在等待过程中被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。将分配给当前线程的 permits
     * 改为分配给尝试获取 permit 的其他线程,就好像通过调用 release() 使 permits 可用
     * 一样。
     *
     * 参数:permits - 获得的 permits 数量
     * @throws InterruptedException - 如果当前线程被中断
     * @throws IllegalArgumentException – 如果permits是负数
     */
    public void acquire(int permits) throws InterruptedException {
        if (permits < 0) throw new IllegalArgumentException();
        sync.acquireSharedInterruptibly(permits);
    }

    /**
     * 从信号量获取给定数量的 permits,阻塞直至所有的 permits 可用。
     *
     * 获取给定数量的 permits,如果存在可用会立即返回,并将可用 permits 减去给定数量。
     *
     * 如果没有可用的 permits,或可用的 permits 不足则处于线程调度目的,当前线程将被禁
     * 用并处于休眠状态,直到某个其他线程调用此信号量的 release 方法并且当前线程被分配
     * 到足够数量可用的 permits。
     *
     * 如果当前线程在等待 permits 时发生中断,那么它将继续等待,并且它在队列中的位置不受
     * 影响。当线程确实从此方法返回时,将设置其中断状态。
     *
     * 参数:permits - permits 数量
     * @throws IllegalArgumentException - 如果 permits 为负数
     */
    public void acquireUninterruptibly(int permits) {
        if (permits < 0) throw new IllegalArgumentException();
        sync.acquireShared(permits);
    }

    /**
     * 仅当调用时有给定数量的 permits 可用时,才从此信号量中获取到给定数量的 permits。
     *
     * 获取给定数量的 permits,如果存在可用会立即返回,并将可用 permit 减去给定数量。
     * 
     * 如果可用的 permits 不足,则此方法立即返回 false,并且可用 permits 数量不变。
     *
     * 即使次信号量已设置为公平排序策略,对于 tryAcquire() 的调用也会立即获得
     * permit(如果可用),无论其他线程当前是否正在等待。这种“闯入”行为在某些情况下
     * 可能很有用,即使它破坏了公平性。如果要尊重公平设置,请使用几乎等效的
     * tryAcquire(permits, 0, TimeUnit.SECONDS)(它也会检测中断)。
     *
     * 参数:permits - 获取的 permits 数量
     * 返回:如果获得了 permit,则为 true,否则为 false
     * @throws IllegalArgumentException - 如果 permits 为负数
     */
    public boolean tryAcquire(int permits) {
        if (permits < 0) throw new IllegalArgumentException();
        return sync.nonfairTryAcquireShared(permits) >= 0;
    }

    /**
     * 如果在给定超时时间内没有中断,且有足够的 permits 可用,则从信号量中获取 permits。
     *
     * 获取给定数量的 permits,如果存在足够数量可用则立即返回 true,并将可用 permits 的
     * 数量减去给定数值。
     *
     * 如果没有足够可用的 permits,则处于线程调度目的,当前线程将被禁用并处于休眠状态,直到
     * 发生以下三种情况下之一:
     * - 其他一些线程调用此信号量的 release 方法,并且当前线接下来获得足够数量 permits;或者
     * - 其他线程中断当前线程;或者
     * - 超过指定的超时时间。
     *
     * 如果获得 permits,则返回 true。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 在等待过程中被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。将分配给当前线程的 permits
     * 改为分配给尝试获取 permit 的其他线程,就好像通过调用 release() 使 permits 可用
     * 一样。
     *
     * 如果经过指定的等待时间,则返回 false。如果时间小于等于零,则该方法不会等待。
     * 参数:permits - 获得的 permits 数量
     *      timeout - 等待 permit 的最大时间
     *      unit - timeout 参数的时间单位
     * 返回:如果已经获得 permits,则为 true;如果获得之前超过等待时间,则为 false。
     * @throws InterruptedException - 如果当前线程被中断
     * @throws IllegalArgumentException - 如果 permits 为负数
     */
    public boolean tryAcquire(int permits, long timeout, TimeUnit unit)
            throws InterruptedException {
        if (permits < 0) throw new IllegalArgumentException();
        return sync.tryAcquireSharedNanos(permits, unit.toNanos(timeout));
    }

    /**
     * 释放给定数量的 permits,将其返回给信号量。
     *
     * 释放给定数量的 permits,将可用 permits 数量加上改数量。如果任何线程试图获取
     * permit,则选择一个线程给予刚释放的 permits。如果可用 permits 的数量满足该
     * 线程的要求,处于线程调度目的,该线程(重新)启用;否则线程将等待直到有足够的
     * permits 可用。如果在满足该线程的请求后仍然有可用的 permits,则这些 permits
     * 将依次分配给试图获取 permits 的线程。
     *
     * 不要求线程必须先调用 acquire 获得 permits 之后才能 release 释放 permits。
     * 信号量的正确使用是通过应用程序中的编程约定建立的。
     *
     * 参数:permits - 释放的 permits 数量
     * @throws IllegalArgumentException - permits 为负数
     */
    public void release(int permits) {
        if (permits < 0) throw new IllegalArgumentException();
        sync.releaseShared(permits);
    }

    /**
     * 返回此信号量当前可用的 permits 数量。
     *
     * 此方法通常用于调试和测试。
     *
     * 返回:此信号量中可用的 permit 数量
     */
    public int availablePermits() {
        return sync.getPermits();
    }

    /**
     * 获取并返回当前所有的 permits。
     *
     * 返回:获得的 permits 数量
     */
    public int drainPermits() {
        return sync.drainPermits();
    }

    /**
     * 按照指定的 reduction 减少可用 permits 数量。此方法在使用信号量来跟踪
     * 子类中资源变得不可用情况会很有用。此方法与 acquire 的不同之处在于它不会
     * 阻塞等待 permits 可用。
     *
     * 参数:reduction - 移除的 permits 数量
     * @throws IllegalArgumentException - 如果 reduction 为负数
     */
    protected void reducePermits(int reduction) {
        if (reduction < 0) throw new IllegalArgumentException();
        sync.reducePermits(reduction);
    }
}

其他一些用于监控的非核心方法不再展示。

8.4 CountDownLatch

一种同步辅助工具,允许一个或多个线程等待,知道在其他线程中执行的一组操作完成。

CountDownLatch 使用给定的 计数(count) 进行初始化。调用 await 方法将会一直阻塞,直到调用 countDown 方法将当前计数减少到零,只有所有等待的线程都被释放,任何后续的 await 方法调用将会立即返回。这是一次性使用的现象——计数是无法重置的。如果你需要能够重置计数的版本,请考虑使用 CyclicBarrier。

CountDownLatch 是一种多功能同步工具,可用于多种用途。使用计数 1 初始化的 CountDownLatch 可以用作简单的开/关闩锁:所有调用 await 方法的线程都将在门处等待,直到它被调用 countDown 方法线程打开门。初始化为 N 的 CountDownLatch 可用于使一个线程等待,直到 N 个线程完成某个动作,或某个动作完成 N 次。

CountDownLatch 的一个有用属性是它不需要调用 countDown 的线程等待计数变为零才能继续,它只是阻塞调用 await 方法的线程,直到所有线程都可以通过。

示例用法: 这是一对类,其中一组工作线程使用两个 CountDownLatch:

  • 第一个是启动信号,它阻塞任何 worker 继续前进,直到 driver 准备好让他们继续。
  • 第二个是完成信号,允许 driver 程序等待所有 worker 完成。
class Driver {
  void main() throws InterruptedException {
    CountDownLatch startSignal = new CountDownLatch(1);
    CountDownLatch doneSignal = new CountDownLatch(N);
    
    for (int i = 0; i < N; ++i) { // create and start threads
      new Thread(new Worker(startSignal, doneSignal)).start();
    }
    
    doSomethingElse(); // don't let run yet
    startSignal.countDown(); // let all threads proceed
    doSomethingElse(); 
    doSignal.await(); // wait for all to finish
  }
}

class Worker implements Runnable {
  private final CountDownLatch startSignal;
  private final CountDownLatch doneSignal;
  Worker(CountDownLatch startSignal, CountDownLatch doneSignal) {
    this.startSignal = startSignal;
    this.doneSignal = doneSignal;
  }
  
  public void run() {
    try {
      startSignal.await();
      doWork();
      doneSignal.countDown();
    } catch (InterruptedException ex) {} //return;
  }
  
  void doWork() { ... }
}

另一个典型的用法是将一个问题分成 N 个部分,用一个 Runnable 描述每个部分,该 Runnable 执行该部分并在完成后进行 countDown 操作,并将所有 Runnables 排队到一个 Executor。当所有的子任务执行完成后,协调线程就可以在 await 状态中被释放。(当线程必须以这种方式重复使用 countDown 时,请改用 CyclicBarrier)

class Driver2 { // ...
  void main() throws InterruptedException {
    CountDownLatch doneSignal = new CountDownLatch(N);
    Executor e = ...
    
    for (int i = 0; i < N; ++i) { // create and start threads
      e.execute(new WorkerRunnable(doneSignal, i));
    }
    
    doneSignal.await(); // wait for all to finish
  }
}

class WorkRunnable implements Runnable {
  private final CountDownLatch doneSignal;
  private final int i;
  WorkerRunnable(CountDownLatch doneSignal, int i) {
    this.doneSignal = doneSignal;
    this.i = i;
  }
  
  public void run() {
    try {
      doWork(i);
      doneSignal.countDown();
    } catch (InterruptedException ex) {} // return;
  }
  
  void doWork() { ... }
}

内存一致性影响:直到计数到达零,调用 countDown() 之前的线程中的动作 happen-before 在另一个线程中从相应的 await() 成功返回之后的动作。

8.4.1 Sync

CountDownLatch 的同步控制。使用 AQS 状态来表示计数

private static final class Sync extends AbstractQueuedSynchronizer {
    private static final long serialVersionUID = 4982264981922014374L;

    Sync(int count) {
        setState(count);
    }

    int getCount() {
        return getState();
    }

    protected int tryAcquireShared(int acquires) {
        return (getState() == 0) ? 1 : -1;
    }

    protected boolean tryReleaseShared(int releases) {
        // Decrement count; signal when transition to zero
        for (;;) {
            int c = getState();
            if (c == 0)
                return false;
            int nextc = c-1;
            // CAS 递减,为零返回 true
            if (compareAndSetState(c, nextc))
                return nextc == 0;
        }
    }
}

8.4.2 await & countDown

public class CountDownLatch {
    private final Sync sync;

    /**
     * 使用给定的计数初始化 CountDownLatch。
     *
     * 参数:count - 在线程可以通过 await 之前必须调用 countDown 的次数
     * @throws IllegalArgumentException - 如果 count 为负数
     */
    public CountDownLatch(int count) {
        if (count < 0) throw new IllegalArgumentException("count < 0");
        this.sync = new Sync(count);
    }

    /**
     * 阻塞当前线程,使其等待,直到 CountDownLatch 计数器为零,线程中断则终止。
     *
     * 如果当前计数为零,则此方法立即返回。
     *
     * 如果当前计数大于零,出于线程调度目的,当前线程将被禁用并处于休眠状态,直到以下
     * 两种情况下之一发生:
     * - 由于调用了 countDown 方法,计数达到零;或者
     * - 其他一些线程中断当前线程。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 等待过程中被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     *
     * @throws InterruptedException - 如果当前线程在等待中被中断
     */
    public void await() throws InterruptedException {
        sync.acquireSharedInterruptibly(1);
    }

    /**
     *
     * 阻塞当前线程,使其等待,直到 CountDownLatch 计数器为零,或到达指定的等待时间,
     * 线程中断则终止。
     *
     * 如果当前计数为零,则此方法立即返回 true。
     *
     * 如果当前计数大于零,出于线程调度目的,当前线程将被禁用并处于休眠状态,直到以下
     * 三种情况下之一发生:
     * - 由于调用了 countDown 方法,计数达到零;或者
     * - 其他一些线程中断当前线程;或者
     * - 达到指定的等待时间。
     * 
     * 如果计数到达零,则该方法返回 true。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 等待过程中被中断。
     *
     * 然后抛出InterruptedException并清除当前线程的中断状态。
     * 
     * 如果经过了指定的等待时间,则返回 false。如果时间小于或等于零,则该方法不会等待。
     * 
     * 
     * 参数:timeout - 等待的最长时间
     *      unit - timeout参数的单位
     * 返回:如果计数到达零,则返回 true;如果在计数到达零之前超过的等待时间,则返回 false
     * @throws InterruptedException - 如果当前线程在等待中被中断
     */
    public boolean await(long timeout, TimeUnit unit)
            throws InterruptedException {
        return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
    }

    /**
     * 减少 CountDownLatch 的计数,如果计数达到零,则释放所有等待线程。
     *
     * 如果当前计数大于零,则递减。如果新计数为零,出于线程调度重启所有等待线程。
     *
     * 如果当前计数为零,则不会发生任何事情。
     */
    public void countDown() {
        sync.releaseShared(1);
    }
}

8.5 CyclicBarrier

一种同步辅助工具,它允许一组线程相互等待以达到共同的障碍点。CyclicBarriers 在涉及固定大小的线程组的程序中很有用,这些线程组必须偶尔相互等待。屏障被称为 循环(Cyclic) 的,因为它们可以在等待线程被释放后重新使用。

CyclicBarrier 支持一个可选的 Runnable 命令,该命令在每个屏障点运行一次,在最后一个线程到达之后,但是在任何线程被释放之前。此屏障操作对于在任何一方继续执行之前更新共享状态很有用。

示例用法: 以下是在并行分解设计中使用屏障的示例:

class Solver {
  final int N;
  final float[][] data;
  final CyclicBarrier barrier;
  
  class Worker implements Runnable {
    int myRow;
    Worker(int row) { myRow = row; }
    public void run() {
      while (!done()) {
        processRow(myRow);
        
        try {
          barrier.await();
        } catch (InterruptedException ex) {
          return;
        } catch (BrokenBarrierException ex) {
          return;
        }
      }
    }
  }
  
  public Solver(float[][] matrix) {
    data = matrix;
    N = matrix.length;
    Runnable barrierAction = new Runnable() {
      public void run() {
        margeRows(...);
      }
    };
    barrier = new CyclicBarrier(N, barrierAction);
    
    List<Thread> threads = new ArrayList<Thread>(N);
    for (int i = 0; i < N; i++) {
      Thread thread = new Thread(new Worker(i));
      threads.add(thread);
      thread.start();
    }
    
    // wait until done
    for (Thread thread : threads) {
      thread.join();
    }
  }
}

在这里,每个工作线程处理矩阵的一行,然后在屏障处等待,直到处理完所有行。处理完所有行后,将执行提供的 Runnable 屏障操作,合并矩阵行。如果合并已经确定完成,那 done() 方法会返回 true ,每个工作线程将会终止。

如果 barrier action 在执行时不依赖于被挂起的各个线程,那么该方法中的任何线程都可以在它被释放时执行该动作。为了方便起见,每次调用 await 都会返回该线程在屏障处到达的索引。然后,您可以选择那个线程应该执行 barrier action,例如:

if (barrier.await() == 0) {
  // log the completion of this iteration
}

CyclicBarrier 对失败的同步尝试使用 all-or-none 模型:如果线程由于中断、故障或超时而过早地离开屏障点,则在该屏障点等待的所有其他线程也会通过 BrokenBarrierException(或者如果它们也在同时被中断,抛出InterruptedException )。

内存一致性效果:在调用 await() 之前线程中的操作 happen-before 作为 barrier action 的一部分的操作,而这些操作又 happen-before 从其他线程中的相应 await() 成功返回之后的操作。

8.5.1 Generation

屏障的每次使用都会表现为 generation 实例。每当屏障被触发或重置时,generation 就会发生变化。可能有许多 generation 与使用屏障的线程相关联 —— 由于锁定可能会以不确定的方式分配给等待线程 —— 但一次只能使其中一个 generation 处于活动状态(count 使用的那个)并且所有其余的线程要么 broken,要么 trip(可能是指阻塞?)。如果有中断带没有后续重置,则不需要活动的 generation。

private static class Generation {
    boolean broken = false;
}

8.5.2 实现详解

public class CyclicBarrier {

    // 忽略 Generation Class

    /** 用户保护屏障入口的锁 */
    private final ReentrantLock lock = new ReentrantLock();
    /** 等待直到 triped 的 condition */
    private final Condition trip = lock.newCondition();
    /** 分片数量 */
    private final int parties;
    /* tripped 时执行的命令 */
    private final Runnable barrierCommand;
    /** 当前 generation */
    private Generation generation = new Generation();

    /**
     * 仍在等待的 parties 数量。每个 generation 都会讲 parties 减少到 0。
     * 每次生成新的 generation 或 broken 时会重置。
     */
    private int count;

    /**
     * 更新屏障 trip 状态,并唤醒全部。只有当持有锁才可以调用。
     */
    private void nextGeneration() {
        // signal completion of last generation
        trip.signalAll();
        // set up next generation
        count = parties;
        generation = new Generation();
    }

    /**
     * 设置当前的 generation 为 broken,并唤醒全部。只有当持有锁才可以调用。
     */
    private void breakBarrier() {
        generation.broken = true;
        count = parties;
        trip.signalAll();
    }

    /**
     * 屏障的主要代码,涵盖各种策略。
     */
    private int dowait(boolean timed, long nanos)
        throws InterruptedException, BrokenBarrierException,
               TimeoutException {
        // 屏障入口,先获得锁
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            // 获取当前的 generation
            final Generation g = generation;

            // 判断当前是否 broken,抛出异常
            if (g.broken)
                throw new BrokenBarrierException();

            // 判断线程是否中断
            if (Thread.interrupted()) {
                breakBarrier();
                throw new InterruptedException();
            }

            // 获取当前索引
            int index = --count;
            // 当最后一个任务到达 await 屏障点时,则执行 command
            if (index == 0) {  // tripped
                // 是否执行命令,执行失败(抛出异常)则跳出等待
                boolean ranAction = false;
                try {
                    final Runnable command = barrierCommand;
                    if (command != null)
                        command.run();
                    ranAction = true;
                    // 下一个 generation,也就是重置屏障
                    nextGeneration();
                    return 0;
                } finally {
                    if (!ranAction)
                        breakBarrier();
                }
            }

            // 说明不是最后一个到达屏障的任务,需要阻塞
            // loop until tripped, broken, interrupted, or timed out
            for (;;) {
                try {
                    // 如果没有超时,则直接阻塞;存在超时时间使用超时阻塞
                    // condition 的 await 会进行 fullyRelease,释放持有的锁
                    if (!timed)
                        trip.await();
                    else if (nanos > 0L)
                        nanos = trip.awaitNanos(nanos);
                } catch (InterruptedException ie) {
                    // 如果当前 generation 没有被其他线程改变,且中断
                    if (g == generation && ! g.broken) {
                        // 中断屏障
                        breakBarrier();
                        throw ie;
                    } else {
                        // 即使我们没有被中断,我们也即将完成等待,所以这个中断
                        // 被认为是 “属于” 后续执行的。
                        Thread.currentThread().interrupt();
                    }
                }

                if (g.broken)
                    throw new BrokenBarrierException();

                // generation 已经更换
                if (g != generation)
                    return index;

                // 超时则中断屏障
                if (timed && nanos <= 0L) {
                    breakBarrier();
                    throw new TimeoutException();
                }
            }
        } finally {
            lock.unlock();
        }
    }

    /**
     * 创建一个新的 CyclicBarrier,当给定数量的 parties (线程)正在等待它时,
     * 它将触发继续执行,他将执行给定的 barrierAction,由最后一个进入屏障的线程
     * 执行。
     *
     * 参数:parties - 在屏障被触发之前必须调用 await 的线程数
     *      barrierAction - 当屏障被触发时执行的命令,如果没有动作则为 null
     * @throws IllegalArgumentException - 如果 parties 小于 1
     */
    public CyclicBarrier(int parties, Runnable barrierAction) {
        if (parties <= 0) throw new IllegalArgumentException();
        this.parties = parties;
        this.count = parties;
        this.barrierCommand = barrierAction;
    }

    /**
     * 创建一个新的 CyclicBarrier,当给定数量的 parties (线程)正在等待它时,
     * 它将触发继续执行,在触发屏障继续执行时不执行预定义操作。
     *
     * 参数:parties - 在屏障被触发之前必须调用 await 的线程数
     *      barrierAction - 当屏障被触发时执行的命令,如果没有动作则为 null
     * @throws IllegalArgumentException - 如果 parties 小于 1
     */
    public CyclicBarrier(int parties) {
        this(parties, null);
    }

    /**
     * 返回触发次屏障所需的 parties 数量。
     *
     * 返回:打破此屏障需要的 parties 数量。
     */
    public int getParties() {
        return parties;
    }

    /**
     * 等到所有 parties 都在此屏障上调用 await。
     *
     * 如果当前线程不是最后到达的,处于线程调度目的,将其禁用并处于休眠状态,
     * 直到发生以下情况之一:
     * - 最后一个线程到达;或者
     * - 其他线程中断当前线程;或者
     * = 其他线程中断了任意等待线程;或者
     * - 其他线程在等待屏障时超时;或者
     * - 其他一些线程调用此屏障的 reset 方法。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 等待过程中被中断
     *
     * 然后抛出 InterruptedException 并清除当前线程的中断状态。
     *
     * 如果在任何线程等待时调用屏障的 reset 方法,或者在调用 await 或在任何线程
     * 在等待时屏障时,isBroken() 为 true,则抛出 BrokenBarrierException。
     *
     * 如果任何线程在等待时被中断,那么所有其他等待的线程都会抛出 BrokenBarrierException
     * 并将屏障的 generation 的 broken 状态设置为 true。
     *
     * 如果当前线程是最后到达的线程,并且在构造函数中提供了非空的 barrierAction,则允许当前
     * 在继续之前先执行 barrierAction 操作。如果在屏障操作期间发生了异常,则该异常将在当前
     * 线程中传播,并且屏障处于 broken 状态。
     *
     * 返回:当前线程的到达索引,其中索引 getParties - 1 表示第一个到达,0表示最后一个到达
     * @throws InterruptedException - 如果当前线程在等待时被中断
     * @throws BrokenBarrierException - 如果另一个线程在当前线程等待时中断或超时,或者
     *                                  屏障被重置,或者在调用 await 时屏障被破坏,或者
     *                                  barrierAction (如果存在) 由于异常失败
     */
    public int await() throws InterruptedException, BrokenBarrierException {
        try {
            return dowait(false, 0L);
        } catch (TimeoutException toe) {
            throw new Error(toe); // cannot happen
        }
    }

    /**
     * 等到所有 parties 都在此屏障上调用 await,或达到指定的超时时间。
     *
     * 如果当前线程不是最后到达的,处于线程调度目的,将其禁用并处于休眠状态,
     * 直到发生以下情况之一:
     * - 最后一个线程到达;或者
     * - 到达指定的超时时间;或者
     * - 其他线程中断当前线程;或者
     * = 其他线程中断了任意等待线程;或者
     * - 其他线程在等待屏障时超时;或者
     * - 其他一些线程调用此屏障的 reset 方法。
     *
     * 如果当前线程:
     * - 在进入此方法时设置其中断状态;或者
     * - 等待过程中被中断
     *
     * 然后抛出 InterruptedException 并清除当前线程的中断状态。
     *
     * 如果到达指定的超时时间,则抛出 TimeoutException。如果时间小于或等于零,则
     * 该方法不会等待。
     *
     * 如果在任何线程等待时调用屏障的 reset 方法,或者在调用 await 或在任何线程
     * 在等待时屏障时,isBroken() 为 true,则抛出 BrokenBarrierException。
     *
     * 如果任何线程在等待时被中断,那么所有其他等待的线程都会抛出 BrokenBarrierException
     * 并将屏障的 generation 的 broken 状态设置为 true。
     *
     * 如果当前线程是最后到达的线程,并且在构造函数中提供了非空的 barrierAction,则允许当前
     * 在继续之前先执行 barrierAction 操作。如果在屏障操作期间发生了异常,则该异常将在当前
     * 线程中传播,并且屏障处于 broken 状态。
     *
     * 参数:timeout - 等待屏障的时间
     *       unit - timeout 的单位
     * 返回:当前线程的到达索引,其中索引 getParties - 1 表示第一个到达,0表示最后一个到达
     * @throws InterruptedException - 如果当前线程在等待时被中断
     * @throws TimeoutException - 如果到达指定的超时时间。在这种情况下,屏障将被 broken。
     * @throws BrokenBarrierException - 如果另一个线程在当前线程等待时中断或超时,或者
     *                                  屏障被重置,或者在调用 await 时屏障被破坏,或者
     *                                  barrierAction (如果存在) 由于异常失败
     */
    public int await(long timeout, TimeUnit unit)
        throws InterruptedException,
               BrokenBarrierException,
               TimeoutException {
        return dowait(true, unit.toNanos(timeout));
    }

    /**
     * 查询当前屏障是否处于 broken 状态。
     *
     * 返回:一个或多个 parties 在上次屏障重置后,由于超时或中断而使此屏障 broken,
     *      或者由于异常而导致 barrierAction 失败,则为 true;否则为 false。
     */
    public boolean isBroken() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            return generation.broken;
        } finally {
            lock.unlock();
        }
    }

    /**
     * 将屏障重置为初始状态。如果任何 parties 在当前屏障处等待,他们将返回 BrokenBarrierException。
     * 请注意,由于其他原因发生 broken 后的重置可能会很复杂;线程需要以其他方式重新同步,并选择一个
     * 线程执行 reset 操作。相反,最好为后续使用创建一个新的屏障。
     */
    public void reset() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            breakBarrier();   // break the current generation
            nextGeneration(); // start a new generation
        } finally {
            lock.unlock();
        }
    }

    /**
     * 返回当前在屏障处等待的 parties 数量。此方法主要用于调试和断言。
     *
     * 返回,当前在 await 中被阻塞的 parties 数量
     */
    public int getNumberWaiting() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            return parties - count;
        } finally {
            lock.unlock();
        }
    }
}