ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/concurrent/ForkJoinTask.java
Revision: 1.73
Committed: Fri Feb 1 01:02:37 2013 UTC (11 years, 4 months ago) by dl
Branch: MAIN
Changes since 1.72: +18 -0 lines
Log Message:
Use new java.util.function names

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 dl 1.54 * 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.62 * Tries to set SIGNAL status unless already completed. Used by
272     * ForkJoinPool. Other variants are directly incorporated into
273     * externalAwaitDone etc.
274 dl 1.59 *
275     * @return true if successful
276     */
277     final boolean trySetSignal() {
278 dl 1.62 int s = status;
279     return s >= 0 && U.compareAndSwapInt(this, STATUS, s, s | SIGNAL);
280 dl 1.59 }
281    
282     /**
283 dl 1.40 * Blocks a non-worker-thread until completion.
284 dl 1.45 * @return status upon completion
285 dl 1.19 */
286 dl 1.45 private int externalAwaitDone() {
287 dl 1.64 int s;
288 dl 1.66 ForkJoinPool.externalHelpJoin(this);
289 dl 1.59 boolean interrupted = false;
290 dl 1.66 while ((s = status) >= 0) {
291 dl 1.59 if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
292     synchronized (this) {
293     if (status >= 0) {
294 dl 1.43 try {
295     wait();
296     } catch (InterruptedException ie) {
297     interrupted = true;
298     }
299 dl 1.40 }
300 dl 1.59 else
301     notifyAll();
302 dl 1.19 }
303     }
304     }
305 dl 1.59 if (interrupted)
306     Thread.currentThread().interrupt();
307 dl 1.45 return s;
308 dl 1.19 }
309    
310     /**
311 dl 1.59 * Blocks a non-worker-thread until completion or interruption.
312 jsr166 1.1 */
313 dl 1.59 private int externalInterruptibleAwaitDone() throws InterruptedException {
314 dl 1.66 int s;
315 dl 1.40 if (Thread.interrupted())
316     throw new InterruptedException();
317 dl 1.66 ForkJoinPool.externalHelpJoin(this);
318     while ((s = status) >= 0) {
319 dl 1.59 if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
320     synchronized (this) {
321     if (status >= 0)
322     wait();
323     else
324     notifyAll();
325 dl 1.45 }
326     }
327     }
328     return s;
329     }
330    
331 dl 1.66
332 dl 1.45 /**
333 dl 1.54 * Implementation for join, get, quietlyJoin. Directly handles
334     * only cases of already-completed, external wait, and
335 dl 1.59 * unfork+exec. Others are relayed to ForkJoinPool.awaitJoin.
336 dl 1.54 *
337     * @return status upon completion
338 dl 1.45 */
339 dl 1.54 private int doJoin() {
340     int s; Thread t; ForkJoinWorkerThread wt; ForkJoinPool.WorkQueue w;
341 dl 1.64 return (s = status) < 0 ? s :
342     ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
343     (w = (wt = (ForkJoinWorkerThread)t).workQueue).
344     tryUnpush(this) && (s = doExec()) < 0 ? s :
345     wt.pool.awaitJoin(w, this) :
346     externalAwaitDone();
347 jsr166 1.1 }
348    
349     /**
350 dl 1.54 * Implementation for invoke, quietlyInvoke.
351     *
352 dl 1.45 * @return status upon completion
353 jsr166 1.1 */
354 dl 1.45 private int doInvoke() {
355 dl 1.59 int s; Thread t; ForkJoinWorkerThread wt;
356 dl 1.64 return (s = doExec()) < 0 ? s :
357     ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
358     (wt = (ForkJoinWorkerThread)t).pool.awaitJoin(wt.workQueue, this) :
359     externalAwaitDone();
360 dl 1.45 }
361    
362     // Exception table support
363    
364     /**
365     * Table of exceptions thrown by tasks, to enable reporting by
366     * callers. Because exceptions are rare, we don't directly keep
367     * them with task objects, but instead use a weak ref table. Note
368     * that cancellation exceptions don't appear in the table, but are
369     * instead recorded as status values.
370     *
371     * Note: These statics are initialized below in static block.
372     */
373     private static final ExceptionNode[] exceptionTable;
374     private static final ReentrantLock exceptionTableLock;
375     private static final ReferenceQueue<Object> exceptionTableRefQueue;
376    
377     /**
378     * Fixed capacity for exceptionTable.
379     */
380     private static final int EXCEPTION_MAP_CAPACITY = 32;
381    
382     /**
383     * Key-value nodes for exception table. The chained hash table
384     * uses identity comparisons, full locking, and weak references
385     * for keys. The table has a fixed capacity because it only
386     * maintains task exceptions long enough for joiners to access
387     * them, so should never become very large for sustained
388     * periods. However, since we do not know when the last joiner
389     * completes, we must use weak references and expunge them. We do
390     * so on each operation (hence full locking). Also, some thread in
391 dl 1.47 * any ForkJoinPool will call helpExpungeStaleExceptions when its
392     * pool becomes isQuiescent.
393 dl 1.45 */
394 jsr166 1.58 static final class ExceptionNode extends WeakReference<ForkJoinTask<?>> {
395 dl 1.45 final Throwable ex;
396     ExceptionNode next;
397 dl 1.47 final long thrower; // use id not ref to avoid weak cycles
398 dl 1.45 ExceptionNode(ForkJoinTask<?> task, Throwable ex, ExceptionNode next) {
399     super(task, exceptionTableRefQueue);
400     this.ex = ex;
401     this.next = next;
402     this.thrower = Thread.currentThread().getId();
403     }
404     }
405    
406     /**
407 dl 1.63 * Records exception and sets status.
408 dl 1.45 *
409     * @return status on exit
410     */
411 dl 1.63 final int recordExceptionalCompletion(Throwable ex) {
412 dl 1.62 int s;
413     if ((s = status) >= 0) {
414     int h = System.identityHashCode(this);
415     final ReentrantLock lock = exceptionTableLock;
416     lock.lock();
417     try {
418     expungeStaleExceptions();
419     ExceptionNode[] t = exceptionTable;
420     int i = h & (t.length - 1);
421     for (ExceptionNode e = t[i]; ; e = e.next) {
422     if (e == null) {
423     t[i] = new ExceptionNode(this, ex, t[i]);
424     break;
425     }
426     if (e.get() == this) // already present
427     break;
428 dl 1.45 }
429 dl 1.62 } finally {
430     lock.unlock();
431 dl 1.45 }
432 dl 1.62 s = setCompletion(EXCEPTIONAL);
433 dl 1.45 }
434 dl 1.62 return s;
435     }
436    
437     /**
438 jsr166 1.70 * Records exception and possibly propagates.
439 dl 1.63 *
440     * @return status on exit
441     */
442     private int setExceptionalCompletion(Throwable ex) {
443     int s = recordExceptionalCompletion(ex);
444     if ((s & DONE_MASK) == EXCEPTIONAL)
445     internalPropagateException(ex);
446     return s;
447     }
448    
449     /**
450     * Hook for exception propagation support for tasks with completers.
451 dl 1.62 */
452 dl 1.63 void internalPropagateException(Throwable ex) {
453 dl 1.45 }
454    
455     /**
456 dl 1.54 * Cancels, ignoring any exceptions thrown by cancel. Used during
457     * worker and pool shutdown. Cancel is spec'ed not to throw any
458     * exceptions, but if it does anyway, we have no recourse during
459     * shutdown, so guard against this case.
460     */
461     static final void cancelIgnoringExceptions(ForkJoinTask<?> t) {
462     if (t != null && t.status >= 0) {
463     try {
464     t.cancel(false);
465     } catch (Throwable ignore) {
466     }
467     }
468     }
469    
470     /**
471 jsr166 1.72 * Removes exception node and clears status.
472 dl 1.45 */
473     private void clearExceptionalCompletion() {
474     int h = System.identityHashCode(this);
475 dl 1.47 final ReentrantLock lock = exceptionTableLock;
476 dl 1.45 lock.lock();
477     try {
478     ExceptionNode[] t = exceptionTable;
479     int i = h & (t.length - 1);
480     ExceptionNode e = t[i];
481     ExceptionNode pred = null;
482     while (e != null) {
483     ExceptionNode next = e.next;
484     if (e.get() == this) {
485     if (pred == null)
486     t[i] = next;
487     else
488     pred.next = next;
489     break;
490     }
491     pred = e;
492     e = next;
493     }
494     expungeStaleExceptions();
495     status = 0;
496     } finally {
497     lock.unlock();
498     }
499     }
500    
501     /**
502     * Returns a rethrowable exception for the given task, if
503     * available. To provide accurate stack traces, if the exception
504     * was not thrown by the current thread, we try to create a new
505     * exception of the same type as the one thrown, but with the
506     * recorded exception as its cause. If there is no such
507     * constructor, we instead try to use a no-arg constructor,
508     * followed by initCause, to the same effect. If none of these
509     * apply, or any fail due to other exceptions, we return the
510     * recorded exception, which is still correct, although it may
511     * contain a misleading stack trace.
512     *
513     * @return the exception, or null if none
514     */
515     private Throwable getThrowableException() {
516 dl 1.59 if ((status & DONE_MASK) != EXCEPTIONAL)
517 dl 1.45 return null;
518     int h = System.identityHashCode(this);
519     ExceptionNode e;
520 dl 1.47 final ReentrantLock lock = exceptionTableLock;
521 dl 1.45 lock.lock();
522     try {
523     expungeStaleExceptions();
524     ExceptionNode[] t = exceptionTable;
525     e = t[h & (t.length - 1)];
526     while (e != null && e.get() != this)
527     e = e.next;
528     } finally {
529     lock.unlock();
530     }
531     Throwable ex;
532     if (e == null || (ex = e.ex) == null)
533     return null;
534 dl 1.62 if (false && e.thrower != Thread.currentThread().getId()) {
535 jsr166 1.49 Class<? extends Throwable> ec = ex.getClass();
536 dl 1.45 try {
537     Constructor<?> noArgCtor = null;
538     Constructor<?>[] cs = ec.getConstructors();// public ctors only
539     for (int i = 0; i < cs.length; ++i) {
540     Constructor<?> c = cs[i];
541     Class<?>[] ps = c.getParameterTypes();
542     if (ps.length == 0)
543     noArgCtor = c;
544     else if (ps.length == 1 && ps[0] == Throwable.class)
545     return (Throwable)(c.newInstance(ex));
546     }
547     if (noArgCtor != null) {
548     Throwable wx = (Throwable)(noArgCtor.newInstance());
549     wx.initCause(ex);
550     return wx;
551     }
552     } catch (Exception ignore) {
553     }
554     }
555     return ex;
556     }
557    
558     /**
559     * Poll stale refs and remove them. Call only while holding lock.
560     */
561     private static void expungeStaleExceptions() {
562     for (Object x; (x = exceptionTableRefQueue.poll()) != null;) {
563     if (x instanceof ExceptionNode) {
564     ForkJoinTask<?> key = ((ExceptionNode)x).get();
565     ExceptionNode[] t = exceptionTable;
566     int i = System.identityHashCode(key) & (t.length - 1);
567     ExceptionNode e = t[i];
568     ExceptionNode pred = null;
569     while (e != null) {
570     ExceptionNode next = e.next;
571     if (e == x) {
572     if (pred == null)
573     t[i] = next;
574     else
575     pred.next = next;
576     break;
577     }
578     pred = e;
579     e = next;
580     }
581     }
582     }
583     }
584    
585     /**
586 dl 1.47 * If lock is available, poll stale refs and remove them.
587 dl 1.45 * Called from ForkJoinPool when pools become quiescent.
588     */
589     static final void helpExpungeStaleExceptions() {
590 dl 1.47 final ReentrantLock lock = exceptionTableLock;
591 dl 1.45 if (lock.tryLock()) {
592     try {
593     expungeStaleExceptions();
594     } finally {
595     lock.unlock();
596     }
597 jsr166 1.1 }
598 dl 1.45 }
599    
600     /**
601 dl 1.65 * A version of "sneaky throw" to relay exceptions
602     */
603     static void rethrow(final Throwable ex) {
604     if (ex != null) {
605     if (ex instanceof Error)
606     throw (Error)ex;
607     if (ex instanceof RuntimeException)
608     throw (RuntimeException)ex;
609 dl 1.71 ForkJoinTask.<RuntimeException>uncheckedThrow(ex);
610 dl 1.65 }
611     }
612    
613     /**
614     * The sneaky part of sneaky throw, relying on generics
615     * limitations to evade compiler complaints about rethrowing
616     * unchecked exceptions
617     */
618     @SuppressWarnings("unchecked") static <T extends Throwable>
619 dl 1.71 void uncheckedThrow(Throwable t) throws T {
620     if (t != null)
621     throw (T)t; // rely on vacuous cast
622 dl 1.65 }
623    
624     /**
625 dl 1.59 * Throws exception, if any, associated with the given status.
626 dl 1.45 */
627 dl 1.59 private void reportException(int s) {
628 dl 1.65 if (s == CANCELLED)
629     throw new CancellationException();
630     if (s == EXCEPTIONAL)
631     rethrow(getThrowableException());
632 jsr166 1.1 }
633    
634     // public methods
635    
636     /**
637 dl 1.64 * Arranges to asynchronously execute this task in the pool the
638     * current task is running in, if applicable, or using the {@link
639 dl 1.67 * ForkJoinPool#commonPool()} if not {@link #inForkJoinPool}. While
640 dl 1.64 * it is not necessarily enforced, it is a usage error to fork a
641     * task more than once unless it has completed and been
642     * reinitialized. Subsequent modifications to the state of this
643     * task or any data it operates on are not necessarily
644     * consistently observable by any thread other than the one
645     * executing it unless preceded by a call to {@link #join} or
646     * related methods, or a call to {@link #isDone} returning {@code
647     * true}.
648 jsr166 1.2 *
649 jsr166 1.6 * @return {@code this}, to simplify usage
650 jsr166 1.1 */
651 jsr166 1.2 public final ForkJoinTask<V> fork() {
652 dl 1.64 Thread t;
653     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
654     ((ForkJoinWorkerThread)t).workQueue.push(this);
655     else
656 dl 1.71 ForkJoinPool.common.externalPush(this);
657 jsr166 1.2 return this;
658 jsr166 1.1 }
659    
660     /**
661 dl 1.38 * Returns the result of the computation when it {@link #isDone is
662     * done}. This method differs from {@link #get()} in that
663 jsr166 1.6 * abnormal completion results in {@code RuntimeException} or
664 dl 1.38 * {@code Error}, not {@code ExecutionException}, and that
665     * interrupts of the calling thread do <em>not</em> cause the
666     * method to abruptly return by throwing {@code
667     * InterruptedException}.
668 jsr166 1.1 *
669     * @return the computed result
670     */
671     public final V join() {
672 dl 1.59 int s;
673     if ((s = doJoin() & DONE_MASK) != NORMAL)
674     reportException(s);
675     return getRawResult();
676 jsr166 1.1 }
677    
678     /**
679     * Commences performing this task, awaits its completion if
680 jsr166 1.21 * necessary, and returns its result, or throws an (unchecked)
681 dl 1.20 * {@code RuntimeException} or {@code Error} if the underlying
682     * computation did so.
683 jsr166 1.1 *
684     * @return the computed result
685     */
686     public final V invoke() {
687 dl 1.59 int s;
688     if ((s = doInvoke() & DONE_MASK) != NORMAL)
689     reportException(s);
690     return getRawResult();
691 jsr166 1.1 }
692    
693     /**
694 jsr166 1.8 * Forks the given tasks, returning when {@code isDone} holds for
695     * each task or an (unchecked) exception is encountered, in which
696 dl 1.20 * case the exception is rethrown. If more than one task
697     * encounters an exception, then this method throws any one of
698     * these exceptions. If any task encounters an exception, the
699     * other may be cancelled. However, the execution status of
700     * individual tasks is not guaranteed upon exceptional return. The
701     * status of each task may be obtained using {@link
702     * #getException()} and related methods to check if they have been
703     * cancelled, completed normally or exceptionally, or left
704     * unprocessed.
705 jsr166 1.6 *
706     * @param t1 the first task
707     * @param t2 the second task
708     * @throws NullPointerException if any task is null
709 jsr166 1.1 */
710 jsr166 1.6 public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
711 dl 1.59 int s1, s2;
712 jsr166 1.1 t2.fork();
713 dl 1.59 if ((s1 = t1.doInvoke() & DONE_MASK) != NORMAL)
714     t1.reportException(s1);
715     if ((s2 = t2.doJoin() & DONE_MASK) != NORMAL)
716     t2.reportException(s2);
717 jsr166 1.1 }
718    
719     /**
720 jsr166 1.6 * Forks the given tasks, returning when {@code isDone} holds for
721 jsr166 1.8 * each task or an (unchecked) exception is encountered, in which
722 dl 1.20 * case the exception is rethrown. If more than one task
723     * encounters an exception, then this method throws any one of
724     * these exceptions. If any task encounters an exception, others
725     * may be cancelled. However, the execution status of individual
726     * tasks is not guaranteed upon exceptional return. The status of
727     * each task may be obtained using {@link #getException()} and
728     * related methods to check if they have been cancelled, completed
729     * normally or exceptionally, or left unprocessed.
730 jsr166 1.6 *
731     * @param tasks the tasks
732 jsr166 1.8 * @throws NullPointerException if any task is null
733 jsr166 1.1 */
734     public static void invokeAll(ForkJoinTask<?>... tasks) {
735     Throwable ex = null;
736     int last = tasks.length - 1;
737     for (int i = last; i >= 0; --i) {
738     ForkJoinTask<?> t = tasks[i];
739     if (t == null) {
740     if (ex == null)
741     ex = new NullPointerException();
742     }
743     else if (i != 0)
744     t.fork();
745 dl 1.45 else if (t.doInvoke() < NORMAL && ex == null)
746     ex = t.getException();
747 jsr166 1.1 }
748     for (int i = 1; i <= last; ++i) {
749     ForkJoinTask<?> t = tasks[i];
750     if (t != null) {
751     if (ex != null)
752     t.cancel(false);
753 jsr166 1.52 else if (t.doJoin() < NORMAL)
754 dl 1.45 ex = t.getException();
755 jsr166 1.1 }
756     }
757     if (ex != null)
758 dl 1.65 rethrow(ex);
759 jsr166 1.1 }
760    
761     /**
762 jsr166 1.7 * Forks all tasks in the specified collection, returning when
763 jsr166 1.8 * {@code isDone} holds for each task or an (unchecked) exception
764 dl 1.20 * is encountered, in which case the exception is rethrown. If
765     * more than one task encounters an exception, then this method
766     * throws any one of these exceptions. If any task encounters an
767     * exception, others may be cancelled. However, the execution
768     * status of individual tasks is not guaranteed upon exceptional
769     * return. The status of each task may be obtained using {@link
770     * #getException()} and related methods to check if they have been
771     * cancelled, completed normally or exceptionally, or left
772     * unprocessed.
773 jsr166 1.6 *
774 jsr166 1.1 * @param tasks the collection of tasks
775 jsr166 1.2 * @return the tasks argument, to simplify usage
776 jsr166 1.1 * @throws NullPointerException if tasks or any element are null
777     */
778 jsr166 1.2 public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) {
779 jsr166 1.7 if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) {
780 jsr166 1.1 invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
781 jsr166 1.2 return tasks;
782 jsr166 1.1 }
783     @SuppressWarnings("unchecked")
784     List<? extends ForkJoinTask<?>> ts =
785     (List<? extends ForkJoinTask<?>>) tasks;
786     Throwable ex = null;
787     int last = ts.size() - 1;
788     for (int i = last; i >= 0; --i) {
789     ForkJoinTask<?> t = ts.get(i);
790     if (t == null) {
791     if (ex == null)
792     ex = new NullPointerException();
793     }
794     else if (i != 0)
795     t.fork();
796 dl 1.45 else if (t.doInvoke() < NORMAL && ex == null)
797     ex = t.getException();
798 jsr166 1.1 }
799     for (int i = 1; i <= last; ++i) {
800     ForkJoinTask<?> t = ts.get(i);
801     if (t != null) {
802     if (ex != null)
803     t.cancel(false);
804 jsr166 1.52 else if (t.doJoin() < NORMAL)
805 dl 1.45 ex = t.getException();
806 jsr166 1.1 }
807     }
808     if (ex != null)
809 dl 1.65 rethrow(ex);
810 jsr166 1.2 return tasks;
811 jsr166 1.1 }
812    
813     /**
814 jsr166 1.7 * Attempts to cancel execution of this task. This attempt will
815 jsr166 1.36 * fail if the task has already completed or could not be
816     * cancelled for some other reason. If successful, and this task
817     * has not started when {@code cancel} is called, execution of
818 dl 1.38 * this task is suppressed. After this method returns
819     * successfully, unless there is an intervening call to {@link
820     * #reinitialize}, subsequent calls to {@link #isCancelled},
821     * {@link #isDone}, and {@code cancel} will return {@code true}
822     * and calls to {@link #join} and related methods will result in
823     * {@code CancellationException}.
824 jsr166 1.1 *
825     * <p>This method may be overridden in subclasses, but if so, must
826 dl 1.38 * still ensure that these properties hold. In particular, the
827     * {@code cancel} method itself must not throw exceptions.
828 jsr166 1.1 *
829 jsr166 1.6 * <p>This method is designed to be invoked by <em>other</em>
830 jsr166 1.1 * tasks. To terminate the current task, you can just return or
831     * throw an unchecked exception from its computation method, or
832 jsr166 1.4 * invoke {@link #completeExceptionally}.
833 jsr166 1.1 *
834 dl 1.38 * @param mayInterruptIfRunning this value has no effect in the
835     * default implementation because interrupts are not used to
836     * control cancellation.
837 jsr166 1.1 *
838 jsr166 1.4 * @return {@code true} if this task is now cancelled
839 jsr166 1.1 */
840     public boolean cancel(boolean mayInterruptIfRunning) {
841 dl 1.59 return (setCompletion(CANCELLED) & DONE_MASK) == CANCELLED;
842 jsr166 1.1 }
843    
844 jsr166 1.8 public final boolean isDone() {
845     return status < 0;
846     }
847    
848     public final boolean isCancelled() {
849 dl 1.59 return (status & DONE_MASK) == CANCELLED;
850 jsr166 1.8 }
851    
852     /**
853 jsr166 1.4 * Returns {@code true} if this task threw an exception or was cancelled.
854 jsr166 1.1 *
855 jsr166 1.4 * @return {@code true} if this task threw an exception or was cancelled
856 jsr166 1.1 */
857     public final boolean isCompletedAbnormally() {
858 dl 1.16 return status < NORMAL;
859 jsr166 1.1 }
860    
861     /**
862 jsr166 1.8 * Returns {@code true} if this task completed without throwing an
863     * exception and was not cancelled.
864     *
865     * @return {@code true} if this task completed without throwing an
866     * exception and was not cancelled
867     */
868     public final boolean isCompletedNormally() {
869 dl 1.59 return (status & DONE_MASK) == NORMAL;
870 jsr166 1.8 }
871    
872     /**
873 jsr166 1.1 * Returns the exception thrown by the base computation, or a
874 jsr166 1.6 * {@code CancellationException} if cancelled, or {@code null} if
875     * none or if the method has not yet completed.
876 jsr166 1.1 *
877 jsr166 1.4 * @return the exception, or {@code null} if none
878 jsr166 1.1 */
879     public final Throwable getException() {
880 dl 1.59 int s = status & DONE_MASK;
881 jsr166 1.8 return ((s >= NORMAL) ? null :
882     (s == CANCELLED) ? new CancellationException() :
883 dl 1.45 getThrowableException());
884 jsr166 1.1 }
885    
886     /**
887     * Completes this task abnormally, and if not already aborted or
888     * cancelled, causes it to throw the given exception upon
889     * {@code join} and related operations. This method may be used
890     * to induce exceptions in asynchronous tasks, or to force
891     * completion of tasks that would not otherwise complete. Its use
892 jsr166 1.6 * in other situations is discouraged. This method is
893 jsr166 1.1 * overridable, but overridden versions must invoke {@code super}
894     * implementation to maintain guarantees.
895     *
896 jsr166 1.11 * @param ex the exception to throw. If this exception is not a
897     * {@code RuntimeException} or {@code Error}, the actual exception
898     * thrown will be a {@code RuntimeException} with cause {@code ex}.
899 jsr166 1.1 */
900     public void completeExceptionally(Throwable ex) {
901 dl 1.15 setExceptionalCompletion((ex instanceof RuntimeException) ||
902     (ex instanceof Error) ? ex :
903     new RuntimeException(ex));
904 jsr166 1.1 }
905    
906     /**
907     * Completes this task, and if not already aborted or cancelled,
908 dl 1.22 * returning the given value as the result of subsequent
909     * invocations of {@code join} and related operations. This method
910     * may be used to provide results for asynchronous tasks, or to
911     * provide alternative handling for tasks that would not otherwise
912     * complete normally. Its use in other situations is
913     * discouraged. This method is overridable, but overridden
914     * versions must invoke {@code super} implementation to maintain
915     * guarantees.
916 jsr166 1.1 *
917     * @param value the result value for this task
918     */
919     public void complete(V value) {
920     try {
921     setRawResult(value);
922     } catch (Throwable rex) {
923 dl 1.15 setExceptionalCompletion(rex);
924 jsr166 1.1 return;
925     }
926 dl 1.13 setCompletion(NORMAL);
927 jsr166 1.1 }
928    
929 jsr166 1.25 /**
930 dl 1.62 * Completes this task normally without setting a value. The most
931     * recent value established by {@link #setRawResult} (or {@code
932     * null} by default) will be returned as the result of subsequent
933     * invocations of {@code join} and related operations.
934     *
935     * @since 1.8
936 dl 1.60 */
937     public final void quietlyComplete() {
938     setCompletion(NORMAL);
939     }
940    
941     /**
942 dl 1.29 * Waits if necessary for the computation to complete, and then
943     * retrieves its result.
944     *
945     * @return the computed result
946     * @throws CancellationException if the computation was cancelled
947     * @throws ExecutionException if the computation threw an
948     * exception
949     * @throws InterruptedException if the current thread is not a
950     * member of a ForkJoinPool and was interrupted while waiting
951 jsr166 1.25 */
952 jsr166 1.1 public final V get() throws InterruptedException, ExecutionException {
953 dl 1.45 int s = (Thread.currentThread() instanceof ForkJoinWorkerThread) ?
954 dl 1.59 doJoin() : externalInterruptibleAwaitDone();
955 dl 1.45 Throwable ex;
956 dl 1.59 if ((s &= DONE_MASK) == CANCELLED)
957 dl 1.45 throw new CancellationException();
958     if (s == EXCEPTIONAL && (ex = getThrowableException()) != null)
959     throw new ExecutionException(ex);
960 dl 1.15 return getRawResult();
961 jsr166 1.1 }
962 dl 1.14
963 jsr166 1.25 /**
964 dl 1.29 * Waits if necessary for at most the given time for the computation
965     * to complete, and then retrieves its result, if available.
966     *
967     * @param timeout the maximum time to wait
968     * @param unit the time unit of the timeout argument
969     * @return the computed result
970     * @throws CancellationException if the computation was cancelled
971     * @throws ExecutionException if the computation threw an
972     * exception
973     * @throws InterruptedException if the current thread is not a
974     * member of a ForkJoinPool and was interrupted while waiting
975     * @throws TimeoutException if the wait timed out
976 jsr166 1.25 */
977 jsr166 1.1 public final V get(long timeout, TimeUnit unit)
978     throws InterruptedException, ExecutionException, TimeoutException {
979 dl 1.59 if (Thread.interrupted())
980     throw new InterruptedException();
981     // Messy in part because we measure in nanosecs, but wait in millisecs
982 dl 1.69 int s; long ms;
983     long ns = unit.toNanos(timeout);
984     if ((s = status) >= 0 && ns > 0L) {
985 dl 1.59 long deadline = System.nanoTime() + ns;
986     ForkJoinPool p = null;
987     ForkJoinPool.WorkQueue w = null;
988     Thread t = Thread.currentThread();
989     if (t instanceof ForkJoinWorkerThread) {
990     ForkJoinWorkerThread wt = (ForkJoinWorkerThread)t;
991     p = wt.pool;
992     w = wt.workQueue;
993 dl 1.66 p.helpJoinOnce(w, this); // no retries on failure
994 dl 1.59 }
995 dl 1.66 else
996     ForkJoinPool.externalHelpJoin(this);
997 dl 1.59 boolean canBlock = false;
998     boolean interrupted = false;
999 dl 1.54 try {
1000     while ((s = status) >= 0) {
1001 dl 1.66 if (w != null && w.qlock < 0)
1002 dl 1.54 cancelIgnoringExceptions(this);
1003 dl 1.59 else if (!canBlock) {
1004 dl 1.66 if (p == null || p.tryCompensate())
1005 dl 1.59 canBlock = true;
1006     }
1007 dl 1.54 else {
1008 dl 1.59 if ((ms = TimeUnit.NANOSECONDS.toMillis(ns)) > 0L &&
1009 dl 1.54 U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
1010 dl 1.59 synchronized (this) {
1011     if (status >= 0) {
1012     try {
1013     wait(ms);
1014     } catch (InterruptedException ie) {
1015     if (p == null)
1016     interrupted = true;
1017     }
1018 dl 1.54 }
1019 dl 1.59 else
1020     notifyAll();
1021 dl 1.54 }
1022     }
1023 dl 1.59 if ((s = status) < 0 || interrupted ||
1024     (ns = deadline - System.nanoTime()) <= 0L)
1025 dl 1.54 break;
1026 dl 1.45 }
1027     }
1028 dl 1.54 } finally {
1029 dl 1.59 if (p != null && canBlock)
1030 dl 1.54 p.incrementActiveCount();
1031 dl 1.45 }
1032 dl 1.59 if (interrupted)
1033     throw new InterruptedException();
1034 dl 1.45 }
1035 dl 1.59 if ((s &= DONE_MASK) != NORMAL) {
1036 dl 1.15 Throwable ex;
1037 dl 1.40 if (s == CANCELLED)
1038 dl 1.15 throw new CancellationException();
1039 dl 1.45 if (s != EXCEPTIONAL)
1040     throw new TimeoutException();
1041     if ((ex = getThrowableException()) != null)
1042 dl 1.15 throw new ExecutionException(ex);
1043     }
1044     return getRawResult();
1045 jsr166 1.1 }
1046    
1047     /**
1048 dl 1.17 * Joins this task, without returning its result or throwing its
1049 jsr166 1.1 * exception. This method may be useful when processing
1050     * collections of tasks when some have been cancelled or otherwise
1051     * known to have aborted.
1052     */
1053     public final void quietlyJoin() {
1054 dl 1.45 doJoin();
1055 jsr166 1.1 }
1056    
1057     /**
1058     * Commences performing this task and awaits its completion if
1059 dl 1.17 * necessary, without returning its result or throwing its
1060 dl 1.22 * exception.
1061 jsr166 1.1 */
1062     public final void quietlyInvoke() {
1063 dl 1.45 doInvoke();
1064 jsr166 1.1 }
1065    
1066     /**
1067     * Possibly executes tasks until the pool hosting the current task
1068 jsr166 1.7 * {@link ForkJoinPool#isQuiescent is quiescent}. This method may
1069     * be of use in designs in which many tasks are forked, but none
1070     * are explicitly joined, instead executing them until all are
1071     * processed.
1072 jsr166 1.1 */
1073     public static void helpQuiesce() {
1074 dl 1.64 Thread t;
1075     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
1076     ForkJoinWorkerThread wt = (ForkJoinWorkerThread)t;
1077     wt.pool.helpQuiescePool(wt.workQueue);
1078     }
1079     else
1080 dl 1.71 ForkJoinPool.quiesceCommonPool();
1081 jsr166 1.1 }
1082    
1083     /**
1084     * Resets the internal bookkeeping state of this task, allowing a
1085     * subsequent {@code fork}. This method allows repeated reuse of
1086     * this task, but only if reuse occurs when this task has either
1087     * never been forked, or has been forked, then completed and all
1088     * outstanding joins of this task have also completed. Effects
1089 jsr166 1.6 * under any other usage conditions are not guaranteed.
1090     * This method may be useful when executing
1091 jsr166 1.1 * pre-constructed trees of subtasks in loops.
1092 jsr166 1.34 *
1093 dl 1.33 * <p>Upon completion of this method, {@code isDone()} reports
1094     * {@code false}, and {@code getException()} reports {@code
1095     * null}. However, the value returned by {@code getRawResult} is
1096     * unaffected. To clear this value, you can invoke {@code
1097     * setRawResult(null)}.
1098 jsr166 1.1 */
1099     public void reinitialize() {
1100 dl 1.59 if ((status & DONE_MASK) == EXCEPTIONAL)
1101 dl 1.45 clearExceptionalCompletion();
1102     else
1103     status = 0;
1104 jsr166 1.1 }
1105    
1106     /**
1107     * Returns the pool hosting the current task execution, or null
1108     * if this task is executing outside of any ForkJoinPool.
1109     *
1110 jsr166 1.6 * @see #inForkJoinPool
1111 jsr166 1.4 * @return the pool, or {@code null} if none
1112 jsr166 1.1 */
1113     public static ForkJoinPool getPool() {
1114     Thread t = Thread.currentThread();
1115     return (t instanceof ForkJoinWorkerThread) ?
1116     ((ForkJoinWorkerThread) t).pool : null;
1117     }
1118    
1119     /**
1120 dl 1.42 * Returns {@code true} if the current thread is a {@link
1121     * ForkJoinWorkerThread} executing as a ForkJoinPool computation.
1122 jsr166 1.1 *
1123 dl 1.42 * @return {@code true} if the current thread is a {@link
1124     * ForkJoinWorkerThread} executing as a ForkJoinPool computation,
1125     * or {@code false} otherwise
1126 jsr166 1.1 */
1127     public static boolean inForkJoinPool() {
1128     return Thread.currentThread() instanceof ForkJoinWorkerThread;
1129     }
1130    
1131     /**
1132     * Tries to unschedule this task for execution. This method will
1133 dl 1.64 * typically (but is not guaranteed to) succeed if this task is
1134     * the most recently forked task by the current thread, and has
1135     * not commenced executing in another thread. This method may be
1136     * useful when arranging alternative local processing of tasks
1137     * that could have been, but were not, stolen.
1138 jsr166 1.1 *
1139 jsr166 1.4 * @return {@code true} if unforked
1140 jsr166 1.1 */
1141     public boolean tryUnfork() {
1142 dl 1.64 Thread t;
1143 dl 1.66 return (((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1144     ((ForkJoinWorkerThread)t).workQueue.tryUnpush(this) :
1145     ForkJoinPool.tryExternalUnpush(this));
1146 jsr166 1.1 }
1147    
1148     /**
1149     * Returns an estimate of the number of tasks that have been
1150     * forked by the current worker thread but not yet executed. This
1151     * value may be useful for heuristic decisions about whether to
1152     * fork other tasks.
1153     *
1154     * @return the number of tasks
1155     */
1156     public static int getQueuedTaskCount() {
1157 dl 1.66 Thread t; ForkJoinPool.WorkQueue q;
1158     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
1159     q = ((ForkJoinWorkerThread)t).workQueue;
1160     else
1161     q = ForkJoinPool.commonSubmitterQueue();
1162     return (q == null) ? 0 : q.queueSize();
1163 jsr166 1.1 }
1164    
1165     /**
1166     * Returns an estimate of how many more locally queued tasks are
1167     * held by the current worker thread than there are other worker
1168 dl 1.64 * threads that might steal them, or zero if this thread is not
1169     * operating in a ForkJoinPool. This value may be useful for
1170 jsr166 1.1 * heuristic decisions about whether to fork other tasks. In many
1171     * usages of ForkJoinTasks, at steady state, each worker should
1172     * aim to maintain a small constant surplus (for example, 3) of
1173     * tasks, and to process computations locally if this threshold is
1174     * exceeded.
1175     *
1176     * @return the surplus number of tasks, which may be negative
1177     */
1178     public static int getSurplusQueuedTaskCount() {
1179 dl 1.66 return ForkJoinPool.getSurplusQueuedTaskCount();
1180 jsr166 1.1 }
1181    
1182     // Extension methods
1183    
1184     /**
1185 jsr166 1.4 * Returns the result that would be returned by {@link #join}, even
1186     * if this task completed abnormally, or {@code null} if this task
1187     * is not known to have been completed. This method is designed
1188     * to aid debugging, as well as to support extensions. Its use in
1189     * any other context is discouraged.
1190 jsr166 1.1 *
1191 jsr166 1.4 * @return the result, or {@code null} if not completed
1192 jsr166 1.1 */
1193     public abstract V getRawResult();
1194    
1195     /**
1196     * Forces the given value to be returned as a result. This method
1197     * is designed to support extensions, and should not in general be
1198     * called otherwise.
1199     *
1200     * @param value the value
1201     */
1202     protected abstract void setRawResult(V value);
1203    
1204     /**
1205 dl 1.62 * Immediately performs the base action of this task and returns
1206     * true if, upon return from this method, this task is guaranteed
1207     * to have completed normally. This method may return false
1208     * otherwise, to indicate that this task is not necessarily
1209     * complete (or is not known to be complete), for example in
1210 jsr166 1.1 * asynchronous actions that require explicit invocations of
1211 dl 1.62 * completion methods. This method may also throw an (unchecked)
1212     * exception to indicate abnormal exit. This method is designed to
1213     * support extensions, and should not in general be called
1214     * otherwise.
1215 jsr166 1.1 *
1216 dl 1.62 * @return {@code true} if this task is known to have completed normally
1217 jsr166 1.1 */
1218     protected abstract boolean exec();
1219    
1220     /**
1221 jsr166 1.5 * Returns, but does not unschedule or execute, a task queued by
1222     * the current thread but not yet executed, if one is immediately
1223 dl 1.66 * available. There is no guarantee that this task will actually
1224     * be polled or executed next. Conversely, this method may return
1225     * null even if a task exists but cannot be accessed without
1226     * contention with other threads. This method is designed
1227 jsr166 1.5 * primarily to support extensions, and is unlikely to be useful
1228 jsr166 1.6 * otherwise.
1229     *
1230 jsr166 1.4 * @return the next task, or {@code null} if none are available
1231 jsr166 1.1 */
1232     protected static ForkJoinTask<?> peekNextLocalTask() {
1233 dl 1.66 Thread t; ForkJoinPool.WorkQueue q;
1234     if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
1235     q = ((ForkJoinWorkerThread)t).workQueue;
1236     else
1237     q = ForkJoinPool.commonSubmitterQueue();
1238     return (q == null) ? null : q.peek();
1239 jsr166 1.1 }
1240    
1241     /**
1242     * Unschedules and returns, without executing, the next task
1243 dl 1.64 * queued by the current thread but not yet executed, if the
1244     * current thread is operating in a ForkJoinPool. This method is
1245     * designed primarily to support extensions, and is unlikely to be
1246     * useful otherwise.
1247 jsr166 1.1 *
1248 jsr166 1.4 * @return the next task, or {@code null} if none are available
1249 jsr166 1.1 */
1250     protected static ForkJoinTask<?> pollNextLocalTask() {
1251 dl 1.64 Thread t;
1252     return ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1253     ((ForkJoinWorkerThread)t).workQueue.nextLocalTask() :
1254     null;
1255 jsr166 1.1 }
1256    
1257     /**
1258 dl 1.64 * If the current thread is operating in a ForkJoinPool,
1259     * unschedules and returns, without executing, the next task
1260 jsr166 1.1 * queued by the current thread but not yet executed, if one is
1261     * available, or if not available, a task that was forked by some
1262     * other thread, if available. Availability may be transient, so a
1263 dl 1.64 * {@code null} result does not necessarily imply quiescence of
1264     * the pool this task is operating in. This method is designed
1265 jsr166 1.1 * primarily to support extensions, and is unlikely to be useful
1266 jsr166 1.6 * otherwise.
1267     *
1268 jsr166 1.4 * @return a task, or {@code null} if none are available
1269 jsr166 1.1 */
1270     protected static ForkJoinTask<?> pollTask() {
1271 dl 1.64 Thread t; ForkJoinWorkerThread wt;
1272     return ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1273     (wt = (ForkJoinWorkerThread)t).pool.nextTaskFor(wt.workQueue) :
1274     null;
1275 dl 1.54 }
1276    
1277 dl 1.60 // tag operations
1278 dl 1.54
1279     /**
1280 dl 1.60 * Returns the tag for this task.
1281 dl 1.54 *
1282 dl 1.60 * @return the tag for this task
1283 dl 1.54 * @since 1.8
1284     */
1285 dl 1.60 public final short getForkJoinTaskTag() {
1286     return (short)status;
1287 dl 1.54 }
1288    
1289     /**
1290 dl 1.60 * Atomically sets the tag value for this task.
1291 dl 1.54 *
1292 dl 1.60 * @param tag the tag value
1293     * @return the previous value of the tag
1294 dl 1.54 * @since 1.8
1295     */
1296 dl 1.60 public final short setForkJoinTaskTag(short tag) {
1297 dl 1.54 for (int s;;) {
1298 dl 1.60 if (U.compareAndSwapInt(this, STATUS, s = status,
1299     (s & ~SMASK) | (tag & SMASK)))
1300     return (short)s;
1301 dl 1.54 }
1302     }
1303    
1304     /**
1305 dl 1.60 * Atomically conditionally sets the tag value for this task.
1306     * Among other applications, tags can be used as visit markers
1307 dl 1.61 * in tasks operating on graphs, as in methods that check: {@code
1308 dl 1.60 * if (task.compareAndSetForkJoinTaskTag((short)0, (short)1))}
1309     * before processing, otherwise exiting because the node has
1310     * already been visited.
1311 dl 1.54 *
1312 dl 1.60 * @param e the expected tag value
1313     * @param tag the new tag value
1314     * @return true if successful; i.e., the current value was
1315     * equal to e and is now tag.
1316 dl 1.54 * @since 1.8
1317     */
1318 dl 1.60 public final boolean compareAndSetForkJoinTaskTag(short e, short tag) {
1319 dl 1.54 for (int s;;) {
1320 dl 1.60 if ((short)(s = status) != e)
1321 dl 1.54 return false;
1322 dl 1.60 if (U.compareAndSwapInt(this, STATUS, s,
1323     (s & ~SMASK) | (tag & SMASK)))
1324 dl 1.54 return true;
1325     }
1326 jsr166 1.1 }
1327    
1328 jsr166 1.5 /**
1329     * Adaptor for Runnables. This implements RunnableFuture
1330     * to be compliant with AbstractExecutorService constraints
1331     * when used in ForkJoinPool.
1332     */
1333     static final class AdaptedRunnable<T> extends ForkJoinTask<T>
1334     implements RunnableFuture<T> {
1335     final Runnable runnable;
1336     T result;
1337     AdaptedRunnable(Runnable runnable, T result) {
1338     if (runnable == null) throw new NullPointerException();
1339     this.runnable = runnable;
1340 dl 1.59 this.result = result; // OK to set this even before completion
1341 jsr166 1.5 }
1342 dl 1.59 public final T getRawResult() { return result; }
1343     public final void setRawResult(T v) { result = v; }
1344     public final boolean exec() { runnable.run(); return true; }
1345     public final void run() { invoke(); }
1346     private static final long serialVersionUID = 5232453952276885070L;
1347     }
1348    
1349     /**
1350     * Adaptor for Runnables without results
1351     */
1352     static final class AdaptedRunnableAction extends ForkJoinTask<Void>
1353     implements RunnableFuture<Void> {
1354     final Runnable runnable;
1355     AdaptedRunnableAction(Runnable runnable) {
1356     if (runnable == null) throw new NullPointerException();
1357     this.runnable = runnable;
1358 jsr166 1.5 }
1359 dl 1.59 public final Void getRawResult() { return null; }
1360     public final void setRawResult(Void v) { }
1361     public final boolean exec() { runnable.run(); return true; }
1362     public final void run() { invoke(); }
1363 jsr166 1.5 private static final long serialVersionUID = 5232453952276885070L;
1364     }
1365    
1366     /**
1367 dl 1.73 * Adaptor for Runnables in which failure forces worker exception
1368     */
1369     static final class RunnableExecuteAction extends ForkJoinTask<Void> {
1370     final Runnable runnable;
1371     RunnableExecuteAction(Runnable runnable) {
1372     if (runnable == null) throw new NullPointerException();
1373     this.runnable = runnable;
1374     }
1375     public final Void getRawResult() { return null; }
1376     public final void setRawResult(Void v) { }
1377     public final boolean exec() { runnable.run(); return true; }
1378     void internalPropagateException(Throwable ex) {
1379     rethrow(ex); // rethrow outside exec() catches.
1380     }
1381     private static final long serialVersionUID = 5232453952276885070L;
1382     }
1383    
1384     /**
1385 jsr166 1.5 * Adaptor for Callables
1386     */
1387     static final class AdaptedCallable<T> extends ForkJoinTask<T>
1388     implements RunnableFuture<T> {
1389 jsr166 1.6 final Callable<? extends T> callable;
1390 jsr166 1.5 T result;
1391 jsr166 1.6 AdaptedCallable(Callable<? extends T> callable) {
1392 jsr166 1.5 if (callable == null) throw new NullPointerException();
1393     this.callable = callable;
1394     }
1395 dl 1.59 public final T getRawResult() { return result; }
1396     public final void setRawResult(T v) { result = v; }
1397     public final boolean exec() {
1398 jsr166 1.5 try {
1399     result = callable.call();
1400     return true;
1401     } catch (Error err) {
1402     throw err;
1403     } catch (RuntimeException rex) {
1404     throw rex;
1405     } catch (Exception ex) {
1406     throw new RuntimeException(ex);
1407     }
1408     }
1409 dl 1.59 public final void run() { invoke(); }
1410 jsr166 1.5 private static final long serialVersionUID = 2838392045355241008L;
1411     }
1412 jsr166 1.2
1413     /**
1414 jsr166 1.6 * Returns a new {@code ForkJoinTask} that performs the {@code run}
1415     * method of the given {@code Runnable} as its action, and returns
1416     * a null result upon {@link #join}.
1417 jsr166 1.2 *
1418     * @param runnable the runnable action
1419     * @return the task
1420     */
1421 jsr166 1.6 public static ForkJoinTask<?> adapt(Runnable runnable) {
1422 dl 1.59 return new AdaptedRunnableAction(runnable);
1423 jsr166 1.2 }
1424    
1425     /**
1426 jsr166 1.6 * Returns a new {@code ForkJoinTask} that performs the {@code run}
1427     * method of the given {@code Runnable} as its action, and returns
1428     * the given result upon {@link #join}.
1429 jsr166 1.2 *
1430     * @param runnable the runnable action
1431     * @param result the result upon completion
1432     * @return the task
1433     */
1434     public static <T> ForkJoinTask<T> adapt(Runnable runnable, T result) {
1435 jsr166 1.5 return new AdaptedRunnable<T>(runnable, result);
1436 jsr166 1.2 }
1437    
1438     /**
1439 jsr166 1.6 * Returns a new {@code ForkJoinTask} that performs the {@code call}
1440     * method of the given {@code Callable} as its action, and returns
1441     * its result upon {@link #join}, translating any checked exceptions
1442     * encountered into {@code RuntimeException}.
1443 jsr166 1.2 *
1444     * @param callable the callable action
1445     * @return the task
1446     */
1447 jsr166 1.6 public static <T> ForkJoinTask<T> adapt(Callable<? extends T> callable) {
1448 jsr166 1.5 return new AdaptedCallable<T>(callable);
1449 jsr166 1.2 }
1450    
1451 jsr166 1.1 // Serialization support
1452    
1453     private static final long serialVersionUID = -7721805057305804111L;
1454    
1455     /**
1456 jsr166 1.53 * Saves this task to a stream (that is, serializes it).
1457 jsr166 1.1 *
1458     * @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.1 */
1470     private void readObject(java.io.ObjectInputStream s)
1471     throws java.io.IOException, ClassNotFoundException {
1472     s.defaultReadObject();
1473     Object ex = s.readObject();
1474     if (ex != null)
1475 dl 1.45 setExceptionalCompletion((Throwable)ex);
1476 jsr166 1.1 }
1477    
1478 jsr166 1.3 // Unsafe mechanics
1479 dl 1.54 private static final sun.misc.Unsafe U;
1480     private static final long STATUS;
1481 dl 1.66
1482 dl 1.45 static {
1483     exceptionTableLock = new ReentrantLock();
1484     exceptionTableRefQueue = new ReferenceQueue<Object>();
1485     exceptionTable = new ExceptionNode[EXCEPTION_MAP_CAPACITY];
1486 jsr166 1.1 try {
1487 dl 1.54 U = sun.misc.Unsafe.getUnsafe();
1488 dl 1.66 Class<?> k = ForkJoinTask.class;
1489 dl 1.54 STATUS = U.objectFieldOffset
1490 dl 1.66 (k.getDeclaredField("status"));
1491 dl 1.45 } catch (Exception e) {
1492     throw new Error(e);
1493 jsr166 1.1 }
1494     }
1495 dl 1.45
1496 jsr166 1.1 }