ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/jsr166y/ForkJoinTask.java
(Generate patch)

Comparing jsr166/src/jsr166y/ForkJoinTask.java (file contents):
Revision 1.32 by dl, Mon Aug 3 13:01:15 2009 UTC vs.
Revision 1.71 by dl, Tue Nov 23 10:51:18 2010 UTC

# Line 6 | Line 6
6  
7   package jsr166y;
8  
9 import java.util.concurrent.*;
10
9   import java.io.Serializable;
10   import java.util.Collection;
11   import java.util.Collections;
# Line 15 | Line 13 | import java.util.List;
13   import java.util.RandomAccess;
14   import java.util.Map;
15   import java.util.WeakHashMap;
16 + import java.util.concurrent.Callable;
17 + import java.util.concurrent.CancellationException;
18 + import java.util.concurrent.ExecutionException;
19 + import java.util.concurrent.Executor;
20 + import java.util.concurrent.ExecutorService;
21 + import java.util.concurrent.Future;
22 + import java.util.concurrent.RejectedExecutionException;
23 + import java.util.concurrent.RunnableFuture;
24 + import java.util.concurrent.TimeUnit;
25 + import java.util.concurrent.TimeoutException;
26  
27   /**
28   * Abstract base class for tasks that run within a {@link ForkJoinPool}.
# Line 28 | Line 36 | import java.util.WeakHashMap;
36   * start other subtasks.  As indicated by the name of this class,
37   * many programs using {@code ForkJoinTask} employ only methods
38   * {@link #fork} and {@link #join}, or derivatives such as {@link
39 < * #invokeAll}.  However, this class also provides a number of other
40 < * methods that can come into play in advanced usages, as well as
41 < * extension mechanics that allow support of new forms of fork/join
42 < * processing.
39 > * #invokeAll(ForkJoinTask...) invokeAll}.  However, this class also
40 > * provides a number of other methods that can come into play in
41 > * advanced usages, as well as extension mechanics that allow
42 > * support of new forms of fork/join processing.
43   *
44   * <p>A {@code ForkJoinTask} is a lightweight form of {@link Future}.
45   * The efficiency of {@code ForkJoinTask}s stems from a set of
# Line 56 | Line 64 | import java.util.WeakHashMap;
64   * exceptions such as {@code IOExceptions} to be thrown. However,
65   * computations may still encounter unchecked exceptions, that are
66   * rethrown to callers attempting to join them. These exceptions may
67 < * additionally include RejectedExecutionExceptions stemming from
68 < * internal resource exhaustion such as failure to allocate internal
69 < * task queues.
67 > * additionally include {@link RejectedExecutionException} stemming
68 > * from internal resource exhaustion, such as failure to allocate
69 > * internal task queues.
70   *
71   * <p>The primary method for awaiting completion and extracting
72   * results of a task is {@link #join}, but there are several variants:
73   * The {@link Future#get} methods support interruptible and/or timed
74   * waits for completion and report results using {@code Future}
75 < * conventions. Method {@link #helpJoin} enables callers to actively
76 < * execute other tasks while awaiting joins, which is sometimes more
77 < * efficient but only applies when all subtasks are known to be
78 < * strictly tree-structured. Method {@link #invoke} is semantically
71 < * equivalent to {@code fork(); join()} but always attempts to
72 < * begin execution in the current thread. The "<em>quiet</em>" forms
73 < * of these methods do not extract results or report exceptions. These
75 > * conventions. Method {@link #invoke} is semantically
76 > * equivalent to {@code fork(); join()} but always attempts to begin
77 > * execution in the current thread. The "<em>quiet</em>" forms of
78 > * these methods do not extract results or report exceptions. These
79   * may be useful when a set of tasks are being executed, and you need
80   * to delay processing of results or exceptions until all complete.
81   * Method {@code invokeAll} (available in multiple versions)
82   * performs the most common form of parallel invocation: forking a set
83   * of tasks and joining them all.
84   *
85 + * <p>The execution status of tasks may be queried at several levels
86 + * of detail: {@link #isDone} is true if a task completed in any way
87 + * (including the case where a task was cancelled without executing);
88 + * {@link #isCompletedNormally} is true if a task completed without
89 + * cancellation or encountering an exception; {@link #isCancelled} is
90 + * true if the task was cancelled (in which case {@link #getException}
91 + * returns a {@link java.util.concurrent.CancellationException}); and
92 + * {@link #isCompletedAbnormally} is true if a task was either
93 + * cancelled or encountered an exception, in which case {@link
94 + * #getException} will return either the encountered exception or
95 + * {@link java.util.concurrent.CancellationException}.
96 + *
97   * <p>The ForkJoinTask class is not usually directly subclassed.
98   * Instead, you subclass one of the abstract classes that support a
99   * particular style of fork/join processing, typically {@link
# Line 91 | Line 108 | import java.util.WeakHashMap;
108   * ForkJoinTasks (as may be determined using method {@link
109   * #inForkJoinPool}).  Attempts to invoke them in other contexts
110   * result in exceptions or errors, possibly including
111 < * ClassCastException.
111 > * {@code ClassCastException}.
112 > *
113 > * <p>Method {@link #join} and its variants are appropriate for use
114 > * only when completion dependencies are acyclic; that is, the
115 > * parallel computation can be described as a directed acyclic graph
116 > * (DAG). Otherwise, executions may encounter a form of deadlock as
117 > * tasks cyclically wait for each other.  However, this framework
118 > * supports other methods and techniques (for example the use of
119 > * {@link Phaser}, {@link #helpQuiesce}, and {@link #complete}) that
120 > * may be of use in constructing custom subclasses for problems that
121 > * are not statically structured as DAGs.
122   *
123   * <p>Most base support methods are {@code final}, to prevent
124   * overriding of implementations that are intrinsically tied to the
# Line 107 | Line 134 | import java.util.WeakHashMap;
134   * computation. Large tasks should be split into smaller subtasks,
135   * usually via recursive decomposition. As a very rough rule of thumb,
136   * a task should perform more than 100 and less than 10000 basic
137 < * computational steps. If tasks are too big, then parallelism cannot
138 < * improve throughput. If too small, then memory and internal task
139 < * maintenance overhead may overwhelm processing.
137 > * computational steps, and should avoid indefinite looping. If tasks
138 > * are too big, then parallelism cannot improve throughput. If too
139 > * small, then memory and internal task maintenance overhead may
140 > * overwhelm processing.
141   *
142 < * <p>This class provides {@code adapt} methods for {@link
143 < * java.lang.Runnable} and {@link java.util.concurrent.Callable}, that
144 < * may be of use when mixing execution of ForkJoinTasks with other
145 < * kinds of tasks. When all tasks are of this form, consider using a
118 < * pool in {@link ForkJoinPool#setAsyncMode}.
142 > * <p>This class provides {@code adapt} methods for {@link Runnable}
143 > * and {@link Callable}, that may be of use when mixing execution of
144 > * {@code ForkJoinTasks} with other kinds of tasks. When all tasks are
145 > * of this form, consider using a pool constructed in <em>asyncMode</em>.
146   *
147   * <p>ForkJoinTasks are {@code Serializable}, which enables them to be
148   * used in extensions such as remote execution frameworks. It is
# Line 127 | Line 154 | import java.util.WeakHashMap;
154   */
155   public abstract class ForkJoinTask<V> implements Future<V>, Serializable {
156  
157 <    /**
158 <     * Run control status bits packed into a single int to minimize
159 <     * footprint and to ensure atomicity (via CAS).  Status is
160 <     * initially zero, and takes on nonnegative values until
161 <     * completed, upon which status holds COMPLETED. CANCELLED, or
162 <     * EXCEPTIONAL, which use the top 3 bits.  Tasks undergoing
163 <     * blocking waits by other threads have SIGNAL_MASK bits set --
164 <     * bit 15 for external (nonFJ) waits, and the rest a count of
165 <     * waiting FJ threads.  (This representation relies on
166 <     * ForkJoinPool max thread limits). Completion of a stolen task
167 <     * with SIGNAL_MASK bits set awakens waiter via notifyAll. Even
168 <     * though suboptimal for some purposes, we use basic builtin
169 <     * wait/notify to take advantage of "monitor inflation" in JVMs
170 <     * that we would otherwise need to emulate to avoid adding further
171 <     * per-task bookkeeping overhead. Note that bits 16-28 are
172 <     * currently unused. Also value 0x80000000 is available as spare
173 <     * completion value.
157 >    /*
158 >     * See the internal documentation of class ForkJoinPool for a
159 >     * general implementation overview.  ForkJoinTasks are mainly
160 >     * responsible for maintaining their "status" field amidst relays
161 >     * to methods in ForkJoinWorkerThread and ForkJoinPool. The
162 >     * methods of this class are more-or-less layered into (1) basic
163 >     * status maintenance (2) execution and awaiting completion (3)
164 >     * user-level methods that additionally report results. This is
165 >     * sometimes hard to see because this file orders exported methods
166 >     * in a way that flows well in javadocs. In particular, most
167 >     * join mechanics are in method quietlyJoin, below.
168 >     */
169 >
170 >    /*
171 >     * The status field holds run control status bits packed into a
172 >     * single int to minimize footprint and to ensure atomicity (via
173 >     * CAS).  Status is initially zero, and takes on nonnegative
174 >     * values until completed, upon which status holds value
175 >     * NORMAL, CANCELLED, or EXCEPTIONAL. Tasks undergoing blocking
176 >     * waits by other threads have the SIGNAL bit set.  Completion of
177 >     * a stolen task with SIGNAL set awakens any waiters via
178 >     * notifyAll. Even though suboptimal for some purposes, we use
179 >     * basic builtin wait/notify to take advantage of "monitor
180 >     * inflation" in JVMs that we would otherwise need to emulate to
181 >     * avoid adding further per-task bookkeeping overhead.  We want
182 >     * these monitors to be "fat", i.e., not use biasing or thin-lock
183 >     * techniques, so use some odd coding idioms that tend to avoid
184 >     * them.
185       */
186 +
187 +    /** The run status of this task */
188      volatile int status; // accessed directly by pool and workers
189  
190 <    static final int COMPLETION_MASK      = 0xe0000000;
191 <    static final int NORMAL               = 0xe0000000; // == mask
192 <    static final int CANCELLED            = 0xc0000000;
193 <    static final int EXCEPTIONAL          = 0xa0000000;
154 <    static final int SIGNAL_MASK          = 0x0000ffff;
155 <    static final int INTERNAL_SIGNAL_MASK = 0x00007fff;
156 <    static final int EXTERNAL_SIGNAL      = 0x00008000; // top bit of low word
190 >    private static final int NORMAL      = -1;
191 >    private static final int CANCELLED   = -2;
192 >    private static final int EXCEPTIONAL = -3;
193 >    private static final int SIGNAL      =  1;
194  
195      /**
196       * Table of exceptions thrown by tasks, to enable reporting by
# Line 167 | Line 204 | public abstract class ForkJoinTask<V> im
204          Collections.synchronizedMap
205          (new WeakHashMap<ForkJoinTask<?>, Throwable>());
206  
207 <    // within-package utilities
171 <
172 <    /**
173 <     * Gets current worker thread, or null if not a worker thread.
174 <     */
175 <    static ForkJoinWorkerThread getWorker() {
176 <        Thread t = Thread.currentThread();
177 <        return ((t instanceof ForkJoinWorkerThread) ?
178 <                (ForkJoinWorkerThread) t : null);
179 <    }
180 <
181 <    final boolean casStatus(int cmp, int val) {
182 <        return UNSAFE.compareAndSwapInt(this, statusOffset, cmp, val);
183 <    }
207 >    // Maintaining completion status
208  
209      /**
210 <     * Workaround for not being able to rethrow unchecked exceptions.
211 <     */
188 <    static void rethrowException(Throwable ex) {
189 <        if (ex != null)
190 <            UNSAFE.throwException(ex);
191 <    }
192 <
193 <    // Setting completion status
194 <
195 <    /**
196 <     * Marks completion and wakes up threads waiting to join this task.
210 >     * Marks completion and wakes up threads waiting to join this task,
211 >     * also clearing signal request bits.
212       *
213       * @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
214       */
215 <    final void setCompletion(int completion) {
201 <        ForkJoinPool pool = getPool();
202 <        if (pool != null) {
203 <            int s; // Clear signal bits while setting completion status
204 <            do {} while ((s = status) >= 0 && !casStatus(s, completion));
205 <
206 <            if ((s & SIGNAL_MASK) != 0) {
207 <                if ((s &= INTERNAL_SIGNAL_MASK) != 0)
208 <                    pool.updateRunningCount(s);
209 <                synchronized (this) { notifyAll(); }
210 <            }
211 <        }
212 <        else
213 <            externallySetCompletion(completion);
214 <    }
215 <
216 <    /**
217 <     * Version of setCompletion for non-FJ threads.  Leaves signal
218 <     * bits for unblocked threads to adjust, and always notifies.
219 <     */
220 <    private void externallySetCompletion(int completion) {
221 <        int s;
222 <        do {} while ((s = status) >= 0 &&
223 <                     !casStatus(s, (s & SIGNAL_MASK) | completion));
224 <        synchronized (this) { notifyAll(); }
225 <    }
226 <
227 <    /**
228 <     * Sets status to indicate normal completion.
229 <     */
230 <    final void setNormalCompletion() {
231 <        // Try typical fast case -- single CAS, no signal, not already done.
232 <        // Manually expand casStatus to improve chances of inlining it
233 <        if (!UNSAFE.compareAndSwapInt(this, statusOffset, 0, NORMAL))
234 <            setCompletion(NORMAL);
235 <    }
236 <
237 <    // internal waiting and notification
238 <
239 <    /**
240 <     * Performs the actual monitor wait for awaitDone.
241 <     */
242 <    private void doAwaitDone() {
243 <        // Minimize lock bias and in/de-flation effects by maximizing
244 <        // chances of waiting inside sync
245 <        try {
246 <            while (status >= 0)
247 <                synchronized (this) { if (status >= 0) wait(); }
248 <        } catch (InterruptedException ie) {
249 <            onInterruptedWait();
250 <        }
251 <    }
252 <
253 <    /**
254 <     * Performs the actual timed monitor wait for awaitDone.
255 <     */
256 <    private void doAwaitDone(long startTime, long nanos) {
257 <        synchronized (this) {
258 <            try {
259 <                while (status >= 0) {
260 <                    long nt = nanos - (System.nanoTime() - startTime);
261 <                    if (nt <= 0)
262 <                        break;
263 <                    wait(nt / 1000000, (int) (nt % 1000000));
264 <                }
265 <            } catch (InterruptedException ie) {
266 <                onInterruptedWait();
267 <            }
268 <        }
269 <    }
270 <
271 <    // Awaiting completion
272 <
273 <    /**
274 <     * Sets status to indicate there is joiner, then waits for join,
275 <     * surrounded with pool notifications.
276 <     *
277 <     * @return status upon exit
278 <     */
279 <    private int awaitDone(ForkJoinWorkerThread w,
280 <                          boolean maintainParallelism) {
281 <        ForkJoinPool pool = (w == null) ? null : w.pool;
215 >    private void setCompletion(int completion) {
216          int s;
217          while ((s = status) >= 0) {
218 <            if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
219 <                if (pool == null || !pool.preJoin(this, maintainParallelism))
220 <                    doAwaitDone();
287 <                if (((s = status) & INTERNAL_SIGNAL_MASK) != 0)
288 <                    adjustPoolCountsOnUnblock(pool);
218 >            if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) {
219 >                if (s != 0)
220 >                    synchronized (this) { notifyAll(); }
221                  break;
222              }
223          }
292        return s;
224      }
225  
226      /**
227 <     * Timed version of awaitDone
227 >     * Records exception and sets exceptional completion.
228       *
229 <     * @return status upon exit
299 <     */
300 <    private int awaitDone(ForkJoinWorkerThread w, long nanos) {
301 <        ForkJoinPool pool = (w == null) ? null : w.pool;
302 <        int s;
303 <        while ((s = status) >= 0) {
304 <            if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
305 <                long startTime = System.nanoTime();
306 <                if (pool == null || !pool.preJoin(this, false))
307 <                    doAwaitDone(startTime, nanos);
308 <                if ((s = status) >= 0) {
309 <                    adjustPoolCountsOnCancelledWait(pool);
310 <                    s = status;
311 <                }
312 <                if (s < 0 && (s & INTERNAL_SIGNAL_MASK) != 0)
313 <                    adjustPoolCountsOnUnblock(pool);
314 <                break;
315 <            }
316 <        }
317 <        return s;
318 <    }
319 <
320 <    /**
321 <     * Notifies pool that thread is unblocked. Called by signalled
322 <     * threads when woken by non-FJ threads (which is atypical).
323 <     */
324 <    private void adjustPoolCountsOnUnblock(ForkJoinPool pool) {
325 <        int s;
326 <        do {} while ((s = status) < 0 && !casStatus(s, s & COMPLETION_MASK));
327 <        if (pool != null && (s &= INTERNAL_SIGNAL_MASK) != 0)
328 <            pool.updateRunningCount(s);
329 <    }
330 <
331 <    /**
332 <     * Notifies pool to adjust counts on cancelled or timed out wait.
333 <     */
334 <    private void adjustPoolCountsOnCancelledWait(ForkJoinPool pool) {
335 <        if (pool != null) {
336 <            int s;
337 <            while ((s = status) >= 0 && (s & INTERNAL_SIGNAL_MASK) != 0) {
338 <                if (casStatus(s, s - 1)) {
339 <                    pool.updateRunningCount(1);
340 <                    break;
341 <                }
342 <            }
343 <        }
344 <    }
345 <
346 <    /**
347 <     * Handles interruptions during waits.
229 >     * @return status on exit
230       */
231 <    private void onInterruptedWait() {
350 <        ForkJoinWorkerThread w = getWorker();
351 <        if (w == null)
352 <            Thread.currentThread().interrupt(); // re-interrupt
353 <        else if (w.isTerminating())
354 <            cancelIgnoringExceptions();
355 <        // else if FJworker, ignore interrupt
356 <    }
357 <
358 <    // Recording and reporting exceptions
359 <
360 <    private void setDoneExceptionally(Throwable rex) {
231 >    private void setExceptionalCompletion(Throwable rex) {
232          exceptionMap.put(this, rex);
233          setCompletion(EXCEPTIONAL);
234      }
235  
236      /**
237 <     * Throws the exception associated with status s.
238 <     *
368 <     * @throws the exception
237 >     * Blocks a worker thread until completed or timed out.  Called
238 >     * only by pool.
239       */
240 <    private void reportException(int s) {
241 <        if ((s &= COMPLETION_MASK) < NORMAL) {
242 <            if (s == CANCELLED)
243 <                throw new CancellationException();
244 <            else
245 <                rethrowException(exceptionMap.get(this));
240 >    final void internalAwaitDone(long millis, int nanos) {
241 >        if (status >= 0) {
242 >            try {     // the odd construction reduces lock bias effects
243 >                synchronized (this) {
244 >                    if (status > 0 ||
245 >                        UNSAFE.compareAndSwapInt(this, statusOffset,
246 >                                                 0, SIGNAL))
247 >                        wait(millis, nanos);
248 >                }
249 >            } catch (InterruptedException ie) {
250 >                cancelIfTerminating();
251 >            }
252          }
253      }
254  
255      /**
256 <     * Returns result or throws exception using j.u.c.Future conventions.
381 <     * Only call when {@code isDone} known to be true.
256 >     * Blocks a non-worker-thread until completion.
257       */
258 <    private V reportFutureResult()
259 <        throws ExecutionException, InterruptedException {
260 <        int s = status & COMPLETION_MASK;
261 <        if (s < NORMAL) {
262 <            Throwable ex;
263 <            if (s == CANCELLED)
264 <                throw new CancellationException();
265 <            if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
266 <                throw new ExecutionException(ex);
267 <            if (Thread.interrupted())
268 <                throw new InterruptedException();
258 >    private void externalAwaitDone() {
259 >        if (status >= 0) {
260 >            boolean interrupted = false;
261 >            synchronized(this) {
262 >                int s;
263 >                while ((s = status) >= 0) {
264 >                    if (s == 0 &&
265 >                        !UNSAFE.compareAndSwapInt(this, statusOffset,
266 >                                                  0, SIGNAL))
267 >                        continue;
268 >                    try {
269 >                        wait();
270 >                    } catch (InterruptedException ie) {
271 >                        interrupted = true;
272 >                    }
273 >                }
274 >            }
275 >            if (interrupted)
276 >                Thread.currentThread().interrupt();
277          }
395        return getRawResult();
278      }
279  
280      /**
281 <     * Returns result or throws exception using j.u.c.Future conventions
400 <     * with timeouts.
281 >     * Blocks a non-worker-thread until completion or interruption or timeout.
282       */
283 <    private V reportTimedFutureResult()
284 <        throws InterruptedException, ExecutionException, TimeoutException {
404 <        Throwable ex;
405 <        int s = status & COMPLETION_MASK;
406 <        if (s == NORMAL)
407 <            return getRawResult();
408 <        if (s == CANCELLED)
409 <            throw new CancellationException();
410 <        if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
411 <            throw new ExecutionException(ex);
283 >    private void externalInterruptibleAwaitDone(boolean timed, long nanos)
284 >        throws InterruptedException {
285          if (Thread.interrupted())
286              throw new InterruptedException();
414        throw new TimeoutException();
415    }
416
417    // internal execution methods
418
419    /**
420     * Calls exec, recording completion, and rethrowing exception if
421     * encountered. Caller should normally check status before calling.
422     *
423     * @return true if completed normally
424     */
425    private boolean tryExec() {
426        try { // try block must contain only call to exec
427            if (!exec())
428                return false;
429        } catch (Throwable rex) {
430            setDoneExceptionally(rex);
431            rethrowException(rex);
432            return false; // not reached
433        }
434        setNormalCompletion();
435        return true;
436    }
437
438    /**
439     * Main execution method used by worker threads. Invokes
440     * base computation unless already complete.
441     */
442    final void quietlyExec() {
287          if (status >= 0) {
288 <            try {
289 <                if (!exec())
290 <                    return;
291 <            } catch (Throwable rex) {
292 <                setDoneExceptionally(rex);
293 <                return;
288 >            long startTime = timed ? System.nanoTime() : 0L;
289 >            synchronized(this) {
290 >                int s;
291 >                while ((s = status) >= 0) {
292 >                    long nt;
293 >                    if (s == 0 &&
294 >                        !UNSAFE.compareAndSwapInt(this, statusOffset,
295 >                                                  0, SIGNAL))
296 >                        continue;
297 >                    else if (!timed)
298 >                        wait();
299 >                    else if ((nt = nanos - (System.nanoTime()-startTime)) > 0L)
300 >                        wait(nt / 1000000, (int)(nt % 1000000));
301 >                    else
302 >                        break;
303 >                }
304              }
451            setNormalCompletion();
305          }
306      }
307  
308      /**
309 <     * Calls exec(), recording but not rethrowing exception.
310 <     * Caller should normally check status before calling.
311 <     *
459 <     * @return true if completed normally
309 >     * Unless done, calls exec and records status if completed, but
310 >     * doesn't wait for completion otherwise. Primary execution method
311 >     * for ForkJoinWorkerThread.
312       */
313 <    private boolean tryQuietlyInvoke() {
313 >    final void quietlyExec() {
314          try {
315 <            if (!exec())
316 <                return false;
315 >            if (status < 0 || !exec())
316 >                return;
317          } catch (Throwable rex) {
318 <            setDoneExceptionally(rex);
319 <            return false;
468 <        }
469 <        setNormalCompletion();
470 <        return true;
471 <    }
472 <
473 <    /**
474 <     * Cancels, ignoring any exceptions it throws.
475 <     */
476 <    final void cancelIgnoringExceptions() {
477 <        try {
478 <            cancel(false);
479 <        } catch (Throwable ignore) {
318 >            setExceptionalCompletion(rex);
319 >            return;
320          }
321 <    }
482 <
483 <    /**
484 <     * Main implementation of helpJoin
485 <     */
486 <    private int busyJoin(ForkJoinWorkerThread w) {
487 <        int s;
488 <        ForkJoinTask<?> t;
489 <        while ((s = status) >= 0 && (t = w.scanWhileJoining(this)) != null)
490 <            t.quietlyExec();
491 <        return (s >= 0) ? awaitDone(w, false) : s; // block if no work
321 >        setCompletion(NORMAL); // must be outside try block
322      }
323  
324      // public methods
# Line 497 | Line 327 | public abstract class ForkJoinTask<V> im
327       * Arranges to asynchronously execute this task.  While it is not
328       * necessarily enforced, it is a usage error to fork a task more
329       * than once unless it has completed and been reinitialized.
330 +     * Subsequent modifications to the state of this task or any data
331 +     * it operates on are not necessarily consistently observable by
332 +     * any thread other than the one executing it unless preceded by a
333 +     * call to {@link #join} or related methods, or a call to {@link
334 +     * #isDone} returning {@code true}.
335       *
336       * <p>This method may be invoked only from within {@code
337 <     * ForkJoinTask} computations (as may be determined using method
337 >     * ForkJoinPool} computations (as may be determined using method
338       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
339       * result in exceptions or errors, possibly including {@code
340       * ClassCastException}.
# Line 513 | Line 348 | public abstract class ForkJoinTask<V> im
348      }
349  
350      /**
351 <     * Returns the result of the computation when it is ready.
352 <     * This method differs from {@link #get()} in that
351 >     * Returns the result of the computation when it {@link #isDone is
352 >     * done}.  This method differs from {@link #get()} in that
353       * abnormal completion results in {@code RuntimeException} or
354 <     * {@code Error}, not {@code ExecutionException}.
354 >     * {@code Error}, not {@code ExecutionException}, and that
355 >     * interrupts of the calling thread do <em>not</em> cause the
356 >     * method to abruptly return by throwing {@code
357 >     * InterruptedException}.
358       *
359       * @return the computed result
360       */
361      public final V join() {
362 <        ForkJoinWorkerThread w = getWorker();
363 <        if (w == null || status < 0 || !w.unpushTask(this) || !tryExec())
364 <            reportException(awaitDone(w, true));
362 >        quietlyJoin();
363 >        Throwable ex;
364 >        if (status < NORMAL && (ex = getException()) != null)
365 >            UNSAFE.throwException(ex);
366          return getRawResult();
367      }
368  
369      /**
370       * Commences performing this task, awaits its completion if
371 <     * necessary, and return its result.
371 >     * necessary, and returns its result, or throws an (unchecked)
372 >     * {@code RuntimeException} or {@code Error} if the underlying
373 >     * computation did so.
374       *
534     * @throws Throwable (a RuntimeException, Error, or unchecked
535     * exception) if the underlying computation did so
375       * @return the computed result
376       */
377      public final V invoke() {
378 <        if (status >= 0 && tryExec())
379 <            return getRawResult();
380 <        else
381 <            return join();
378 >        quietlyInvoke();
379 >        Throwable ex;
380 >        if (status < NORMAL && (ex = getException()) != null)
381 >            UNSAFE.throwException(ex);
382 >        return getRawResult();
383      }
384  
385      /**
386 <     * Forks the given tasks, returning when {@code isDone} holds
387 <     * for each task or an exception is encountered.
386 >     * Forks the given tasks, returning when {@code isDone} holds for
387 >     * each task or an (unchecked) exception is encountered, in which
388 >     * case the exception is rethrown. If more than one task
389 >     * encounters an exception, then this method throws any one of
390 >     * these exceptions. If any task encounters an exception, the
391 >     * other may be cancelled. However, the execution status of
392 >     * individual tasks is not guaranteed upon exceptional return. The
393 >     * status of each task may be obtained using {@link
394 >     * #getException()} and related methods to check if they have been
395 >     * cancelled, completed normally or exceptionally, or left
396 >     * unprocessed.
397       *
398       * <p>This method may be invoked only from within {@code
399 <     * ForkJoinTask} computations (as may be determined using method
399 >     * ForkJoinPool} computations (as may be determined using method
400       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
401       * result in exceptions or errors, possibly including {@code
402       * ClassCastException}.
# Line 555 | Line 404 | public abstract class ForkJoinTask<V> im
404       * @param t1 the first task
405       * @param t2 the second task
406       * @throws NullPointerException if any task is null
558     * @throws RuntimeException or Error if a task did so
407       */
408      public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
409          t2.fork();
# Line 565 | Line 413 | public abstract class ForkJoinTask<V> im
413  
414      /**
415       * Forks the given tasks, returning when {@code isDone} holds for
416 <     * each task or an exception is encountered. If any task
417 <     * encounters an exception, others may be, but are not guaranteed
418 <     * to be, cancelled.
416 >     * each task or an (unchecked) exception is encountered, in which
417 >     * case the exception is rethrown. If more than one task
418 >     * encounters an exception, then this method throws any one of
419 >     * these exceptions. If any task encounters an exception, others
420 >     * may be cancelled. However, the execution status of individual
421 >     * tasks is not guaranteed upon exceptional return. The status of
422 >     * each task may be obtained using {@link #getException()} and
423 >     * related methods to check if they have been cancelled, completed
424 >     * normally or exceptionally, or left unprocessed.
425       *
426       * <p>This method may be invoked only from within {@code
427 <     * ForkJoinTask} computations (as may be determined using method
427 >     * ForkJoinPool} computations (as may be determined using method
428       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
429       * result in exceptions or errors, possibly including {@code
430       * ClassCastException}.
431       *
432       * @param tasks the tasks
433 <     * @throws NullPointerException if tasks or any element are null
580 <     * @throws RuntimeException or Error if any task did so
433 >     * @throws NullPointerException if any task is null
434       */
435      public static void invokeAll(ForkJoinTask<?>... tasks) {
436          Throwable ex = null;
# Line 592 | Line 445 | public abstract class ForkJoinTask<V> im
445                  t.fork();
446              else {
447                  t.quietlyInvoke();
448 <                if (ex == null)
448 >                if (ex == null && t.status < NORMAL)
449                      ex = t.getException();
450              }
451          }
# Line 603 | Line 456 | public abstract class ForkJoinTask<V> im
456                      t.cancel(false);
457                  else {
458                      t.quietlyJoin();
459 <                    if (ex == null)
459 >                    if (ex == null && t.status < NORMAL)
460                          ex = t.getException();
461                  }
462              }
463          }
464          if (ex != null)
465 <            rethrowException(ex);
465 >            UNSAFE.throwException(ex);
466      }
467  
468      /**
469       * Forks all tasks in the specified collection, returning when
470 <     * {@code isDone} holds for each task or an exception is
471 <     * encountered.  If any task encounters an exception, others may
472 <     * be, but are not guaranteed to be, cancelled. The behavior of
473 <     * this operation is undefined if the specified collection is
474 <     * modified while the operation is in progress.
470 >     * {@code isDone} holds for each task or an (unchecked) exception
471 >     * is encountered, in which case the exception is rethrown. If
472 >     * more than one task encounters an exception, then this method
473 >     * throws any one of these exceptions. If any task encounters an
474 >     * exception, others may be cancelled. However, the execution
475 >     * status of individual tasks is not guaranteed upon exceptional
476 >     * return. The status of each task may be obtained using {@link
477 >     * #getException()} and related methods to check if they have been
478 >     * cancelled, completed normally or exceptionally, or left
479 >     * unprocessed.
480       *
481       * <p>This method may be invoked only from within {@code
482 <     * ForkJoinTask} computations (as may be determined using method
482 >     * ForkJoinPool} computations (as may be determined using method
483       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
484       * result in exceptions or errors, possibly including {@code
485       * ClassCastException}.
# Line 629 | Line 487 | public abstract class ForkJoinTask<V> im
487       * @param tasks the collection of tasks
488       * @return the tasks argument, to simplify usage
489       * @throws NullPointerException if tasks or any element are null
632     * @throws RuntimeException or Error if any task did so
490       */
491      public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) {
492          if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) {
# Line 651 | Line 508 | public abstract class ForkJoinTask<V> im
508                  t.fork();
509              else {
510                  t.quietlyInvoke();
511 <                if (ex == null)
511 >                if (ex == null && t.status < NORMAL)
512                      ex = t.getException();
513              }
514          }
# Line 662 | Line 519 | public abstract class ForkJoinTask<V> im
519                      t.cancel(false);
520                  else {
521                      t.quietlyJoin();
522 <                    if (ex == null)
522 >                    if (ex == null && t.status < NORMAL)
523                          ex = t.getException();
524                  }
525              }
526          }
527          if (ex != null)
528 <            rethrowException(ex);
528 >            UNSAFE.throwException(ex);
529          return tasks;
530      }
531  
532      /**
533 <     * Returns {@code true} if the computation performed by this task
534 <     * has completed (or has been cancelled).
535 <     *
536 <     * @return {@code true} if this computation has completed
537 <     */
538 <    public final boolean isDone() {
539 <        return status < 0;
540 <    }
541 <
542 <    /**
686 <     * Returns {@code true} if this task was cancelled.
687 <     *
688 <     * @return {@code true} if this task was cancelled
689 <     */
690 <    public final boolean isCancelled() {
691 <        return (status & COMPLETION_MASK) == CANCELLED;
692 <    }
693 <
694 <    /**
695 <     * Asserts that the results of this task's computation will not be
696 <     * used. If a cancellation occurs before attempting to execute this
697 <     * task, execution will be suppressed, {@link #isCancelled}
698 <     * will report true, and {@link #join} will result in a
699 <     * {@code CancellationException} being thrown. Otherwise, when
700 <     * cancellation races with completion, there are no guarantees
701 <     * about whether {@code isCancelled} will report {@code true},
702 <     * whether {@code join} will return normally or via an exception,
703 <     * or whether these behaviors will remain consistent upon repeated
704 <     * invocation.
533 >     * Attempts to cancel execution of this task. This attempt will
534 >     * fail if the task has already completed or could not be
535 >     * cancelled for some other reason. If successful, and this task
536 >     * has not started when {@code cancel} is called, execution of
537 >     * this task is suppressed. After this method returns
538 >     * successfully, unless there is an intervening call to {@link
539 >     * #reinitialize}, subsequent calls to {@link #isCancelled},
540 >     * {@link #isDone}, and {@code cancel} will return {@code true}
541 >     * and calls to {@link #join} and related methods will result in
542 >     * {@code CancellationException}.
543       *
544       * <p>This method may be overridden in subclasses, but if so, must
545 <     * still ensure that these minimal properties hold. In particular,
546 <     * the {@code cancel} method itself must not throw exceptions.
545 >     * still ensure that these properties hold. In particular, the
546 >     * {@code cancel} method itself must not throw exceptions.
547       *
548       * <p>This method is designed to be invoked by <em>other</em>
549       * tasks. To terminate the current task, you can just return or
550       * throw an unchecked exception from its computation method, or
551       * invoke {@link #completeExceptionally}.
552       *
553 <     * @param mayInterruptIfRunning this value is ignored in the
554 <     * default implementation because tasks are not in general
555 <     * cancelled via interruption
553 >     * @param mayInterruptIfRunning this value has no effect in the
554 >     * default implementation because interrupts are not used to
555 >     * control cancellation.
556       *
557       * @return {@code true} if this task is now cancelled
558       */
559      public boolean cancel(boolean mayInterruptIfRunning) {
560          setCompletion(CANCELLED);
561 <        return (status & COMPLETION_MASK) == CANCELLED;
561 >        return status == CANCELLED;
562 >    }
563 >
564 >    /**
565 >     * Cancels, ignoring any exceptions thrown by cancel. Used during
566 >     * worker and pool shutdown. Cancel is spec'ed not to throw any
567 >     * exceptions, but if it does anyway, we have no recourse during
568 >     * shutdown, so guard against this case.
569 >     */
570 >    final void cancelIgnoringExceptions() {
571 >        try {
572 >            cancel(false);
573 >        } catch (Throwable ignore) {
574 >        }
575 >    }
576 >
577 >    /**
578 >     * Cancels if current thread is a terminating worker thread,
579 >     * ignoring any exceptions thrown by cancel.
580 >     */
581 >    final void cancelIfTerminating() {
582 >        Thread t = Thread.currentThread();
583 >        if ((t instanceof ForkJoinWorkerThread) &&
584 >            ((ForkJoinWorkerThread) t).isTerminating()) {
585 >            try {
586 >                cancel(false);
587 >            } catch (Throwable ignore) {
588 >            }
589 >        }
590 >    }
591 >
592 >    public final boolean isDone() {
593 >        return status < 0;
594 >    }
595 >
596 >    public final boolean isCancelled() {
597 >        return status == CANCELLED;
598      }
599  
600      /**
# Line 729 | Line 603 | public abstract class ForkJoinTask<V> im
603       * @return {@code true} if this task threw an exception or was cancelled
604       */
605      public final boolean isCompletedAbnormally() {
606 <        return (status & COMPLETION_MASK) < NORMAL;
606 >        return status < NORMAL;
607 >    }
608 >
609 >    /**
610 >     * Returns {@code true} if this task completed without throwing an
611 >     * exception and was not cancelled.
612 >     *
613 >     * @return {@code true} if this task completed without throwing an
614 >     * exception and was not cancelled
615 >     */
616 >    public final boolean isCompletedNormally() {
617 >        return status == NORMAL;
618      }
619  
620      /**
# Line 740 | Line 625 | public abstract class ForkJoinTask<V> im
625       * @return the exception, or {@code null} if none
626       */
627      public final Throwable getException() {
628 <        int s = status & COMPLETION_MASK;
629 <        if (s >= NORMAL)
630 <            return null;
631 <        if (s == CANCELLED)
747 <            return new CancellationException();
748 <        return exceptionMap.get(this);
628 >        int s = status;
629 >        return ((s >= NORMAL)    ? null :
630 >                (s == CANCELLED) ? new CancellationException() :
631 >                exceptionMap.get(this));
632      }
633  
634      /**
# Line 758 | Line 641 | public abstract class ForkJoinTask<V> im
641       * overridable, but overridden versions must invoke {@code super}
642       * implementation to maintain guarantees.
643       *
644 <     * @param ex the exception to throw. If this exception is
645 <     * not a RuntimeException or Error, the actual exception thrown
646 <     * will be a RuntimeException with cause ex.
644 >     * @param ex the exception to throw. If this exception is not a
645 >     * {@code RuntimeException} or {@code Error}, the actual exception
646 >     * thrown will be a {@code RuntimeException} with cause {@code ex}.
647       */
648      public void completeExceptionally(Throwable ex) {
649 <        setDoneExceptionally((ex instanceof RuntimeException) ||
650 <                             (ex instanceof Error) ? ex :
651 <                             new RuntimeException(ex));
649 >        setExceptionalCompletion((ex instanceof RuntimeException) ||
650 >                                 (ex instanceof Error) ? ex :
651 >                                 new RuntimeException(ex));
652      }
653  
654      /**
655       * Completes this task, and if not already aborted or cancelled,
656 <     * returning a {@code null} result upon {@code join} and related
657 <     * operations. This method may be used to provide results for
658 <     * asynchronous tasks, or to provide alternative handling for
659 <     * tasks that would not otherwise complete normally. Its use in
660 <     * other situations is discouraged. This method is
661 <     * overridable, but overridden versions must invoke {@code super}
662 <     * implementation to maintain guarantees.
656 >     * returning the given value as the result of subsequent
657 >     * invocations of {@code join} and related operations. This method
658 >     * may be used to provide results for asynchronous tasks, or to
659 >     * provide alternative handling for tasks that would not otherwise
660 >     * complete normally. Its use in other situations is
661 >     * discouraged. This method is overridable, but overridden
662 >     * versions must invoke {@code super} implementation to maintain
663 >     * guarantees.
664       *
665       * @param value the result value for this task
666       */
# Line 784 | Line 668 | public abstract class ForkJoinTask<V> im
668          try {
669              setRawResult(value);
670          } catch (Throwable rex) {
671 <            setDoneExceptionally(rex);
671 >            setExceptionalCompletion(rex);
672              return;
673          }
674 <        setNormalCompletion();
791 <    }
792 <
793 <    public final V get() throws InterruptedException, ExecutionException {
794 <        ForkJoinWorkerThread w = getWorker();
795 <        if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
796 <            awaitDone(w, true);
797 <        return reportFutureResult();
798 <    }
799 <
800 <    public final V get(long timeout, TimeUnit unit)
801 <        throws InterruptedException, ExecutionException, TimeoutException {
802 <        long nanos = unit.toNanos(timeout);
803 <        ForkJoinWorkerThread w = getWorker();
804 <        if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
805 <            awaitDone(w, nanos);
806 <        return reportTimedFutureResult();
674 >        setCompletion(NORMAL);
675      }
676  
677      /**
678 <     * Possibly executes other tasks until this task is ready, then
679 <     * returns the result of the computation.  This method may be more
812 <     * efficient than {@code join}, but is only applicable when
813 <     * there are no potential dependencies between continuation of the
814 <     * current task and that of any other task that might be executed
815 <     * while helping. (This usually holds for pure divide-and-conquer
816 <     * tasks).
817 <     *
818 <     * <p>This method may be invoked only from within {@code
819 <     * ForkJoinTask} computations (as may be determined using method
820 <     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
821 <     * result in exceptions or errors, possibly including {@code
822 <     * ClassCastException}.
678 >     * Waits if necessary for the computation to complete, and then
679 >     * retrieves its result.
680       *
681       * @return the computed result
682 +     * @throws CancellationException if the computation was cancelled
683 +     * @throws ExecutionException if the computation threw an
684 +     * exception
685 +     * @throws InterruptedException if the current thread is not a
686 +     * member of a ForkJoinPool and was interrupted while waiting
687       */
688 <    public final V helpJoin() {
689 <        ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
690 <        if (status < 0 || !w.unpushTask(this) || !tryExec())
691 <            reportException(busyJoin(w));
688 >    public final V get() throws InterruptedException, ExecutionException {
689 >        Thread t = Thread.currentThread();
690 >        if (t instanceof ForkJoinWorkerThread)
691 >            quietlyJoin();
692 >        else
693 >            externalInterruptibleAwaitDone(false, 0L);
694 >        int s = status;
695 >        if (s != NORMAL) {
696 >            Throwable ex;
697 >            if (s == CANCELLED)
698 >                throw new CancellationException();
699 >            if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
700 >                throw new ExecutionException(ex);
701 >        }
702          return getRawResult();
703      }
704  
705      /**
706 <     * Possibly executes other tasks until this task is ready.  This
707 <     * method may be useful when processing collections of tasks when
836 <     * some have been cancelled or otherwise known to have aborted.
706 >     * Waits if necessary for at most the given time for the computation
707 >     * to complete, and then retrieves its result, if available.
708       *
709 <     * <p>This method may be invoked only from within {@code
710 <     * ForkJoinTask} computations (as may be determined using method
711 <     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
712 <     * result in exceptions or errors, possibly including {@code
713 <     * ClassCastException}.
709 >     * @param timeout the maximum time to wait
710 >     * @param unit the time unit of the timeout argument
711 >     * @return the computed result
712 >     * @throws CancellationException if the computation was cancelled
713 >     * @throws ExecutionException if the computation threw an
714 >     * exception
715 >     * @throws InterruptedException if the current thread is not a
716 >     * member of a ForkJoinPool and was interrupted while waiting
717 >     * @throws TimeoutException if the wait timed out
718       */
719 <    public final void quietlyHelpJoin() {
720 <        if (status >= 0) {
721 <            ForkJoinWorkerThread w =
722 <                (ForkJoinWorkerThread) Thread.currentThread();
723 <            if (!w.unpushTask(this) || !tryQuietlyInvoke())
724 <                busyJoin(w);
719 >    public final V get(long timeout, TimeUnit unit)
720 >        throws InterruptedException, ExecutionException, TimeoutException {
721 >        long nanos = unit.toNanos(timeout);
722 >        Thread t = Thread.currentThread();
723 >        if (t instanceof ForkJoinWorkerThread)
724 >            ((ForkJoinWorkerThread)t).joinTask(this, true, nanos);
725 >        else
726 >            externalInterruptibleAwaitDone(true, nanos);
727 >        int s = status;
728 >        if (s != NORMAL) {
729 >            Throwable ex;
730 >            if (s == CANCELLED)
731 >                throw new CancellationException();
732 >            if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
733 >                throw new ExecutionException(ex);
734 >            throw new TimeoutException();
735          }
736 +        return getRawResult();
737      }
738  
739      /**
740 <     * Joins this task, without returning its result or throwing an
740 >     * Joins this task, without returning its result or throwing its
741       * exception. This method may be useful when processing
742       * collections of tasks when some have been cancelled or otherwise
743       * known to have aborted.
744       */
745      public final void quietlyJoin() {
746 <        if (status >= 0) {
747 <            ForkJoinWorkerThread w = getWorker();
748 <            if (w == null || !w.unpushTask(this) || !tryQuietlyInvoke())
749 <                awaitDone(w, true);
746 >        Thread t;
747 >        if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
748 >            ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
749 >            if (status >= 0) {
750 >                if (w.unpushTask(this)) {
751 >                    boolean completed;
752 >                    try {
753 >                        completed = exec();
754 >                    } catch (Throwable rex) {
755 >                        setExceptionalCompletion(rex);
756 >                        return;
757 >                    }
758 >                    if (completed) {
759 >                        setCompletion(NORMAL);
760 >                        return;
761 >                    }
762 >                }
763 >                w.joinTask(this, false, 0L);
764 >            }
765          }
766 +        else
767 +            externalAwaitDone();
768      }
769  
770      /**
771       * Commences performing this task and awaits its completion if
772 <     * necessary, without returning its result or throwing an
773 <     * exception. This method may be useful when processing
871 <     * collections of tasks when some have been cancelled or otherwise
872 <     * known to have aborted.
772 >     * necessary, without returning its result or throwing its
773 >     * exception.
774       */
775      public final void quietlyInvoke() {
776 <        if (status >= 0 && !tryQuietlyInvoke())
777 <            quietlyJoin();
776 >        if (status >= 0) {
777 >            boolean completed;
778 >            try {
779 >                completed = exec();
780 >            } catch (Throwable rex) {
781 >                setExceptionalCompletion(rex);
782 >                return;
783 >            }
784 >            if (completed)
785 >                setCompletion(NORMAL);
786 >            else
787 >                quietlyJoin();
788 >        }
789      }
790  
791      /**
792       * Possibly executes tasks until the pool hosting the current task
793 <     * {@link ForkJoinPool#isQuiescent}. This method may be of use in
794 <     * designs in which many tasks are forked, but none are explicitly
795 <     * joined, instead executing them until all are processed.
793 >     * {@link ForkJoinPool#isQuiescent is quiescent}. This method may
794 >     * be of use in designs in which many tasks are forked, but none
795 >     * are explicitly joined, instead executing them until all are
796 >     * processed.
797       *
798       * <p>This method may be invoked only from within {@code
799 <     * ForkJoinTask} computations (as may be determined using method
799 >     * ForkJoinPool} computations (as may be determined using method
800       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
801       * result in exceptions or errors, possibly including {@code
802       * ClassCastException}.
# Line 902 | Line 815 | public abstract class ForkJoinTask<V> im
815       * under any other usage conditions are not guaranteed.
816       * This method may be useful when executing
817       * pre-constructed trees of subtasks in loops.
818 +     *
819 +     * <p>Upon completion of this method, {@code isDone()} reports
820 +     * {@code false}, and {@code getException()} reports {@code
821 +     * null}. However, the value returned by {@code getRawResult} is
822 +     * unaffected. To clear this value, you can invoke {@code
823 +     * setRawResult(null)}.
824       */
825      public void reinitialize() {
826 <        if ((status & COMPLETION_MASK) == EXCEPTIONAL)
826 >        if (status == EXCEPTIONAL)
827              exceptionMap.remove(this);
828          status = 0;
829      }
# Line 923 | Line 842 | public abstract class ForkJoinTask<V> im
842      }
843  
844      /**
845 <     * Returns {@code true} if the current thread is executing as a
846 <     * ForkJoinPool computation.
845 >     * Returns {@code true} if the current thread is a {@link
846 >     * ForkJoinWorkerThread} executing as a ForkJoinPool computation.
847       *
848 <     * @return {@code true} if the current thread is executing as a
849 <     * ForkJoinPool computation, or false otherwise
848 >     * @return {@code true} if the current thread is a {@link
849 >     * ForkJoinWorkerThread} executing as a ForkJoinPool computation,
850 >     * or {@code false} otherwise
851       */
852      public static boolean inForkJoinPool() {
853          return Thread.currentThread() instanceof ForkJoinWorkerThread;
# Line 942 | Line 862 | public abstract class ForkJoinTask<V> im
862       * were not, stolen.
863       *
864       * <p>This method may be invoked only from within {@code
865 <     * ForkJoinTask} computations (as may be determined using method
865 >     * ForkJoinPool} computations (as may be determined using method
866       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
867       * result in exceptions or errors, possibly including {@code
868       * ClassCastException}.
# Line 961 | Line 881 | public abstract class ForkJoinTask<V> im
881       * fork other tasks.
882       *
883       * <p>This method may be invoked only from within {@code
884 <     * ForkJoinTask} computations (as may be determined using method
884 >     * ForkJoinPool} computations (as may be determined using method
885       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
886       * result in exceptions or errors, possibly including {@code
887       * ClassCastException}.
# Line 984 | Line 904 | public abstract class ForkJoinTask<V> im
904       * exceeded.
905       *
906       * <p>This method may be invoked only from within {@code
907 <     * ForkJoinTask} computations (as may be determined using method
907 >     * ForkJoinPool} computations (as may be determined using method
908       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
909       * result in exceptions or errors, possibly including {@code
910       * ClassCastException}.
# Line 1024 | Line 944 | public abstract class ForkJoinTask<V> im
944       * called otherwise. The return value controls whether this task
945       * is considered to be done normally. It may return false in
946       * asynchronous actions that require explicit invocations of
947 <     * {@link #complete} to become joinable. It may throw exceptions
948 <     * to indicate abnormal exit.
947 >     * {@link #complete} to become joinable. It may also throw an
948 >     * (unchecked) exception to indicate abnormal exit.
949       *
950       * @return {@code true} if completed normally
1031     * @throws Error or RuntimeException if encountered during computation
951       */
952      protected abstract boolean exec();
953  
# Line 1043 | Line 962 | public abstract class ForkJoinTask<V> im
962       * otherwise.
963       *
964       * <p>This method may be invoked only from within {@code
965 <     * ForkJoinTask} computations (as may be determined using method
965 >     * ForkJoinPool} computations (as may be determined using method
966       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
967       * result in exceptions or errors, possibly including {@code
968       * ClassCastException}.
# Line 1062 | Line 981 | public abstract class ForkJoinTask<V> im
981       * be useful otherwise.
982       *
983       * <p>This method may be invoked only from within {@code
984 <     * ForkJoinTask} computations (as may be determined using method
984 >     * ForkJoinPool} computations (as may be determined using method
985       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
986       * result in exceptions or errors, possibly including {@code
987       * ClassCastException}.
# Line 1085 | Line 1004 | public abstract class ForkJoinTask<V> im
1004       * otherwise.
1005       *
1006       * <p>This method may be invoked only from within {@code
1007 <     * ForkJoinTask} computations (as may be determined using method
1007 >     * ForkJoinPool} computations (as may be determined using method
1008       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1009       * result in exceptions or errors, possibly including {@code
1010       * ClassCastException}.
# Line 1195 | Line 1114 | public abstract class ForkJoinTask<V> im
1114      private static final long serialVersionUID = -7721805057305804111L;
1115  
1116      /**
1117 <     * Save the state to a stream.
1117 >     * Saves the state to a stream (that is, serializes it).
1118       *
1119       * @serialData the current run status and the exception thrown
1120       * during execution, or {@code null} if none
# Line 1208 | Line 1127 | public abstract class ForkJoinTask<V> im
1127      }
1128  
1129      /**
1130 <     * Reconstitute the instance from a stream.
1130 >     * Reconstitutes the instance from a stream (that is, deserializes it).
1131       *
1132       * @param s the stream
1133       */
1134      private void readObject(java.io.ObjectInputStream s)
1135          throws java.io.IOException, ClassNotFoundException {
1136          s.defaultReadObject();
1218        status &= ~INTERNAL_SIGNAL_MASK; // clear internal signal counts
1219        status |= EXTERNAL_SIGNAL; // conservatively set external signal
1137          Object ex = s.readObject();
1138          if (ex != null)
1139 <            setDoneExceptionally((Throwable) ex);
1139 >            setExceptionalCompletion((Throwable) ex);
1140      }
1141  
1142      // Unsafe mechanics

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines