Java鎖之AbstractQueuedSynchronizer

AbstractQueuedSynchronizer

一、AbstractQueuedSynchronizer

1.1 acquireQueued 同步隊列中節點獲取鎖

當前節點的前繼節點是頭節點嘗試獲取鎖，獲取成功直接返回。
當前節點的前繼節點不是頭節點或者獲取鎖失敗，判斷當前線程是否應該Park
前繼節點狀態是Node.SIGNAL(當前繼節點釋放時會喚醒後繼節點)，當前線程應該Park
前繼節點狀態是大於0，一直向前遍歷直到找到第一個前繼節點狀態小於0，設置後繼節點爲當前節點
前繼節點狀態是小於等於0且不是Node.SIGNAL，設置前繼節點狀態爲Node.SIGNAL
當前線程是需要Park時，執行Park，當執行Unpark後檢查是否設置中斷標誌
如果獲取鎖期間發生異常且failed = true即沒有獲取到鎖，同步隊列中移除當前節點
向前遍歷直到找到第一個前繼節點狀態小於0，作爲有效的前繼節點
如果當前節點是尾節點，則尾節點更換爲前繼節點
如果當前節點不是尾節點
如果前繼節點不是頭節點、前繼節點狀態是Node.SIGNAL或者成功設置爲Node.SIGNAL、前繼節點的線程
存在，設置前繼節點的後繼節點爲當前節點的後繼節點
否則喚醒後繼節點

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.2 shouldParkAfterFailedAcquire 獲取鎖後是否Park

private static boolean shouldParkAfterFailedAcquire(Node pred, Node node) {
       int ws = pred.waitStatus;
       if (ws == Node.SIGNAL)
           // 前繼節點狀態是Node.SIGNAL，當前繼節點釋放時會喚醒後繼節點
           return true;
       if (ws > 0) {
           // 前繼節點已經取消，一直向前遍歷直到找到第一個前繼節點狀態小於0
           do {
               node.prev = pred = pred.prev;
           } while (pred.waitStatus > 0);
           pred.next = node;
       } else {
           /*
            waitStatus必須爲0或PROPAGATE。 表示我們需要一個信號，但不要Park。 需要重試以確保在Park之前無法獲取。
            */
           compareAndSetWaitStatus(pred, ws, Node.SIGNAL);
       }
       return false;
   }

1.3 parkAndCheckInterrupt 喚醒且檢查線程是否中斷

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

1.4 cancelAcquire 同步隊列中移除當前節點

private void cancelAcquire(Node node) {
       // 節點爲NULL直接返回
       if (node == null)
           return;

node.thread = null;

// 向前查找合適的前繼節點
       Node pred = node.prev;
       while (pred.waitStatus > 0)
           node.prev = pred = pred.prev;

Node predNext = pred.next;
  // 當前節點獲取鎖異常設置狀態爲Node.CANCELLED
       node.waitStatus = Node.CANCELLED;

// 如果當前節點是尾節點則更換爲pred
       if (node == tail && compareAndSetTail(node, pred)) {
           compareAndSetNext(pred, predNext, null);
       } else {
           // 如果前繼節點不是頭節點、前繼節點狀態是Node.SIGNAL或者成功設置爲Node.SIGNAL、前繼節點的線程存在，設置前繼節點的後繼節點爲當前節點的後繼節點
           int ws;
           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
       }
   }

1.5 unparkSuccessor 喚醒後繼節點

(1) 如果當前節點狀態小於0設置爲0
(2) 當前節點後繼節點爲NULL獲取後繼節點狀態大於0，則從尾節點開始遍歷找到最後一個節點狀態小於等於0的節點
(3) 當前節點存在有效的後繼節點則喚醒
private void unparkSuccessor(Node node) {
       /*
        如果狀態小於0(即可能是SINGAL)，請嘗試清除以預期發出信號。 如果失敗或等待線程更改狀態，則可以。
        */
       int ws = node.waitStatus;
       if (ws < 0)
           compareAndSetWaitStatus(node, ws, 0);

/*
       要取消駐留的線程保留在後繼線程中，後者通常只是下一個節點。 但是，如果下一個節點不存在或者狀態大於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);
   }

1.6 release 釋放線程持有的鎖

1.6.1 release

public final boolean release(int arg) {
  // 留給AbstractQueuedSynchronizer子類實現
       if (tryRelease(arg)) {
           Node h = head;
           if (h != null && h.waitStatus != 0)
    // 傳送門 1.5
               unparkSuccessor(h);
           return true;
       }
       return false;
   }

1.6.2 releaseShared

public final boolean releaseShared(int arg) {
       if (tryReleaseShared(arg)) {
           doReleaseShared();
           return true;
       }
       return false;
   }

1.6.2.1 doReleaseShared

private void doReleaseShared() {
       for (;😉 {
           Node h = head;
           if (h != null && h != tail) {
     int ws = h.waitStatus; 
// 如果head的waitStatus爲SIGNAL，一定是它的後繼節點設置的，共享模式下要喚醒它的後繼
               if (ws == Node.SIGNAL) {
   // 先將head的waitStatus設置爲0,成功後喚醒其後繼
                   if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
                       continue;
   // 若成功喚醒了它的後繼，它的後繼就會去獲取鎖，如果獲取成功，會造成head的改變
                   unparkSuccessor(h);
               }
     // 沒有後繼結點,設爲PROPAGATE
               else if (ws == 0 &&
                        !compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
                   continue;  
           }
 // 若head發生改變,說明後繼成功獲取了鎖，此時要檢查新head的waitStatus，判斷是否繼續喚醒(下次循環)，head沒有發生改變則停止持續喚醒
           if (h == head)  
               break;
       }
   }

1.7 獨佔式獲取鎖

1.7.1 acquire

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

1.7.2 acquireInterruptibly

public final void acquireInterruptibly(int arg)
           throws InterruptedException {
       if (Thread.interrupted())
           throw new InterruptedException();
       if (!tryAcquire(arg))
          ** doAcquireInterruptibly(arg);**
   }

1.7.2.1 doAcquireInterruptibly

// acquireQueued 傳送門1.1
private void doAcquireInterruptibly(int arg)
       throws InterruptedException {
       final Node node = addWaiter(Node.EXCLUSIVE);
       boolean failed = true;
       try {
           for (;😉 {
               final Node p = node.predecessor();
               if (p == head && tryAcquire(arg)) {
                   setHead(node);
                   p.next = null; // help GC
                   failed = false;
                   return;
               }
               if (shouldParkAfterFailedAcquire(p, node) &&
                   parkAndCheckInterrupt())
                   throw new InterruptedException();
           }
       } finally {
           if (failed)
// 傳送門 1.4
               cancelAcquire(node);
       }
   }

1.8 共享式獲取鎖

1.8.1 acquireShared

public final void acquireShared(int arg) {
       if (tryAcquireShared(arg) < 0)
           doAcquireShared(arg);
   }

1.8.1.1 doAcquireShared

private void doAcquireShared(int arg) {
       final Node node = addWaiter(Node.SHARED);
       boolean failed = true;
       try {
           boolean interrupted = false;
           for (;😉 {
               final Node p = node.predecessor();
               if (p == head) {
                   int r = tryAcquireShared(arg);
                   if (r >= 0) {
  // 設置隊列頭，並檢查後繼者是否可能在共享模式下等待，如果正在傳播，則傳播是否設置爲propagate > 0或PROPAGATE狀態。
                       setHeadAndPropagate(node, r);
                       p.next = null; // help GC
                       if (interrupted)
                           selfInterrupt();
                       failed = false;
                       return;
                   }
               }
               if (shouldParkAfterFailedAcquire(p, node) &&
                   parkAndCheckInterrupt())
                 **  interrupted = true;**
           }
       } finally {
           if (failed)
// 傳送門 1.4
               cancelAcquire(node);
       }
   }

1.8.2 acquireSharedInterruptibly

public final void acquireSharedInterruptibly(int arg)
           throws InterruptedException {
       if (Thread.interrupted())
           throw new InterruptedException();
       if (tryAcquireShared(arg) < 0)
           doAcquireSharedInterruptibly(arg);
   }

1.8.2.1 doAcquireSharedInterruptibly

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) {
  // 設置隊列頭，並檢查後繼者是否可能在共享模式下等待，如果正在傳播，則傳播是否設置爲傳播> 0或PROPAGATE狀態。
                       setHeadAndPropagate(node, r);
                       p.next = null; // help GC
                       failed = false;
                       return;
                   }
               }
               if (shouldParkAfterFailedAcquire(p, node) &&
                   parkAndCheckInterrupt())
                   throw new InterruptedException();
           }
       } finally {
           if (failed)
// 傳送門 1.4
               cancelAcquire(node);
       }
   }

1.8.2.2 setHeadAndPropagate

// propagate是資源剩餘量
private void setHeadAndPropagate(Node node, int propagate) {
  // 將舊的頭結點先記錄下來
       Node h = head;
  // 將當前node線程設爲頭結點,node已經獲取了鎖
       setHead(node);
  // 如果資源有剩餘量，或者原來的頭結點的waitStatus小於0，進一步檢查node後繼節點是否也是共享模式
       if (propagate > 0 || h == null || h.waitStatus < 0 ||
           (h = head) == null || h.waitStatus < 0) {
           Node s = node.next;
// 如果後繼節點是共享模式或者現在還看不到後繼的狀態，則都繼續喚醒後繼線程
           if (s == null || s.isShared())
               doReleaseShared();
       }
   }

二、ConditionObject

2.1 喚醒條件隊列中的節點

2.1.1 signal 喚醒條件隊列中一個節點

public final void signal() {
           if (!isHeldExclusively())
               throw new IllegalMonitorStateException();
           Node first = firstWaiter;
           if (first != null)
               doSignal(first);
       }

// 直到條件隊列中節點第一個進入同步對列爲止
 private void doSignal(Node first) {
           do {
               if ( (firstWaiter = first.nextWaiter) == null)
                   lastWaiter = null;
               first.nextWaiter = null;
           } while (!transferForSignal(first) &&
**                    (first = firstWaiter) != null);**
       }

2.1.2 signalAll 喚醒條件隊列中所有節點

public final void signalAll() {
           if (!isHeldExclusively())
               throw new IllegalMonitorStateException();
           Node first = firstWaiter;
           if (first != null)
               doSignalAll(first);
       }

// 不保證條件隊列中所有節點都能進入同步對列
private void doSignalAll(Node first) {
           lastWaiter = firstWaiter = null;
           do {
               Node next = first.nextWaiter;
               first.nextWaiter = null;
               transferForSignal(first);
               first = next;
           } while (first != null);
       }

2.1.3 transferForSignal 條件隊列中節點轉移到同步隊列

final boolean transferForSignal(Node node) {
       // 如果無法更改waitStatus，則該節點已被取消。
       if (!compareAndSetWaitStatus(node, Node.CONDITION, 0))
           return false;

/*
        進入到同步隊列並嘗試設置前繼節點的waitStatus來指示線程（可能）正在等待。 如果取消設置或嘗試設置waitStatus失敗，請喚醒以重新同步（在這種情況下，waitStatus可能會短暫而無害地出現錯誤）。
        */
       Node p = enq(node);
       int ws = p.waitStatus;
  // 前繼節點狀態大於0表示節點已經取消或者設置狀態爲Node.SIGNAL失敗則喚醒節點線程競爭鎖。
       if (ws > 0 || !compareAndSetWaitStatus(p, ws, Node.SIGNAL))
           LockSupport.unpark(node.thread);
       return true;
   }

2.2 條件隊列中節點取消等待

2.2.1 checkInterruptWhileWaiting 檢查條件隊列中節點是否設置中斷信號

// await()  await(等待時間) awaitNanos awaitUntil 調用該方法檢查是否被中斷
// 條件隊列中節點在等待過程中可能被其他線程設置了中斷信號，需要檢查中斷，如果在發出信號(調用signal/signal方法)之前被中斷，則返回THROW_IE；如果在發出信號(調用signal/signal方法)之後被中斷，則返回REINTERRUPT；否則，則返回0。
private int checkInterruptWhileWaiting(Node node) {
           return Thread.interrupted() ?
               (transferAfterCancelledWait(node) ? THROW_IE : REINTERRUPT) :
               0;
       }

2.2.2 transferAfterCancelledWait 條件隊列中節點取消等待後轉移到同步隊列

// await(等待時間) awaitNanos awaitUntil 等待時間到達或者設置了中斷標誌調用該方法轉移到同步隊列
// 條件隊列中節點取消等待後轉移到同步隊列。signal signalAll方法將節點轉移到同步隊列中。
final boolean transferAfterCancelledWait(Node node) {
       // 條件隊列中節點狀態成功設置爲0，則進入同步隊列
       if (compareAndSetWaitStatus(node, Node.CONDITION, 0)) {
           enq(node);
           return true;
       }
       // 如果調用signal/signal方法，那麼直到它完成enq()之前我們無法繼續進行
       while (!isOnSyncQueue(node))
           Thread.yield();
       return false;
   }

2.2.3 isOnSyncQueue 檢查節點是否在同步隊列中

(1) 節點狀態是Node.CONDITION 或者 前繼節點是NULL，則節點不在同步隊列中。
(2) 節點後繼節點不爲NULL，則節點在同步隊列中。
(3) 節點前繼節點不爲NULL，節點狀態不是Node.CONDITION，且後繼節點爲NULL，可能是同步隊列尾節點。則從同步隊列尾節點開始向前便利，判斷節點是否是同步隊列中的節點。

final boolean isOnSyncQueue(Node node) {
       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可以爲非null，但尚未排隊，因爲將節點放入隊列的CAS可能會失敗。 因此，我們必須從尾部開始遍歷以確保它確實做到了。 在此方法的調用中，它將始終處於尾部，除非CAS失敗（這不太可能），否則它將一直存在，因此我們幾乎不會遍歷太多。
        */
       return findNodeFromTail(node);
   }

2.2.4 findNodeFromTail 從尾向前搜索節點是否在同步隊列中

如果節點在同步隊列中（從尾向前搜索），則返回true。僅在isOnSyncQueue需要時調用。
private boolean findNodeFromTail(Node node) {
       Node t = tail;
       for (;😉 {
           if (t == node)
               return true;
           if (t == null)
               return false;
           t = t.prev;
       }
   }

2.3 不響應中斷的等待

2.3.1 awaitUninterruptibly

public final void awaitUninterruptibly() {
// 往條件隊列中添加節點
           Node node = addConditionWaiter();
// 釋放節點持有的狀態即鎖
           int savedState = fullyRelease(node);
           boolean interrupted = false;
// 循環檢測節點是否被轉移到同步隊列中
           while (!isOnSyncQueue(node)) {
               LockSupport.park(this);
               if (Thread.interrupted())
                   interrupted = true;
           }

// 線程被喚醒嘗試獲取鎖 傳送門：1.1
           if (acquireQueued(node, savedState) || interrupted)
               selfInterrupt();
       }

2.3.2 addConditionWaiter 添加條件隊列節點

// 判斷尾節點狀態，如果狀態不是Node.CONDITION則從頭節點開始遍歷刪除狀態不是Node.CONDITION的節點
// 創建節點並加入條件隊列中
private Node addConditionWaiter() {
           Node t = lastWaiter;
           // 尾節點狀態不是Node.CONDITION需要清除
           if (t != null && t.waitStatus != Node.CONDITION) {
               unlinkCancelledWaiters();
               t = lastWaiter;
           }

// 創建節點並加入條件隊列中
           Node node = new Node(Thread.currentThread(), Node.CONDITION);
           if (t == null)
               firstWaiter = node;
           else
               t.nextWaiter = node;
           lastWaiter = node;
           return node;
       }

2.3.2.1 unlinkCancelledWaiters 刪除條件隊列中狀態不是CONDITION的節點

// 從頭節點開始遍歷刪除狀態不是Node.CONDITION的節點
private void unlinkCancelledWaiters() {
           Node t = firstWaiter;
           Node trail = null;
           while (t != null) {
               Node next = t.nextWaiter;
               if (t.waitStatus != Node.CONDITION) {
                   t.nextWaiter = null;
                   if (trail == null)
                       firstWaiter = next;
                   else
                       trail.nextWaiter = next;
                   if (next == null)
                       lastWaiter = trail;
               }
               else
                   trail = t;
               t = next;
           }
       }

2.3.3 fullyRelease 釋放當前線程持有的鎖狀態

final int fullyRelease(Node node) {
       boolean failed = true;
       try {
           int savedState = getState();
// 傳送門 1.6.1
           if (release(savedState)) {
               failed = false;
               return savedState;
           } else {
               throw new IllegalMonitorStateException();
           }
       } finally {
           if (failed)
               node.waitStatus = Node.CANCELLED;
       }
   }