ReentrantLock源码解析

ReentrantLock的概念

ReentrantLock是一个可重入的独占锁，即允许同一个线程获取多次，但是不允许多个线程同时获取锁。即又是一个互斥锁。
ReentrantLock有公平锁和非公平锁两种模式，
主要控制锁和释放锁的方法都是有一个类型为sync的成员变量控制的，

 private final Sync sync;

    abstract static class Sync extends AbstractQueuedSynchronizer 

它继承自AbstractQueuedSynchronizer（下文简称AQS）这是concurrent包下一个非常有用的用于同步和锁的基类，其实现是基于一个先进先出队列，用CAS控制变量的状态来控制锁的控制权。子类实现它既可以用作互斥锁，又可以作为共享锁。
sync本身是一个抽象类，提供了一个抽象的lock()方法供子类实现。

   abstract void lock();

其实现有公平锁和非公平锁都是继承自Sync作为ReentrantLock的内部类，ReentrantLock默认创建的是非公平锁，因为获取锁控制主要有一个FIFO队列来管理的，非公平锁，会直接尝试去获得锁，而公平锁这是按照对列的顺序来决定谁获取锁，即如果队列前面有线程等待获取锁，当前线程就会继续等待。公平锁整体的吞吐量低。

  /**
     * Creates an instance of {@code ReentrantLock}.
     * This is equivalent to using {@code ReentrantLock(false)}.
     */
    public ReentrantLock() {
        sync = new NonfairSync();
    }

    /**
     * Creates an instance of {@code ReentrantLock} with the
     * given fairness policy.
     *
     * @param fair {@code true} if this lock should use a fair ordering policy
     */
    public ReentrantLock(boolean fair) {
        sync = fair ? new FairSync() : new NonfairSync();
    }

非公平锁

具体的实现是有2个不同的内部类实现的。

 /**
     * Sync object for non-fair locks
     */
    static final class NonfairSync extends Sync {
        private static final long serialVersionUID = 7316153563782823691L;

        /**
         * Performs lock.  Try immediate barge, backing up to normal
         * acquire on failure.
         */
        final void lock() {
        //先判断AQS中的state是否为0
            if (compareAndSetState(0, 1))
                setExclusiveOwnerThread(Thread.currentThread());
            else
                acquire(1);
        }

        protected final boolean tryAcquire(int acquires) {
            return nonfairTryAcquire(acquires);
        }
    }

先来看lock()方法,
1.首先以compareAndSetState(0, 1)这是AQS用CAS方式给其state字段（用于控制同步的变量）进行对比赋值。
这个方法的意思是如果当前参数为0就把1赋值给state字段。
这里简单的介绍一个什么叫CAS（Compare and swap）即比较和替换，我们知道在java中只有赋值和return操作是原子性的，例如i++这种算数运算在多线程的情况下就会出现问题，例如下面例子。

if(state == 0){
     state=1;
}

除非在上述代码包裹在中加入synchronized修饰的函数或代码代码块中。而使用CAS可以将上述的操作视为原子的操作而且CAS特性可以让你利用底层的你的程序所运行机器的CPU的CAS特性。这会使还有CAS的代码运行更快。我们看看这个方法

    protected final boolean compareAndSetState(int expect, int update) {
        // See below for intrinsics setup to support this
        return unsafe.compareAndSwapInt(this, stateOffset, expect, update);
    }

其调用的Unsafe的compareAndSwapInt()方法，其底层实现是由c++实现的。concurrent报下还提供很多原子操作的类，AtomicInteger，AtomicBoolean。。等可以用与CAS来控制同步。
我们回归正题，如果if中返回true，即state被赋值为1即表示当前线程获取了锁，

setExclusiveOwnerThread(Thread.currentThread());

    protected final void setExclusiveOwnerThread(Thread thread) {
        exclusiveOwnerThread = thread;
    }

将当前占有锁的线程设置为当前现成。
2.如果state设置失败，返回了false，则尝试再次获取锁，如果获取失败则加入到等待队列，这个方法是AQS中的方法。

acquire(1);

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

1首先要调用tryAcquire(arg)方法，这个方法AQS本身并未做具体的实现，只是抛出了一个异常，由子类重写。
我们看下非公平锁的实现，调用了syn的nonfairTryAcquire方法

 protected final boolean tryAcquire(int acquires) {
            return nonfairTryAcquire(acquires);
        }

 final boolean nonfairTryAcquire(int acquires) {
            final Thread current = Thread.currentThread();
            int c = getState();
            if (c == 0) {
                if (compareAndSetState(0, acquires)) {
                    setExclusiveOwnerThread(current);
                    return true;
                }
            }
            else if (current == getExclusiveOwnerThread()) {
                int nextc = c + acquires;
                if (nextc < 0) // overflow
                    throw new Error("Maximum lock count exceeded");
                setState(nextc);
                return true;
            }
            return false;
        }

该方法意思和前面差不多，就是获取判断AQS中state的状态，如果是0则说明当前锁未被别的线程获取，由该线程尝试获取，并将占有锁的线程设置为当前线程。返回true,如果state不为0，就判断当前线程和占有锁的线程是否是同一个线程，如果是就将state的值递增赋给state，都不符合就返回false。

如果tryAcquire方法返回false，说明获取锁失败，该线程将被加入等待队列。

AQS的等待队列是由Node节点构成的，Node节点是AQS的一个内部类

   static final class Node {
    static final Node SHARED = new Node();

    static final Node EXCLUSIVE = null;
    //当前线程取消
    static final int CANCELLED =  1;
    //表示当前节点的后继节点需要获取锁
    static final int SIGNAL    = -1;
    //当前节点在conditon条件队列中
    static final int CONDITION = -2;
     //后续的acquireShared能够得以执行
    static final int PROPAGATE = -3;
    //以上几个常量都表示waitstatus的可能值，默认创建Node的waitstatus的值为0,表示当前节点在等待锁。
    volatile int waitStatus;
    //指向前面的节点
    volatile Node prev;
    //保存线程变量的引用
    volatile Thread thread;
    指向后面的节点
     volatile Node next;
    //存贮condition条件队列的后继节点
    Node nextWaiter;

    final boolean isShared() {
        return nextWaiter == SHARED;
    }

其实就是一个双链表构成的队列。我们继续看
addWaiter(Node.EXCLUSIVE), arg)方法

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

1.以独占锁的形式为当前线程创建了node节点，判断尾节点是否为空（tail和head是AQS的全局变量，保存的等待队列的队头和队尾的引用），如不为空则将当前节点加入等待队列的尾部，并返回。
2.如果当前队列为空，则执行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;
                }
            }
        }
    }

进入到循环，获取尾节点，如果为空，利用CAS创建一个新的节点赋值给头结点，尾节点指向头结点。完成队列的初始化。第二次t肯定不为空，进入else，将node的前置节点设置为前一个尾节点t,
调用compareAndSetTail(t, node)方法比较t和tail尾节点，如果t是尾节点 ,将t的后置节点设置为node节点，然后返回。这样node节点就被插入到等待队列的队尾了。
让我们addWaiter将当前线程插入队列之后，

acquireQueued(addWaiter(Node.EXCLUSIVE), 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);
        }
    }

这个方法主要就是当线程通过自旋的方式去获取锁，
1.首先判断当前node节点的前驱节点是否是头结点，如果是并且调用tryAcquire(arg),成功的获取了锁，就将node节点设置为头结点，将p节点设置为null，这是为了使gc更快的回收该对象，然后返回false。
2.如果当前节点不是头结点，则进入第二个if语句的判断shouldParkAfterFailedAcquire(p, node)&&parkAndCheckInterrupt()
我们先看shouldParkAfterFailedAcquire(Node pred, Node node)方法

 private static boolean shouldParkAfterFailedAcquire(Node pred, Node node) {
        int ws = pred.waitStatus;
        if (ws == Node.SIGNAL)     
            return true;
        if (ws > 0) {

            do {
                node.prev = pred = pred.prev;
            } while (pred.waitStatus > 0);
            pred.next = node;
        } else {        
            compareAndSetWaitStatus(pred, ws, Node.SIGNAL);
        }
        return false;
    }

1.首先获取前驱节点p的waitstatus,在独占锁模式下，创建时是0，判断其是不是等于-1，-1表示当前节点需要获取锁，如果等于-1则返回true,
2.如果不等于-1，判断是否大于0，0表示当前线程取消获取锁，括号里面是一个do while循环，就是找到一个不大waitstatus不大于0的，即把取消的任务的节点从队列里面删除。
3.利用CAS将前驱节点的waitstatus的值设置为-1。并返回false。又会尝试去获取锁如果还失败就会调用
parkAndCheckInterrupt()

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

这里LockSupport的park方法其实底层也是调的unsafe的park方法，作用就是阻塞当前线程。知道别的线程调用了unsafe的unpark方法
相当与一个唤醒的作用。

上面讲了如何获取锁，再来看如何释放锁

public void unlock() {
        sync.release(1);
    }

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

调用的还是AQS的release方法，
1.调用尝试释放的方法tryRelease(arg)，

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

这是由sync类重写的，
1.将state的值减1（入参是1），判断当前线程和掌握锁的线程是否是同一个线程，不是则抛出IllegalMonitorStateException()，
判断state的值是不是0如果是0则返回true,否则返回false

继续看AQS的release方法

  if (tryRelease(arg)) {
            Node h = head;
            if (h != null && h.waitStatus != 0)
                unparkSuccessor(h);
            return true;
        }

如果返回true，取头结点，判断头节点的值不为空或不为0的话，唤醒后面的节点

 private void unparkSuccessor(Node node) {
        int ws = node.waitStatus;
        if (ws < 0)
            compareAndSetWaitStatus(node, ws, 0);
        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);
    }

更改node节点的waitstatus状态，如果当前node的waitstatus状态小于0就把它改为0，取node节点的后继节点s,如果s不为空就唤醒s的线程（队列中每个节点都在自旋只有当前节点的前置节点是头结点的时候，当前节点才能获取锁），如果s为空就从队尾找一个不为空的并且waitstatus<0的进行唤醒。这里如果当前等待队列不为空，则重新设置队列头结点的时候是在调用acquireQueued方法的时候，会将自身设置为头结点。如果当前节点在被唤醒了有机会获得锁，但任务被中断了，则在finally块中 cancelAcquire(node);会取消当前节点任务，重新找一个新的节点进行唤醒。

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

公平锁

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

    final void lock() {
        acquire(1);
    }


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

与非公平锁的区别在于tryAcquire方法中调用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());
    }