ReentrantLock源码解析

简介

• ReentrantLock是AQS下一种实现，提供了公平锁与非公平锁两种机制。
• 默认为非公平锁，可在ReentrantLock实例化时指定。
• 公平锁与非公平锁区别在于，当一个线程获取锁时，如果当前锁已被其他线程获取。公平锁直接将当前线程加入到阻塞队列，而非公平锁会尝试再次获取锁，若获取成功将不再阻塞。

初始化

public ReentrantLock() {
	sync = new NonfairSync(); // 非公平锁
}

public ReentrantLock(boolean fair) {
	sync = fair ? new FairSync() : new NonfairSync(); // 指定公平|非公平锁
}

获取锁

ReentrantLock提供了两种获取锁的方式，lock()、tryLock()。
lock()获取锁时，如果锁已被其他线程持有，当前线程会进入阻塞状态。
tryLock()获取锁时，如果锁已被其他线程持有，将放弃锁的获取，而是继续执行当前线程。

public boolean tryLock()

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;
	}
	// 未获取到锁，不再阻塞等待，直接返回false结束锁获取
	return false;
}

final void lock()【NonfairSync】

final void lock() {
	// 如果当前锁状态为0，则将锁状态该为1，表示当前线程获取当了锁
	if (compareAndSetState(0, 1))
		setExclusiveOwnerThread(Thread.currentThread()); // 设置获取到锁的线程
	else
		acquire(1);
}

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

// 非公平锁尝试获取锁
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;
}

执行至此处时，表示当前线程未获取到锁。

// 添加当前线程到等待队列
private Node addWaiter(Node mode) {
	// 创建一个thread为当前线程的节点
	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) { // 当tail节点不为null时
		node.prev = pred; // 将当前节点的prev节点指向tail节点
		if (compareAndSetTail(pred, node)) { // 将tail节点指向当前节点
			pred.next = node; // 原tail节点的next节点指向当前节点
			return node;
		}
	}
	enq(node); // 当tail节点为空或者将tail节点指向当前节点失败时，会执行到当前
	return node;
}

// 当前线程入队
private Node enq(final Node node) {
	// 由于当前操作是非线程安全的，使用了CAS+自旋的方式来保证操作的原子性以及节点入队
	for (;;) {
		Node t = tail;
		if (t == null) { // Must initialize
			if (compareAndSetHead(new Node())) // tail节点为空时，会创建一个thread为null节点，并使head、tail节点指向该节点
				tail = head;
		} else {
			// 此处与addWaiter()方法逻辑是一致的，将当前节点的prev节点指向tail节点，并将tail节点指向当前节点以及原tail节点的next节点指向当前节点
			// 如果将tail节点指向当前节点失败，由于使用了自旋方式，会不断尝试该操作，直至将tail节点指向当前节点为止
			node.prev = t;
			if (compareAndSetTail(t, node)) {
				t.next = node;
				return t;
			}
		}
	}
}

// 此时当前线程节点以及加入到队列中
final boolean acquireQueued(final Node node, int arg) {
	boolean failed = true;
	try {
		boolean interrupted = false;
		// 进入到此后，首先会尝试获取锁，
		for (;;) {
			final Node p = node.predecessor(); // 获取当前节点的prev节点
			if (p == head && tryAcquire(arg)) { // 如果prev节点是head节点，会尝试获取锁
				// 此时表示当前线程获取到了锁，但节点仍在队列中
				// 将当前节点设置为head节点
				// 很巧妙隐形的将当前节点从队列中移除【因为此时已获得锁】
				setHead(node);
				p.next = null; // help GC
				failed = false;
				return interrupted;
			}
			// 将head节点waitStatus设为SIGNAL，并让当前线程挂起，直至线程被唤醒，
			// 线程被唤醒后会再次尝试获取锁，如果获取失败会再次被挂起，如此自旋直至获取锁为止
			if (shouldParkAfterFailedAcquire(p, node) &&
				parkAndCheckInterrupt())
				interrupted = true;
		}
	} finally {
		if (failed)
			cancelAcquire(node);
	}
}

// 将当前节点设置为head节点
// 将节点的prev节点与thread设置为null即可
private void setHead(Node node) {
	head = node;
	node.thread = null;
	node.prev = null;
}

private static boolean shouldParkAfterFailedAcquire(Node pred, Node node) {
	int ws = pred.waitStatus; // 获取prev节点waitStatus
	if (ws == Node.SIGNAL)
		return true;
	if (ws > 0) { // waitStatus>0，标段已取消
		// 从队列中删除当前节点的prev节点已取消的节点，但是否被GC回收来呢？？？是否原来的prev、next指向依然在。
		do {
			node.prev = pred = pred.prev; // 将当前节点的prev节点指向prev节点的prev节点
		} while (pred.waitStatus > 0);
		pred.next = node; // 当前节点新的prev节点指向当前节点
	} else {
		compareAndSetWaitStatus(pred, ws, Node.SIGNAL); // 设置当前节点的prev节点的状态为SIGNAL
	}
	return false;
}

// 此时当前线程经过了层层叠嶂，依然未获取到锁，于是将当前线程挂起。
private final boolean parkAndCheckInterrupt() {
	LockSupport.park(this);
	return Thread.interrupted();
}

此时，lock()获取指向完毕，如果获取到了锁就继续执行当前线程，否则当前线程已挂起。

释放锁

final void lock()【NonfairSync】

public final boolean release(int arg) {
	if (tryRelease(arg)) { // 锁是否成功
		Node h = head;
		if (h != null && h.waitStatus != 0) // head节点不为null并且状态不为0时，唤醒一个阻塞中线程
			unparkSuccessor(h);
		return true;
	}
	return false;
}

// 尝试释放
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;
}

// 唤醒线程，node=head，但似乎没有从队列中删除，是在唤醒后尝试获得锁成功后删除的
private void unparkSuccessor(Node node) {
	int ws = node.waitStatus; // waitStatus=SIGNAL，在shouldParkAfterFailedAcquire()中设置的
	if (ws < 0)
		compareAndSetWaitStatus(node, ws, 0); // 设置head的waitStatus为0

	Node s = node.next; // 获取head的next节点，即队列中第一个thread不为null节点
	if (s == null || s.waitStatus > 0) { // 节点为空或者waitStatus大于0时
		s = null; // s节点本就为null或者已被取消，从新设置为null
		// 从tail节点开始直至head节点
		// 为什么要这样操作呢？？？
		// 虽然s当前是null，
		for (Node t = tail; t != null && t != node; t = t.prev)
			if (t.waitStatus <= 0) // waitStatus不是取消时，设置s为该节点
				s = t;
	}
	// 当待唤醒节点不为null时，唤醒该节点
	if (s != null)
		LockSupport.unpark(s.thread);
}

// 取消当前线程节点
private void cancelAcquire(Node node) {
	if (node == null)
		return;

	node.thread = null; // 设置节点thread为null

	Node pred = node.prev;
	while (pred.waitStatus > 0)
		node.prev = pred = pred.prev;

	Node predNext = pred.next; // 最新pred节点的next节点

	node.waitStatus = Node.CANCELLED; // 当前节点设置为取消状态

	// 如果当前节点是tail节点，则将tail节点指向最新得到的pred节点
	if (node == tail && compareAndSetTail(node, pred)) {
		compareAndSetNext(pred, predNext, null); // 设置最新tail节点的next节点为null
	} else {
		int ws;
		// tail节点不等于head节点 && (tail节点SIGNAL || tail的thread不为null)
		if (pred != head &&
			((ws = pred.waitStatus) == Node.SIGNAL ||
			 (ws <= 0 && compareAndSetWaitStatus(pred, ws, Node.SIGNAL))) &&
			pred.thread != null) {
			Node next = node.next;
			if (next != null && next.waitStatus <= 0)
				compareAndSetNext(pred, predNext, next);
		} else {
			// 唤醒第一个有效节点
			unparkSuccessor(node);
		}

		node.next = node; // help GC
	}
}

原文地址：https://www.cnblogs.com/90909de0/p/15932364.html