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.9 by jsr166, Mon Jul 20 22:26:03 2009 UTC vs.
Revision 1.40 by dl, Wed Aug 5 11:09:28 2009 UTC

# Line 5 | Line 5
5   */
6  
7   package jsr166y;
8 < import java.io.Serializable;
9 < import java.util.*;
8 >
9   import java.util.concurrent.*;
10 < import java.util.concurrent.atomic.*;
11 < import sun.misc.Unsafe;
12 < import java.lang.reflect.*;
10 >
11 > import java.io.Serializable;
12 > import java.util.Collection;
13 > import java.util.Collections;
14 > import java.util.List;
15 > import java.util.RandomAccess;
16 > import java.util.Map;
17 > import java.util.WeakHashMap;
18  
19   /**
20 < * Abstract base class for tasks that run within a {@link
21 < * ForkJoinPool}.  A ForkJoinTask is a thread-like entity that is much
20 > * Abstract base class for tasks that run within a {@link ForkJoinPool}.
21 > * A {@code ForkJoinTask} is a thread-like entity that is much
22   * lighter weight than a normal thread.  Huge numbers of tasks and
23   * subtasks may be hosted by a small number of actual threads in a
24   * ForkJoinPool, at the price of some usage limitations.
25   *
26 < * <p> A "main" ForkJoinTask begins execution when submitted to a
27 < * {@link ForkJoinPool}. Once started, it will usually in turn start
28 < * other subtasks.  As indicated by the name of this class, many
29 < * programs using ForkJoinTasks employ only methods {@code fork}
30 < * and {@code join}, or derivatives such as
31 < * {@code invokeAll}.  However, this class also provides a number
32 < * of other methods that can come into play in advanced usages, as
33 < * well as extension mechanics that allow support of new forms of
34 < * fork/join processing.
26 > * <p>A "main" {@code ForkJoinTask} begins execution when submitted
27 > * to a {@link ForkJoinPool}.  Once started, it will usually in turn
28 > * start other subtasks.  As indicated by the name of this class,
29 > * many programs using {@code ForkJoinTask} employ only methods
30 > * {@link #fork} and {@link #join}, or derivatives such as {@link
31 > * #invokeAll}.  However, this class also provides a number of other
32 > * methods that can come into play in advanced usages, as well as
33 > * extension mechanics that allow support of new forms of fork/join
34 > * processing.
35   *
36 < * <p>A ForkJoinTask is a lightweight form of {@link Future}.  The
37 < * efficiency of ForkJoinTasks stems from a set of restrictions (that
38 < * are only partially statically enforceable) reflecting their
39 < * intended use as computational tasks calculating pure functions or
40 < * operating on purely isolated objects.  The primary coordination
41 < * mechanisms are {@link #fork}, that arranges asynchronous execution,
42 < * and {@link #join}, that doesn't proceed until the task's result has
43 < * been computed.  Computations should avoid {@code synchronized}
44 < * methods or blocks, and should minimize other blocking
45 < * synchronization apart from joining other tasks or using
46 < * synchronizers such as Phasers that are advertised to cooperate with
47 < * fork/join scheduling. Tasks should also not perform blocking IO,
48 < * and should ideally access variables that are completely independent
49 < * of those accessed by other running tasks. Minor breaches of these
50 < * restrictions, for example using shared output streams, may be
51 < * tolerable in practice, but frequent use may result in poor
52 < * performance, and the potential to indefinitely stall if the number
53 < * of threads not waiting for IO or other external synchronization
54 < * becomes exhausted. This usage restriction is in part enforced by
55 < * not permitting checked exceptions such as {@code IOExceptions}
56 < * to be thrown. However, computations may still encounter unchecked
57 < * exceptions, that are rethrown to callers attempting join
58 < * them. These exceptions may additionally include
59 < * RejectedExecutionExceptions stemming from internal resource
60 < * exhaustion such as failure to allocate internal task queues.
36 > * <p>A {@code ForkJoinTask} is a lightweight form of {@link Future}.
37 > * The efficiency of {@code ForkJoinTask}s stems from a set of
38 > * restrictions (that are only partially statically enforceable)
39 > * reflecting their intended use as computational tasks calculating
40 > * pure functions or operating on purely isolated objects.  The
41 > * primary coordination mechanisms are {@link #fork}, that arranges
42 > * asynchronous execution, and {@link #join}, that doesn't proceed
43 > * until the task's result has been computed.  Computations should
44 > * avoid {@code synchronized} methods or blocks, and should minimize
45 > * other blocking synchronization apart from joining other tasks or
46 > * using synchronizers such as Phasers that are advertised to
47 > * cooperate with fork/join scheduling. Tasks should also not perform
48 > * blocking IO, and should ideally access variables that are
49 > * completely independent of those accessed by other running
50 > * tasks. Minor breaches of these restrictions, for example using
51 > * shared output streams, may be tolerable in practice, but frequent
52 > * use may result in poor performance, and the potential to
53 > * indefinitely stall if the number of threads not waiting for IO or
54 > * other external synchronization becomes exhausted. This usage
55 > * restriction is in part enforced by not permitting checked
56 > * exceptions such as {@code IOExceptions} to be thrown. However,
57 > * computations may still encounter unchecked exceptions, that are
58 > * rethrown to callers attempting to join them. These exceptions may
59 > * additionally include RejectedExecutionExceptions stemming from
60 > * internal resource exhaustion such as failure to allocate internal
61 > * task queues.
62   *
63   * <p>The primary method for awaiting completion and extracting
64   * results of a task is {@link #join}, but there are several variants:
# Line 63 | Line 68 | import java.lang.reflect.*;
68   * execute other tasks while awaiting joins, which is sometimes more
69   * efficient but only applies when all subtasks are known to be
70   * 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
71 > * equivalent to {@code fork(); join()} but always attempts to begin
72 > * execution in the current thread. The "<em>quiet</em>" forms of
73 > * these methods do not extract results or report exceptions. These
74   * may be useful when a set of tasks are being executed, and you need
75   * to delay processing of results or exceptions until all complete.
76   * Method {@code invokeAll} (available in multiple versions)
77   * performs the most common form of parallel invocation: forking a set
78   * of tasks and joining them all.
79   *
80 < * <p> The ForkJoinTask class is not usually directly subclassed.
80 > * <p>The execution status of tasks may be queried at several levels
81 > * of detail: {@link #isDone} is true if a task completed in any way
82 > * (including the case where a task was cancelled without executing);
83 > * {@link #isCancelled} is true if completion was due to cancellation;
84 > * {@link #isCompletedNormally} is true if a task completed without
85 > * cancellation or encountering an exception; {@link
86 > * #isCompletedExceptionally} is true if if the task encountered an
87 > * exception (in which case {@link #getException} returns the
88 > * exception); {@link #isCancelled} is true if the task was cancelled
89 > * (in which case {@link #getException} returns a {@link
90 > * java.util.concurrent.CancellationException}); and {@link
91 > * #isCompletedAbnormally} is true if a task was either cancelled or
92 > * encountered an exception.
93 > *
94 > * <p>The ForkJoinTask class is not usually directly subclassed.
95   * Instead, you subclass one of the abstract classes that support a
96 < * particular style of fork/join processing.  Normally, a concrete
96 > * particular style of fork/join processing, typically {@link
97 > * RecursiveAction} for computations that do not return results, or
98 > * {@link RecursiveTask} for those that do.  Normally, a concrete
99   * ForkJoinTask subclass declares fields comprising its parameters,
100   * established in a constructor, and then defines a {@code compute}
101   * method that somehow uses the control methods supplied by this base
102   * class. While these methods have {@code public} access (to allow
103 < * instances of different task subclasses to call each others
103 > * instances of different task subclasses to call each other's
104   * methods), some of them may only be called from within other
105 < * ForkJoinTasks. Attempts to invoke them in other contexts result in
106 < * exceptions or errors possibly including ClassCastException.
105 > * ForkJoinTasks (as may be determined using method {@link
106 > * #inForkJoinPool}).  Attempts to invoke them in other contexts
107 > * result in exceptions or errors, possibly including
108 > * ClassCastException.
109   *
110 < * <p>Most base support methods are {@code final} because their
111 < * implementations are intrinsically tied to the underlying
112 < * lightweight task scheduling framework, and so cannot be overridden.
113 < * Developers creating new basic styles of fork/join processing should
114 < * minimally implement {@code protected} methods
115 < * {@code exec}, {@code setRawResult}, and
116 < * {@code getRawResult}, while also introducing an abstract
117 < * computational method that can be implemented in its subclasses,
118 < * possibly relying on other {@code protected} methods provided
96 < * by this class.
110 > * <p>Most base support methods are {@code final}, to prevent
111 > * overriding of implementations that are intrinsically tied to the
112 > * underlying lightweight task scheduling framework.  Developers
113 > * creating new basic styles of fork/join processing should minimally
114 > * implement {@code protected} methods {@link #exec}, {@link
115 > * #setRawResult}, and {@link #getRawResult}, while also introducing
116 > * an abstract computational method that can be implemented in its
117 > * subclasses, possibly relying on other {@code protected} methods
118 > * provided by this class.
119   *
120   * <p>ForkJoinTasks should perform relatively small amounts of
121 < * computations, otherwise splitting into smaller tasks. As a very
122 < * rough rule of thumb, a task should perform more than 100 and less
123 < * than 10000 basic computational steps. If tasks are too big, then
124 < * parallelism cannot improve throughput. If too small, then memory
125 < * and internal task maintenance overhead may overwhelm processing.
121 > * computation. Large tasks should be split into smaller subtasks,
122 > * usually via recursive decomposition. As a very rough rule of thumb,
123 > * a task should perform more than 100 and less than 10000 basic
124 > * computational steps. If tasks are too big, then parallelism cannot
125 > * improve throughput. If too small, then memory and internal task
126 > * maintenance overhead may overwhelm processing.
127   *
128 < * <p>ForkJoinTasks are {@code Serializable}, which enables them
129 < * to be used in extensions such as remote execution frameworks. It is
130 < * in general sensible to serialize tasks only before or after, but
131 < * not during execution. Serialization is not relied on during
132 < * execution itself.
128 > * <p>This class provides {@code adapt} methods for {@link Runnable}
129 > * and {@link Callable}, that may be of use when mixing execution of
130 > * {@code ForkJoinTasks} with other kinds of tasks. When all tasks
131 > * are of this form, consider using a pool in
132 > * {@linkplain ForkJoinPool#setAsyncMode async mode}.
133 > *
134 > * <p>ForkJoinTasks are {@code Serializable}, which enables them to be
135 > * used in extensions such as remote execution frameworks. It is
136 > * sensible to serialize tasks only before or after, but not during,
137 > * execution. Serialization is not relied on during execution itself.
138 > *
139 > * @since 1.7
140 > * @author Doug Lea
141   */
142   public abstract class ForkJoinTask<V> implements Future<V>, Serializable {
143  
# Line 141 | Line 172 | public abstract class ForkJoinTask<V> im
172      /**
173       * Table of exceptions thrown by tasks, to enable reporting by
174       * callers. Because exceptions are rare, we don't directly keep
175 <     * them with task objects, but instead us a weak ref table.  Note
175 >     * them with task objects, but instead use a weak ref table.  Note
176       * that cancellation exceptions don't appear in the table, but are
177       * instead recorded as status values.
178 <     * Todo: Use ConcurrentReferenceHashMap
178 >     * TODO: Use ConcurrentReferenceHashMap
179       */
180      static final Map<ForkJoinTask<?>, Throwable> exceptionMap =
181          Collections.synchronizedMap
# Line 153 | Line 184 | public abstract class ForkJoinTask<V> im
184      // within-package utilities
185  
186      /**
187 <     * Get current worker thread, or null if not a worker thread
187 >     * Gets current worker thread, or null if not a worker thread.
188       */
189      static ForkJoinWorkerThread getWorker() {
190          Thread t = Thread.currentThread();
191 <        return ((t instanceof ForkJoinWorkerThread)?
192 <                (ForkJoinWorkerThread)t : null);
191 >        return ((t instanceof ForkJoinWorkerThread) ?
192 >                (ForkJoinWorkerThread) t : null);
193      }
194  
195      final boolean casStatus(int cmp, int val) {
196 <        return _unsafe.compareAndSwapInt(this, statusOffset, cmp, val);
196 >        return UNSAFE.compareAndSwapInt(this, statusOffset, cmp, val);
197      }
198  
199      /**
# Line 170 | Line 201 | public abstract class ForkJoinTask<V> im
201       */
202      static void rethrowException(Throwable ex) {
203          if (ex != null)
204 <            _unsafe.throwException(ex);
204 >            UNSAFE.throwException(ex);
205      }
206  
207      // Setting completion status
208  
209      /**
210 <     * Mark completion and wake up threads waiting to join this task.
210 >     * Marks completion and wakes up threads waiting to join this task.
211 >     *
212       * @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
213       */
214      final void setCompletion(int completion) {
215          ForkJoinPool pool = getPool();
216          if (pool != null) {
217              int s; // Clear signal bits while setting completion status
218 <            do;while ((s = status) >= 0 && !casStatus(s, completion));
218 >            do {} while ((s = status) >= 0 && !casStatus(s, completion));
219  
220              if ((s & SIGNAL_MASK) != 0) {
221                  if ((s &= INTERNAL_SIGNAL_MASK) != 0)
222                      pool.updateRunningCount(s);
223 <                synchronized(this) { notifyAll(); }
223 >                synchronized (this) { notifyAll(); }
224              }
225          }
226          else
# Line 201 | Line 233 | public abstract class ForkJoinTask<V> im
233       */
234      private void externallySetCompletion(int completion) {
235          int s;
236 <        do;while ((s = status) >= 0 &&
237 <                  !casStatus(s, (s & SIGNAL_MASK) | completion));
238 <        synchronized(this) { notifyAll(); }
236 >        do {} while ((s = status) >= 0 &&
237 >                     !casStatus(s, (s & SIGNAL_MASK) | completion));
238 >        synchronized (this) { notifyAll(); }
239      }
240  
241      /**
242 <     * Sets status to indicate normal completion
242 >     * Sets status to indicate normal completion.
243       */
244      final void setNormalCompletion() {
245          // Try typical fast case -- single CAS, no signal, not already done.
246          // Manually expand casStatus to improve chances of inlining it
247 <        if (!_unsafe.compareAndSwapInt(this, statusOffset, 0, NORMAL))
247 >        if (!UNSAFE.compareAndSwapInt(this, statusOffset, 0, NORMAL))
248              setCompletion(NORMAL);
249      }
250  
251      // internal waiting and notification
252  
253      /**
254 <     * Performs the actual monitor wait for awaitDone
254 >     * Performs the actual monitor wait for awaitDone.
255       */
256      private void doAwaitDone() {
257          // Minimize lock bias and in/de-flation effects by maximizing
258          // chances of waiting inside sync
259          try {
260              while (status >= 0)
261 <                synchronized(this) { if (status >= 0) wait(); }
261 >                synchronized (this) { if (status >= 0) wait(); }
262          } catch (InterruptedException ie) {
263              onInterruptedWait();
264          }
265      }
266  
267      /**
268 <     * Performs the actual monitor wait for awaitDone
268 >     * Performs the actual timed monitor wait for awaitDone.
269       */
270      private void doAwaitDone(long startTime, long nanos) {
271 <        synchronized(this) {
271 >        synchronized (this) {
272              try {
273                  while (status >= 0) {
274 <                    long nt = nanos - System.nanoTime() - startTime;
274 >                    long nt = nanos - (System.nanoTime() - startTime);
275                      if (nt <= 0)
276                          break;
277 <                    wait(nt / 1000000, (int)(nt % 1000000));
277 >                    wait(nt / 1000000, (int) (nt % 1000000));
278                  }
279              } catch (InterruptedException ie) {
280                  onInterruptedWait();
# Line 255 | Line 287 | public abstract class ForkJoinTask<V> im
287      /**
288       * Sets status to indicate there is joiner, then waits for join,
289       * surrounded with pool notifications.
290 +     *
291       * @return status upon exit
292       */
293 <    private int awaitDone(ForkJoinWorkerThread w, boolean maintainParallelism) {
294 <        ForkJoinPool pool = w == null? null : w.pool;
293 >    private int awaitDone(ForkJoinWorkerThread w,
294 >                          boolean maintainParallelism) {
295 >        ForkJoinPool pool = (w == null) ? null : w.pool;
296          int s;
297          while ((s = status) >= 0) {
298 <            if (casStatus(s, pool == null? s|EXTERNAL_SIGNAL : s+1)) {
298 >            if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
299                  if (pool == null || !pool.preJoin(this, maintainParallelism))
300                      doAwaitDone();
301                  if (((s = status) & INTERNAL_SIGNAL_MASK) != 0)
# Line 274 | Line 308 | public abstract class ForkJoinTask<V> im
308  
309      /**
310       * Timed version of awaitDone
311 +     *
312       * @return status upon exit
313       */
314      private int awaitDone(ForkJoinWorkerThread w, long nanos) {
315 <        ForkJoinPool pool = w == null? null : w.pool;
315 >        ForkJoinPool pool = (w == null) ? null : w.pool;
316          int s;
317          while ((s = status) >= 0) {
318 <            if (casStatus(s, pool == null? s|EXTERNAL_SIGNAL : s+1)) {
318 >            if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
319                  long startTime = System.nanoTime();
320                  if (pool == null || !pool.preJoin(this, false))
321                      doAwaitDone(startTime, nanos);
# Line 297 | Line 332 | public abstract class ForkJoinTask<V> im
332      }
333  
334      /**
335 <     * Notify pool that thread is unblocked. Called by signalled
335 >     * Notifies pool that thread is unblocked. Called by signalled
336       * threads when woken by non-FJ threads (which is atypical).
337       */
338      private void adjustPoolCountsOnUnblock(ForkJoinPool pool) {
339          int s;
340 <        do;while ((s = status) < 0 && !casStatus(s, s & COMPLETION_MASK));
340 >        do {} while ((s = status) < 0 && !casStatus(s, s & COMPLETION_MASK));
341          if (pool != null && (s &= INTERNAL_SIGNAL_MASK) != 0)
342              pool.updateRunningCount(s);
343      }
344  
345      /**
346 <     * Notify pool to adjust counts on cancelled or timed out wait
346 >     * Notifies pool to adjust counts on cancelled or timed out wait.
347       */
348      private void adjustPoolCountsOnCancelledWait(ForkJoinPool pool) {
349          if (pool != null) {
# Line 323 | Line 358 | public abstract class ForkJoinTask<V> im
358      }
359  
360      /**
361 <     * Handle interruptions during waits.
361 >     * Handles interruptions during waits.
362       */
363      private void onInterruptedWait() {
364          ForkJoinWorkerThread w = getWorker();
# Line 342 | Line 377 | public abstract class ForkJoinTask<V> im
377      }
378  
379      /**
380 <     * Throws the exception associated with status s;
380 >     * Throws the exception associated with status s.
381 >     *
382       * @throws the exception
383       */
384      private void reportException(int s) {
# Line 355 | Line 391 | public abstract class ForkJoinTask<V> im
391      }
392  
393      /**
394 <     * Returns result or throws exception using j.u.c.Future conventions
395 <     * Only call when isDone known to be true.
394 >     * Returns result or throws exception using j.u.c.Future conventions.
395 >     * Only call when {@code isDone} known to be true or thread known
396 >     * to be interrupted.
397       */
398      private V reportFutureResult()
399 <        throws ExecutionException, InterruptedException {
399 >        throws InterruptedException, ExecutionException {
400 >        if (Thread.interrupted())
401 >            throw new InterruptedException();
402          int s = status & COMPLETION_MASK;
403          if (s < NORMAL) {
404              Throwable ex;
# Line 367 | Line 406 | public abstract class ForkJoinTask<V> im
406                  throw new CancellationException();
407              if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
408                  throw new ExecutionException(ex);
370            if (Thread.interrupted())
371                throw new InterruptedException();
409          }
410          return getRawResult();
411      }
412  
413      /**
414       * Returns result or throws exception using j.u.c.Future conventions
415 <     * with timeouts
415 >     * with timeouts.
416       */
417      private V reportTimedFutureResult()
418          throws InterruptedException, ExecutionException, TimeoutException {
419 +        if (Thread.interrupted())
420 +            throw new InterruptedException();
421          Throwable ex;
422          int s = status & COMPLETION_MASK;
423          if (s == NORMAL)
424              return getRawResult();
425 <        if (s == CANCELLED)
425 >        else if (s == CANCELLED)
426              throw new CancellationException();
427 <        if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
427 >        else if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
428              throw new ExecutionException(ex);
429 <        if (Thread.interrupted())
430 <            throw new InterruptedException();
392 <        throw new TimeoutException();
429 >        else
430 >            throw new TimeoutException();
431      }
432  
433      // internal execution methods
434  
435      /**
436       * Calls exec, recording completion, and rethrowing exception if
437 <     * encountered. Caller should normally check status before calling
437 >     * encountered. Caller should normally check status before calling.
438 >     *
439       * @return true if completed normally
440       */
441      private boolean tryExec() {
# Line 414 | Line 453 | public abstract class ForkJoinTask<V> im
453  
454      /**
455       * Main execution method used by worker threads. Invokes
456 <     * base computation unless already complete
456 >     * base computation unless already complete.
457       */
458      final void quietlyExec() {
459          if (status >= 0) {
460              try {
461                  if (!exec())
462                      return;
463 <            } catch(Throwable rex) {
463 >            } catch (Throwable rex) {
464                  setDoneExceptionally(rex);
465                  return;
466              }
# Line 430 | Line 469 | public abstract class ForkJoinTask<V> im
469      }
470  
471      /**
472 <     * Calls exec, recording but not rethrowing exception
473 <     * Caller should normally check status before calling
472 >     * Calls exec(), recording but not rethrowing exception.
473 >     * Caller should normally check status before calling.
474 >     *
475       * @return true if completed normally
476       */
477      private boolean tryQuietlyInvoke() {
# Line 447 | Line 487 | public abstract class ForkJoinTask<V> im
487      }
488  
489      /**
490 <     * Cancel, ignoring any exceptions it throws
490 >     * Cancels, ignoring any exceptions it throws.
491       */
492      final void cancelIgnoringExceptions() {
493          try {
494              cancel(false);
495 <        } catch(Throwable ignore) {
495 >        } catch (Throwable ignore) {
496          }
497      }
498  
# Line 464 | Line 504 | public abstract class ForkJoinTask<V> im
504          ForkJoinTask<?> t;
505          while ((s = status) >= 0 && (t = w.scanWhileJoining(this)) != null)
506              t.quietlyExec();
507 <        return (s >= 0)? awaitDone(w, false) : s; // block if no work
507 >        return (s >= 0) ? awaitDone(w, false) : s; // block if no work
508      }
509  
510      // public methods
# Line 472 | Line 512 | public abstract class ForkJoinTask<V> im
512      /**
513       * Arranges to asynchronously execute this task.  While it is not
514       * necessarily enforced, it is a usage error to fork a task more
515 <     * than once unless it has completed and been reinitialized.  This
516 <     * method may be invoked only from within ForkJoinTask
517 <     * computations. Attempts to invoke in other contexts result in
518 <     * exceptions or errors possibly including ClassCastException.
515 >     * than once unless it has completed and been reinitialized.
516 >     *
517 >     * <p>This method may be invoked only from within {@code
518 >     * ForkJoinTask} computations (as may be determined using method
519 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
520 >     * result in exceptions or errors, possibly including {@code
521 >     * ClassCastException}.
522 >     *
523 >     * @return {@code this}, to simplify usage
524       */
525 <    public final void fork() {
526 <        ((ForkJoinWorkerThread)(Thread.currentThread())).pushTask(this);
525 >    public final ForkJoinTask<V> fork() {
526 >        ((ForkJoinWorkerThread) Thread.currentThread())
527 >            .pushTask(this);
528 >        return this;
529      }
530  
531      /**
532       * Returns the result of the computation when it is ready.
533 <     * This method differs from {@code get} in that abnormal
534 <     * completion results in RuntimeExceptions or Errors, not
535 <     * ExecutionExceptions.
533 >     * This method differs from {@link #get()} in that
534 >     * abnormal completion results in {@code RuntimeException} or
535 >     * {@code Error}, not {@code ExecutionException}.
536       *
537       * @return the computed result
538       */
# Line 498 | Line 545 | public abstract class ForkJoinTask<V> im
545  
546      /**
547       * Commences performing this task, awaits its completion if
548 <     * necessary, and return its result.
549 <     * @throws Throwable (a RuntimeException, Error, or unchecked
550 <     * exception) if the underlying computation did so.
548 >     * necessary, and return its result, or throws an (unchecked)
549 >     * exception if the underlying computation did so.
550 >     *
551       * @return the computed result
552       */
553      public final V invoke() {
# Line 511 | Line 558 | public abstract class ForkJoinTask<V> im
558      }
559  
560      /**
561 <     * Forks both tasks, returning when {@code isDone} holds for
562 <     * both of them or an exception is encountered. This method may be
563 <     * invoked only from within ForkJoinTask computations. Attempts to
564 <     * invoke in other contexts result in exceptions or errors
565 <     * possibly including ClassCastException.
566 <     * @param t1 one task
567 <     * @param t2 the other task
568 <     * @throws NullPointerException if t1 or t2 are null
569 <     * @throws RuntimeException or Error if either task did so.
561 >     * Forks the given tasks, returning when {@code isDone} holds for
562 >     * each task or an (unchecked) exception is encountered, in which
563 >     * case the exception is rethrown.  If either task encounters an
564 >     * exception, the other one may be, but is not guaranteed to be,
565 >     * cancelled.  If both tasks throw an exception, then this method
566 >     * throws one of them.  The individual status of each task may be
567 >     * checked using {@link #getException()} and related methods.
568 >     *
569 >     * <p>This method may be invoked only from within {@code
570 >     * ForkJoinTask} computations (as may be determined using method
571 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
572 >     * result in exceptions or errors, possibly including {@code
573 >     * ClassCastException}.
574 >     *
575 >     * @param t1 the first task
576 >     * @param t2 the second task
577 >     * @throws NullPointerException if any task is null
578       */
579 <    public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) {
579 >    public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
580          t2.fork();
581          t1.invoke();
582          t2.join();
583      }
584  
585      /**
586 <     * Forks the given tasks, returning when {@code isDone} holds
587 <     * for all of them. If any task encounters an exception, others
588 <     * may be cancelled.  This method may be invoked only from within
589 <     * ForkJoinTask computations. Attempts to invoke in other contexts
590 <     * result in exceptions or errors possibly including ClassCastException.
591 <     * @param tasks the array of tasks
592 <     * @throws NullPointerException if tasks or any element are null.
593 <     * @throws RuntimeException or Error if any task did so.
586 >     * Forks the given tasks, returning when {@code isDone} holds for
587 >     * each task or an (unchecked) exception is encountered, in which
588 >     * case the exception is rethrown. If any task encounters an
589 >     * exception, others may be, but are not guaranteed to be,
590 >     * cancelled.  If more than one task encounters an exception, then
591 >     * this method throws any one of these exceptions.  The individual
592 >     * status of each task may be checked using {@link #getException()}
593 >     * and related methods.
594 >     *
595 >     * <p>This method may be invoked only from within {@code
596 >     * ForkJoinTask} computations (as may be determined using method
597 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
598 >     * result in exceptions or errors, possibly including {@code
599 >     * ClassCastException}.
600 >     *
601 >     * @param tasks the tasks
602 >     * @throws NullPointerException if any task is null
603       */
604      public static void invokeAll(ForkJoinTask<?>... tasks) {
605          Throwable ex = null;
# Line 571 | Line 635 | public abstract class ForkJoinTask<V> im
635      }
636  
637      /**
638 <     * Forks all tasks in the collection, returning when
639 <     * {@code isDone} holds for all of them. If any task
640 <     * encounters an exception, others may be cancelled.  This method
641 <     * may be invoked only from within ForkJoinTask
642 <     * computations. Attempts to invoke in other contexts result in
643 <     * exceptions or errors possibly including ClassCastException.
638 >     * Forks all tasks in the specified collection, returning when
639 >     * {@code isDone} holds for each task or an (unchecked) exception
640 >     * is encountered.  If any task encounters an exception, others
641 >     * may be, but are not guaranteed to be, cancelled.  If more than
642 >     * one task encounters an exception, then this method throws any
643 >     * one of these exceptions.  The individual status of each task
644 >     * may be checked using {@link #getException()} and related
645 >     * methods.  The behavior of this operation is undefined if the
646 >     * specified collection is modified while the operation is in
647 >     * progress.
648 >     *
649 >     * <p>This method may be invoked only from within {@code
650 >     * ForkJoinTask} computations (as may be determined using method
651 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
652 >     * result in exceptions or errors, possibly including {@code
653 >     * ClassCastException}.
654 >     *
655       * @param tasks the collection of tasks
656 <     * @throws NullPointerException if tasks or any element are null.
657 <     * @throws RuntimeException or Error if any task did so.
656 >     * @return the tasks argument, to simplify usage
657 >     * @throws NullPointerException if tasks or any element are null
658       */
659 <    public static void invokeAll(Collection<? extends ForkJoinTask<?>> tasks) {
660 <        if (!(tasks instanceof List)) {
661 <            invokeAll(tasks.toArray(new ForkJoinTask[tasks.size()]));
662 <            return;
659 >    public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) {
660 >        if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) {
661 >            invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
662 >            return tasks;
663          }
664 +        @SuppressWarnings("unchecked")
665          List<? extends ForkJoinTask<?>> ts =
666 <            (List<? extends ForkJoinTask<?>>)tasks;
666 >            (List<? extends ForkJoinTask<?>>) tasks;
667          Throwable ex = null;
668          int last = ts.size() - 1;
669          for (int i = last; i >= 0; --i) {
# Line 618 | Line 694 | public abstract class ForkJoinTask<V> im
694          }
695          if (ex != null)
696              rethrowException(ex);
697 +        return tasks;
698      }
699  
700      /**
701 <     * Returns true if the computation performed by this task has
702 <     * completed (or has been cancelled).
703 <     * @return true if this computation has completed
704 <     */
705 <    public final boolean isDone() {
706 <        return status < 0;
707 <    }
631 <
632 <    /**
633 <     * Returns true if this task was cancelled.
634 <     * @return true if this task was cancelled
635 <     */
636 <    public final boolean isCancelled() {
637 <        return (status & COMPLETION_MASK) == CANCELLED;
638 <    }
639 <
640 <    /**
641 <     * Asserts that the results of this task's computation will not be
642 <     * used. If a cancellation occurs before attempting to execute this
643 <     * task, then execution will be suppressed, {@code isCancelled}
644 <     * will report true, and {@code join} will result in a
645 <     * {@code CancellationException} being thrown. Otherwise, when
646 <     * cancellation races with completion, there are no guarantees
647 <     * about whether {@code isCancelled} will report true, whether
648 <     * {@code join} will return normally or via an exception, or
649 <     * whether these behaviors will remain consistent upon repeated
650 <     * invocation.
701 >     * Attempts to cancel execution of this task. This attempt will
702 >     * fail if the task has already completed, has already been
703 >     * cancelled, or could not be cancelled for some other reason. If
704 >     * successful, and this task has not started when cancel is
705 >     * called, execution of this task is suppressed, {@link
706 >     * #isCancelled} will report true, and {@link #join} will result
707 >     * in a {@code CancellationException} being thrown.
708       *
709       * <p>This method may be overridden in subclasses, but if so, must
710       * still ensure that these minimal properties hold. In particular,
711 <     * the cancel method itself must not throw exceptions.
711 >     * the {@code cancel} method itself must not throw exceptions.
712       *
713 <     * <p> This method is designed to be invoked by <em>other</em>
713 >     * <p>This method is designed to be invoked by <em>other</em>
714       * tasks. To terminate the current task, you can just return or
715       * throw an unchecked exception from its computation method, or
716 <     * invoke {@code completeExceptionally}.
716 >     * invoke {@link #completeExceptionally}.
717       *
718       * @param mayInterruptIfRunning this value is ignored in the
719 <     * default implementation because tasks are not in general
720 <     * cancelled via interruption.
719 >     * default implementation because tasks are not
720 >     * cancelled via interruption
721       *
722 <     * @return true if this task is now cancelled
722 >     * @return {@code true} if this task is now cancelled
723       */
724      public boolean cancel(boolean mayInterruptIfRunning) {
725          setCompletion(CANCELLED);
726          return (status & COMPLETION_MASK) == CANCELLED;
727      }
728  
729 +    public final boolean isDone() {
730 +        return status < 0;
731 +    }
732 +
733 +    public final boolean isCancelled() {
734 +        return (status & COMPLETION_MASK) == CANCELLED;
735 +    }
736 +
737      /**
738 <     * Returns true if this task threw an exception or was cancelled
739 <     * @return true if this task threw an exception or was cancelled
738 >     * Returns {@code true} if this task threw an exception or was cancelled.
739 >     *
740 >     * @return {@code true} if this task threw an exception or was cancelled
741       */
742      public final boolean isCompletedAbnormally() {
743          return (status & COMPLETION_MASK) < NORMAL;
744      }
745  
746      /**
747 +     * Returns {@code true} if this task completed without throwing an
748 +     * exception and was not cancelled.
749 +     *
750 +     * @return {@code true} if this task completed without throwing an
751 +     * exception and was not cancelled
752 +     */
753 +    public final boolean isCompletedNormally() {
754 +        return (status & COMPLETION_MASK) == NORMAL;
755 +    }
756 +
757 +    /**
758 +     * Returns {@code true} if this task threw an exception.
759 +     *
760 +     * @return {@code true} if this task threw an exception
761 +     */
762 +    public final boolean isCompletedExceptionally() {
763 +        return (status & COMPLETION_MASK) == EXCEPTIONAL;
764 +    }
765 +
766 +    /**
767       * Returns the exception thrown by the base computation, or a
768 <     * CancellationException if cancelled, or null if none or if the
769 <     * method has not yet completed.
770 <     * @return the exception, or null if none
768 >     * {@code CancellationException} if cancelled, or {@code null} if
769 >     * none or if the method has not yet completed.
770 >     *
771 >     * @return the exception, or {@code null} if none
772       */
773      public final Throwable getException() {
774          int s = status & COMPLETION_MASK;
775 <        if (s >= NORMAL)
776 <            return null;
777 <        if (s == CANCELLED)
691 <            return new CancellationException();
692 <        return exceptionMap.get(this);
775 >        return ((s >= NORMAL)    ? null :
776 >                (s == CANCELLED) ? new CancellationException() :
777 >                exceptionMap.get(this));
778      }
779  
780      /**
# Line 698 | Line 783 | public abstract class ForkJoinTask<V> im
783       * {@code join} and related operations. This method may be used
784       * to induce exceptions in asynchronous tasks, or to force
785       * completion of tasks that would not otherwise complete.  Its use
786 <     * in other situations is likely to be wrong.  This method is
786 >     * in other situations is discouraged.  This method is
787       * overridable, but overridden versions must invoke {@code super}
788       * implementation to maintain guarantees.
789       *
# Line 708 | Line 793 | public abstract class ForkJoinTask<V> im
793       */
794      public void completeExceptionally(Throwable ex) {
795          setDoneExceptionally((ex instanceof RuntimeException) ||
796 <                             (ex instanceof Error)? ex :
796 >                             (ex instanceof Error) ? ex :
797                               new RuntimeException(ex));
798      }
799  
# Line 718 | Line 803 | public abstract class ForkJoinTask<V> im
803       * operations. This method may be used to provide results for
804       * asynchronous tasks, or to provide alternative handling for
805       * tasks that would not otherwise complete normally. Its use in
806 <     * other situations is likely to be wrong. This method is
806 >     * other situations is discouraged. This method is
807       * overridable, but overridden versions must invoke {@code super}
808       * implementation to maintain guarantees.
809       *
810 <     * @param value the result value for this task.
810 >     * @param value the result value for this task
811       */
812      public void complete(V value) {
813          try {
814              setRawResult(value);
815 <        } catch(Throwable rex) {
815 >        } catch (Throwable rex) {
816              setDoneExceptionally(rex);
817              return;
818          }
# Line 743 | Line 828 | public abstract class ForkJoinTask<V> im
828  
829      public final V get(long timeout, TimeUnit unit)
830          throws InterruptedException, ExecutionException, TimeoutException {
831 +        long nanos = unit.toNanos(timeout);
832          ForkJoinWorkerThread w = getWorker();
833          if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
834 <            awaitDone(w, unit.toNanos(timeout));
834 >            awaitDone(w, nanos);
835          return reportTimedFutureResult();
836      }
837  
# Line 756 | Line 842 | public abstract class ForkJoinTask<V> im
842       * there are no potential dependencies between continuation of the
843       * current task and that of any other task that might be executed
844       * while helping. (This usually holds for pure divide-and-conquer
845 <     * tasks). This method may be invoked only from within
846 <     * ForkJoinTask computations. Attempts to invoke in other contexts
847 <     * result in exceptions or errors possibly including ClassCastException.
845 >     * tasks).
846 >     *
847 >     * <p>This method may be invoked only from within {@code
848 >     * ForkJoinTask} computations (as may be determined using method
849 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
850 >     * result in exceptions or errors, possibly including {@code
851 >     * ClassCastException}.
852 >     *
853       * @return the computed result
854       */
855      public final V helpJoin() {
856 <        ForkJoinWorkerThread w = (ForkJoinWorkerThread)(Thread.currentThread());
856 >        ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
857          if (status < 0 || !w.unpushTask(this) || !tryExec())
858              reportException(busyJoin(w));
859          return getRawResult();
# Line 770 | Line 861 | public abstract class ForkJoinTask<V> im
861  
862      /**
863       * Possibly executes other tasks until this task is ready.  This
864 <     * method may be invoked only from within ForkJoinTask
865 <     * computations. Attempts to invoke in other contexts result in
866 <     * exceptions or errors possibly including ClassCastException.
864 >     * method may be useful when processing collections of tasks when
865 >     * some have been cancelled or otherwise known to have aborted.
866 >     *
867 >     * <p>This method may be invoked only from within {@code
868 >     * ForkJoinTask} computations (as may be determined using method
869 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
870 >     * result in exceptions or errors, possibly including {@code
871 >     * ClassCastException}.
872       */
873      public final void quietlyHelpJoin() {
874          if (status >= 0) {
875              ForkJoinWorkerThread w =
876 <                (ForkJoinWorkerThread)(Thread.currentThread());
876 >                (ForkJoinWorkerThread) Thread.currentThread();
877              if (!w.unpushTask(this) || !tryQuietlyInvoke())
878                  busyJoin(w);
879          }
# Line 811 | Line 907 | public abstract class ForkJoinTask<V> im
907  
908      /**
909       * Possibly executes tasks until the pool hosting the current task
910 <     * {@link ForkJoinPool#isQuiescent}. This method may be of use in
911 <     * designs in which many tasks are forked, but none are explicitly
912 <     * joined, instead executing them until all are processed.
910 >     * {@link ForkJoinPool#isQuiescent is quiescent}. This method may
911 >     * be of use in designs in which many tasks are forked, but none
912 >     * are explicitly joined, instead executing them until all are
913 >     * processed.
914 >     *
915 >     * <p>This method may be invoked only from within {@code
916 >     * ForkJoinTask} computations (as may be determined using method
917 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
918 >     * result in exceptions or errors, possibly including {@code
919 >     * ClassCastException}.
920       */
921      public static void helpQuiesce() {
922 <        ((ForkJoinWorkerThread)(Thread.currentThread())).
923 <            helpQuiescePool();
922 >        ((ForkJoinWorkerThread) Thread.currentThread())
923 >            .helpQuiescePool();
924      }
925  
926      /**
# Line 826 | Line 929 | public abstract class ForkJoinTask<V> im
929       * this task, but only if reuse occurs when this task has either
930       * never been forked, or has been forked, then completed and all
931       * outstanding joins of this task have also completed. Effects
932 <     * under any other usage conditions are not guaranteed, and are
933 <     * almost surely wrong. This method may be useful when executing
932 >     * under any other usage conditions are not guaranteed.
933 >     * This method may be useful when executing
934       * pre-constructed trees of subtasks in loops.
935       */
936      public void reinitialize() {
# Line 838 | Line 941 | public abstract class ForkJoinTask<V> im
941  
942      /**
943       * Returns the pool hosting the current task execution, or null
944 <     * if this task is executing outside of any pool.
945 <     * @return the pool, or null if none.
944 >     * if this task is executing outside of any ForkJoinPool.
945 >     *
946 >     * @see #inForkJoinPool
947 >     * @return the pool, or {@code null} if none
948       */
949      public static ForkJoinPool getPool() {
950          Thread t = Thread.currentThread();
951 <        return ((t instanceof ForkJoinWorkerThread)?
952 <                ((ForkJoinWorkerThread)t).pool : null);
951 >        return (t instanceof ForkJoinWorkerThread) ?
952 >            ((ForkJoinWorkerThread) t).pool : null;
953 >    }
954 >
955 >    /**
956 >     * Returns {@code true} if the current thread is executing as a
957 >     * ForkJoinPool computation.
958 >     *
959 >     * @return {@code true} if the current thread is executing as a
960 >     * ForkJoinPool computation, or false otherwise
961 >     */
962 >    public static boolean inForkJoinPool() {
963 >        return Thread.currentThread() instanceof ForkJoinWorkerThread;
964      }
965  
966      /**
# Line 853 | Line 969 | public abstract class ForkJoinTask<V> im
969       * by the current thread, and has not commenced executing in
970       * another thread.  This method may be useful when arranging
971       * alternative local processing of tasks that could have been, but
972 <     * were not, stolen. This method may be invoked only from within
973 <     * ForkJoinTask computations. Attempts to invoke in other contexts
974 <     * result in exceptions or errors possibly including ClassCastException.
975 <     * @return true if unforked
972 >     * were not, stolen.
973 >     *
974 >     * <p>This method may be invoked only from within {@code
975 >     * ForkJoinTask} computations (as may be determined using method
976 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
977 >     * result in exceptions or errors, possibly including {@code
978 >     * ClassCastException}.
979 >     *
980 >     * @return {@code true} if unforked
981       */
982      public boolean tryUnfork() {
983 <        return ((ForkJoinWorkerThread)(Thread.currentThread())).unpushTask(this);
983 >        return ((ForkJoinWorkerThread) Thread.currentThread())
984 >            .unpushTask(this);
985      }
986  
987      /**
# Line 867 | Line 989 | public abstract class ForkJoinTask<V> im
989       * forked by the current worker thread but not yet executed. This
990       * value may be useful for heuristic decisions about whether to
991       * fork other tasks.
992 +     *
993 +     * <p>This method may be invoked only from within {@code
994 +     * ForkJoinTask} computations (as may be determined using method
995 +     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
996 +     * result in exceptions or errors, possibly including {@code
997 +     * ClassCastException}.
998 +     *
999       * @return the number of tasks
1000       */
1001      public static int getQueuedTaskCount() {
1002 <        return ((ForkJoinWorkerThread)(Thread.currentThread())).
1003 <            getQueueSize();
1002 >        return ((ForkJoinWorkerThread) Thread.currentThread())
1003 >            .getQueueSize();
1004      }
1005  
1006      /**
1007 <     * Returns a estimate of how many more locally queued tasks are
1007 >     * Returns an estimate of how many more locally queued tasks are
1008       * held by the current worker thread than there are other worker
1009       * threads that might steal them.  This value may be useful for
1010       * heuristic decisions about whether to fork other tasks. In many
# Line 883 | Line 1012 | public abstract class ForkJoinTask<V> im
1012       * aim to maintain a small constant surplus (for example, 3) of
1013       * tasks, and to process computations locally if this threshold is
1014       * exceeded.
1015 +     *
1016 +     * <p>This method may be invoked only from within {@code
1017 +     * ForkJoinTask} computations (as may be determined using method
1018 +     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1019 +     * result in exceptions or errors, possibly including {@code
1020 +     * ClassCastException}.
1021 +     *
1022       * @return the surplus number of tasks, which may be negative
1023       */
1024      public static int getSurplusQueuedTaskCount() {
1025 <        return ((ForkJoinWorkerThread)(Thread.currentThread()))
1025 >        return ((ForkJoinWorkerThread) Thread.currentThread())
1026              .getEstimatedSurplusTaskCount();
1027      }
1028  
1029      // Extension methods
1030  
1031      /**
1032 <     * Returns the result that would be returned by {@code join},
1033 <     * even if this task completed abnormally, or null if this task is
1034 <     * not known to have been completed.  This method is designed to
1035 <     * aid debugging, as well as to support extensions. Its use in any
1036 <     * other context is discouraged.
1032 >     * Returns the result that would be returned by {@link #join}, even
1033 >     * if this task completed abnormally, or {@code null} if this task
1034 >     * is not known to have been completed.  This method is designed
1035 >     * to aid debugging, as well as to support extensions. Its use in
1036 >     * any other context is discouraged.
1037       *
1038 <     * @return the result, or null if not completed.
1038 >     * @return the result, or {@code null} if not completed
1039       */
1040      public abstract V getRawResult();
1041  
# Line 918 | Line 1054 | public abstract class ForkJoinTask<V> im
1054       * called otherwise. The return value controls whether this task
1055       * is considered to be done normally. It may return false in
1056       * asynchronous actions that require explicit invocations of
1057 <     * {@code complete} to become joinable. It may throw exceptions
1058 <     * to indicate abnormal exit.
1059 <     * @return true if completed normally
1060 <     * @throws Error or RuntimeException if encountered during computation
1057 >     * {@link #complete} to become joinable. It may also throw an
1058 >     * (unchecked) exception to indicate abnormal exit.
1059 >     *
1060 >     * @return {@code true} if completed normally
1061       */
1062      protected abstract boolean exec();
1063  
1064      /**
1065 <     * Returns, but does not unschedule or execute, the task queued by
1066 <     * the current thread but not yet executed, if one is
1065 >     * Returns, but does not unschedule or execute, a task queued by
1066 >     * the current thread but not yet executed, if one is immediately
1067       * available. There is no guarantee that this task will actually
1068 <     * be polled or executed next.  This method is designed primarily
1069 <     * to support extensions, and is unlikely to be useful otherwise.
1070 <     * This method may be invoked only from within ForkJoinTask
1071 <     * computations. Attempts to invoke in other contexts result in
1072 <     * exceptions or errors possibly including ClassCastException.
1068 >     * be polled or executed next. Conversely, this method may return
1069 >     * null even if a task exists but cannot be accessed without
1070 >     * contention with other threads.  This method is designed
1071 >     * primarily to support extensions, and is unlikely to be useful
1072 >     * otherwise.
1073 >     *
1074 >     * <p>This method may be invoked only from within {@code
1075 >     * ForkJoinTask} computations (as may be determined using method
1076 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1077 >     * result in exceptions or errors, possibly including {@code
1078 >     * ClassCastException}.
1079       *
1080 <     * @return the next task, or null if none are available
1080 >     * @return the next task, or {@code null} if none are available
1081       */
1082      protected static ForkJoinTask<?> peekNextLocalTask() {
1083 <        return ((ForkJoinWorkerThread)(Thread.currentThread())).peekTask();
1083 >        return ((ForkJoinWorkerThread) Thread.currentThread())
1084 >            .peekTask();
1085      }
1086  
1087      /**
1088       * Unschedules and returns, without executing, the next task
1089       * queued by the current thread but not yet executed.  This method
1090       * is designed primarily to support extensions, and is unlikely to
1091 <     * be useful otherwise.  This method may be invoked only from
949 <     * within ForkJoinTask computations. Attempts to invoke in other
950 <     * contexts result in exceptions or errors possibly including
951 <     * ClassCastException.
1091 >     * be useful otherwise.
1092       *
1093 <     * @return the next task, or null if none are available
1093 >     * <p>This method may be invoked only from within {@code
1094 >     * ForkJoinTask} computations (as may be determined using method
1095 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1096 >     * result in exceptions or errors, possibly including {@code
1097 >     * ClassCastException}.
1098 >     *
1099 >     * @return the next task, or {@code null} if none are available
1100       */
1101      protected static ForkJoinTask<?> pollNextLocalTask() {
1102 <        return ((ForkJoinWorkerThread)(Thread.currentThread())).pollLocalTask();
1102 >        return ((ForkJoinWorkerThread) Thread.currentThread())
1103 >            .pollLocalTask();
1104      }
1105  
1106      /**
# Line 964 | Line 1111 | public abstract class ForkJoinTask<V> im
1111       * {@code null} result does not necessarily imply quiescence
1112       * of the pool this task is operating in.  This method is designed
1113       * primarily to support extensions, and is unlikely to be useful
1114 <     * otherwise.  This method may be invoked only from within
1115 <     * ForkJoinTask computations. Attempts to invoke in other contexts
1116 <     * result in exceptions or errors possibly including
1117 <     * ClassCastException.
1114 >     * otherwise.
1115 >     *
1116 >     * <p>This method may be invoked only from within {@code
1117 >     * ForkJoinTask} computations (as may be determined using method
1118 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1119 >     * result in exceptions or errors, possibly including {@code
1120 >     * ClassCastException}.
1121       *
1122 <     * @return a task, or null if none are available
1122 >     * @return a task, or {@code null} if none are available
1123       */
1124      protected static ForkJoinTask<?> pollTask() {
1125 <        return ((ForkJoinWorkerThread)(Thread.currentThread())).
1126 <            pollTask();
1125 >        return ((ForkJoinWorkerThread) Thread.currentThread())
1126 >            .pollTask();
1127 >    }
1128 >
1129 >    /**
1130 >     * Adaptor for Runnables. This implements RunnableFuture
1131 >     * to be compliant with AbstractExecutorService constraints
1132 >     * when used in ForkJoinPool.
1133 >     */
1134 >    static final class AdaptedRunnable<T> extends ForkJoinTask<T>
1135 >        implements RunnableFuture<T> {
1136 >        final Runnable runnable;
1137 >        final T resultOnCompletion;
1138 >        T result;
1139 >        AdaptedRunnable(Runnable runnable, T result) {
1140 >            if (runnable == null) throw new NullPointerException();
1141 >            this.runnable = runnable;
1142 >            this.resultOnCompletion = result;
1143 >        }
1144 >        public T getRawResult() { return result; }
1145 >        public void setRawResult(T v) { result = v; }
1146 >        public boolean exec() {
1147 >            runnable.run();
1148 >            result = resultOnCompletion;
1149 >            return true;
1150 >        }
1151 >        public void run() { invoke(); }
1152 >        private static final long serialVersionUID = 5232453952276885070L;
1153 >    }
1154 >
1155 >    /**
1156 >     * Adaptor for Callables
1157 >     */
1158 >    static final class AdaptedCallable<T> extends ForkJoinTask<T>
1159 >        implements RunnableFuture<T> {
1160 >        final Callable<? extends T> callable;
1161 >        T result;
1162 >        AdaptedCallable(Callable<? extends T> callable) {
1163 >            if (callable == null) throw new NullPointerException();
1164 >            this.callable = callable;
1165 >        }
1166 >        public T getRawResult() { return result; }
1167 >        public void setRawResult(T v) { result = v; }
1168 >        public boolean exec() {
1169 >            try {
1170 >                result = callable.call();
1171 >                return true;
1172 >            } catch (Error err) {
1173 >                throw err;
1174 >            } catch (RuntimeException rex) {
1175 >                throw rex;
1176 >            } catch (Exception ex) {
1177 >                throw new RuntimeException(ex);
1178 >            }
1179 >        }
1180 >        public void run() { invoke(); }
1181 >        private static final long serialVersionUID = 2838392045355241008L;
1182 >    }
1183 >
1184 >    /**
1185 >     * Returns a new {@code ForkJoinTask} that performs the {@code run}
1186 >     * method of the given {@code Runnable} as its action, and returns
1187 >     * a null result upon {@link #join}.
1188 >     *
1189 >     * @param runnable the runnable action
1190 >     * @return the task
1191 >     */
1192 >    public static ForkJoinTask<?> adapt(Runnable runnable) {
1193 >        return new AdaptedRunnable<Void>(runnable, null);
1194 >    }
1195 >
1196 >    /**
1197 >     * Returns a new {@code ForkJoinTask} that performs the {@code run}
1198 >     * method of the given {@code Runnable} as its action, and returns
1199 >     * the given result upon {@link #join}.
1200 >     *
1201 >     * @param runnable the runnable action
1202 >     * @param result the result upon completion
1203 >     * @return the task
1204 >     */
1205 >    public static <T> ForkJoinTask<T> adapt(Runnable runnable, T result) {
1206 >        return new AdaptedRunnable<T>(runnable, result);
1207 >    }
1208 >
1209 >    /**
1210 >     * Returns a new {@code ForkJoinTask} that performs the {@code call}
1211 >     * method of the given {@code Callable} as its action, and returns
1212 >     * its result upon {@link #join}, translating any checked exceptions
1213 >     * encountered into {@code RuntimeException}.
1214 >     *
1215 >     * @param callable the callable action
1216 >     * @return the task
1217 >     */
1218 >    public static <T> ForkJoinTask<T> adapt(Callable<? extends T> callable) {
1219 >        return new AdaptedCallable<T>(callable);
1220      }
1221  
1222      // Serialization support
# Line 984 | Line 1227 | public abstract class ForkJoinTask<V> im
1227       * Save the state to a stream.
1228       *
1229       * @serialData the current run status and the exception thrown
1230 <     * during execution, or null if none.
1230 >     * during execution, or {@code null} if none
1231       * @param s the stream
1232       */
1233      private void writeObject(java.io.ObjectOutputStream s)
# Line 995 | Line 1238 | public abstract class ForkJoinTask<V> im
1238  
1239      /**
1240       * Reconstitute the instance from a stream.
1241 +     *
1242       * @param s the stream
1243       */
1244      private void readObject(java.io.ObjectInputStream s)
# Line 1004 | Line 1248 | public abstract class ForkJoinTask<V> im
1248          status |= EXTERNAL_SIGNAL; // conservatively set external signal
1249          Object ex = s.readObject();
1250          if (ex != null)
1251 <            setDoneExceptionally((Throwable)ex);
1251 >            setDoneExceptionally((Throwable) ex);
1252 >    }
1253 >
1254 >    // Unsafe mechanics
1255 >
1256 >    private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1257 >    private static final long statusOffset =
1258 >        objectFieldOffset("status", ForkJoinTask.class);
1259 >
1260 >    private static long objectFieldOffset(String field, Class<?> klazz) {
1261 >        try {
1262 >            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1263 >        } catch (NoSuchFieldException e) {
1264 >            // Convert Exception to corresponding Error
1265 >            NoSuchFieldError error = new NoSuchFieldError(field);
1266 >            error.initCause(e);
1267 >            throw error;
1268 >        }
1269      }
1270  
1271 <    // Temporary Unsafe mechanics for preliminary release
1272 <    private static Unsafe getUnsafe() throws Throwable {
1271 >    /**
1272 >     * Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
1273 >     * Replace with a simple call to Unsafe.getUnsafe when integrating
1274 >     * into a jdk.
1275 >     *
1276 >     * @return a sun.misc.Unsafe
1277 >     */
1278 >    private static sun.misc.Unsafe getUnsafe() {
1279          try {
1280 <            return Unsafe.getUnsafe();
1280 >            return sun.misc.Unsafe.getUnsafe();
1281          } catch (SecurityException se) {
1282              try {
1283                  return java.security.AccessController.doPrivileged
1284 <                    (new java.security.PrivilegedExceptionAction<Unsafe>() {
1285 <                        public Unsafe run() throws Exception {
1286 <                            return getUnsafePrivileged();
1284 >                    (new java.security
1285 >                     .PrivilegedExceptionAction<sun.misc.Unsafe>() {
1286 >                        public sun.misc.Unsafe run() throws Exception {
1287 >                            java.lang.reflect.Field f = sun.misc
1288 >                                .Unsafe.class.getDeclaredField("theUnsafe");
1289 >                            f.setAccessible(true);
1290 >                            return (sun.misc.Unsafe) f.get(null);
1291                          }});
1292              } catch (java.security.PrivilegedActionException e) {
1293 <                throw e.getCause();
1293 >                throw new RuntimeException("Could not initialize intrinsics",
1294 >                                           e.getCause());
1295              }
1296          }
1297      }
1026
1027    private static Unsafe getUnsafePrivileged()
1028            throws NoSuchFieldException, IllegalAccessException {
1029        Field f = Unsafe.class.getDeclaredField("theUnsafe");
1030        f.setAccessible(true);
1031        return (Unsafe) f.get(null);
1032    }
1033
1034    private static long fieldOffset(String fieldName)
1035            throws NoSuchFieldException {
1036        return _unsafe.objectFieldOffset
1037            (ForkJoinTask.class.getDeclaredField(fieldName));
1038    }
1039
1040    static final Unsafe _unsafe;
1041    static final long statusOffset;
1042
1043    static {
1044        try {
1045            _unsafe = getUnsafe();
1046            statusOffset = fieldOffset("status");
1047        } catch (Throwable e) {
1048            throw new RuntimeException("Could not initialize intrinsics", e);
1049        }
1050    }
1051
1298   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines