Java8 ForkJoinTask 源碼解析

目錄

1、定義

2、fork 

3、join / quietlyJoin

4、invoke / quietlyInvoke

5、complete / quietlyComplete/ completeExceptionally

6、recordExceptionalCompletion / clearExceptionalCompletion / getException 

7、invokeAll

8、get

9、tryUnfork / reinitialize


      本篇博客講解ForkJoinTask的fork,join,invoke等方法的實現細節及其使用。

1、定義

       ForkJoinTask表示在ForkJoinPool中執行的一個任務,其類繼承關係如下:

該類是一個抽象類,有多個子類,如下:

帶S的幾個大都是ForkJoinTask的內部類,其實現比較簡單,用於將Runnable等接口轉換成ForkJoinTask類,對應於ForkJoinPool的adapt方法,以AdaptedCallable的實現爲例說明,如下:

public static <T> ForkJoinTask<T> adapt(Callable<? extends T> callable) {
        return new AdaptedCallable<T>(callable);
    }

static final class AdaptedCallable<T> extends ForkJoinTask<T>
        implements RunnableFuture<T> {
        final Callable<? extends T> callable;
        T result;
        AdaptedCallable(Callable<? extends T> callable) {
            if (callable == null) throw new NullPointerException();
            this.callable = callable;
        }
        public final T getRawResult() { return result; }
        public final void setRawResult(T v) { result = v; }

        //改寫核心的exec方法
        public final boolean exec() {
            try {
                result = callable.call();
                return true;
            } catch (Error err) {
                throw err;
            } catch (RuntimeException rex) {
                throw rex;
            } catch (Exception ex) {
                throw new RuntimeException(ex);
            }
        }
        public final void run() { invoke(); }
        private static final long serialVersionUID = 2838392045355241008L;
    }

該類包含的屬性如下:

 //保存ExceptionNode的數組,單個數組元素對應一個ExceptionNode鏈表
 private static final ExceptionNode[] exceptionTable;

 //修改exceptionTable時的鎖
 private static final ReentrantLock exceptionTableLock;
 
 //保存被清楚掉的弱引用的隊列   
 private static final ReferenceQueue<Object> exceptionTableRefQueue;

 //任務的狀態,初始值爲0,大於等於0時表示任務未執行或者正在執行的過程中,小於0表示已執行完成
 volatile int status; // accessed directly by pool and workers

  靜態屬性通過static代碼塊初始化,如下:

  該類定義的常量如下:

    //最高位爲1
    static final int DONE_MASK   = 0xf0000000;  // mask out non-completion bits
    
    //正常完成
    static final int NORMAL      = 0xf0000000;  // must be negative
    
    //任務被取消了
    static final int CANCELLED   = 0xc0000000;  // must be < NORMAL
    
    //任務異常終止
    static final int EXCEPTIONAL = 0x80000000;  // must be < CANCELLED
    
    //某個線程在等待當前任務執行完成,需要在任務結束時喚醒等待的線程
    static final int SIGNAL      = 0x00010000;  // must be >= 1 << 16
    
    //獲取低16位的值
    static final int SMASK       = 0x0000ffff;  // short bits for tags

    private static final int EXCEPTION_MAP_CAPACITY = 32;

 其中ExceptionNode是一個繼承自WeakReference的內部類,其定義如下:

 

多個ExceptionNode通過next屬性構成一個鏈表。

2、fork 

      fork方法並不是如其方法名會fork一個新線程來執行任務,只是將任務提交到任務隊列中而已,然後立即返回,不會等待任務執行完成,其實現如下:

//fork方法並不是如其命名會創建一個新線程來執行任務,只是將任務提交到任務隊列中而已
public final ForkJoinTask<V> fork() {
        Thread t;
        if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
            //如果當前線程是ForkJoinWorkerThread,將其提交到關聯的WorkQueue中
            ((ForkJoinWorkerThread)t).workQueue.push(this);
        else
            //如果是普通線程,則提交到common線程池的任務隊列中
            ForkJoinPool.common.externalPush(this);
        return this;
    }

其測試用例如下: 

 @Test
    public void test() throws Exception {
        ForkJoinTask task=ForkJoinTask.adapt(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(2000);
                    System.out.println(Thread.currentThread().getName()+" exit");
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        });
        //提交任務到common線程池
        task.fork();
        //阻塞等待任務執行完成,get方法會將該任務從任務隊列中pop出來並執行
        //所以run方法打印出來的線程名就是main
        task.get();
        System.out.println("main thread exit");
    }

其輸出如下:

可以在adapt方法對應的AdaptedRunnableAction打斷點,如下:

然後debug,觀察調用鏈如下:

3、join / quietlyJoin

     join方法用於阻塞當前線程,等待任務執行完成,部分情形下會通過當前線程執行任務,如果異常結束或者被取消需要拋出異常;quietlyJoin方法只是阻塞當前線程等待任務執行完成,不會拋出異常;其實現如下:

//join方法等待任務執行完成並返回結果,如果出現異常則報告異常
public final V join() {
        int s;
        //doJoin方法會阻塞當前線程直到任務執行完成並返回任務的狀態
        if ((s = doJoin() & DONE_MASK) != NORMAL)
            //如果不是正常完成的,則報告異常
            reportException(s);
        //返回執行結果,該方法是抽象方法    
        return getRawResult();
    }

public final void quietlyJoin() {
        doJoin(); //只是等待任務執行完成
    }


private void reportException(int s) {
        if (s == CANCELLED)
            //被取消了
            throw new CancellationException();
        if (s == EXCEPTIONAL)
            //重新拋出異常
            rethrow(getThrowableException());
    }

static void rethrow(Throwable ex) {
        if (ex != null)
            ForkJoinTask.<RuntimeException>uncheckedThrow(ex);
    }

@SuppressWarnings("unchecked") static <T extends Throwable>
        void uncheckedThrow(Throwable t) throws T {
        throw (T)t; // rely on vacuous cast
    }



private int doJoin() {
        int s; Thread t; ForkJoinWorkerThread wt; ForkJoinPool.WorkQueue w;
        //status小於0說明任務已結束,直接返回
        return (s = status) < 0 ? s :
            //如果status大於等於0
            ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
            //如果當前線程是ForkJoinWorkerThread,執行tryUnpush,返回true以後執行doExec
            //如果tryUnpush返回false或者doExec返回大於等於0,則執行awaitJoin
            //如果this在任務隊列的頂端,tryUnpush會將其pop出來,返回true,否則返回false
            (w = (wt = (ForkJoinWorkerThread)t).workQueue).
            tryUnpush(this) && (s = doExec()) < 0 ? s :
            //awaitJoin也是阻塞當前線程,直到任務執行完成
            wt.pool.awaitJoin(w, this, 0L) :
            //如果當前線程是普通的Java線程
            externalAwaitDone();
    }


//執行任務,doExec方法的返回值取決於exec方法,如果exec返回true,則doExec返回值小於0
//如果返回false,則doExec返回值大於等於0
final int doExec() {
        int s; boolean completed;
        if ((s = status) >= 0) {
            try {
                //exec是子類實現的方法
                completed = exec();
            } catch (Throwable rex) {
                //執行異常
                return setExceptionalCompletion(rex);
            }
            if (completed)
                //正常完成
                s = setCompletion(NORMAL);
        }
        return s;
    }

//阻塞普通Java線程等待任務執行完成
 private int externalAwaitDone() {
        int s = ((this instanceof CountedCompleter) ? // try helping
                 //如果是CountedCompleter,則通過externalHelpComplete方法阻塞當前線程等待任務完成
                 ForkJoinPool.common.externalHelpComplete(
                     (CountedCompleter<?>)this, 0) :
                 //如果是普通的ForkJoinTask,則通過tryExternalUnpush嘗試將其從任務隊列中pop出來,如果該任務位於任務隊列頂端則pop成功並返回true
                 //pop成功後執行doExec方法,即通過當前線程完成任務
                 ForkJoinPool.common.tryExternalUnpush(this) ? doExec() : 0);
        if (s >= 0 && (s = status) >= 0) {
            boolean interrupted = false;
            do {
                //修改status,加上SIGNAL標識,表示有線程等待了
                if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
                    synchronized (this) {
                        if (status >= 0) { //再次校驗狀態
                            try {
                                //0表示無期限等待,直到被喚醒
                                //任務執行完成,可通過setCompletion方法喚醒等待的線程
                                wait(0L);
                            } catch (InterruptedException ie) {
                                interrupted = true;
                            }
                        }
                        else
                            //任務已執行完成,則喚醒所有等待的線程
                            notifyAll();
                    }
                }
            } while ((s = status) >= 0);
            if (interrupted)
                //等待時被中斷,將當前線程標記爲已中斷
                Thread.currentThread().interrupt();
        }
        return s;
    }

其測試用例如下:

 @Test
    public void test() throws Exception {
        ForkJoinTask task=ForkJoinTask.adapt(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(2000);
                    System.out.println(Thread.currentThread().getName()+" exit");
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        });
        //提交任務到common線程池
        task.fork();
        //阻塞等待任務執行完成,join方法會將該任務從任務隊列中pop出來並執行
        //所以run方法打印出來的線程名就是main
        task.join();
        System.out.println("main thread exit");
    }

4、invoke / quietlyInvoke

      invoke會立即執行當前任務,如果doExec方法返回值大於等於0說明還有其他的子任務未完成,則等待其他子任務執行完成,典型的應用場景就是CountedCompleter,RecursiveAction和RecursiveTask通常doExec返回值小於0,會在compute方法即執行exec方法時等待所有的子任務執行完成;quietlyInvoke和invoke 都是基於doInvoke實現,區別在於前者不關心執行的結果,不會拋出異常。其實現如下:

 public final V invoke() {
        int s;
        //通過doExec立即執行任務,如果任務未完成則等待
        if ((s = doInvoke() & DONE_MASK) != NORMAL)
            reportException(s); //任務被取消或者異常終止則拋出異常
        return getRawResult();
    }

 public final void quietlyInvoke() {
        doInvoke(); //不需要拋出異常
    }

private int doInvoke() {
        int s; Thread t; ForkJoinWorkerThread wt;
        //直接調用doExec方法執行任務,如果執行完成,則直接返回
        return (s = doExec()) < 0 ? s :
             //如果doExec的結果大於等於0,說明未完成,典型的如CountedCompleter的子類應用
            ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
            //如果是ForkJoinWorkerThread,通過awaitJoin方法等待任務執行完成
            (wt = (ForkJoinWorkerThread)t).pool.
            awaitJoin(wt.workQueue, this, 0L) :
            //普通的Java線程,通過externalAwaitDone等待任務執行完成
            externalAwaitDone();
    }

 測試用例如下:

@Test
    public void test3() throws Exception {
        Thread thread=Thread.currentThread();
        ForkJoinTask task=new ForkJoinTask() {
            @Override
            public Object getRawResult() {
                return null;
            }

            @Override
            protected void setRawResult(Object value) {

            }

            @Override
            protected boolean exec() {
                System.out.println(Thread.currentThread().getName()+" start run");
                if(thread==Thread.currentThread()){
                    return false;
                }else{
                    try {
                        Thread.sleep(2000);
                        System.out.println(Thread.currentThread().getName()+" exit");
                        return true;
                    } catch (InterruptedException e) {
                        return false;
                    }
                }
            }
        };
        ForkJoinPool.commonPool().submit(task);
        //阻塞當前線程,等待任務執行完成
        task.invoke();
        System.out.println("main thread exit");
    }

上述用例的運行結果有兩種,如下圖:

 第二種會無期限阻塞,第一種是正常退出,爲啥會有這種情形了?main線程執行invoke方法,invoke方法調用doExec方法返回值等於0後就執行externalAwaitDone方法了,如果執行ForkJoinPool.common.tryExternalUnpush方法返回true,則再次執行doExec方法,因爲返回值還是0,則通過wait方法等待了,因爲沒有其他線程喚醒該線程,就會無期限等待;如果執行ForkJoinPool.common.tryExternalUnpush方法返回false,說明某個Worker線程已經將該任務從任務隊列中移走了,Worker線程會負責執行該任務並修改任務執行狀態,如果Worker線程正在執行的過程中則wait等待Worker線程執行完成,Worker執行完成會喚醒等待的main線程,main線程判斷任務已完成就正常退出了。

5、complete / quietlyComplete/ completeExceptionally

     這三個方法都是任務執行完成時調用的,其中complete方法用於保存任務執行的結果並修改狀態,quietlyComplete方法只修改狀態,completeExceptionally用於任務執行異常時保存異常信息並修改狀態,其中只有quietlyComplete方法有調用方,都是CountedCompleter及其子類,其調用鏈如下:

這三個方法的實現如下: 

//保存任務執行的結果並修改任務狀態
public void complete(V value) {
        try {
            //保存結果
            setRawResult(value);
        } catch (Throwable rex) {
            //出現異常,保存關聯的異常
            setExceptionalCompletion(rex);
            return;
        }
        //修改狀態,正常完成
        setCompletion(NORMAL);
    }

 
public final void quietlyComplete() {
        //修改狀態正常完成
        setCompletion(NORMAL);
    }

//任務異常結束時,保存異常信息並修改狀態
public void completeExceptionally(Throwable ex) {
        //記錄異常信息並更新任務狀態
        setExceptionalCompletion((ex instanceof RuntimeException) ||
                                 (ex instanceof Error) ? ex :
                                 new RuntimeException(ex)); //如果不是RuntimeException或者Error,則將其用RuntimeException包裝一層
    }

 private int setCompletion(int completion) {
        for (int s;;) {
            if ((s = status) < 0) //如果已完成,直接返回
                return s;
            if (U.compareAndSwapInt(this, STATUS, s, s | completion)) {
                //cas修改狀態成功
                if ((s >>> 16) != 0) //如果status中有SIGNAL標識,即有線程在等待當前任務執行完成
                    synchronized (this) { notifyAll(); } //喚醒等待的線程
                return completion;
            }
        }
    }

 private int setExceptionalCompletion(Throwable ex) {
        //記錄異常信息並更新任務狀態
        int s = recordExceptionalCompletion(ex);
        if ((s & DONE_MASK) == EXCEPTIONAL) //如果狀態是異常完成,則執行鉤子方法
            internalPropagateException(ex); //默認是空實現
        return s;
    }

  void internalPropagateException(Throwable ex) {
    }

6、recordExceptionalCompletion / clearExceptionalCompletion / getException 

     這幾個方法都是異常處理的,recordExceptionalCompletion用於記錄異常信息並修改任務狀態,getException方法獲取當前任務關聯的異常信息,如果任務是正常結束的則返回null,如果是被取消則返回CancellationException,如果異常結束則返回執行任務過程中拋出的異常,clearExceptionalCompletion是reinitialize調用的,用於清理掉當前任務關聯的異常信息。

//保存異常信息,並設置狀態異常結束
final int recordExceptionalCompletion(Throwable ex) {
        int s;
        if ((s = status) >= 0) {
            //獲取hash值
            int h = System.identityHashCode(this);
            final ReentrantLock lock = exceptionTableLock;
            lock.lock(); //加鎖
            try {
                //清理掉已經被GC回收掉的ExceptionNode
                expungeStaleExceptions();
                ExceptionNode[] t = exceptionTable;
                //計算該節點的索引
                int i = h & (t.length - 1);
                for (ExceptionNode e = t[i]; ; e = e.next) {
                    if (e == null) {
                        //如果t[i]爲null或者遍歷完了沒有找到匹配的,則創建一個新節點,插入到t[i]鏈表的前面
                        t[i] = new ExceptionNode(this, ex, t[i]);
                        break;
                    }
                    //找到目標節點
                    if (e.get() == this) // already present
                        break;
                }
            } finally {
                lock.unlock();
            }
            //設置狀態,異常終止
            s = setCompletion(EXCEPTIONAL);
        }
        return s;
    }

public final Throwable getException() {
        int s = status & DONE_MASK; 
        return ((s >= NORMAL)    ? null : //如果是正常完成,則返回null
                (s == CANCELLED) ? new CancellationException() : //任務被取消,則返回CancellationException
                getThrowableException()); //任務異常結束,獲取之前異常結束時保存的異常信息
    }

//將exceptionTableRefQueue中已經被GC回收掉的節點從exceptionTable中移除
private static void expungeStaleExceptions() {
         //poll方法移除並返回鏈表頭,鏈表中的節點是已經被回收掉了
        for (Object x; (x = exceptionTableRefQueue.poll()) != null;) {
            if (x instanceof ExceptionNode) {
                int hashCode = ((ExceptionNode)x).hashCode;
                ExceptionNode[] t = exceptionTable;
                //計算該節點的索引
                int i = hashCode & (t.length - 1);
                ExceptionNode e = t[i];
                ExceptionNode pred = null;
                while (e != null) {
                    ExceptionNode next = e.next;
                    if (e == x) { //找到目標節點
                        if (pred == null) //x就是鏈表第一個節點
                            t[i] = next;
                        else  //x是鏈表中某個節點
                            pred.next = next;
                        break;
                    }
                    //遍歷下一個節點
                    pred = e;
                    e = next;
                }
            }
        }
    }

 private Throwable getThrowableException() {
        if ((status & DONE_MASK) != EXCEPTIONAL) //不是異常結束,返回null
            return null;
        int h = System.identityHashCode(this);
        ExceptionNode e;
        //加鎖
        final ReentrantLock lock = exceptionTableLock;
        lock.lock();
        try {
            //清理掉已經被GC回收掉的ExceptionNode
            expungeStaleExceptions();
            ExceptionNode[] t = exceptionTable;
            //計算所屬的數組元素
            e = t[h & (t.length - 1)];
            //遍歷鏈表,e.get()方法返回該ExceptionNode關聯的Task
            while (e != null && e.get() != this)
                e = e.next;
        } finally {
            lock.unlock();
        }
        Throwable ex;
        //沒有找到當前Task 或者ex爲null
        if (e == null || (ex = e.ex) == null) 
            return null;
        if (e.thrower != Thread.currentThread().getId()) {
            //如果保存異常信息的線程不是當前線程,創建一個同類型的異常實例包裝原來的異常信息,從而提供準確的異常調用鏈
            Class<? extends Throwable> ec = ex.getClass();
            try {
                Constructor<?> noArgCtor = null;
                //獲取構造函數
                Constructor<?>[] cs = ec.getConstructors();// public ctors only
                for (int i = 0; i < cs.length; ++i) {
                    Constructor<?> c = cs[i];
                    //獲取構造函數的參數類型
                    Class<?>[] ps = c.getParameterTypes();
                    if (ps.length == 0)
                        noArgCtor = c; //默認的構造函數
                    else if (ps.length == 1 && ps[0] == Throwable.class) {
                        //如果只有一個參數,且參數類型是Throwable,則創建一個新異常實例
                        Throwable wx = (Throwable)c.newInstance(ex);
                        return (wx == null) ? ex : wx;
                    }
                }
                if (noArgCtor != null) {
                    //有默認的無參構造函數,創建一個實例並設置ex
                    Throwable wx = (Throwable)(noArgCtor.newInstance());
                    if (wx != null) {
                        wx.initCause(ex);
                        return wx;
                    }
                }
            } catch (Exception ignore) {
            }
        }
        return ex;
    }

//清理掉當前Task關聯的ExceptionNode
private void clearExceptionalCompletion() {
        //獲取hash值
        int h = System.identityHashCode(this);
        //加鎖
        final ReentrantLock lock = exceptionTableLock;
        lock.lock();
        try {
            ExceptionNode[] t = exceptionTable;
            //計算所屬的數組元素
            int i = h & (t.length - 1);
            ExceptionNode e = t[i];
            ExceptionNode pred = null;
            //遍歷鏈表
            while (e != null) {
                ExceptionNode next = e.next;
                if (e.get() == this) {
                    if (pred == null) //this是鏈表第一個節點
                        t[i] = next;
                    else
                        pred.next = next; //this是鏈表中的一個節點
                    break;
                }
                //遍歷下一個節點
                pred = e;
                e = next;
            }
            //清理掉已經被GC回收掉的ExceptionNode
            expungeStaleExceptions();
            status = 0;
        } finally {
            lock.unlock();
        }
    }

7、invokeAll

     invokeAll方法有三個重載版本,都是等待多個任務執行完成,其中第一個任務都是有當前線程執行,其他任務是提交到線程池執行,多個任務時,如果有一個任務執行異常,則會取消掉剩餘未執行的任務。其實現如下:

public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
        int s1, s2;
        t2.fork(); //將t2提交到任務隊列
        if ((s1 = t1.doInvoke() & DONE_MASK) != NORMAL) //執行t1並等待其執行完成
            t1.reportException(s1); //不是正常結束則拋出異常
        if ((s2 = t2.doJoin() & DONE_MASK) != NORMAL) //等待t2執行完成
            t2.reportException(s2);
    }

//此時tasks相當於一個ForkJoinTask數組
public static void invokeAll(ForkJoinTask<?>... tasks) {
        Throwable ex = null;
        int last = tasks.length - 1;
        //從數組末尾處往前遍歷
        for (int i = last; i >= 0; --i) {
            ForkJoinTask<?> t = tasks[i];
            if (t == null) {
                //某個ForkJoinTask爲null
                if (ex == null)
                    ex = new NullPointerException();
            }
            else if (i != 0) //i不等於0的,將其提交到任務隊列
                t.fork();
            //i等於0,立即執行並等待其執行完成    
            else if (t.doInvoke() < NORMAL && ex == null)
                ex = t.getException();
        }
        //從1開始往前遍歷
        for (int i = 1; i <= last; ++i) {
            ForkJoinTask<?> t = tasks[i];
            if (t != null) {
                if (ex != null) //ex不爲空,則取消任務
                    t.cancel(false); 
                else if (t.doJoin() < NORMAL) //等待任務執行完成,如果不是正常結束的則獲取拋出的異常
                    ex = t.getException();
            }
        }
        if (ex != null)
            rethrow(ex); //重新拋出異常
    }

public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) {
        if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) {
            //如果沒有實現RandomAccess接口或者不是List類型
            invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
            return tasks;
        }
        //是List類型且實現了RandomAccess接口
        @SuppressWarnings("unchecked")
        List<? extends ForkJoinTask<?>> ts =
            (List<? extends ForkJoinTask<?>>) tasks;
        Throwable ex = null;
        //邏輯同上
        int last = ts.size() - 1;
        //從last處往前遍歷
        for (int i = last; i >= 0; --i) {
            ForkJoinTask<?> t = ts.get(i);
            if (t == null) {
                if (ex == null)
                    ex = new NullPointerException();
            }
            else if (i != 0)
                t.fork();
            else if (t.doInvoke() < NORMAL && ex == null)
                ex = t.getException();
        }
        //從1開始往後遍歷
        for (int i = 1; i <= last; ++i) {
            ForkJoinTask<?> t = ts.get(i);
            if (t != null) {
                if (ex != null)
                    t.cancel(false);
                else if (t.doJoin() < NORMAL)
                    ex = t.getException();
            }
        }
        if (ex != null)
            rethrow(ex);
        return tasks;
    }

  public boolean cancel(boolean mayInterruptIfRunning) {
        return (setCompletion(CANCELLED) & DONE_MASK) == CANCELLED;
    }

8、get

      get方法是阻塞當前線程並等待任務執行完成,其效果和實現跟join方法基本一致,最大的區別在於如果線程等待的過程中被中斷了,get方法會拋出異常InterruptedException,而join方法不會拋出異常,其實現如下:

 public final V get() throws InterruptedException, ExecutionException {
        //如果是ForkJoinWorkerThread執行doJoin 否則執行externalInterruptibleAwaitDone
        int s = (Thread.currentThread() instanceof ForkJoinWorkerThread) ?
            doJoin() : externalInterruptibleAwaitDone();
        Throwable ex;
        if ((s &= DONE_MASK) == CANCELLED) //任務被取消
            throw new CancellationException();
        if (s == EXCEPTIONAL && (ex = getThrowableException()) != null) //異常終止
            throw new ExecutionException(ex);
        return getRawResult(); //返回執行的結果
    }

public final V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException {
        int s;
        long nanos = unit.toNanos(timeout);
        if (Thread.interrupted()) //被中斷拋出異常
            throw new InterruptedException();
        if ((s = status) >= 0 && nanos > 0L) {
            //獲取等待的終止時間
            long d = System.nanoTime() + nanos;
            long deadline = (d == 0L) ? 1L : d; // avoid 0
            Thread t = Thread.currentThread();
            if (t instanceof ForkJoinWorkerThread) {
                //如果是ForkJoinWorkerThread,通過awaitJoin方法等待任務執行完成
                ForkJoinWorkerThread wt = (ForkJoinWorkerThread)t;
                s = wt.pool.awaitJoin(wt.workQueue, this, deadline);
            }
            //如果是普通Java線程
            else if ((s = ((this instanceof CountedCompleter) ?
                           //如果是CountedCompleter,則通過externalHelpComplete等待其執行完成
                           ForkJoinPool.common.externalHelpComplete(
                               (CountedCompleter<?>)this, 0) :
                           //如果是普通的ForkJoinTask,嘗試將其從任務隊列中pop出來並執行    
                           ForkJoinPool.common.tryExternalUnpush(this) ?
                           doExec() : 0)) >= 0) {
                //如果tryExternalUnpush返回false或者doExec方法返回值大於等於0,即任務未執行完成           
                long ns, ms; // measure in nanosecs, but wait in millisecs
                while ((s = status) >= 0 &&  //任務已執行
                       (ns = deadline - System.nanoTime()) > 0L) {  //等待超時
                    if ((ms = TimeUnit.NANOSECONDS.toMillis(ns)) > 0L &&
                        U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
                        //cas修改狀態加上SIGNAL
                        synchronized (this) {
                            if (status >= 0)
                                //阻塞當前線程指定時間,如果被中斷則拋出異常
                                wait(ms); // OK to throw InterruptedException
                            else
                                notifyAll();
                        }
                    }
                }
            }
        }
        if (s >= 0) 
            s = status; //再次讀取狀態
        if ((s &= DONE_MASK) != NORMAL) { //不是正常執行
            Throwable ex;
            if (s == CANCELLED) //被取消
                throw new CancellationException(); 
            if (s != EXCEPTIONAL) //不是異常終止,則是等待超時
                throw new TimeoutException();
            if ((ex = getThrowableException()) != null) //異常終止
                throw new ExecutionException(ex);
        }
        return getRawResult();
    }

//邏輯同externalAwaitDone,區別在於如果被中斷拋出異常
//externalAwaitDone不會拋出異常,如果被中斷了會將當前線程標記爲已中斷
private int externalInterruptibleAwaitDone() throws InterruptedException {
        int s;
        if (Thread.interrupted())
            throw new InterruptedException(); //被中斷則拋出異常
        if ((s = status) >= 0 &&
            (s = ((this instanceof CountedCompleter) ?
                  ForkJoinPool.common.externalHelpComplete(
                      (CountedCompleter<?>)this, 0) :
                  ForkJoinPool.common.tryExternalUnpush(this) ? doExec() :
                  0)) >= 0) {
            while ((s = status) >= 0) {
                if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
                    synchronized (this) {
                        if (status >= 0)
                            wait(0L);
                        else
                            notifyAll();
                    }
                }
            }
        }
        return s;
    }

9、tryUnfork / reinitialize

//嘗試將當前任務從任務隊列中pop出來,然後可以在當前線程執行
public boolean tryUnfork() {
        Thread t;
        return (((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
                ((ForkJoinWorkerThread)t).workQueue.tryUnpush(this) : //如果Worker線程,嘗試將當前任務從其關聯的WorkQueue中pop出來
                ForkJoinPool.common.tryExternalUnpush(this)); //非Worker線程,嘗試將當前任務從probe屬性關聯的WorkQueue中pop出來
    }

//將任務恢復至初始狀態,然後可正常執行
public void reinitialize() {
        if ((status & DONE_MASK) == EXCEPTIONAL)
            clearExceptionalCompletion(); //如果是異常結束,則清除關聯的異常信息
        else
            //狀態恢復成0
            status = 0;
    }

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章