--- jsr166/src/jsr166y/ForkJoinTask.java 2010/04/05 15:52:26 1.46
+++ jsr166/src/jsr166y/ForkJoinTask.java 2010/11/22 12:24:34 1.69
@@ -6,8 +6,6 @@
package jsr166y;
-import java.util.concurrent.*;
-
import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
@@ -15,6 +13,16 @@ import java.util.List;
import java.util.RandomAccess;
import java.util.Map;
import java.util.WeakHashMap;
+import java.util.concurrent.Callable;
+import java.util.concurrent.CancellationException;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Executor;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Future;
+import java.util.concurrent.RejectedExecutionException;
+import java.util.concurrent.RunnableFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
/**
* Abstract base class for tasks that run within a {@link ForkJoinPool}.
@@ -28,10 +36,10 @@ import java.util.WeakHashMap;
* start other subtasks. As indicated by the name of this class,
* many programs using {@code ForkJoinTask} employ only methods
* {@link #fork} and {@link #join}, or derivatives such as {@link
- * #invokeAll}. However, this class also provides a number of other
- * methods that can come into play in advanced usages, as well as
- * extension mechanics that allow support of new forms of fork/join
- * processing.
+ * #invokeAll(ForkJoinTask...) invokeAll}. However, this class also
+ * provides a number of other methods that can come into play in
+ * advanced usages, as well as extension mechanics that allow
+ * support of new forms of fork/join processing.
*
* A {@code ForkJoinTask} is a lightweight form of {@link Future}.
* The efficiency of {@code ForkJoinTask}s stems from a set of
@@ -64,10 +72,7 @@ import java.util.WeakHashMap;
* results of a task is {@link #join}, but there are several variants:
* The {@link Future#get} methods support interruptible and/or timed
* waits for completion and report results using {@code Future}
- * conventions. Method {@link #helpJoin} enables callers to actively
- * execute other tasks while awaiting joins, which is sometimes more
- * efficient but only applies when all subtasks are known to be
- * strictly tree-structured. Method {@link #invoke} is semantically
+ * conventions. Method {@link #invoke} is semantically
* equivalent to {@code fork(); join()} but always attempts to begin
* execution in the current thread. The "quiet" forms of
* these methods do not extract results or report exceptions. These
@@ -103,7 +108,17 @@ import java.util.WeakHashMap;
* ForkJoinTasks (as may be determined using method {@link
* #inForkJoinPool}). Attempts to invoke them in other contexts
* result in exceptions or errors, possibly including
- * ClassCastException.
+ * {@code ClassCastException}.
+ *
+ *
Method {@link #join} and its variants are appropriate for use
+ * only when completion dependencies are acyclic; that is, the
+ * parallel computation can be described as a directed acyclic graph
+ * (DAG). Otherwise, executions may encounter a form of deadlock as
+ * tasks cyclically wait for each other. However, this framework
+ * supports other methods and techniques (for example the use of
+ * {@link Phaser}, {@link #helpQuiesce}, and {@link #complete}) that
+ * may be of use in constructing custom subclasses for problems that
+ * are not statically structured as DAGs.
*
*
Most base support methods are {@code final}, to prevent
* overriding of implementations that are intrinsically tied to the
@@ -125,9 +140,8 @@ import java.util.WeakHashMap;
*
*
This class provides {@code adapt} methods for {@link Runnable}
* and {@link Callable}, that may be of use when mixing execution of
- * {@code ForkJoinTasks} with other kinds of tasks. When all tasks
- * are of this form, consider using a pool in
- * {@linkplain ForkJoinPool#setAsyncMode async mode}.
+ * {@code ForkJoinTasks} with other kinds of tasks. When all tasks are
+ * of this form, consider using a pool constructed in asyncMode.
*
*
ForkJoinTasks are {@code Serializable}, which enables them to be
* used in extensions such as remote execution frameworks. It is
@@ -148,44 +162,34 @@ public abstract class ForkJoinTask im
* status maintenance (2) execution and awaiting completion (3)
* user-level methods that additionally report results. This is
* sometimes hard to see because this file orders exported methods
- * in a way that flows well in javadocs.
+ * in a way that flows well in javadocs. In particular, most
+ * join mechanics are in method quietlyJoin, below.
*/
- /**
- * Run control status bits packed into a single int to minimize
- * footprint and to ensure atomicity (via CAS). Status is
- * initially zero, and takes on nonnegative values until
- * completed, upon which status holds COMPLETED. CANCELLED, or
- * EXCEPTIONAL, which use the top 3 bits. Tasks undergoing
- * blocking waits by other threads have SIGNAL_MASK bits set --
- * bit 15 for external (nonFJ) waits, and the rest a count of
- * waiting FJ threads. (This representation relies on
- * ForkJoinPool max thread limits). Signal counts are not directly
- * incremented by ForkJoinTask methods, but instead via a call to
- * requestSignal within ForkJoinPool.preJoin, once their need is
- * established.
- *
- * Completion of a stolen task with SIGNAL_MASK bits set awakens
- * any waiters via notifyAll. Even though suboptimal for some
- * purposes, we use basic builtin wait/notify to take advantage of
- * "monitor inflation" in JVMs that we would otherwise need to
- * emulate to avoid adding further per-task bookkeeping overhead.
- * We want these monitors to be "fat", i.e., not use biasing or
- * thin-lock techniques, so use some odd coding idioms that tend
- * to avoid them.
- *
- * Note that bits 16-28 are currently unused. Also value
- * 0x80000000 is available as spare completion value.
+ /*
+ * The status field holds run control status bits packed into a
+ * single int to minimize footprint and to ensure atomicity (via
+ * CAS). Status is initially zero, and takes on nonnegative
+ * values until completed, upon which status holds value
+ * NORMAL, CANCELLED, or EXCEPTIONAL. Tasks undergoing blocking
+ * waits by other threads have the SIGNAL bit set. Completion of
+ * a stolen task with SIGNAL set awakens any waiters via
+ * notifyAll. Even though suboptimal for some purposes, we use
+ * basic builtin wait/notify to take advantage of "monitor
+ * inflation" in JVMs that we would otherwise need to emulate to
+ * avoid adding further per-task bookkeeping overhead. We want
+ * these monitors to be "fat", i.e., not use biasing or thin-lock
+ * techniques, so use some odd coding idioms that tend to avoid
+ * them.
*/
+
+ /** The run status of this task */
volatile int status; // accessed directly by pool and workers
- private static final int COMPLETION_MASK = 0xe0000000;
- private static final int NORMAL = 0xe0000000; // == mask
- private static final int CANCELLED = 0xc0000000;
- private static final int EXCEPTIONAL = 0xa0000000;
- private static final int SIGNAL_MASK = 0x0000ffff;
- private static final int INTERNAL_SIGNAL_MASK = 0x00007fff;
- private static final int EXTERNAL_SIGNAL = 0x00008000;
+ private static final int NORMAL = -1;
+ private static final int CANCELLED = -2;
+ private static final int EXCEPTIONAL = -3;
+ private static final int SIGNAL = 1;
/**
* Table of exceptions thrown by tasks, to enable reporting by
@@ -211,155 +215,82 @@ public abstract class ForkJoinTask im
int s;
while ((s = status) >= 0) {
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) {
- if ((s & SIGNAL_MASK) != 0) {
- Thread t = Thread.currentThread();
- if (t instanceof ForkJoinWorkerThread)
- ((ForkJoinWorkerThread) t).pool.updateRunningCount
- (s & INTERNAL_SIGNAL_MASK);
+ if (s != 0)
synchronized (this) { notifyAll(); }
- }
- return;
+ break;
}
}
}
/**
- * Record exception and set exceptional completion
+ * Records exception and sets exceptional completion.
+ *
+ * @return status on exit
*/
- private void setDoneExceptionally(Throwable rex) {
+ private void setExceptionalCompletion(Throwable rex) {
exceptionMap.put(this, rex);
setCompletion(EXCEPTIONAL);
}
/**
- * Main internal execution method: Unless done, calls exec and
- * records completion.
- *
- * @return true if ran and completed normally
+ * Blocks a worker thread until completion. Called only by
+ * pool. Currently unused -- pool-based waits use timeout
+ * version below.
*/
- final boolean tryExec() {
- try {
- if (status < 0 || !exec())
- return false;
- } catch (Throwable rex) {
- setDoneExceptionally(rex);
- return false;
+ final void internalAwaitDone() {
+ int s; // the odd construction reduces lock bias effects
+ while ((s = status) >= 0) {
+ try {
+ synchronized (this) {
+ if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL))
+ wait();
+ }
+ } catch (InterruptedException ie) {
+ cancelIfTerminating();
+ }
}
- setCompletion(NORMAL); // must be outside try block
- return true;
}
/**
- * Increments internal signal count (thus requesting signal upon
- * completion) unless already done. Call only once per join.
- * Used by ForkJoinPool.preJoin.
- *
- * @return status
- */
- final int requestSignal() {
- int s;
- do {} while ((s = status) >= 0 &&
- !UNSAFE.compareAndSwapInt(this, statusOffset, s, s + 1));
- return s;
- }
-
- /**
- * Sets external signal request unless already done.
+ * Blocks a worker thread until completed or timed out. Called
+ * only by pool.
*
- * @return status
+ * @return status on exit
*/
- private int requestExternalSignal() {
+ final int internalAwaitDone(long millis, int nanos) {
int s;
- do {} while ((s = status) >= 0 &&
- !UNSAFE.compareAndSwapInt(this, statusOffset,
- s, s | EXTERNAL_SIGNAL));
- return s;
- }
-
- /*
- * Awaiting completion. The four versions, internal vs external X
- * untimed vs timed, have the same overall structure but differ
- * from each other enough to defy simple integration.
- */
-
- /**
- * Blocks a worker until this task is done, also maintaining pool
- * and signal counts
- */
- private void awaitDone(ForkJoinWorkerThread w) {
- if (status >= 0) {
- w.pool.preJoin(this);
- while (status >= 0) {
- try { // minimize lock scope
- synchronized(this) {
- if (status >= 0)
- wait();
- else { // help release; also helps avoid lock-biasing
- notifyAll();
- break;
- }
- }
- } catch (InterruptedException ie) {
- cancelIfTerminating();
+ if ((s = status) >= 0) {
+ try {
+ synchronized (this) {
+ if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL))
+ wait(millis, nanos);
}
+ } catch (InterruptedException ie) {
+ cancelIfTerminating();
}
+ s = status;
}
+ return s;
}
/**
- * Blocks a non-ForkJoin thread until this task is done.
+ * Blocks a non-worker-thread until completion.
*/
private void externalAwaitDone() {
- if (requestExternalSignal() >= 0) {
- boolean interrupted = false;
- while (status >= 0) {
- try {
- synchronized(this) {
- if (status >= 0)
- wait();
- else {
- notifyAll();
- break;
- }
- }
- } catch (InterruptedException ie) {
- interrupted = true;
- }
- }
- if (interrupted)
- Thread.currentThread().interrupt();
- }
- }
-
- /**
- * Blocks a worker until this task is done or timeout elapses
- */
- private void timedAwaitDone(ForkJoinWorkerThread w, long nanos) {
- if (status >= 0) {
- long startTime = System.nanoTime();
- ForkJoinPool pool = w.pool;
- pool.preJoin(this);
- while (status >= 0) {
- long nt = nanos - (System.nanoTime() - startTime);
- if (nt > 0) {
- long ms = nt / 1000000;
- int ns = (int) (nt % 1000000);
- try {
- synchronized(this) { if (status >= 0) wait(ms, ns); }
- } catch (InterruptedException ie) {
- cancelIfTerminating();
- }
- }
- else {
- int s; // adjust running count on timeout
- while ((s = status) >= 0 &&
- (s & INTERNAL_SIGNAL_MASK) != 0) {
- if (UNSAFE.compareAndSwapInt(this, statusOffset,
- s, s - 1)) {
- pool.updateRunningCount(1);
- break;
+ int s;
+ while ((s = status) >= 0) {
+ synchronized (this) {
+ if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)) {
+ boolean interrupted = false;
+ while (status >= 0) {
+ try {
+ wait();
+ } catch (InterruptedException ie) {
+ interrupted = true;
}
}
+ if (interrupted)
+ Thread.currentThread().interrupt();
break;
}
}
@@ -367,83 +298,19 @@ public abstract class ForkJoinTask im
}
/**
- * Blocks a non-ForkJoin thread until this task is done or timeout elapses
+ * Unless done, calls exec and records status if completed, but
+ * doesn't wait for completion otherwise. Primary execution method
+ * for ForkJoinWorkerThread.
*/
- private void externalTimedAwaitDone(long nanos) {
- if (requestExternalSignal() >= 0) {
- long startTime = System.nanoTime();
- boolean interrupted = false;
- while (status >= 0) {
- long nt = nanos - (System.nanoTime() - startTime);
- if (nt <= 0)
- break;
- long ms = nt / 1000000;
- int ns = (int) (nt % 1000000);
- try {
- synchronized(this) { if (status >= 0) wait(ms, ns); }
- } catch (InterruptedException ie) {
- interrupted = true;
- }
- }
- if (interrupted)
- Thread.currentThread().interrupt();
- }
- }
-
- // reporting results
-
- /**
- * Returns result or throws the exception associated with status.
- * Uses Unsafe as a workaround for javac not allowing rethrow of
- * unchecked exceptions.
- */
- private V reportResult() {
- if ((status & COMPLETION_MASK) < NORMAL) {
- Throwable ex = getException();
- if (ex != null)
- UNSAFE.throwException(ex);
- }
- return getRawResult();
- }
-
- /**
- * Returns result or throws exception using j.u.c.Future conventions.
- * Only call when {@code isDone} known to be true or thread known
- * to be interrupted.
- */
- private V reportFutureResult()
- throws InterruptedException, ExecutionException {
- if (Thread.interrupted())
- throw new InterruptedException();
- int s = status & COMPLETION_MASK;
- if (s < NORMAL) {
- Throwable ex;
- if (s == CANCELLED)
- throw new CancellationException();
- if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
- throw new ExecutionException(ex);
+ final void quietlyExec() {
+ try {
+ if (status < 0 || !exec())
+ return;
+ } catch (Throwable rex) {
+ setExceptionalCompletion(rex);
+ return;
}
- return getRawResult();
- }
-
- /**
- * Returns result or throws exception using j.u.c.Future conventions
- * with timeouts.
- */
- private V reportTimedFutureResult()
- throws InterruptedException, ExecutionException, TimeoutException {
- if (Thread.interrupted())
- throw new InterruptedException();
- Throwable ex;
- int s = status & COMPLETION_MASK;
- if (s == NORMAL)
- return getRawResult();
- else if (s == CANCELLED)
- throw new CancellationException();
- else if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
- throw new ExecutionException(ex);
- else
- throw new TimeoutException();
+ setCompletion(NORMAL); // must be outside try block
}
// public methods
@@ -473,42 +340,55 @@ public abstract class ForkJoinTask im
}
/**
- * Returns the result of the computation when it {@link #isDone is done}.
- * This method differs from {@link #get()} in that
+ * Returns the result of the computation when it {@link #isDone is
+ * done}. This method differs from {@link #get()} in that
* abnormal completion results in {@code RuntimeException} or
- * {@code Error}, not {@code ExecutionException}.
+ * {@code Error}, not {@code ExecutionException}, and that
+ * interrupts of the calling thread do not cause the
+ * method to abruptly return by throwing {@code
+ * InterruptedException}.
*
* @return the computed result
*/
public final V join() {
quietlyJoin();
- return reportResult();
+ Throwable ex;
+ if (status < NORMAL && (ex = getException()) != null)
+ UNSAFE.throwException(ex);
+ return getRawResult();
}
/**
* Commences performing this task, awaits its completion if
- * necessary, and return its result, or throws an (unchecked)
- * exception if the underlying computation did so.
+ * necessary, and returns its result, or throws an (unchecked)
+ * {@code RuntimeException} or {@code Error} if the underlying
+ * computation did so.
*
* @return the computed result
*/
public final V invoke() {
- if (!tryExec())
- quietlyJoin();
- return reportResult();
+ quietlyInvoke();
+ Throwable ex;
+ if (status < NORMAL && (ex = getException()) != null)
+ UNSAFE.throwException(ex);
+ return getRawResult();
}
/**
* Forks the given tasks, returning when {@code isDone} holds for
* each task or an (unchecked) exception is encountered, in which
- * case the exception is rethrown. If either task encounters an
- * exception, the other one may be, but is not guaranteed to be,
- * cancelled. If both tasks throw an exception, then this method
- * throws one of them. The individual status of each task may be
- * checked using {@link #getException()} and related methods.
+ * case the exception is rethrown. If more than one task
+ * encounters an exception, then this method throws any one of
+ * these exceptions. If any task encounters an exception, the
+ * other may be cancelled. However, the execution status of
+ * individual tasks is not guaranteed upon exceptional return. The
+ * status of each task may be obtained using {@link
+ * #getException()} and related methods to check if they have been
+ * cancelled, completed normally or exceptionally, or left
+ * unprocessed.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -526,15 +406,17 @@ public abstract class ForkJoinTask im
/**
* Forks the given tasks, returning when {@code isDone} holds for
* each task or an (unchecked) exception is encountered, in which
- * case the exception is rethrown. If any task encounters an
- * exception, others may be, but are not guaranteed to be,
- * cancelled. If more than one task encounters an exception, then
- * this method throws any one of these exceptions. The individual
- * status of each task may be checked using {@link #getException()}
- * and related methods.
+ * case the exception is rethrown. If more than one task
+ * encounters an exception, then this method throws any one of
+ * these exceptions. If any task encounters an exception, others
+ * may be cancelled. However, the execution status of individual
+ * tasks is not guaranteed upon exceptional return. The status of
+ * each task may be obtained using {@link #getException()} and
+ * related methods to check if they have been cancelled, completed
+ * normally or exceptionally, or left unprocessed.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -555,7 +437,7 @@ public abstract class ForkJoinTask im
t.fork();
else {
t.quietlyInvoke();
- if (ex == null)
+ if (ex == null && t.status < NORMAL)
ex = t.getException();
}
}
@@ -566,7 +448,7 @@ public abstract class ForkJoinTask im
t.cancel(false);
else {
t.quietlyJoin();
- if (ex == null)
+ if (ex == null && t.status < NORMAL)
ex = t.getException();
}
}
@@ -578,17 +460,18 @@ public abstract class ForkJoinTask im
/**
* Forks all tasks in the specified collection, returning when
* {@code isDone} holds for each task or an (unchecked) exception
- * is encountered. If any task encounters an exception, others
- * may be, but are not guaranteed to be, cancelled. If more than
- * one task encounters an exception, then this method throws any
- * one of these exceptions. The individual status of each task
- * may be checked using {@link #getException()} and related
- * methods. The behavior of this operation is undefined if the
- * specified collection is modified while the operation is in
- * progress.
+ * is encountered, in which case the exception is rethrown. If
+ * more than one task encounters an exception, then this method
+ * throws any one of these exceptions. If any task encounters an
+ * exception, others may be cancelled. However, the execution
+ * status of individual tasks is not guaranteed upon exceptional
+ * return. The status of each task may be obtained using {@link
+ * #getException()} and related methods to check if they have been
+ * cancelled, completed normally or exceptionally, or left
+ * unprocessed.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -617,7 +500,7 @@ public abstract class ForkJoinTask im
t.fork();
else {
t.quietlyInvoke();
- if (ex == null)
+ if (ex == null && t.status < NORMAL)
ex = t.getException();
}
}
@@ -628,7 +511,7 @@ public abstract class ForkJoinTask im
t.cancel(false);
else {
t.quietlyJoin();
- if (ex == null)
+ if (ex == null && t.status < NORMAL)
ex = t.getException();
}
}
@@ -640,36 +523,41 @@ public abstract class ForkJoinTask im
/**
* Attempts to cancel execution of this task. This attempt will
- * fail if the task has already completed, has already been
- * cancelled, or could not be cancelled for some other reason. If
- * successful, and this task has not started when cancel is
- * called, execution of this task is suppressed, {@link
- * #isCancelled} will report true, and {@link #join} will result
- * in a {@code CancellationException} being thrown.
+ * fail if the task has already completed or could not be
+ * cancelled for some other reason. If successful, and this task
+ * has not started when {@code cancel} is called, execution of
+ * this task is suppressed. After this method returns
+ * successfully, unless there is an intervening call to {@link
+ * #reinitialize}, subsequent calls to {@link #isCancelled},
+ * {@link #isDone}, and {@code cancel} will return {@code true}
+ * and calls to {@link #join} and related methods will result in
+ * {@code CancellationException}.
*
* This method may be overridden in subclasses, but if so, must
- * still ensure that these minimal properties hold. In particular,
- * the {@code cancel} method itself must not throw exceptions.
+ * still ensure that these properties hold. In particular, the
+ * {@code cancel} method itself must not throw exceptions.
*
*
This method is designed to be invoked by other
* tasks. To terminate the current task, you can just return or
* throw an unchecked exception from its computation method, or
* invoke {@link #completeExceptionally}.
*
- * @param mayInterruptIfRunning this value is ignored in the
- * default implementation because tasks are not
- * cancelled via interruption
+ * @param mayInterruptIfRunning this value has no effect in the
+ * default implementation because interrupts are not used to
+ * control cancellation.
*
* @return {@code true} if this task is now cancelled
*/
public boolean cancel(boolean mayInterruptIfRunning) {
setCompletion(CANCELLED);
- return (status & COMPLETION_MASK) == CANCELLED;
+ return status == CANCELLED;
}
/**
- * Cancels, ignoring any exceptions it throws. Used during worker
- * and pool shutdown.
+ * Cancels, ignoring any exceptions thrown by cancel. Used during
+ * worker and pool shutdown. Cancel is spec'ed not to throw any
+ * exceptions, but if it does anyway, we have no recourse during
+ * shutdown, so guard against this case.
*/
final void cancelIgnoringExceptions() {
try {
@@ -679,12 +567,13 @@ public abstract class ForkJoinTask im
}
/**
- * Cancels ignoring exceptions if worker is terminating
+ * Cancels if current thread is a terminating worker thread,
+ * ignoring any exceptions thrown by cancel.
*/
- private void cancelIfTerminating() {
+ final void cancelIfTerminating() {
Thread t = Thread.currentThread();
if ((t instanceof ForkJoinWorkerThread) &&
- ((ForkJoinWorkerThread) t).isTerminating()) {
+ ((ForkJoinWorkerThread) t).isTerminating()) {
try {
cancel(false);
} catch (Throwable ignore) {
@@ -697,7 +586,7 @@ public abstract class ForkJoinTask im
}
public final boolean isCancelled() {
- return (status & COMPLETION_MASK) == CANCELLED;
+ return status == CANCELLED;
}
/**
@@ -706,7 +595,7 @@ public abstract class ForkJoinTask im
* @return {@code true} if this task threw an exception or was cancelled
*/
public final boolean isCompletedAbnormally() {
- return (status & COMPLETION_MASK) < NORMAL;
+ return status < NORMAL;
}
/**
@@ -717,7 +606,7 @@ public abstract class ForkJoinTask im
* exception and was not cancelled
*/
public final boolean isCompletedNormally() {
- return (status & COMPLETION_MASK) == NORMAL;
+ return status == NORMAL;
}
/**
@@ -728,7 +617,7 @@ public abstract class ForkJoinTask im
* @return the exception, or {@code null} if none
*/
public final Throwable getException() {
- int s = status & COMPLETION_MASK;
+ int s = status;
return ((s >= NORMAL) ? null :
(s == CANCELLED) ? new CancellationException() :
exceptionMap.get(this));
@@ -749,20 +638,21 @@ public abstract class ForkJoinTask im
* thrown will be a {@code RuntimeException} with cause {@code ex}.
*/
public void completeExceptionally(Throwable ex) {
- setDoneExceptionally((ex instanceof RuntimeException) ||
- (ex instanceof Error) ? ex :
- new RuntimeException(ex));
+ setExceptionalCompletion((ex instanceof RuntimeException) ||
+ (ex instanceof Error) ? ex :
+ new RuntimeException(ex));
}
/**
* Completes this task, and if not already aborted or cancelled,
- * returning a {@code null} result upon {@code join} and related
- * operations. This method may be used to provide results for
- * asynchronous tasks, or to provide alternative handling for
- * tasks that would not otherwise complete normally. Its use in
- * other situations is discouraged. This method is
- * overridable, but overridden versions must invoke {@code super}
- * implementation to maintain guarantees.
+ * returning the given value as the result of subsequent
+ * invocations of {@code join} and related operations. This method
+ * may be used to provide results for asynchronous tasks, or to
+ * provide alternative handling for tasks that would not otherwise
+ * complete normally. Its use in other situations is
+ * discouraged. This method is overridable, but overridden
+ * versions must invoke {@code super} implementation to maintain
+ * guarantees.
*
* @param value the result value for this task
*/
@@ -770,92 +660,141 @@ public abstract class ForkJoinTask im
try {
setRawResult(value);
} catch (Throwable rex) {
- setDoneExceptionally(rex);
+ setExceptionalCompletion(rex);
return;
}
setCompletion(NORMAL);
}
- public final V get() throws InterruptedException, ExecutionException {
- quietlyJoin();
- return reportFutureResult();
- }
-
- public final V get(long timeout, TimeUnit unit)
- throws InterruptedException, ExecutionException, TimeoutException {
- long nanos = unit.toNanos(timeout);
- Thread t = Thread.currentThread();
- if (t instanceof ForkJoinWorkerThread) {
- ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
- if (!w.unpushTask(this) || !tryExec())
- timedAwaitDone(w, nanos);
- }
- else
- externalTimedAwaitDone(nanos);
- return reportTimedFutureResult();
- }
-
/**
- * Possibly executes other tasks until this task {@link #isDone is
- * done}, then returns the result of the computation. This method
- * may be more efficient than {@code join}, but is only applicable
- * when there are no potential dependencies between continuation
- * of the current task and that of any other task that might be
- * executed while helping. (This usually holds for pure
- * divide-and-conquer tasks).
- *
- * This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
- * {@link #inForkJoinPool}). Attempts to invoke in other contexts
- * result in exceptions or errors, possibly including {@code
- * ClassCastException}.
+ * Waits if necessary for the computation to complete, and then
+ * retrieves its result.
*
* @return the computed result
+ * @throws CancellationException if the computation was cancelled
+ * @throws ExecutionException if the computation threw an
+ * exception
+ * @throws InterruptedException if the current thread is not a
+ * member of a ForkJoinPool and was interrupted while waiting
*/
- public final V helpJoin() {
- quietlyHelpJoin();
- return reportResult();
+ public final V get() throws InterruptedException, ExecutionException {
+ int s;
+ if (Thread.currentThread() instanceof ForkJoinWorkerThread) {
+ quietlyJoin();
+ s = status;
+ }
+ else {
+ while ((s = status) >= 0) {
+ synchronized (this) { // interruptible form of awaitDone
+ if (UNSAFE.compareAndSwapInt(this, statusOffset,
+ s, SIGNAL)) {
+ while (status >= 0)
+ wait();
+ }
+ }
+ }
+ }
+ if (s < NORMAL) {
+ Throwable ex;
+ if (s == CANCELLED)
+ throw new CancellationException();
+ if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
+ throw new ExecutionException(ex);
+ }
+ return getRawResult();
}
/**
- * Possibly executes other tasks until this task {@link #isDone is
- * done}. This method may be useful when processing collections
- * of tasks when some have been cancelled or otherwise known to
- * have aborted.
+ * Waits if necessary for at most the given time for the computation
+ * to complete, and then retrieves its result, if available.
*
- *
This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
- * {@link #inForkJoinPool}). Attempts to invoke in other contexts
- * result in exceptions or errors, possibly including {@code
- * ClassCastException}.
+ * @param timeout the maximum time to wait
+ * @param unit the time unit of the timeout argument
+ * @return the computed result
+ * @throws CancellationException if the computation was cancelled
+ * @throws ExecutionException if the computation threw an
+ * exception
+ * @throws InterruptedException if the current thread is not a
+ * member of a ForkJoinPool and was interrupted while waiting
+ * @throws TimeoutException if the wait timed out
*/
- public final void quietlyHelpJoin() {
- ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
- if (!w.unpushTask(this) || !tryExec()) {
- while (status >= 0) {
- ForkJoinTask t = w.scanWhileJoining(this);
- if (t == null) {
- if (status >= 0)
- awaitDone(w);
- break;
+ public final V get(long timeout, TimeUnit unit)
+ throws InterruptedException, ExecutionException, TimeoutException {
+ long nanos = unit.toNanos(timeout);
+ if (status >= 0) {
+ Thread t = Thread.currentThread();
+ if (t instanceof ForkJoinWorkerThread) {
+ ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
+ boolean completed = false; // timed variant of quietlyJoin
+ if (w.unpushTask(this)) {
+ try {
+ completed = exec();
+ } catch (Throwable rex) {
+ setExceptionalCompletion(rex);
+ }
+ }
+ if (completed)
+ setCompletion(NORMAL);
+ else if (status >= 0)
+ w.joinTask(this, true, nanos);
+ }
+ else if (Thread.interrupted())
+ throw new InterruptedException();
+ else {
+ long startTime = System.nanoTime();
+ int s; long nt;
+ while ((s = status) >= 0 &&
+ (nt = nanos - (System.nanoTime() - startTime)) > 0) {
+ if (UNSAFE.compareAndSwapInt(this, statusOffset, s,
+ SIGNAL)) {
+ long ms = nt / 1000000;
+ int ns = (int) (nt % 1000000);
+ synchronized (this) {
+ if (status >= 0)
+ wait(ms, ns); // exit on IE throw
+ }
+ }
}
- t.tryExec();
}
}
+ int es = status;
+ if (es != NORMAL) {
+ Throwable ex;
+ if (es == CANCELLED)
+ throw new CancellationException();
+ if (es == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
+ throw new ExecutionException(ex);
+ throw new TimeoutException();
+ }
+ return getRawResult();
}
/**
- * Joins this task, without returning its result or throwing an
+ * Joins this task, without returning its result or throwing its
* exception. This method may be useful when processing
* collections of tasks when some have been cancelled or otherwise
* known to have aborted.
*/
public final void quietlyJoin() {
- Thread t = Thread.currentThread();
- if (t instanceof ForkJoinWorkerThread) {
+ Thread t;
+ if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
- if (!w.unpushTask(this) || !tryExec())
- awaitDone(w);
+ if (status >= 0) {
+ if (w.unpushTask(this)) {
+ boolean completed;
+ try {
+ completed = exec();
+ } catch (Throwable rex) {
+ setExceptionalCompletion(rex);
+ return;
+ }
+ if (completed) {
+ setCompletion(NORMAL);
+ return;
+ }
+ }
+ w.joinTask(this, false, 0L);
+ }
}
else
externalAwaitDone();
@@ -863,14 +802,23 @@ public abstract class ForkJoinTask im
/**
* Commences performing this task and awaits its completion if
- * necessary, without returning its result or throwing an
- * exception. This method may be useful when processing
- * collections of tasks when some have been cancelled or otherwise
- * known to have aborted.
+ * necessary, without returning its result or throwing its
+ * exception.
*/
public final void quietlyInvoke() {
- if (!tryExec())
- quietlyJoin();
+ if (status >= 0) {
+ boolean completed;
+ try {
+ completed = exec();
+ } catch (Throwable rex) {
+ setExceptionalCompletion(rex);
+ return;
+ }
+ if (completed)
+ setCompletion(NORMAL);
+ else
+ quietlyJoin();
+ }
}
/**
@@ -881,7 +829,7 @@ public abstract class ForkJoinTask im
* processed.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -900,9 +848,15 @@ public abstract class ForkJoinTask im
* under any other usage conditions are not guaranteed.
* This method may be useful when executing
* pre-constructed trees of subtasks in loops.
+ *
+ * Upon completion of this method, {@code isDone()} reports
+ * {@code false}, and {@code getException()} reports {@code
+ * null}. However, the value returned by {@code getRawResult} is
+ * unaffected. To clear this value, you can invoke {@code
+ * setRawResult(null)}.
*/
public void reinitialize() {
- if ((status & COMPLETION_MASK) == EXCEPTIONAL)
+ if (status == EXCEPTIONAL)
exceptionMap.remove(this);
status = 0;
}
@@ -940,7 +894,7 @@ public abstract class ForkJoinTask im
* were not, stolen.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -959,7 +913,7 @@ public abstract class ForkJoinTask im
* fork other tasks.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -982,7 +936,7 @@ public abstract class ForkJoinTask im
* exceeded.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -1040,7 +994,7 @@ public abstract class ForkJoinTask im
* otherwise.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -1059,7 +1013,7 @@ public abstract class ForkJoinTask im
* be useful otherwise.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -1082,7 +1036,7 @@ public abstract class ForkJoinTask im
* otherwise.
*
* This method may be invoked only from within {@code
- * ForkJoinTask} computations (as may be determined using method
+ * ForkJoinPool} computations (as may be determined using method
* {@link #inForkJoinPool}). Attempts to invoke in other contexts
* result in exceptions or errors, possibly including {@code
* ClassCastException}.
@@ -1192,7 +1146,7 @@ public abstract class ForkJoinTask im
private static final long serialVersionUID = -7721805057305804111L;
/**
- * Saves the state to a stream.
+ * Saves the state to a stream (that is, serializes it).
*
* @serialData the current run status and the exception thrown
* during execution, or {@code null} if none
@@ -1205,18 +1159,16 @@ public abstract class ForkJoinTask im
}
/**
- * Reconstitutes the instance from a stream.
+ * Reconstitutes the instance from a stream (that is, deserializes it).
*
* @param s the stream
*/
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
s.defaultReadObject();
- status &= ~INTERNAL_SIGNAL_MASK; // clear internal signal counts
- status |= EXTERNAL_SIGNAL; // conservatively set external signal
Object ex = s.readObject();
if (ex != null)
- setDoneExceptionally((Throwable) ex);
+ setExceptionalCompletion((Throwable) ex);
}
// Unsafe mechanics