ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/concurrent/ForkJoinTask.java
Revision: 1.89
Committed: Fri Jul 11 16:10:38 2014 UTC (9 years, 10 months ago) by dl
Branch: MAIN
Changes since 1.88: +8 -4 lines
Log Message:
Exception compatibility

File Contents

# User Rev Content
1 jsr166 1.1 /*
2     * Written by Doug Lea with assistance from members of JCP JSR-166
3     * Expert Group and released to the public domain, as explained at
4 jsr166 1.48 * http://creativecommons.org/publicdomain/zero/1.0/
5 jsr166 1.1 */
6    
7     package java.util.concurrent;
8    
9     import java.io.Serializable;
10     import java.util.Collection;
11     import java.util.List;
12 jsr166 1.7 import java.util.RandomAccess;
13 dl 1.45 import java.lang.ref.WeakReference;
14     import java.lang.ref.ReferenceQueue;
15 dl 1.32 import java.util.concurrent.Callable;
16     import java.util.concurrent.CancellationException;
17     import java.util.concurrent.ExecutionException;
18     import java.util.concurrent.Future;
19     import java.util.concurrent.RejectedExecutionException;
20     import java.util.concurrent.RunnableFuture;
21     import java.util.concurrent.TimeUnit;
22     import java.util.concurrent.TimeoutException;
23 dl 1.45 import java.util.concurrent.locks.ReentrantLock;
24     import java.lang.reflect.Constructor;
25 jsr166 1.1
26     /**
27 jsr166 1.6 * Abstract base class for tasks that run within a {@link ForkJoinPool}.
28     * A {@code ForkJoinTask} is a thread-like entity that is much
29 jsr166 1.1 * lighter weight than a normal thread. Huge numbers of tasks and
30     * subtasks may be hosted by a small number of actual threads in a
31     * ForkJoinPool, at the price of some usage limitations.
32     *
33 dl 1.64 * <p>A "main" {@code ForkJoinTask} begins execution when it is
34     * explicitly submitted to a {@link ForkJoinPool}, or, if not already
35     * engaged in a ForkJoin computation, commenced in the {@link
36 dl 1.67 * ForkJoinPool#commonPool()} via {@link #fork}, {@link #invoke}, or
37 dl 1.64 * related methods. Once started, it will usually in turn start other
38     * subtasks. As indicated by the name of this class, many programs
39     * using {@code ForkJoinTask} employ only methods {@link #fork} and
40     * {@link #join}, or derivatives such as {@link
41 jsr166 1.27 * #invokeAll(ForkJoinTask...) invokeAll}. However, this class also
42     * provides a number of other methods that can come into play in
43 dl 1.64 * advanced usages, as well as extension mechanics that allow support
44     * of new forms of fork/join processing.
45 jsr166 1.1 *
46 jsr166 1.6 * <p>A {@code ForkJoinTask} is a lightweight form of {@link Future}.
47     * The efficiency of {@code ForkJoinTask}s stems from a set of
48     * restrictions (that are only partially statically enforceable)
49 dl 1.54 * reflecting their main use as computational tasks calculating pure
50     * functions or operating on purely isolated objects. The primary
51     * coordination mechanisms are {@link #fork}, that arranges
52 jsr166 1.6 * asynchronous execution, and {@link #join}, that doesn't proceed
53     * until the task's result has been computed. Computations should
54 dl 1.54 * ideally avoid {@code synchronized} methods or blocks, and should
55     * minimize other blocking synchronization apart from joining other
56     * tasks or using synchronizers such as Phasers that are advertised to
57     * cooperate with fork/join scheduling. Subdividable tasks should also
58 jsr166 1.68 * not perform blocking I/O, and should ideally access variables that
59 dl 1.54 * are completely independent of those accessed by other running
60     * tasks. These guidelines are loosely enforced by not permitting
61     * checked exceptions such as {@code IOExceptions} to be
62     * thrown. However, computations may still encounter unchecked
63     * exceptions, that are rethrown to callers attempting to join
64     * them. These exceptions may additionally include {@link
65     * RejectedExecutionException} stemming from internal resource
66     * exhaustion, such as failure to allocate internal task
67     * queues. Rethrown exceptions behave in the same way as regular
68     * exceptions, but, when possible, contain stack traces (as displayed
69     * for example using {@code ex.printStackTrace()}) of both the thread
70     * that initiated the computation as well as the thread actually
71     * encountering the exception; minimally only the latter.
72     *
73     * <p>It is possible to define and use ForkJoinTasks that may block,
74     * but doing do requires three further considerations: (1) Completion
75     * of few if any <em>other</em> tasks should be dependent on a task
76 jsr166 1.68 * that blocks on external synchronization or I/O. Event-style async
77 dl 1.63 * tasks that are never joined (for example, those subclassing {@link
78     * CountedCompleter}) often fall into this category. (2) To minimize
79     * resource impact, tasks should be small; ideally performing only the
80     * (possibly) blocking action. (3) Unless the {@link
81 dl 1.54 * ForkJoinPool.ManagedBlocker} API is used, or the number of possibly
82     * blocked tasks is known to be less than the pool's {@link
83     * ForkJoinPool#getParallelism} level, the pool cannot guarantee that
84     * enough threads will be available to ensure progress or good
85     * performance.
86 jsr166 1.1 *
87     * <p>The primary method for awaiting completion and extracting
88     * results of a task is {@link #join}, but there are several variants:
89     * The {@link Future#get} methods support interruptible and/or timed
90     * waits for completion and report results using {@code Future}
91 dl 1.16 * conventions. Method {@link #invoke} is semantically
92 jsr166 1.8 * equivalent to {@code fork(); join()} but always attempts to begin
93     * execution in the current thread. The "<em>quiet</em>" forms of
94     * these methods do not extract results or report exceptions. These
95 jsr166 1.1 * may be useful when a set of tasks are being executed, and you need
96     * to delay processing of results or exceptions until all complete.
97     * Method {@code invokeAll} (available in multiple versions)
98     * performs the most common form of parallel invocation: forking a set
99     * of tasks and joining them all.
100     *
101 jsr166 1.57 * <p>In the most typical usages, a fork-join pair act like a call
102 dl 1.54 * (fork) and return (join) from a parallel recursive function. As is
103     * the case with other forms of recursive calls, returns (joins)
104     * should be performed innermost-first. For example, {@code a.fork();
105     * b.fork(); b.join(); a.join();} is likely to be substantially more
106     * efficient than joining {@code a} before {@code b}.
107     *
108 jsr166 1.8 * <p>The execution status of tasks may be queried at several levels
109     * of detail: {@link #isDone} is true if a task completed in any way
110     * (including the case where a task was cancelled without executing);
111     * {@link #isCompletedNormally} is true if a task completed without
112 jsr166 1.10 * cancellation or encountering an exception; {@link #isCancelled} is
113     * true if the task was cancelled (in which case {@link #getException}
114     * returns a {@link java.util.concurrent.CancellationException}); and
115     * {@link #isCompletedAbnormally} is true if a task was either
116     * cancelled or encountered an exception, in which case {@link
117     * #getException} will return either the encountered exception or
118     * {@link java.util.concurrent.CancellationException}.
119 jsr166 1.8 *
120 jsr166 1.6 * <p>The ForkJoinTask class is not usually directly subclassed.
121 jsr166 1.1 * Instead, you subclass one of the abstract classes that support a
122 jsr166 1.6 * particular style of fork/join processing, typically {@link
123 dl 1.62 * RecursiveAction} for most computations that do not return results,
124     * {@link RecursiveTask} for those that do, and {@link
125     * CountedCompleter} for those in which completed actions trigger
126     * other actions. Normally, a concrete ForkJoinTask subclass declares
127     * fields comprising its parameters, established in a constructor, and
128     * then defines a {@code compute} method that somehow uses the control
129 dl 1.64 * methods supplied by this base class.
130 jsr166 1.1 *
131 dl 1.38 * <p>Method {@link #join} and its variants are appropriate for use
132     * only when completion dependencies are acyclic; that is, the
133     * parallel computation can be described as a directed acyclic graph
134     * (DAG). Otherwise, executions may encounter a form of deadlock as
135     * tasks cyclically wait for each other. However, this framework
136     * supports other methods and techniques (for example the use of
137     * {@link Phaser}, {@link #helpQuiesce}, and {@link #complete}) that
138     * may be of use in constructing custom subclasses for problems that
139 jsr166 1.79 * are not statically structured as DAGs. To support such usages, a
140 dl 1.63 * ForkJoinTask may be atomically <em>tagged</em> with a {@code short}
141     * value using {@link #setForkJoinTaskTag} or {@link
142 dl 1.60 * #compareAndSetForkJoinTaskTag} and checked using {@link
143 dl 1.63 * #getForkJoinTaskTag}. The ForkJoinTask implementation does not use
144     * these {@code protected} methods or tags for any purpose, but they
145     * may be of use in the construction of specialized subclasses. For
146     * example, parallel graph traversals can use the supplied methods to
147     * avoid revisiting nodes/tasks that have already been processed.
148     * (Method names for tagging are bulky in part to encourage definition
149     * of methods that reflect their usage patterns.)
150 dl 1.38 *
151 jsr166 1.7 * <p>Most base support methods are {@code final}, to prevent
152     * overriding of implementations that are intrinsically tied to the
153     * underlying lightweight task scheduling framework. Developers
154     * creating new basic styles of fork/join processing should minimally
155     * implement {@code protected} methods {@link #exec}, {@link
156     * #setRawResult}, and {@link #getRawResult}, while also introducing
157     * an abstract computational method that can be implemented in its
158     * subclasses, possibly relying on other {@code protected} methods
159     * provided by this class.
160 jsr166 1.1 *
161     * <p>ForkJoinTasks should perform relatively small amounts of
162 jsr166 1.7 * computation. Large tasks should be split into smaller subtasks,
163     * usually via recursive decomposition. As a very rough rule of thumb,
164     * a task should perform more than 100 and less than 10000 basic
165 dl 1.40 * computational steps, and should avoid indefinite looping. If tasks
166     * are too big, then parallelism cannot improve throughput. If too
167     * small, then memory and internal task maintenance overhead may
168     * overwhelm processing.
169 jsr166 1.1 *
170 jsr166 1.8 * <p>This class provides {@code adapt} methods for {@link Runnable}
171     * and {@link Callable}, that may be of use when mixing execution of
172 dl 1.16 * {@code ForkJoinTasks} with other kinds of tasks. When all tasks are
173     * of this form, consider using a pool constructed in <em>asyncMode</em>.
174 jsr166 1.6 *
175 jsr166 1.7 * <p>ForkJoinTasks are {@code Serializable}, which enables them to be
176     * used in extensions such as remote execution frameworks. It is
177     * sensible to serialize tasks only before or after, but not during,
178     * execution. Serialization is not relied on during execution itself.
179 jsr166 1.1 *
180     * @since 1.7
181     * @author Doug Lea
182     */
183     public abstract class ForkJoinTask<V> implements Future<V>, Serializable {
184    
185 dl 1.13 /*
186     * See the internal documentation of class ForkJoinPool for a
187     * general implementation overview. ForkJoinTasks are mainly
188     * responsible for maintaining their "status" field amidst relays
189 jsr166 1.51 * to methods in ForkJoinWorkerThread and ForkJoinPool.
190     *
191     * The methods of this class are more-or-less layered into
192     * (1) basic status maintenance
193     * (2) execution and awaiting completion
194     * (3) user-level methods that additionally report results.
195     * This is sometimes hard to see because this file orders exported
196     * methods in a way that flows well in javadocs.
197 dl 1.13 */
198    
199 dl 1.17 /*
200     * The status field holds run control status bits packed into a
201     * single int to minimize footprint and to ensure atomicity (via
202     * CAS). Status is initially zero, and takes on nonnegative
203 dl 1.59 * values until completed, upon which status (anded with
204     * DONE_MASK) holds value NORMAL, CANCELLED, or EXCEPTIONAL. Tasks
205     * undergoing blocking waits by other threads have the SIGNAL bit
206     * set. Completion of a stolen task with SIGNAL set awakens any
207     * waiters via notifyAll. Even though suboptimal for some
208     * purposes, we use basic builtin wait/notify to take advantage of
209     * "monitor inflation" in JVMs that we would otherwise need to
210     * emulate to avoid adding further per-task bookkeeping overhead.
211     * We want these monitors to be "fat", i.e., not use biasing or
212     * thin-lock techniques, so use some odd coding idioms that tend
213     * to avoid them, mainly by arranging that every synchronized
214     * block performs a wait, notifyAll or both.
215 dl 1.60 *
216     * These control bits occupy only (some of) the upper half (16
217     * bits) of status field. The lower bits are used for user-defined
218     * tags.
219 jsr166 1.1 */
220 dl 1.17
221     /** The run status of this task */
222 jsr166 1.1 volatile int status; // accessed directly by pool and workers
223 dl 1.59 static final int DONE_MASK = 0xf0000000; // mask out non-completion bits
224     static final int NORMAL = 0xf0000000; // must be negative
225     static final int CANCELLED = 0xc0000000; // must be < NORMAL
226     static final int EXCEPTIONAL = 0x80000000; // must be < CANCELLED
227 dl 1.60 static final int SIGNAL = 0x00010000; // must be >= 1 << 16
228     static final int SMASK = 0x0000ffff; // short bits for tags
229 jsr166 1.1
230     /**
231 dl 1.54 * Marks completion and wakes up threads waiting to join this
232 dl 1.60 * task.
233 dl 1.13 *
234     * @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
235 dl 1.45 * @return completion status on exit
236 jsr166 1.1 */
237 dl 1.45 private int setCompletion(int completion) {
238     for (int s;;) {
239     if ((s = status) < 0)
240     return s;
241 dl 1.59 if (U.compareAndSwapInt(this, STATUS, s, s | completion)) {
242 dl 1.60 if ((s >>> 16) != 0)
243 dl 1.13 synchronized (this) { notifyAll(); }
244 dl 1.45 return completion;
245 dl 1.13 }
246     }
247 jsr166 1.1 }
248    
249     /**
250 dl 1.54 * Primary execution method for stolen tasks. Unless done, calls
251     * exec and records status if completed, but doesn't wait for
252     * completion otherwise.
253 jsr166 1.24 *
254 dl 1.54 * @return status on exit from this method
255 jsr166 1.1 */
256 dl 1.54 final int doExec() {
257     int s; boolean completed;
258     if ((s = status) >= 0) {
259     try {
260     completed = exec();
261     } catch (Throwable rex) {
262     return setExceptionalCompletion(rex);
263     }
264 dl 1.60 if (completed)
265     s = setCompletion(NORMAL);
266 jsr166 1.1 }
267 dl 1.54 return s;
268 jsr166 1.1 }
269    
270     /**
271 dl 1.87 * If not done, sets SIGNAL status and performs Object.wait(timeout).
272     * This task may or may not be done on exit. Ignores interrupts.
273     *
274     * @param timeout using Object.wait conventions.
275     */
276     final void internalWait(long timeout) {
277     int s;
278     if ((s = status) >= 0 && // force completer to issue notify
279     U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
280     synchronized (this) {
281     if (status >= 0)
282     try { wait(timeout); } catch (InterruptedException ie) { }
283     else
284     notifyAll();
285     }
286     }
287 dl 1.59 }
288    
289     /**
290 dl 1.40 * Blocks a non-worker-thread until completion.
291 dl 1.45 * @return status upon completion
292 dl 1.19 */
293 dl 1.45 private int externalAwaitDone() {
294 dl 1.87 int s = ((this instanceof CountedCompleter) ? // try helping
295     ForkJoinPool.common.externalHelpComplete(
296     (CountedCompleter<?>)this, 0) :
297     ForkJoinPool.common.tryExternalUnpush(this) ? doExec() : 0);
298     if (s >= 0 && (s = status) >= 0) {
299     boolean interrupted = false;
300     do {
301     if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
302     synchronized (this) {
303     if (status >= 0) {
304     try {
305     wait(0L);
306     } catch (InterruptedException ie) {
307     interrupted = true;
308 dl 1.75 }
309 dl 1.43 }
310 dl 1.87 else
311     notifyAll();
312 dl 1.40 }
313 dl 1.87 }
314     } while ((s = status) >= 0);
315     if (interrupted)
316     Thread.currentThread().interrupt();
317 dl 1.19 }
318 dl 1.45 return s;
319 dl 1.19 }
320    
321     /**
322 dl 1.59 * Blocks a non-worker-thread until completion or interruption.
323 jsr166 1.1 */
324 dl 1.59 private int externalInterruptibleAwaitDone() throws InterruptedException {
325 dl 1.66 int s;
326 dl 1.40 if (Thread.interrupted())
327     throw new InterruptedException();
328 dl 1.87 if ((s = status) >= 0 &&
329     (s = ((this instanceof CountedCompleter) ?
330     ForkJoinPool.common.externalHelpComplete(
331     (CountedCompleter<?>)this, 0) :
332     ForkJoinPool.common.tryExternalUnpush(this) ? doExec() :
333     0)) >= 0) {
334     while ((s = status) >= 0) {
335     if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
336     synchronized (this) {
337     if (status >= 0)
338     wait(0L);
339     else
340     notifyAll();
341     }
342 dl 1.45 }
343     }
344     }
345     return s;
346     }
347    
348     /**
349 dl 1.54 * Implementation for join, get, quietlyJoin. Directly handles
350     * only cases of already-completed, external wait, and
351 dl 1.59 * unfork+exec. Others are relayed to ForkJoinPool.awaitJoin.
352 dl 1.54 *
353     * @return status upon completion
354 dl 1.45 */
355 dl 1.54 private int doJoin() {
356     int s; Thread t; ForkJoinWorkerThread wt; ForkJoinPool.WorkQueue w;
357 dl 1.64 return (s = status) < 0 ? s :
358     ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
359     (w = (wt = (ForkJoinWorkerThread)t).workQueue).
360     tryUnpush(this) && (s = doExec()) < 0 ? s :
361 dl 1.87 wt.pool.awaitJoin(w, this, 0L) :
362 dl 1.64 externalAwaitDone();
363 jsr166 1.1 }
364    
365     /**
366 dl 1.54 * Implementation for invoke, quietlyInvoke.
367     *
368 dl 1.45 * @return status upon completion
369 jsr166 1.1 */
370 dl 1.45 private int doInvoke() {
371 dl 1.59 int s; Thread t; ForkJoinWorkerThread wt;
372 dl 1.64 return (s = doExec()) < 0 ? s :
373     ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
374 dl 1.87 (wt = (ForkJoinWorkerThread)t).pool.
375     awaitJoin(wt.workQueue, this, 0L) :
376 dl 1.64 externalAwaitDone();
377 dl 1.45 }
378    
379     // Exception table support
380    
381     /**
382     * Table of exceptions thrown by tasks, to enable reporting by
383     * callers. Because exceptions are rare, we don't directly keep
384     * them with task objects, but instead use a weak ref table. Note
385     * that cancellation exceptions don't appear in the table, but are
386     * instead recorded as status values.
387     *
388     * Note: These statics are initialized below in static block.
389     */
390     private static final ExceptionNode[] exceptionTable;
391     private static final ReentrantLock exceptionTableLock;
392     private static final ReferenceQueue<Object> exceptionTableRefQueue;
393    
394     /**
395     * Fixed capacity for exceptionTable.
396     */
397     private static final int EXCEPTION_MAP_CAPACITY = 32;
398    
399     /**
400     * Key-value nodes for exception table. The chained hash table
401     * uses identity comparisons, full locking, and weak references
402     * for keys. The table has a fixed capacity because it only
403     * maintains task exceptions long enough for joiners to access
404     * them, so should never become very large for sustained
405     * periods. However, since we do not know when the last joiner
406     * completes, we must use weak references and expunge them. We do
407     * so on each operation (hence full locking). Also, some thread in
408 dl 1.47 * any ForkJoinPool will call helpExpungeStaleExceptions when its
409     * pool becomes isQuiescent.
410 dl 1.45 */
411 jsr166 1.58 static final class ExceptionNode extends WeakReference<ForkJoinTask<?>> {
412 dl 1.45 final Throwable ex;
413     ExceptionNode next;
414 dl 1.47 final long thrower; // use id not ref to avoid weak cycles
415 dl 1.85 final int hashCode; // store task hashCode before weak ref disappears
416 dl 1.45 ExceptionNode(ForkJoinTask<?> task, Throwable ex, ExceptionNode next) {
417     super(task, exceptionTableRefQueue);
418     this.ex = ex;
419     this.next = next;
420     this.thrower = Thread.currentThread().getId();
421 dl 1.85 this.hashCode = System.identityHashCode(task);
422 dl 1.45 }
423     }
424    
425     /**
426 dl 1.63 * Records exception and sets status.
427 dl 1.45 *
428     * @return status on exit
429     */
430 dl 1.63 final int recordExceptionalCompletion(Throwable ex) {
431 dl 1.62 int s;
432     if ((s = status) >= 0) {
433     int h = System.identityHashCode(this);
434     final ReentrantLock lock = exceptionTableLock;
435     lock.lock();
436     try {
437     expungeStaleExceptions();
438     ExceptionNode[] t = exceptionTable;
439     int i = h & (t.length - 1);
440     for (ExceptionNode e = t[i]; ; e = e.next) {
441     if (e == null) {
442     t[i] = new ExceptionNode(this, ex, t[i]);
443     break;
444     }
445     if (e.get() == this) // already present
446     break;
447 dl 1.45 }
448 dl 1.62 } finally {
449     lock.unlock();
450 dl 1.45 }
451 dl 1.62 s = setCompletion(EXCEPTIONAL);
452 dl 1.45 }
453 dl 1.62 return s;
454     }
455    
456     /**
457 jsr166 1.70 * Records exception and possibly propagates.
458 dl 1.63 *
459     * @return status on exit
460     */
461     private int setExceptionalCompletion(Throwable ex) {
462     int s = recordExceptionalCompletion(ex);
463     if ((s & DONE_MASK) == EXCEPTIONAL)
464     internalPropagateException(ex);
465     return s;
466     }
467    
468     /**
469     * Hook for exception propagation support for tasks with completers.
470 dl 1.62 */
471 dl 1.63 void internalPropagateException(Throwable ex) {
472 dl 1.45 }
473    
474     /**
475 dl 1.54 * Cancels, ignoring any exceptions thrown by cancel. Used during
476     * worker and pool shutdown. Cancel is spec'ed not to throw any
477     * exceptions, but if it does anyway, we have no recourse during
478     * shutdown, so guard against this case.
479     */
480     static final void cancelIgnoringExceptions(ForkJoinTask<?> t) {
481     if (t != null && t.status >= 0) {
482     try {
483     t.cancel(false);
484     } catch (Throwable ignore) {
485     }
486     }
487     }
488    
489     /**
490 jsr166 1.72 * Removes exception node and clears status.
491 dl 1.45 */
492     private void clearExceptionalCompletion() {
493     int h = System.identityHashCode(this);
494 dl 1.47 final ReentrantLock lock = exceptionTableLock;
495 dl 1.45 lock.lock();
496     try {
497     ExceptionNode[] t = exceptionTable;
498     int i = h & (t.length - 1);
499     ExceptionNode e = t[i];
500     ExceptionNode pred = null;
501     while (e != null) {
502     ExceptionNode next = e.next;
503     if (e.get() == this) {
504     if (pred == null)
505     t[i] = next;
506     else
507     pred.next = next;
508     break;
509     }
510     pred = e;
511     e = next;
512     }
513     expungeStaleExceptions();
514     status = 0;
515     } finally {
516     lock.unlock();
517     }
518     }
519    
520     /**
521     * Returns a rethrowable exception for the given task, if
522     * available. To provide accurate stack traces, if the exception
523     * was not thrown by the current thread, we try to create a new
524     * exception of the same type as the one thrown, but with the
525     * recorded exception as its cause. If there is no such
526     * constructor, we instead try to use a no-arg constructor,
527     * followed by initCause, to the same effect. If none of these
528     * apply, or any fail due to other exceptions, we return the
529     * recorded exception, which is still correct, although it may
530     * contain a misleading stack trace.
531     *
532     * @return the exception, or null if none
533     */
534     private Throwable getThrowableException() {
535 dl 1.59 if ((status & DONE_MASK) != EXCEPTIONAL)
536 dl 1.45 return null;
537     int h = System.identityHashCode(this);
538     ExceptionNode e;
539 dl 1.47 final ReentrantLock lock = exceptionTableLock;
540 dl 1.45 lock.lock();
541     try {
542     expungeStaleExceptions();
543     ExceptionNode[] t = exceptionTable;
544     e = t[h & (t.length - 1)];
545     while (e != null && e.get() != this)
546     e = e.next;
547     } finally {
548     lock.unlock();
549     }
550     Throwable ex;
551     if (e == null || (ex = e.ex) == null)
552     return null;
553 dl 1.86 if (e.thrower != Thread.currentThread().getId()) {
554 jsr166 1.49 Class<? extends Throwable> ec = ex.getClass();
555 dl 1.45 try {
556     Constructor<?> noArgCtor = null;
557     Constructor<?>[] cs = ec.getConstructors();// public ctors only
558     for (int i = 0; i < cs.length; ++i) {
559     Constructor<?> c = cs[i];
560     Class<?>[] ps = c.getParameterTypes();
561     if (ps.length == 0)
562     noArgCtor = c;
563 dl 1.89 else if (ps.length == 1 && ps[0] == Throwable.class) {
564     Throwable wx = (Throwable)c.newInstance(ex);
565     return (wx == null) ? ex : wx;
566     }
567 dl 1.45 }
568     if (noArgCtor != null) {
569     Throwable wx = (Throwable)(noArgCtor.newInstance());
570 dl 1.89 if (wx != null) {
571     wx.initCause(ex);
572     return wx;
573     }
574 dl 1.45 }
575     } catch (Exception ignore) {
576     }
577     }
578     return ex;
579     }
580    
581     /**
582     * Poll stale refs and remove them. Call only while holding lock.
583     */
584     private static void expungeStaleExceptions() {
585     for (Object x; (x = exceptionTableRefQueue.poll()) != null;) {
586     if (x instanceof ExceptionNode) {
587 dl 1.85 int hashCode = ((ExceptionNode)x).hashCode;
588 dl 1.45 ExceptionNode[] t = exceptionTable;
589 dl 1.85 int i = hashCode & (t.length - 1);
590 dl 1.45 ExceptionNode e = t[i];
591     ExceptionNode pred = null;
592     while (e != null) {
593     ExceptionNode next = e.next;
594     if (e == x) {
595     if (pred == null)
596     t[i] = next;
597     else
598     pred.next = next;
599     break;
600     }
601     pred = e;
602     e = next;
603     }
604     }
605     }
606     }
607    
608     /**
609 dl 1.47 * If lock is available, poll stale refs and remove them.
610 dl 1.45 * Called from ForkJoinPool when pools become quiescent.
611     */
612     static final void helpExpungeStaleExceptions() {
613 dl 1.47 final ReentrantLock lock = exceptionTableLock;
614 dl 1.45 if (lock.tryLock()) {
615     try {
616     expungeStaleExceptions();
617     } finally {
618     lock.unlock();
619     }
620 jsr166 1.1 }
621 dl 1.45 }
622    
623     /**
624 dl 1.65 * A version of "sneaky throw" to relay exceptions
625     */
626 jsr166 1.78 static void rethrow(Throwable ex) {
627 jsr166 1.77 if (ex != null)
628 dl 1.71 ForkJoinTask.<RuntimeException>uncheckedThrow(ex);
629 dl 1.65 }
630    
631     /**
632     * The sneaky part of sneaky throw, relying on generics
633     * limitations to evade compiler complaints about rethrowing
634     * unchecked exceptions
635     */
636     @SuppressWarnings("unchecked") static <T extends Throwable>
637 dl 1.71 void uncheckedThrow(Throwable t) throws T {
638 jsr166 1.77 throw (T)t; // rely on vacuous cast
639 dl 1.65 }
640    
641     /**
642 dl 1.59 * Throws exception, if any, associated with the given status.
643 dl 1.45 */
644 dl 1.59 private void reportException(int s) {
645 dl 1.65 if (s == CANCELLED)
646     throw new CancellationException();
647     if (s == EXCEPTIONAL)
648     rethrow(getThrowableException());
649 jsr166 1.1 }
650    
651     // public methods
652    
653     /**
654 dl 1.64 * Arranges to asynchronously execute this task in the pool the
655     * current task is running in, if applicable, or using the {@link
656 dl 1.67 * ForkJoinPool#commonPool()} if not {@link #inForkJoinPool}. While
657 dl 1.64 * it is not necessarily enforced, it is a usage error to fork a
658     * task more than once unless it has completed and been
659     * reinitialized. Subsequent modifications to the state of this
660     * task or any data it operates on are not necessarily
661     * consistently observable by any thread other than the one
662     * executing it unless preceded by a call to {@link #join} or
663     * related methods, or a call to {@link #isDone} returning {@code
664     * true}.
665 jsr166 1.2 *
666 jsr166 1.6 * @return {@code this}, to simplify usage
667 jsr166 1.1 */
668 jsr166 1.2 public final ForkJoinTask<V> fork() {
669 dl 1.64 Thread t;
670     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
671     ((ForkJoinWorkerThread)t).workQueue.push(this);
672     else
673 dl 1.71 ForkJoinPool.common.externalPush(this);
674 jsr166 1.2 return this;
675 jsr166 1.1 }
676    
677     /**
678 dl 1.38 * Returns the result of the computation when it {@link #isDone is
679     * done}. This method differs from {@link #get()} in that
680 jsr166 1.6 * abnormal completion results in {@code RuntimeException} or
681 dl 1.38 * {@code Error}, not {@code ExecutionException}, and that
682     * interrupts of the calling thread do <em>not</em> cause the
683     * method to abruptly return by throwing {@code
684     * InterruptedException}.
685 jsr166 1.1 *
686     * @return the computed result
687     */
688     public final V join() {
689 dl 1.59 int s;
690     if ((s = doJoin() & DONE_MASK) != NORMAL)
691     reportException(s);
692     return getRawResult();
693 jsr166 1.1 }
694    
695     /**
696     * Commences performing this task, awaits its completion if
697 jsr166 1.21 * necessary, and returns its result, or throws an (unchecked)
698 dl 1.20 * {@code RuntimeException} or {@code Error} if the underlying
699     * computation did so.
700 jsr166 1.1 *
701     * @return the computed result
702     */
703     public final V invoke() {
704 dl 1.59 int s;
705     if ((s = doInvoke() & DONE_MASK) != NORMAL)
706     reportException(s);
707     return getRawResult();
708 jsr166 1.1 }
709    
710     /**
711 jsr166 1.8 * Forks the given tasks, returning when {@code isDone} holds for
712     * each task or an (unchecked) exception is encountered, in which
713 dl 1.20 * case the exception is rethrown. If more than one task
714     * encounters an exception, then this method throws any one of
715     * these exceptions. If any task encounters an exception, the
716     * other may be cancelled. However, the execution status of
717     * individual tasks is not guaranteed upon exceptional return. The
718     * status of each task may be obtained using {@link
719     * #getException()} and related methods to check if they have been
720     * cancelled, completed normally or exceptionally, or left
721     * unprocessed.
722 jsr166 1.6 *
723     * @param t1 the first task
724     * @param t2 the second task
725     * @throws NullPointerException if any task is null
726 jsr166 1.1 */
727 jsr166 1.6 public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
728 dl 1.59 int s1, s2;
729 jsr166 1.1 t2.fork();
730 dl 1.59 if ((s1 = t1.doInvoke() & DONE_MASK) != NORMAL)
731     t1.reportException(s1);
732     if ((s2 = t2.doJoin() & DONE_MASK) != NORMAL)
733     t2.reportException(s2);
734 jsr166 1.1 }
735    
736     /**
737 jsr166 1.6 * Forks the given tasks, returning when {@code isDone} holds for
738 jsr166 1.8 * each task or an (unchecked) exception is encountered, in which
739 dl 1.20 * case the exception is rethrown. If more than one task
740     * encounters an exception, then this method throws any one of
741     * these exceptions. If any task encounters an exception, others
742     * may be cancelled. However, the execution status of individual
743     * tasks is not guaranteed upon exceptional return. The status of
744     * each task may be obtained using {@link #getException()} and
745     * related methods to check if they have been cancelled, completed
746     * normally or exceptionally, or left unprocessed.
747 jsr166 1.6 *
748     * @param tasks the tasks
749 jsr166 1.8 * @throws NullPointerException if any task is null
750 jsr166 1.1 */
751     public static void invokeAll(ForkJoinTask<?>... tasks) {
752     Throwable ex = null;
753     int last = tasks.length - 1;
754     for (int i = last; i >= 0; --i) {
755     ForkJoinTask<?> t = tasks[i];
756     if (t == null) {
757     if (ex == null)
758     ex = new NullPointerException();
759     }
760     else if (i != 0)
761     t.fork();
762 dl 1.45 else if (t.doInvoke() < NORMAL && ex == null)
763     ex = t.getException();
764 jsr166 1.1 }
765     for (int i = 1; i <= last; ++i) {
766     ForkJoinTask<?> t = tasks[i];
767     if (t != null) {
768     if (ex != null)
769     t.cancel(false);
770 jsr166 1.52 else if (t.doJoin() < NORMAL)
771 dl 1.45 ex = t.getException();
772 jsr166 1.1 }
773     }
774     if (ex != null)
775 dl 1.65 rethrow(ex);
776 jsr166 1.1 }
777    
778     /**
779 jsr166 1.7 * Forks all tasks in the specified collection, returning when
780 jsr166 1.8 * {@code isDone} holds for each task or an (unchecked) exception
781 dl 1.20 * is encountered, in which case the exception is rethrown. If
782     * more than one task encounters an exception, then this method
783     * throws any one of these exceptions. If any task encounters an
784     * exception, others may be cancelled. However, the execution
785     * status of individual tasks is not guaranteed upon exceptional
786     * return. The status of each task may be obtained using {@link
787     * #getException()} and related methods to check if they have been
788     * cancelled, completed normally or exceptionally, or left
789     * unprocessed.
790 jsr166 1.6 *
791 jsr166 1.1 * @param tasks the collection of tasks
792 jsr166 1.82 * @param <T> the type of the values returned from the tasks
793 jsr166 1.2 * @return the tasks argument, to simplify usage
794 jsr166 1.1 * @throws NullPointerException if tasks or any element are null
795     */
796 jsr166 1.2 public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) {
797 jsr166 1.7 if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) {
798 jsr166 1.1 invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
799 jsr166 1.2 return tasks;
800 jsr166 1.1 }
801     @SuppressWarnings("unchecked")
802     List<? extends ForkJoinTask<?>> ts =
803     (List<? extends ForkJoinTask<?>>) tasks;
804     Throwable ex = null;
805     int last = ts.size() - 1;
806     for (int i = last; i >= 0; --i) {
807     ForkJoinTask<?> t = ts.get(i);
808     if (t == null) {
809     if (ex == null)
810     ex = new NullPointerException();
811     }
812     else if (i != 0)
813     t.fork();
814 dl 1.45 else if (t.doInvoke() < NORMAL && ex == null)
815     ex = t.getException();
816 jsr166 1.1 }
817     for (int i = 1; i <= last; ++i) {
818     ForkJoinTask<?> t = ts.get(i);
819     if (t != null) {
820     if (ex != null)
821     t.cancel(false);
822 jsr166 1.52 else if (t.doJoin() < NORMAL)
823 dl 1.45 ex = t.getException();
824 jsr166 1.1 }
825     }
826     if (ex != null)
827 dl 1.65 rethrow(ex);
828 jsr166 1.2 return tasks;
829 jsr166 1.1 }
830    
831     /**
832 jsr166 1.7 * Attempts to cancel execution of this task. This attempt will
833 jsr166 1.36 * fail if the task has already completed or could not be
834     * cancelled for some other reason. If successful, and this task
835     * has not started when {@code cancel} is called, execution of
836 dl 1.38 * this task is suppressed. After this method returns
837     * successfully, unless there is an intervening call to {@link
838     * #reinitialize}, subsequent calls to {@link #isCancelled},
839     * {@link #isDone}, and {@code cancel} will return {@code true}
840     * and calls to {@link #join} and related methods will result in
841     * {@code CancellationException}.
842 jsr166 1.1 *
843     * <p>This method may be overridden in subclasses, but if so, must
844 dl 1.38 * still ensure that these properties hold. In particular, the
845     * {@code cancel} method itself must not throw exceptions.
846 jsr166 1.1 *
847 jsr166 1.6 * <p>This method is designed to be invoked by <em>other</em>
848 jsr166 1.1 * tasks. To terminate the current task, you can just return or
849     * throw an unchecked exception from its computation method, or
850 jsr166 1.74 * invoke {@link #completeExceptionally(Throwable)}.
851 jsr166 1.1 *
852 dl 1.38 * @param mayInterruptIfRunning this value has no effect in the
853     * default implementation because interrupts are not used to
854     * control cancellation.
855 jsr166 1.1 *
856 jsr166 1.4 * @return {@code true} if this task is now cancelled
857 jsr166 1.1 */
858     public boolean cancel(boolean mayInterruptIfRunning) {
859 dl 1.59 return (setCompletion(CANCELLED) & DONE_MASK) == CANCELLED;
860 jsr166 1.1 }
861    
862 jsr166 1.8 public final boolean isDone() {
863     return status < 0;
864     }
865    
866     public final boolean isCancelled() {
867 dl 1.59 return (status & DONE_MASK) == CANCELLED;
868 jsr166 1.8 }
869    
870     /**
871 jsr166 1.4 * Returns {@code true} if this task threw an exception or was cancelled.
872 jsr166 1.1 *
873 jsr166 1.4 * @return {@code true} if this task threw an exception or was cancelled
874 jsr166 1.1 */
875     public final boolean isCompletedAbnormally() {
876 dl 1.16 return status < NORMAL;
877 jsr166 1.1 }
878    
879     /**
880 jsr166 1.8 * Returns {@code true} if this task completed without throwing an
881     * exception and was not cancelled.
882     *
883     * @return {@code true} if this task completed without throwing an
884     * exception and was not cancelled
885     */
886     public final boolean isCompletedNormally() {
887 dl 1.59 return (status & DONE_MASK) == NORMAL;
888 jsr166 1.8 }
889    
890     /**
891 jsr166 1.1 * Returns the exception thrown by the base computation, or a
892 jsr166 1.6 * {@code CancellationException} if cancelled, or {@code null} if
893     * none or if the method has not yet completed.
894 jsr166 1.1 *
895 jsr166 1.4 * @return the exception, or {@code null} if none
896 jsr166 1.1 */
897     public final Throwable getException() {
898 dl 1.59 int s = status & DONE_MASK;
899 jsr166 1.8 return ((s >= NORMAL) ? null :
900     (s == CANCELLED) ? new CancellationException() :
901 dl 1.45 getThrowableException());
902 jsr166 1.1 }
903    
904     /**
905     * Completes this task abnormally, and if not already aborted or
906     * cancelled, causes it to throw the given exception upon
907     * {@code join} and related operations. This method may be used
908     * to induce exceptions in asynchronous tasks, or to force
909     * completion of tasks that would not otherwise complete. Its use
910 jsr166 1.6 * in other situations is discouraged. This method is
911 jsr166 1.1 * overridable, but overridden versions must invoke {@code super}
912     * implementation to maintain guarantees.
913     *
914 jsr166 1.11 * @param ex the exception to throw. If this exception is not a
915     * {@code RuntimeException} or {@code Error}, the actual exception
916     * thrown will be a {@code RuntimeException} with cause {@code ex}.
917 jsr166 1.1 */
918     public void completeExceptionally(Throwable ex) {
919 dl 1.15 setExceptionalCompletion((ex instanceof RuntimeException) ||
920     (ex instanceof Error) ? ex :
921     new RuntimeException(ex));
922 jsr166 1.1 }
923    
924     /**
925     * Completes this task, and if not already aborted or cancelled,
926 dl 1.22 * returning the given value as the result of subsequent
927     * invocations of {@code join} and related operations. This method
928     * may be used to provide results for asynchronous tasks, or to
929     * provide alternative handling for tasks that would not otherwise
930     * complete normally. Its use in other situations is
931     * discouraged. This method is overridable, but overridden
932     * versions must invoke {@code super} implementation to maintain
933     * guarantees.
934 jsr166 1.1 *
935     * @param value the result value for this task
936     */
937     public void complete(V value) {
938     try {
939     setRawResult(value);
940     } catch (Throwable rex) {
941 dl 1.15 setExceptionalCompletion(rex);
942 jsr166 1.1 return;
943     }
944 dl 1.13 setCompletion(NORMAL);
945 jsr166 1.1 }
946    
947 jsr166 1.25 /**
948 dl 1.62 * Completes this task normally without setting a value. The most
949     * recent value established by {@link #setRawResult} (or {@code
950     * null} by default) will be returned as the result of subsequent
951     * invocations of {@code join} and related operations.
952     *
953     * @since 1.8
954 dl 1.60 */
955     public final void quietlyComplete() {
956     setCompletion(NORMAL);
957     }
958    
959     /**
960 dl 1.29 * Waits if necessary for the computation to complete, and then
961     * retrieves its result.
962     *
963     * @return the computed result
964     * @throws CancellationException if the computation was cancelled
965     * @throws ExecutionException if the computation threw an
966     * exception
967     * @throws InterruptedException if the current thread is not a
968     * member of a ForkJoinPool and was interrupted while waiting
969 jsr166 1.25 */
970 jsr166 1.1 public final V get() throws InterruptedException, ExecutionException {
971 dl 1.45 int s = (Thread.currentThread() instanceof ForkJoinWorkerThread) ?
972 dl 1.59 doJoin() : externalInterruptibleAwaitDone();
973 dl 1.45 Throwable ex;
974 dl 1.59 if ((s &= DONE_MASK) == CANCELLED)
975 dl 1.45 throw new CancellationException();
976     if (s == EXCEPTIONAL && (ex = getThrowableException()) != null)
977     throw new ExecutionException(ex);
978 dl 1.15 return getRawResult();
979 jsr166 1.1 }
980 dl 1.14
981 jsr166 1.25 /**
982 dl 1.29 * Waits if necessary for at most the given time for the computation
983     * to complete, and then retrieves its result, if available.
984     *
985     * @param timeout the maximum time to wait
986     * @param unit the time unit of the timeout argument
987     * @return the computed result
988     * @throws CancellationException if the computation was cancelled
989     * @throws ExecutionException if the computation threw an
990     * exception
991     * @throws InterruptedException if the current thread is not a
992     * member of a ForkJoinPool and was interrupted while waiting
993     * @throws TimeoutException if the wait timed out
994 jsr166 1.25 */
995 jsr166 1.1 public final V get(long timeout, TimeUnit unit)
996     throws InterruptedException, ExecutionException, TimeoutException {
997 dl 1.87 int s;
998     long nanos = unit.toNanos(timeout);
999 dl 1.59 if (Thread.interrupted())
1000     throw new InterruptedException();
1001 dl 1.87 if ((s = status) >= 0 && nanos > 0L) {
1002     long d = System.nanoTime() + nanos;
1003 jsr166 1.88 long deadline = (d == 0L) ? 1L : d; // avoid 0
1004 dl 1.59 Thread t = Thread.currentThread();
1005     if (t instanceof ForkJoinWorkerThread) {
1006     ForkJoinWorkerThread wt = (ForkJoinWorkerThread)t;
1007 dl 1.87 s = wt.pool.awaitJoin(wt.workQueue, this, deadline);
1008 dl 1.59 }
1009 dl 1.87 else if ((s = ((this instanceof CountedCompleter) ?
1010     ForkJoinPool.common.externalHelpComplete(
1011     (CountedCompleter<?>)this, 0) :
1012     ForkJoinPool.common.tryExternalUnpush(this) ?
1013     doExec() : 0)) >= 0) {
1014     long ns, ms; // measure in nanosecs, but wait in millisecs
1015     while ((s = status) >= 0 &&
1016     (ns = deadline - System.nanoTime()) > 0L) {
1017     if ((ms = TimeUnit.NANOSECONDS.toMillis(ns)) > 0L &&
1018     U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
1019     synchronized (this) {
1020     if (status >= 0)
1021     wait(ms); // OK to throw InterruptedException
1022     else
1023     notifyAll();
1024 dl 1.54 }
1025 dl 1.45 }
1026     }
1027     }
1028     }
1029 dl 1.87 if (s >= 0)
1030     s = status;
1031 dl 1.59 if ((s &= DONE_MASK) != NORMAL) {
1032 dl 1.15 Throwable ex;
1033 dl 1.40 if (s == CANCELLED)
1034 dl 1.15 throw new CancellationException();
1035 dl 1.45 if (s != EXCEPTIONAL)
1036     throw new TimeoutException();
1037     if ((ex = getThrowableException()) != null)
1038 dl 1.15 throw new ExecutionException(ex);
1039     }
1040     return getRawResult();
1041 jsr166 1.1 }
1042    
1043     /**
1044 dl 1.17 * Joins this task, without returning its result or throwing its
1045 jsr166 1.1 * exception. This method may be useful when processing
1046     * collections of tasks when some have been cancelled or otherwise
1047     * known to have aborted.
1048     */
1049     public final void quietlyJoin() {
1050 dl 1.45 doJoin();
1051 jsr166 1.1 }
1052    
1053     /**
1054     * Commences performing this task and awaits its completion if
1055 dl 1.17 * necessary, without returning its result or throwing its
1056 dl 1.22 * exception.
1057 jsr166 1.1 */
1058     public final void quietlyInvoke() {
1059 dl 1.45 doInvoke();
1060 jsr166 1.1 }
1061    
1062     /**
1063     * Possibly executes tasks until the pool hosting the current task
1064 jsr166 1.7 * {@link ForkJoinPool#isQuiescent is quiescent}. This method may
1065     * be of use in designs in which many tasks are forked, but none
1066     * are explicitly joined, instead executing them until all are
1067     * processed.
1068 jsr166 1.1 */
1069     public static void helpQuiesce() {
1070 dl 1.64 Thread t;
1071     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
1072     ForkJoinWorkerThread wt = (ForkJoinWorkerThread)t;
1073     wt.pool.helpQuiescePool(wt.workQueue);
1074     }
1075     else
1076 dl 1.71 ForkJoinPool.quiesceCommonPool();
1077 jsr166 1.1 }
1078    
1079     /**
1080     * Resets the internal bookkeeping state of this task, allowing a
1081     * subsequent {@code fork}. This method allows repeated reuse of
1082     * this task, but only if reuse occurs when this task has either
1083     * never been forked, or has been forked, then completed and all
1084     * outstanding joins of this task have also completed. Effects
1085 jsr166 1.6 * under any other usage conditions are not guaranteed.
1086     * This method may be useful when executing
1087 jsr166 1.1 * pre-constructed trees of subtasks in loops.
1088 jsr166 1.34 *
1089 dl 1.33 * <p>Upon completion of this method, {@code isDone()} reports
1090     * {@code false}, and {@code getException()} reports {@code
1091     * null}. However, the value returned by {@code getRawResult} is
1092     * unaffected. To clear this value, you can invoke {@code
1093     * setRawResult(null)}.
1094 jsr166 1.1 */
1095     public void reinitialize() {
1096 dl 1.59 if ((status & DONE_MASK) == EXCEPTIONAL)
1097 dl 1.45 clearExceptionalCompletion();
1098     else
1099     status = 0;
1100 jsr166 1.1 }
1101    
1102     /**
1103     * Returns the pool hosting the current task execution, or null
1104     * if this task is executing outside of any ForkJoinPool.
1105     *
1106 jsr166 1.6 * @see #inForkJoinPool
1107 jsr166 1.4 * @return the pool, or {@code null} if none
1108 jsr166 1.1 */
1109     public static ForkJoinPool getPool() {
1110     Thread t = Thread.currentThread();
1111     return (t instanceof ForkJoinWorkerThread) ?
1112     ((ForkJoinWorkerThread) t).pool : null;
1113     }
1114    
1115     /**
1116 dl 1.42 * Returns {@code true} if the current thread is a {@link
1117     * ForkJoinWorkerThread} executing as a ForkJoinPool computation.
1118 jsr166 1.1 *
1119 dl 1.42 * @return {@code true} if the current thread is a {@link
1120     * ForkJoinWorkerThread} executing as a ForkJoinPool computation,
1121     * or {@code false} otherwise
1122 jsr166 1.1 */
1123     public static boolean inForkJoinPool() {
1124     return Thread.currentThread() instanceof ForkJoinWorkerThread;
1125     }
1126    
1127     /**
1128     * Tries to unschedule this task for execution. This method will
1129 dl 1.64 * typically (but is not guaranteed to) succeed if this task is
1130     * the most recently forked task by the current thread, and has
1131     * not commenced executing in another thread. This method may be
1132     * useful when arranging alternative local processing of tasks
1133     * that could have been, but were not, stolen.
1134 jsr166 1.1 *
1135 jsr166 1.4 * @return {@code true} if unforked
1136 jsr166 1.1 */
1137     public boolean tryUnfork() {
1138 dl 1.64 Thread t;
1139 dl 1.66 return (((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1140     ((ForkJoinWorkerThread)t).workQueue.tryUnpush(this) :
1141 dl 1.75 ForkJoinPool.common.tryExternalUnpush(this));
1142 jsr166 1.1 }
1143    
1144     /**
1145     * Returns an estimate of the number of tasks that have been
1146     * forked by the current worker thread but not yet executed. This
1147     * value may be useful for heuristic decisions about whether to
1148     * fork other tasks.
1149     *
1150     * @return the number of tasks
1151     */
1152     public static int getQueuedTaskCount() {
1153 dl 1.66 Thread t; ForkJoinPool.WorkQueue q;
1154     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
1155     q = ((ForkJoinWorkerThread)t).workQueue;
1156     else
1157     q = ForkJoinPool.commonSubmitterQueue();
1158     return (q == null) ? 0 : q.queueSize();
1159 jsr166 1.1 }
1160    
1161     /**
1162     * Returns an estimate of how many more locally queued tasks are
1163     * held by the current worker thread than there are other worker
1164 dl 1.64 * threads that might steal them, or zero if this thread is not
1165     * operating in a ForkJoinPool. This value may be useful for
1166 jsr166 1.1 * heuristic decisions about whether to fork other tasks. In many
1167     * usages of ForkJoinTasks, at steady state, each worker should
1168     * aim to maintain a small constant surplus (for example, 3) of
1169     * tasks, and to process computations locally if this threshold is
1170     * exceeded.
1171     *
1172     * @return the surplus number of tasks, which may be negative
1173     */
1174     public static int getSurplusQueuedTaskCount() {
1175 dl 1.66 return ForkJoinPool.getSurplusQueuedTaskCount();
1176 jsr166 1.1 }
1177    
1178     // Extension methods
1179    
1180     /**
1181 jsr166 1.4 * Returns the result that would be returned by {@link #join}, even
1182     * if this task completed abnormally, or {@code null} if this task
1183     * is not known to have been completed. This method is designed
1184     * to aid debugging, as well as to support extensions. Its use in
1185     * any other context is discouraged.
1186 jsr166 1.1 *
1187 jsr166 1.4 * @return the result, or {@code null} if not completed
1188 jsr166 1.1 */
1189     public abstract V getRawResult();
1190    
1191     /**
1192     * Forces the given value to be returned as a result. This method
1193     * is designed to support extensions, and should not in general be
1194     * called otherwise.
1195     *
1196     * @param value the value
1197     */
1198     protected abstract void setRawResult(V value);
1199    
1200     /**
1201 dl 1.62 * Immediately performs the base action of this task and returns
1202     * true if, upon return from this method, this task is guaranteed
1203     * to have completed normally. This method may return false
1204     * otherwise, to indicate that this task is not necessarily
1205     * complete (or is not known to be complete), for example in
1206 jsr166 1.1 * asynchronous actions that require explicit invocations of
1207 dl 1.62 * completion methods. This method may also throw an (unchecked)
1208     * exception to indicate abnormal exit. This method is designed to
1209     * support extensions, and should not in general be called
1210     * otherwise.
1211 jsr166 1.1 *
1212 dl 1.62 * @return {@code true} if this task is known to have completed normally
1213 jsr166 1.1 */
1214     protected abstract boolean exec();
1215    
1216     /**
1217 jsr166 1.5 * Returns, but does not unschedule or execute, a task queued by
1218     * the current thread but not yet executed, if one is immediately
1219 dl 1.66 * available. There is no guarantee that this task will actually
1220     * be polled or executed next. Conversely, this method may return
1221     * null even if a task exists but cannot be accessed without
1222     * contention with other threads. This method is designed
1223 jsr166 1.5 * primarily to support extensions, and is unlikely to be useful
1224 jsr166 1.6 * otherwise.
1225     *
1226 jsr166 1.4 * @return the next task, or {@code null} if none are available
1227 jsr166 1.1 */
1228     protected static ForkJoinTask<?> peekNextLocalTask() {
1229 dl 1.66 Thread t; ForkJoinPool.WorkQueue q;
1230     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
1231     q = ((ForkJoinWorkerThread)t).workQueue;
1232     else
1233     q = ForkJoinPool.commonSubmitterQueue();
1234     return (q == null) ? null : q.peek();
1235 jsr166 1.1 }
1236    
1237     /**
1238     * Unschedules and returns, without executing, the next task
1239 dl 1.64 * queued by the current thread but not yet executed, if the
1240     * current thread is operating in a ForkJoinPool. This method is
1241     * designed primarily to support extensions, and is unlikely to be
1242     * useful otherwise.
1243 jsr166 1.1 *
1244 jsr166 1.4 * @return the next task, or {@code null} if none are available
1245 jsr166 1.1 */
1246     protected static ForkJoinTask<?> pollNextLocalTask() {
1247 dl 1.64 Thread t;
1248     return ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1249     ((ForkJoinWorkerThread)t).workQueue.nextLocalTask() :
1250     null;
1251 jsr166 1.1 }
1252    
1253     /**
1254 dl 1.64 * If the current thread is operating in a ForkJoinPool,
1255     * unschedules and returns, without executing, the next task
1256 jsr166 1.1 * queued by the current thread but not yet executed, if one is
1257     * available, or if not available, a task that was forked by some
1258     * other thread, if available. Availability may be transient, so a
1259 dl 1.64 * {@code null} result does not necessarily imply quiescence of
1260     * the pool this task is operating in. This method is designed
1261 jsr166 1.1 * primarily to support extensions, and is unlikely to be useful
1262 jsr166 1.6 * otherwise.
1263     *
1264 jsr166 1.4 * @return a task, or {@code null} if none are available
1265 jsr166 1.1 */
1266     protected static ForkJoinTask<?> pollTask() {
1267 dl 1.64 Thread t; ForkJoinWorkerThread wt;
1268     return ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1269     (wt = (ForkJoinWorkerThread)t).pool.nextTaskFor(wt.workQueue) :
1270     null;
1271 dl 1.54 }
1272    
1273 dl 1.60 // tag operations
1274 dl 1.54
1275     /**
1276 dl 1.60 * Returns the tag for this task.
1277 dl 1.54 *
1278 dl 1.60 * @return the tag for this task
1279 dl 1.54 * @since 1.8
1280     */
1281 dl 1.60 public final short getForkJoinTaskTag() {
1282     return (short)status;
1283 dl 1.54 }
1284    
1285     /**
1286 dl 1.60 * Atomically sets the tag value for this task.
1287 dl 1.54 *
1288 dl 1.60 * @param tag the tag value
1289     * @return the previous value of the tag
1290 dl 1.54 * @since 1.8
1291     */
1292 dl 1.60 public final short setForkJoinTaskTag(short tag) {
1293 dl 1.54 for (int s;;) {
1294 dl 1.60 if (U.compareAndSwapInt(this, STATUS, s = status,
1295     (s & ~SMASK) | (tag & SMASK)))
1296     return (short)s;
1297 dl 1.54 }
1298     }
1299    
1300     /**
1301 dl 1.60 * Atomically conditionally sets the tag value for this task.
1302     * Among other applications, tags can be used as visit markers
1303 dl 1.61 * in tasks operating on graphs, as in methods that check: {@code
1304 dl 1.60 * if (task.compareAndSetForkJoinTaskTag((short)0, (short)1))}
1305     * before processing, otherwise exiting because the node has
1306     * already been visited.
1307 dl 1.54 *
1308 dl 1.60 * @param e the expected tag value
1309     * @param tag the new tag value
1310 jsr166 1.76 * @return {@code true} if successful; i.e., the current value was
1311 dl 1.60 * equal to e and is now tag.
1312 dl 1.54 * @since 1.8
1313     */
1314 dl 1.60 public final boolean compareAndSetForkJoinTaskTag(short e, short tag) {
1315 dl 1.54 for (int s;;) {
1316 dl 1.60 if ((short)(s = status) != e)
1317 dl 1.54 return false;
1318 dl 1.60 if (U.compareAndSwapInt(this, STATUS, s,
1319     (s & ~SMASK) | (tag & SMASK)))
1320 dl 1.54 return true;
1321     }
1322 jsr166 1.1 }
1323    
1324 jsr166 1.5 /**
1325     * Adaptor for Runnables. This implements RunnableFuture
1326     * to be compliant with AbstractExecutorService constraints
1327     * when used in ForkJoinPool.
1328     */
1329     static final class AdaptedRunnable<T> extends ForkJoinTask<T>
1330     implements RunnableFuture<T> {
1331     final Runnable runnable;
1332     T result;
1333     AdaptedRunnable(Runnable runnable, T result) {
1334     if (runnable == null) throw new NullPointerException();
1335     this.runnable = runnable;
1336 dl 1.59 this.result = result; // OK to set this even before completion
1337 jsr166 1.5 }
1338 dl 1.59 public final T getRawResult() { return result; }
1339     public final void setRawResult(T v) { result = v; }
1340     public final boolean exec() { runnable.run(); return true; }
1341     public final void run() { invoke(); }
1342     private static final long serialVersionUID = 5232453952276885070L;
1343     }
1344    
1345     /**
1346     * Adaptor for Runnables without results
1347     */
1348     static final class AdaptedRunnableAction extends ForkJoinTask<Void>
1349     implements RunnableFuture<Void> {
1350     final Runnable runnable;
1351     AdaptedRunnableAction(Runnable runnable) {
1352     if (runnable == null) throw new NullPointerException();
1353     this.runnable = runnable;
1354 jsr166 1.5 }
1355 dl 1.59 public final Void getRawResult() { return null; }
1356     public final void setRawResult(Void v) { }
1357     public final boolean exec() { runnable.run(); return true; }
1358     public final void run() { invoke(); }
1359 jsr166 1.5 private static final long serialVersionUID = 5232453952276885070L;
1360     }
1361    
1362     /**
1363 dl 1.73 * Adaptor for Runnables in which failure forces worker exception
1364     */
1365     static final class RunnableExecuteAction extends ForkJoinTask<Void> {
1366     final Runnable runnable;
1367     RunnableExecuteAction(Runnable runnable) {
1368     if (runnable == null) throw new NullPointerException();
1369     this.runnable = runnable;
1370     }
1371     public final Void getRawResult() { return null; }
1372     public final void setRawResult(Void v) { }
1373     public final boolean exec() { runnable.run(); return true; }
1374     void internalPropagateException(Throwable ex) {
1375     rethrow(ex); // rethrow outside exec() catches.
1376     }
1377     private static final long serialVersionUID = 5232453952276885070L;
1378     }
1379    
1380     /**
1381 jsr166 1.5 * Adaptor for Callables
1382     */
1383     static final class AdaptedCallable<T> extends ForkJoinTask<T>
1384     implements RunnableFuture<T> {
1385 jsr166 1.6 final Callable<? extends T> callable;
1386 jsr166 1.5 T result;
1387 jsr166 1.6 AdaptedCallable(Callable<? extends T> callable) {
1388 jsr166 1.5 if (callable == null) throw new NullPointerException();
1389     this.callable = callable;
1390     }
1391 dl 1.59 public final T getRawResult() { return result; }
1392     public final void setRawResult(T v) { result = v; }
1393     public final boolean exec() {
1394 jsr166 1.5 try {
1395     result = callable.call();
1396     return true;
1397     } catch (Error err) {
1398     throw err;
1399     } catch (RuntimeException rex) {
1400     throw rex;
1401     } catch (Exception ex) {
1402     throw new RuntimeException(ex);
1403     }
1404     }
1405 dl 1.59 public final void run() { invoke(); }
1406 jsr166 1.5 private static final long serialVersionUID = 2838392045355241008L;
1407     }
1408 jsr166 1.2
1409     /**
1410 jsr166 1.6 * Returns a new {@code ForkJoinTask} that performs the {@code run}
1411     * method of the given {@code Runnable} as its action, and returns
1412     * a null result upon {@link #join}.
1413 jsr166 1.2 *
1414     * @param runnable the runnable action
1415     * @return the task
1416     */
1417 jsr166 1.6 public static ForkJoinTask<?> adapt(Runnable runnable) {
1418 dl 1.59 return new AdaptedRunnableAction(runnable);
1419 jsr166 1.2 }
1420    
1421     /**
1422 jsr166 1.6 * Returns a new {@code ForkJoinTask} that performs the {@code run}
1423     * method of the given {@code Runnable} as its action, and returns
1424     * the given result upon {@link #join}.
1425 jsr166 1.2 *
1426     * @param runnable the runnable action
1427     * @param result the result upon completion
1428 jsr166 1.82 * @param <T> the type of the result
1429 jsr166 1.2 * @return the task
1430     */
1431     public static <T> ForkJoinTask<T> adapt(Runnable runnable, T result) {
1432 jsr166 1.5 return new AdaptedRunnable<T>(runnable, result);
1433 jsr166 1.2 }
1434    
1435     /**
1436 jsr166 1.6 * Returns a new {@code ForkJoinTask} that performs the {@code call}
1437     * method of the given {@code Callable} as its action, and returns
1438     * its result upon {@link #join}, translating any checked exceptions
1439     * encountered into {@code RuntimeException}.
1440 jsr166 1.2 *
1441     * @param callable the callable action
1442 jsr166 1.82 * @param <T> the type of the callable's result
1443 jsr166 1.2 * @return the task
1444     */
1445 jsr166 1.6 public static <T> ForkJoinTask<T> adapt(Callable<? extends T> callable) {
1446 jsr166 1.5 return new AdaptedCallable<T>(callable);
1447 jsr166 1.2 }
1448    
1449 jsr166 1.1 // Serialization support
1450    
1451     private static final long serialVersionUID = -7721805057305804111L;
1452    
1453     /**
1454 jsr166 1.53 * Saves this task to a stream (that is, serializes it).
1455 jsr166 1.1 *
1456 jsr166 1.83 * @param s the stream
1457 jsr166 1.84 * @throws java.io.IOException if an I/O error occurs
1458 jsr166 1.1 * @serialData the current run status and the exception thrown
1459 jsr166 1.4 * during execution, or {@code null} if none
1460 jsr166 1.1 */
1461     private void writeObject(java.io.ObjectOutputStream s)
1462     throws java.io.IOException {
1463     s.defaultWriteObject();
1464     s.writeObject(getException());
1465     }
1466    
1467     /**
1468 jsr166 1.53 * Reconstitutes this task from a stream (that is, deserializes it).
1469 jsr166 1.83 * @param s the stream
1470 jsr166 1.84 * @throws ClassNotFoundException if the class of a serialized object
1471     * could not be found
1472     * @throws java.io.IOException if an I/O error occurs
1473 jsr166 1.1 */
1474     private void readObject(java.io.ObjectInputStream s)
1475     throws java.io.IOException, ClassNotFoundException {
1476     s.defaultReadObject();
1477     Object ex = s.readObject();
1478     if (ex != null)
1479 dl 1.45 setExceptionalCompletion((Throwable)ex);
1480 jsr166 1.1 }
1481    
1482 jsr166 1.3 // Unsafe mechanics
1483 dl 1.54 private static final sun.misc.Unsafe U;
1484     private static final long STATUS;
1485 dl 1.66
1486 dl 1.45 static {
1487     exceptionTableLock = new ReentrantLock();
1488     exceptionTableRefQueue = new ReferenceQueue<Object>();
1489     exceptionTable = new ExceptionNode[EXCEPTION_MAP_CAPACITY];
1490 jsr166 1.1 try {
1491 dl 1.54 U = sun.misc.Unsafe.getUnsafe();
1492 dl 1.66 Class<?> k = ForkJoinTask.class;
1493 dl 1.54 STATUS = U.objectFieldOffset
1494 dl 1.66 (k.getDeclaredField("status"));
1495 dl 1.45 } catch (Exception e) {
1496     throw new Error(e);
1497 jsr166 1.1 }
1498     }
1499 dl 1.45
1500 jsr166 1.1 }