ReentrantLock源码自读 -- AQS

ReentrantLock公平锁加锁过程

测试代码

public static void main(String[] args) {
    ReentrantLock lock = new ReentrantLock(true);
    new Thread(() -> {
        System.out.println("11111 try get lock");
        lock.lock();
        System.out.println("11111");
        try {
            TimeUnit.SECONDS.sleep(5);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        lock.unlock();
    }).start();

    try {
        TimeUnit.MILLISECONDS.sleep(100);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }

    new Thread(() -> {
        System.out.println("22222 try get lock");
        lock.lock();
        System.out.println("22222");
        try {
            TimeUnit.SECONDS.sleep(5);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        lock.unlock();
    }).start();

    try {
        TimeUnit.MILLISECONDS.sleep(100);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }

    new Thread(() -> {
        System.out.println("33333 try get lock");
        lock.lock();
        System.out.println("33333");
        try {
            TimeUnit.SECONDS.sleep(5);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        lock.unlock();
    }).start();

    try {
        TimeUnit.MILLISECONDS.sleep(100);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }

    System.out.println("main");
}

这里开启3个线程，并且让3个线程依次执行。

第一个线程加锁

public final void acquire(int arg) {
    if (!tryAcquire(arg) &&
        acquireQueued(addWaiter(Node.EXCLUSIVE), arg))
        selfInterrupt();
}

先来看看上面这段代码中的tryAcquire方法。

protected final boolean tryAcquire(int acquires) {
    final Thread current = Thread.currentThread();
    int c = getState();
    if (c == 0) {
        if (!hasQueuedPredecessors() &&
            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;
}

因为是第一个线程来获取锁，所以getState()会得到state默认值0，接下来进入第一个if代码块，再看hasQueuedPredecessors方法。

public final boolean hasQueuedPredecessors() {
    // The correctness of this depends on head being initialized
    // before tail and on head.next being accurate if the current
    // thread is first in queue.
    Node t = tail; // Read fields in reverse initialization order
    Node h = head;
    Node s;
    return h != t &&
        ((s = h.next) == null || s.thread != Thread.currentThread());
}

同样的因为是第一个线程，所以tail和head也是默认初始值null，也就是说return语句块中的h != t将返回false，再回到tryAcquire方法中，这时!hasQueuedPredecessors()为true，所以紧接着执行compareAndSetState(0, acquires)，这句代码的意思是将state的值由0变为1，代表上锁成功，然后将当前线程置为独占所有者。这时上锁完成。
那么下面的else if中的代码是什么意思呢？没错，正如你想，是重入逻辑。

至此第一个线程的加锁逻辑完成，有没有发现目前跟AQS没有一毛钱的关系。

第二个线程加锁

毫无疑问，我们还是从tryAcquire方法开始。

在不考虑重入的情况下，这时执行getState()方法得到的值为1。所以第一个if代码块不会进，同理，当前独占线程也不是我们所谓的第二个线程，所以else if代码块也不会进，那么直接返回false。这时!tryAcquire(arg)为true，那么执行acquireQueued(addWaiter(Node.EXCLUSIVE), arg)方法。

先看看addWaiter(Node.EXCLUSIVE)方法。

/** Marker to indicate a node is waiting in exclusive mode */
static final Node EXCLUSIVE = null;

private Node addWaiter(Node mode) {
    Node node = new Node(Thread.currentThread(), mode);
    // Try the fast path of enq; backup to full enq on failure
    Node pred = tail;
    if (pred != null) {
        node.prev = pred;
        if (compareAndSetTail(pred, node)) {
            pred.next = node;
            return node;
        }
    }
    enq(node);
    return node;
}

可以看到该方法一开始就new了一个Node，初始化该Node包含我们所谓的第二个线程。注意这里开始涉及AQS（AbstractQueuedSynchronizer）了，其实就是一个链表队列。
言归正传，代码紧接着获取队列的尾部节点，因为第一个线程并没有涉及到队列，所以这里毫无以为tail节点为null，因此执行enq(node)方法。

老规矩，看看代码。

private Node enq(final Node node) {
    for (;;) {
        Node t = tail;
        if (t == null) { // Must initialize
            if (compareAndSetHead(new Node()))
                tail = head;
        } else {
            node.prev = t;
            if (compareAndSetTail(t, node)) {
                t.next = node;
                return t;
            }
        }
    }
}

一进来就看到个死循环。同样的获取尾部节点，没的说，铁定为null。那么执行if代码块，new了一个空节点给头部节点，然后又把头部节点赋值给尾部节点（这时头部和尾部指向同一内存地址）。然后第一次循环结束，因为没有返回值，所以执行第二次循环，这时候尾部节点已经不是null了（哪怕它是一个空节点），那么进入else代码块。
先把传进来的node（上个方法中new出来的包含第二个线程的node）的上一个节点设为第一次循环设置的空节点。
然后把传进来的node给尾部节点。
最后把空节点的下一个节点设置为传进来的node。
这样就形成了拥有两个节点的双向链表。

有点难理解，画个幼儿园水平的图来看看。

首先定义一个抽象的空节点。

然后定义addWaiter方法new出来的节点，赐名t2节点。

再然后定义一个enq方法new出来的空节点。

最后看看节点间的关联关系

执行tail = head;时

执行Node t = tail;时

执行node.prev = t;时

执行compareAndSetTail(t, node)时

执行t.next = node;时

最后形成AQS队列

图画完了，仅代表个人理解。
最后看acquireQueued方法。

final boolean acquireQueued(final Node node, int arg) {
    boolean failed = true;
    try {
        boolean interrupted = false;
        for (;;) {
            final Node p = node.predecessor();
            if (p == head && tryAcquire(arg)) {
                setHead(node);
                p.next = null; // help GC
                failed = false;
                return interrupted;
            }
            if (shouldParkAfterFailedAcquire(p, node) &&
                parkAndCheckInterrupt())
                interrupted = true;
        }
    } finally {
        if (failed)
            cancelAcquire(node);
    }
}

一进来又是一个死循环。第一次循环if (p == head && tryAcquire(arg))这句代码，因为我们设定的场景，所以肯定加锁失败，所以直接看shouldParkAfterFailedAcquire方法。

private static boolean shouldParkAfterFailedAcquire(Node pred, Node node) {
    int ws = pred.waitStatus;
    if (ws == Node.SIGNAL)
        /*
         * This node has already set status asking a release
         * to signal it, so it can safely park.
         */
        return true;
    if (ws > 0) {
        /*
         * Predecessor was cancelled. Skip over predecessors and
         * indicate retry.
         */
        do {
            node.prev = pred = pred.prev;
        } while (pred.waitStatus > 0);
        pred.next = node;
    } else {
        /*
         * waitStatus must be 0 or PROPAGATE.  Indicate that we
         * need a signal, but don't park yet.  Caller will need to
         * retry to make sure it cannot acquire before parking.
         */
        compareAndSetWaitStatus(pred, ws, Node.SIGNAL);
    }
    return false;
}

这时候因为还没有进入等待锁的线程，所以waitStatus为0，那么执行else中的代码将waitStatus置为-1，值得注意的是这里操作的是上一个节点的waitStatus。紧接着第二次循环同样会加锁失败（因为我们设定的场景），再一次进入shouldParkAfterFailedAcquire方法，这时候waitStatus已经被置为-1了，所以返回true。然后执行parkAndCheckInterrupt方法。

private final boolean parkAndCheckInterrupt() {
    LockSupport.park(this);
    return Thread.interrupted();
}

这时候直接调用native方法park()，使第二个线程进入等待。下面先说第三个线程，再看第二个线程是如何加锁成功的。

第三个线程加锁

再次强调我们设定的场景导致第三次加锁铁定失败，所以直接看addWaiter方法。

private Node addWaiter(Node mode) {
    Node node = new Node(Thread.currentThread(), mode);
    // Try the fast path of enq; backup to full enq on failure
    Node pred = tail;
    if (pred != null) {
        node.prev = pred;
        if (compareAndSetTail(pred, node)) {
            pred.next = node;
            return node;
        }
    }
    enq(node);
    return node;
}

这个时候pred肯定不是null了，所以将第三个线程节点的上一个节点设置为第二个线程节点，然后将第三个线程节点设置为尾节点。然后再看acquireQueued方法。

final boolean acquireQueued(final Node node, int arg) {
    boolean failed = true;
    try {
        boolean interrupted = false;
        for (;;) {
            final Node p = node.predecessor();
            if (p == head && tryAcquire(arg)) {
                setHead(node);
                p.next = null; // help GC
                failed = false;
                return interrupted;
            }
            if (shouldParkAfterFailedAcquire(p, node) &&
                parkAndCheckInterrupt())
                interrupted = true;
        }
    } finally {
        if (failed)
            cancelAcquire(node);
    }
}

这个时候p节点肯定不是head节点（其实是第二个线程节点），所有执行第二个if代码块，后面的逻辑就和第二个线程走的一样了。

ReentrantLock公平锁解锁过程

第一个线程解锁

public final boolean release(int arg) {
    if (tryRelease(arg)) {
        Node h = head;
        if (h != null && h.waitStatus != 0)
            unparkSuccessor(h);
        return true;
    }
    return false;
}

直接看tryRelease方法

protected final boolean tryRelease(int releases) {
    int c = getState() - releases;
    if (Thread.currentThread() != getExclusiveOwnerThread())
        throw new IllegalMonitorStateException();
    boolean free = false;
    if (c == 0) {
        free = true;
        setExclusiveOwnerThread(null);
    }
    setState(c);
    return free;
}

还是在不考虑重入的情况下，getState等于1，所以c等于0，将独占线程置为null，最后将state置为0。
接下来，因为第一个线程更AQS队列没有半毛钱关系，所以直接执行unparkSuccessor方法并且返回true，解锁完成。
那么再来看看unparkSuccessor方法。

private void unparkSuccessor(Node node) {
    /*
     * If status is negative (i.e., possibly needing signal) try
     * to clear in anticipation of signalling.  It is OK if this
     * fails or if status is changed by waiting thread.
     */
    int ws = node.waitStatus;
    if (ws < 0)
        compareAndSetWaitStatus(node, ws, 0);

    /*
     * Thread to unpark is held in successor, which is normally
     * just the next node.  But if cancelled or apparently null,
     * traverse backwards from tail to find the actual
     * non-cancelled successor.
     */
    Node s = node.next;
    if (s == null || s.waitStatus > 0) {
        s = null;
        for (Node t = tail; t != null && t != node; t = t.prev)
            if (t.waitStatus <= 0)
                s = t;
    }
    if (s != null)
        LockSupport.unpark(s.thread);
}

上面说过当有线程进入AQS队列时会将waitStatus置为-1，所以进入第一个if代码块，将waitStatus置为0，然后拿到队列中的第二个节点（也就是第二个线程节点），将其唤醒。
然后再说说第二个线程节点被唤醒之候干些什么？
先看看第二个线程进入等待的代码。

private final boolean parkAndCheckInterrupt() {
    LockSupport.park(this);
    return Thread.interrupted();
}

当第二个线程被唤醒之后，将执行return语句，这时因为我们外部并没有打断线程，所以返回false。然后继续开始循环执行if (p == head && tryAcquire(arg))语句，这时候满足p == head，再看tryAcquire方法。

protected final boolean tryAcquire(int acquires) {
    final Thread current = Thread.currentThread();
    int c = getState();
    if (c == 0) {
        if (!hasQueuedPredecessors() &&
            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;
}

这个时候因为第一个线程解锁，将state置为了0，所以进入hasQueuedPredecessors()方法。

public final boolean hasQueuedPredecessors() {
    // The correctness of this depends on head being initialized
    // before tail and on head.next being accurate if the current
    // thread is first in queue.
    Node t = tail; // Read fields in reverse initialization order
    Node h = head;
    Node s;
    return h != t &&
        ((s = h.next) == null || s.thread != Thread.currentThread());
}

因为这个时候队列里有三个节点（第一个空节点，第二个线程节点，第三个线程节点），所以h != t满足条件，(s = h.next) == null也满足条件，因此返回true，然后再反过来看，执行compareAndSetState(0, acquires)方法，将state置为1，表示第二个线程上锁成功，并且将独占线程置为第二个线程，最后返回true。
继续往上层看，这时执行if (p == head && tryAcquire(arg))中的方法。

final boolean acquireQueued(final Node node, int arg) {
    boolean failed = true;
    try {
        boolean interrupted = false;
        for (;;) {
            final Node p = node.predecessor();
            if (p == head && tryAcquire(arg)) {
                setHead(node);
                p.next = null; // help GC
                failed = false;
                return interrupted;
            }
            if (shouldParkAfterFailedAcquire(p, node) &&
                parkAndCheckInterrupt())
                interrupted = true;
        }
    } finally {
        if (failed)
            cancelAcquire(node);
    }
}

将第二个线程节点设置为头节点，并将头节点置为空节点。

private void setHead(Node node) {
    head = node;
    node.thread = null;
    node.prev = null;
}

第二个线程加锁完成。

第三个线程加锁第二个线程相同。不说了。

ReentrantLock非公平锁加锁过程

final void lock() {
    if (compareAndSetState(0, 1))
        setExclusiveOwnerThread(Thread.currentThread());
    else
        acquire(1);
}

可以看到，非公平锁一上来就是尝试去改变state状态。失败了走与公平锁一样的路。所以，非公平锁加锁失败之后还是老老实实排队。