FutureTask原始碼分析筆記

seven1978發表於2019-01-19
原始碼筆記

主要的實現FutureTask

# FutureTask實際上執行還是一個runnable，它對callable做了一個封裝，讓開發人員可以從其中獲取返回值；
FutrueTask是有狀態的 共7種狀態，四種狀態變換的可能
NEW -> COMPLETING -> EXCEPTIONAL
NEW -> CANCELLED
NEW -> COMPLETING -> NORMAL
NEW -> INTERRUPTING -> INTERRUPTED

Callable和runnable的區別

0. 通過call方法呼叫；
1. 有返回值
2. 可以拋異常

get結果的實現原理

1. 判斷狀態；
2. 非NEW,COMPLETING狀態則直接 進入report返回結果；
3. 處於NEW,COMPLETING狀態，則進入等待awaitDone()；

3.x awaitDone 流程

3.1. 獲取等待的超時時間deadline；
3.2. 進入自旋
3.3. 判斷執行緒是否被中斷：如果被中斷則移出等待waiters佇列；並丟擲異常；
3.4. 判斷FutrueTask狀態：如果">COMPLETING"，代表執行完成，進入report；
3.5. 判斷FutrueTask狀態：如果"=COMPLETING"，讓出CPU執行Thread.yield();
3.6. 為當前執行緒建立一個node節點；
3.7. 將當前執行緒WaitNode加入等待佇列waiters中；
3.8. 判斷是否超時；
3.9. 通過LockSupport.park掛起執行緒，等待執行許可；
4. report返回執行結果：如果一切正常就返回執行結果，否則返回Exception；

run具體執行原理如下：

1. 判斷狀態是否正常，避免重複執行；
2. 呼叫callable的call()方法；
3. 修改執行狀態；儲存執行結果；並通知正在等待get的執行緒；
## 3.x通知機制finishCompletion
3.1. 獲取所有waiters的集合；
3.2. 通過cas 拿到執行權；
3.3. 迴圈遍歷所有等待的執行緒，通過LockSupport.unpark 喚醒其執行；

Callable和Future的實現原理（JDK8原始碼分析）

1. cancel 取消執行

public boolean cancel(boolean mayInterruptIfRunning) {
    // 判斷狀態：只有剛建立的情況下才能取消
    // mayInterruptIfRunning：是否中斷當前正在執行這個FutureTask的執行緒；
    if (!(state == NEW &&
          UNSAFE.compareAndSwapInt(this, stateOffset, NEW,
              mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
        return false;
    try {    // in case call to interrupt throws exception
        // 如果要中斷當前執行緒，則對runner釋出interrupt訊號；
        if (mayInterruptIfRunning) {
            try {
                Thread t = runner;
                if (t != null)
                    t.interrupt();
            } finally { // final state
                // 修改狀態為：已經通知執行緒進行中斷
                UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
            }
        }
    } finally {
        // 通知其他在等待結果的執行緒
        finishCompletion();
    }
    return true;
}

2. run

public void run() {
    // 判斷狀態及設定futuretask歸屬的執行緒
    if (state != NEW ||
        !UNSAFE.compareAndSwapObject(this, runnerOffset,
                                    null, Thread.currentThread()))
        return;
    try {
        Callable<V> c = callable;
        if (c != null && state == NEW) {
            V result;
            boolean ran;
            try {
                // 執行Callable
                result = c.call();
                // 標記為執行成功
                ran = true;
            } catch (Throwable ex) {
                result = null;
                // 標記為執行不成功
                ran = false;
                // 設定為異常狀態，並通知其他在等待結果的執行緒
                setException(ex);
            }
            // 如果執行成功，修改狀態為正常，並通知其他在等待結果的執行緒
            if (ran)
                set(result);
        }
    } finally {
        // runner must be non-null until state is settled to
        // prevent concurrent calls to run()
        runner = null;
        // state must be re-read after nulling runner to prevent
        // leaked interrupts
        int s = state;
        // 如果狀態為準備發起中斷訊號或者已經發出中斷訊號，則讓出CPU（Thread.yield()）
        if (s >= INTERRUPTING)
            handlePossibleCancellationInterrupt(s);
    }
}

3. get

public V get() throws InterruptedException, ExecutionException {
    int s = state;
    // 如果還沒執行完，則等待
    if (s <= COMPLETING)
        s = awaitDone(false, 0L);
    // 通過report取結果
    return report(s);
}

3.1 report 取執行結果

private V report(int s) throws ExecutionException {
    Object x = outcome;
    // 如果一切正常，則返回x(x是callable執行的結果outcome)
    if (s == NORMAL)
        return (V)x;
    // 如果被取消，則丟擲已取消異常
    if (s >= CANCELLED)
        throw new CancellationException();
    // 否則丟擲執行異常
    throw new ExecutionException((Throwable)x);
}

3.2 awaitDone 等待FutureTask執行結束

private int awaitDone(boolean timed, long nanos)
    throws InterruptedException {
    // 記錄等待超時的時間
    final long deadline = timed ? System.nanoTime() + nanos : 0L;
    // 多個在等待結果的執行緒，通過一個連結串列進行儲存，waitNode就是每個執行緒在連結串列中的節點;
    WaitNode q = null;
    boolean queued = false;
    // 死迴圈...也可以說是自旋鎖同步
    for (;;) {
        // 判斷當前這個呼叫get的執行緒是否被中斷
        if (Thread.interrupted()) {
            // 將當前執行緒移出佇列
            removeWaiter(q);
            throw new InterruptedException();
        }
        
        int s = state;
        // 如果狀態非初創或執行完畢了,則跳出迴圈，通過report()取執行結果
        if (s > COMPLETING) {
            if (q != null)
                q.thread = null;
            return s;
        }
        // 如果狀態等於已執行,讓出CPU執行，等待狀態變為正常結束
        else if (s == COMPLETING) // cannot time out yet
            Thread.yield();
        // 如果當前執行緒還沒有建立物件的waitNode節點，則建立一個
        else if (q == null)
            q = new WaitNode();
        // 如果當前執行緒對應的waitNode還沒有加入到等待連結串列中，則加入進去;
        else if (!queued)
            queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                q.next = waiters, q);
        // 如果有設定等待超時時間，則通過parkNanos掛起當前執行緒，等待繼續執行的訊號
        else if (timed) {
            nanos = deadline - System.nanoTime();
            if (nanos <= 0L) {
                removeWaiter(q);
                return state;
            }
            LockSupport.parkNanos(this, nanos);
        }
        // 通過park掛起當前執行緒，等待task執行結束後給它發一個繼續執行的訊號(unpark)
        else
            LockSupport.park(this);
    }
}

4. finishCompletion 通知所有在等待結果的執行緒

private void finishCompletion() {
    // assert state > COMPLETING;
    // 遍歷所有正在等待執行結果的執行緒
    for (WaitNode q; (q = waiters) != null;) {
        if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
            for (;;) {
                Thread t = q.thread;
                if (t != null) {
                    q.thread = null;
                    // unpark，釋出一個讓它繼續執行的“許可”
                    LockSupport.unpark(t);
                }
                WaitNode next = q.next;
                if (next == null)
                    break;
                q.next = null; // unlink to help gc
                q = next;
            }
            break;
        }
    }

    done();

    callable = null;        // to reduce footprint
}

相關文章