ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/jsr166y/ForkJoinTask.java

Comparing jsr166/src/jsr166y/ForkJoinTask.java (file contents):
Revision 1.20 by jsr166, Sun Jul 26 05:55:34 2009 UTC vs.
Revision 1.53 by dl, Wed Aug 11 18:45:12 2010 UTC

#	Line 12 | Line 12 | import java.io.Serializable;
12		import java.util.Collection;
13		import java.util.Collections;
14		import java.util.List;
15	+	import java.util.RandomAccess;
16		import java.util.Map;
17		import java.util.WeakHashMap;
18
19		/**
20	<	* Abstract base class for tasks that run within a {@link
21	<	* ForkJoinPool}.  A ForkJoinTask is a thread-like entity that is much
20	>	* Abstract base class for tasks that run within a {@link ForkJoinPool}.
21	>	* A {@code ForkJoinTask} is a thread-like entity that is much
22		* lighter weight than a normal thread.  Huge numbers of tasks and
23		* subtasks may be hosted by a small number of actual threads in a
24		* ForkJoinPool, at the price of some usage limitations.
25		*
26	<	* <p> A "main" ForkJoinTask begins execution when submitted to a
27	<	* {@link ForkJoinPool}. Once started, it will usually in turn start
28	<	* other subtasks.  As indicated by the name of this class, many
29	<	* programs using ForkJoinTasks employ only methods {@code fork}
30	<	* and {@code join}, or derivatives such as
31	<	* {@code invokeAll}.  However, this class also provides a number
32	<	* of other methods that can come into play in advanced usages, as
33	<	* well as extension mechanics that allow support of new forms of
34	<	* fork/join processing.
26	>	* <p>A "main" {@code ForkJoinTask} begins execution when submitted
27	>	* to a {@link ForkJoinPool}.  Once started, it will usually in turn
28	>	* start other subtasks.  As indicated by the name of this class,
29	>	* many programs using {@code ForkJoinTask} employ only methods
30	>	* {@link #fork} and {@link #join}, or derivatives such as {@link
31	>	* #invokeAll}.  However, this class also provides a number of other
32	>	* methods that can come into play in advanced usages, as well as
33	>	* extension mechanics that allow support of new forms of fork/join
34	>	* processing.
35		*
36	<	* <p>A ForkJoinTask is a lightweight form of {@link Future}.  The
37	<	* efficiency of ForkJoinTasks stems from a set of restrictions (that
38	<	* are only partially statically enforceable) reflecting their
39	<	* intended use as computational tasks calculating pure functions or
40	<	* operating on purely isolated objects.  The primary coordination
41	<	* mechanisms are {@link #fork}, that arranges asynchronous execution,
42	<	* and {@link #join}, that doesn't proceed until the task's result has
43	<	* been computed.  Computations should avoid {@code synchronized}
44	<	* methods or blocks, and should minimize other blocking
45	<	* synchronization apart from joining other tasks or using
46	<	* synchronizers such as Phasers that are advertised to cooperate with
47	<	* fork/join scheduling. Tasks should also not perform blocking IO,
48	<	* and should ideally access variables that are completely independent
49	<	* of those accessed by other running tasks. Minor breaches of these
50	<	* restrictions, for example using shared output streams, may be
51	<	* tolerable in practice, but frequent use may result in poor
52	<	* performance, and the potential to indefinitely stall if the number
53	<	* of threads not waiting for IO or other external synchronization
54	<	* becomes exhausted. This usage restriction is in part enforced by
55	<	* not permitting checked exceptions such as {@code IOExceptions}
56	<	* to be thrown. However, computations may still encounter unchecked
57	<	* exceptions, that are rethrown to callers attempting join
58	<	* them. These exceptions may additionally include
59	<	* RejectedExecutionExceptions stemming from internal resource
60	<	* exhaustion such as failure to allocate internal task queues.
36	>	* <p>A {@code ForkJoinTask} is a lightweight form of {@link Future}.
37	>	* The efficiency of {@code ForkJoinTask}s stems from a set of
38	>	* restrictions (that are only partially statically enforceable)
39	>	* reflecting their intended use as computational tasks calculating
40	>	* pure functions or operating on purely isolated objects.  The
41	>	* primary coordination mechanisms are {@link #fork}, that arranges
42	>	* asynchronous execution, and {@link #join}, that doesn't proceed
43	>	* until the task's result has been computed.  Computations should
44	>	* avoid {@code synchronized} methods or blocks, and should minimize
45	>	* other blocking synchronization apart from joining other tasks or
46	>	* using synchronizers such as Phasers that are advertised to
47	>	* cooperate with fork/join scheduling. Tasks should also not perform
48	>	* blocking IO, and should ideally access variables that are
49	>	* completely independent of those accessed by other running
50	>	* tasks. Minor breaches of these restrictions, for example using
51	>	* shared output streams, may be tolerable in practice, but frequent
52	>	* use may result in poor performance, and the potential to
53	>	* indefinitely stall if the number of threads not waiting for IO or
54	>	* other external synchronization becomes exhausted. This usage
55	>	* restriction is in part enforced by not permitting checked
56	>	* exceptions such as {@code IOExceptions} to be thrown. However,
57	>	* computations may still encounter unchecked exceptions, that are
58	>	* rethrown to callers attempting to join them. These exceptions may
59	>	* additionally include {@link RejectedExecutionException} stemming
60	>	* from internal resource exhaustion, such as failure to allocate
61	>	* internal task queues.
62		*
63		* <p>The primary method for awaiting completion and extracting
64		* results of a task is {@link #join}, but there are several variants:
65		* The {@link Future#get} methods support interruptible and/or timed
66		* waits for completion and report results using {@code Future}
67	<	* conventions. Method {@link #helpJoin} enables callers to actively
68	<	* execute other tasks while awaiting joins, which is sometimes more
69	<	* efficient but only applies when all subtasks are known to be
70	<	* strictly tree-structured. Method {@link #invoke} is semantically
69	<	* equivalent to {@code fork(); join()} but always attempts to
70	<	* begin execution in the current thread. The "<em>quiet</em>" forms
71	<	* of these methods do not extract results or report exceptions. These
67	>	* conventions. Method {@link #invoke} is semantically
68	>	* equivalent to {@code fork(); join()} but always attempts to begin
69	>	* execution in the current thread. The "<em>quiet</em>" forms of
70	>	* these methods do not extract results or report exceptions. These
71		* may be useful when a set of tasks are being executed, and you need
72		* to delay processing of results or exceptions until all complete.
73		* Method {@code invokeAll} (available in multiple versions)
74		* performs the most common form of parallel invocation: forking a set
75		* of tasks and joining them all.
76		*
77	<	* <p> The ForkJoinTask class is not usually directly subclassed.
77	>	* <p>The execution status of tasks may be queried at several levels
78	>	* of detail: {@link #isDone} is true if a task completed in any way
79	>	* (including the case where a task was cancelled without executing);
80	>	* {@link #isCompletedNormally} is true if a task completed without
81	>	* cancellation or encountering an exception; {@link #isCancelled} is
82	>	* true if the task was cancelled (in which case {@link #getException}
83	>	* returns a {@link java.util.concurrent.CancellationException}); and
84	>	* {@link #isCompletedAbnormally} is true if a task was either
85	>	* cancelled or encountered an exception, in which case {@link
86	>	* #getException} will return either the encountered exception or
87	>	* {@link java.util.concurrent.CancellationException}.
88	>	*
89	>	* <p>The ForkJoinTask class is not usually directly subclassed.
90		* Instead, you subclass one of the abstract classes that support a
91	<	* particular style of fork/join processing.  Normally, a concrete
91	>	* particular style of fork/join processing, typically {@link
92	>	* RecursiveAction} for computations that do not return results, or
93	>	* {@link RecursiveTask} for those that do.  Normally, a concrete
94		* ForkJoinTask subclass declares fields comprising its parameters,
95		* established in a constructor, and then defines a {@code compute}
96		* method that somehow uses the control methods supplied by this base
97		* class. While these methods have {@code public} access (to allow
98	<	* instances of different task subclasses to call each others
98	>	* instances of different task subclasses to call each other's
99		* methods), some of them may only be called from within other
100		* ForkJoinTasks (as may be determined using method {@link
101		* #inForkJoinPool}).  Attempts to invoke them in other contexts
102		* result in exceptions or errors, possibly including
103		* ClassCastException.
104		*
105	<	* <p>Most base support methods are {@code final} because their
106	<	* implementations are intrinsically tied to the underlying
107	<	* lightweight task scheduling framework, and so cannot be overridden.
108	<	* Developers creating new basic styles of fork/join processing should
109	<	* minimally implement {@code protected} methods
110	<	* {@code exec}, {@code setRawResult}, and
111	<	* {@code getRawResult}, while also introducing an abstract
112	<	* computational method that can be implemented in its subclasses,
113	<	* possibly relying on other {@code protected} methods provided
101	<	* by this class.
105	>	* <p>Most base support methods are {@code final}, to prevent
106	>	* overriding of implementations that are intrinsically tied to the
107	>	* underlying lightweight task scheduling framework.  Developers
108	>	* creating new basic styles of fork/join processing should minimally
109	>	* implement {@code protected} methods {@link #exec}, {@link
110	>	* #setRawResult}, and {@link #getRawResult}, while also introducing
111	>	* an abstract computational method that can be implemented in its
112	>	* subclasses, possibly relying on other {@code protected} methods
113	>	* provided by this class.
114		*
115		* <p>ForkJoinTasks should perform relatively small amounts of
116	<	* computations, otherwise splitting into smaller tasks. As a very
117	<	* rough rule of thumb, a task should perform more than 100 and less
118	<	* than 10000 basic computational steps. If tasks are too big, then
119	<	* parallelism cannot improve throughput. If too small, then memory
120	<	* and internal task maintenance overhead may overwhelm processing.
116	>	* computation. Large tasks should be split into smaller subtasks,
117	>	* usually via recursive decomposition. As a very rough rule of thumb,
118	>	* a task should perform more than 100 and less than 10000 basic
119	>	* computational steps. If tasks are too big, then parallelism cannot
120	>	* improve throughput. If too small, then memory and internal task
121	>	* maintenance overhead may overwhelm processing.
122	>	*
123	>	* <p>This class provides {@code adapt} methods for {@link Runnable}
124	>	* and {@link Callable}, that may be of use when mixing execution of
125	>	* {@code ForkJoinTasks} with other kinds of tasks. When all tasks are
126	>	* of this form, consider using a pool constructed in <em>asyncMode</em>.
127		*
128	<	* <p>ForkJoinTasks are {@code Serializable}, which enables them
129	<	* to be used in extensions such as remote execution frameworks. It is
130	<	* in general sensible to serialize tasks only before or after, but
131	<	* not during execution. Serialization is not relied on during
114	<	* execution itself.
128	>	* <p>ForkJoinTasks are {@code Serializable}, which enables them to be
129	>	* used in extensions such as remote execution frameworks. It is
130	>	* sensible to serialize tasks only before or after, but not during,
131	>	* execution. Serialization is not relied on during execution itself.
132		*
133		* @since 1.7
134		* @author Doug Lea
135		*/
136		public abstract class ForkJoinTask<V> implements Future<V>, Serializable {
137
138	<	/**
139	<	* Run control status bits packed into a single int to minimize
140	<	* footprint and to ensure atomicity (via CAS).  Status is
141	<	* initially zero, and takes on nonnegative values until
142	<	* completed, upon which status holds COMPLETED. CANCELLED, or
143	<	* EXCEPTIONAL, which use the top 3 bits.  Tasks undergoing
144	<	* blocking waits by other threads have SIGNAL_MASK bits set --
145	<	* bit 15 for external (nonFJ) waits, and the rest a count of
146	<	* waiting FJ threads.  (This representation relies on
147	<	* ForkJoinPool max thread limits). Completion of a stolen task
148	<	* with SIGNAL_MASK bits set awakens waiter via notifyAll. Even
149	<	* though suboptimal for some purposes, we use basic builtin
150	<	* wait/notify to take advantage of "monitor inflation" in JVMs
151	<	* that we would otherwise need to emulate to avoid adding further
152	<	* per-task bookkeeping overhead. Note that bits 16-28 are
153	<	* currently unused. Also value 0x80000000 is available as spare
154	<	* completion value.
138	>	/*
139	>	* See the internal documentation of class ForkJoinPool for a
140	>	* general implementation overview.  ForkJoinTasks are mainly
141	>	* responsible for maintaining their "status" field amidst relays
142	>	* to methods in ForkJoinWorkerThread and ForkJoinPool. The
143	>	* methods of this class are more-or-less layered into (1) basic
144	>	* status maintenance (2) execution and awaiting completion (3)
145	>	* user-level methods that additionally report results. This is
146	>	* sometimes hard to see because this file orders exported methods
147	>	* in a way that flows well in javadocs. In particular, most
148	>	* join mechanics are in method quietlyJoin, below.
149	>	*/
150	>
151	>	/*
152	>	* The status field holds run control status bits packed into a
153	>	* single int to minimize footprint and to ensure atomicity (via
154	>	* CAS).  Status is initially zero, and takes on nonnegative
155	>	* values until completed, upon which status holds value
156	>	* COMPLETED. CANCELLED, or EXCEPTIONAL. Tasks undergoing blocking
157	>	* waits by other threads have the SIGNAL bit set.  Completion of
158	>	* a stolen task with SIGNAL set awakens any waiters via
159	>	* notifyAll. Even though suboptimal for some purposes, we use
160	>	* basic builtin wait/notify to take advantage of "monitor
161	>	* inflation" in JVMs that we would otherwise need to emulate to
162	>	* avoid adding further per-task bookkeeping overhead.  We want
163	>	* these monitors to be "fat", i.e., not use biasing or thin-lock
164	>	* techniques, so use some odd coding idioms that tend to avoid
165	>	* them.
166		*/
167	+
168	+	/** The run status of this task */
169		volatile int status; // accessed directly by pool and workers
170
171	<	static final int COMPLETION_MASK      = 0xe0000000;
172	<	static final int NORMAL               = 0xe0000000; // == mask
173	<	static final int CANCELLED            = 0xc0000000;
174	<	static final int EXCEPTIONAL          = 0xa0000000;
145	<	static final int SIGNAL_MASK          = 0x0000ffff;
146	<	static final int INTERNAL_SIGNAL_MASK = 0x00007fff;
147	<	static final int EXTERNAL_SIGNAL      = 0x00008000; // top bit of low word
171	>	private static final int NORMAL      = -1;
172	>	private static final int CANCELLED   = -2;
173	>	private static final int EXCEPTIONAL = -3;
174	>	private static final int SIGNAL      =  1;
175
176		/**
177		* Table of exceptions thrown by tasks, to enable reporting by
#	Line 158 | Line 185 | public abstract class ForkJoinTask<V> im
185		Collections.synchronizedMap
186		(new WeakHashMap<ForkJoinTask<?>, Throwable>());
187
188	<	// within-package utilities
162	<
163	<	/**
164	<	* Gets current worker thread, or null if not a worker thread.
165	<	*/
166	<	static ForkJoinWorkerThread getWorker() {
167	<	Thread t = Thread.currentThread();
168	<	return ((t instanceof ForkJoinWorkerThread) ?
169	<	(ForkJoinWorkerThread) t : null);
170	<	}
171	<
172	<	final boolean casStatus(int cmp, int val) {
173	<	return UNSAFE.compareAndSwapInt(this, statusOffset, cmp, val);
174	<	}
175	<
176	<	/**
177	<	* Workaround for not being able to rethrow unchecked exceptions.
178	<	*/
179	<	static void rethrowException(Throwable ex) {
180	<	if (ex != null)
181	<	UNSAFE.throwException(ex);
182	<	}
183	<
184	<	// Setting completion status
188	>	// Maintaining completion status
189
190		/**
191	<	* Marks completion and wakes up threads waiting to join this task.
191	>	* Marks completion and wakes up threads waiting to join this task,
192	>	* also clearing signal request bits.
193		*
194		* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
195		*/
196	<	final void setCompletion(int completion) {
197	<	ForkJoinPool pool = getPool();
198	<	if (pool != null) {
199	<	int s; // Clear signal bits while setting completion status
200	<	do {} while ((s = status) >= 0 && !casStatus(s, completion));
201	<
202	<	if ((s & SIGNAL_MASK) != 0) {
198	<	if ((s &= INTERNAL_SIGNAL_MASK) != 0)
199	<	pool.updateRunningCount(s);
200	<	synchronized (this) { notifyAll(); }
196	>	private void setCompletion(int completion) {
197	>	int s;
198	>	while ((s = status) >= 0) {
199	>	if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) {
200	>	if (s != 0)
201	>	synchronized (this) { notifyAll(); }
202	>	break;
203		}
204		}
203	–	else
204	–	externallySetCompletion(completion);
205	–	}
206	–
207	–	/**
208	–	* Version of setCompletion for non-FJ threads.  Leaves signal
209	–	* bits for unblocked threads to adjust, and always notifies.
210	–	*/
211	–	private void externallySetCompletion(int completion) {
212	–	int s;
213	–	do {} while ((s = status) >= 0 &&
214	–	!casStatus(s, (s & SIGNAL_MASK) | completion));
215	–	synchronized (this) { notifyAll(); }
205		}
206
207		/**
208	<	* Sets status to indicate normal completion.
208	>	* Record exception and set exceptional completion
209	>	* @return status on exit
210		*/
211	<	final void setNormalCompletion() {
212	<	// Try typical fast case -- single CAS, no signal, not already done.
213	<	// Manually expand casStatus to improve chances of inlining it
224	<	if (!UNSAFE.compareAndSwapInt(this, statusOffset, 0, NORMAL))
225	<	setCompletion(NORMAL);
226	<	}
227	<
228	<	// internal waiting and notification
229	<
230	<	/**
231	<	* Performs the actual monitor wait for awaitDone.
232	<	*/
233	<	private void doAwaitDone() {
234	<	// Minimize lock bias and in/de-flation effects by maximizing
235	<	// chances of waiting inside sync
236	<	try {
237	<	while (status >= 0)
238	<	synchronized (this) { if (status >= 0) wait(); }
239	<	} catch (InterruptedException ie) {
240	<	onInterruptedWait();
241	<	}
211	>	private void setExceptionalCompletion(Throwable rex) {
212	>	exceptionMap.put(this, rex);
213	>	setCompletion(EXCEPTIONAL);
214		}
215
216		/**
217	<	* Performs the actual timed monitor wait for awaitDone.
217	>	* Blocks a worker thread until completion. Called only by pool.
218		*/
219	<	private void doAwaitDone(long startTime, long nanos) {
220	<	synchronized (this) {
219	>	final void internalAwaitDone() {
220	>	int s;         // the odd construction reduces lock bias effects
221	>	while ((s = status) >= 0) {
222		try {
223	<	while (status >= 0) {
224	<	long nt = nanos - System.nanoTime() - startTime;
225	<	if (nt <= 0)
253	<	break;
254	<	wait(nt / 1000000, (int) (nt % 1000000));
223	>	synchronized(this) {
224	>	if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL))
225	>	wait();
226		}
227		} catch (InterruptedException ie) {
228	<	onInterruptedWait();
258	<	}
259	<	}
260	<	}
261	<
262	<	// Awaiting completion
263	<
264	<	/**
265	<	* Sets status to indicate there is joiner, then waits for join,
266	<	* surrounded with pool notifications.
267	<	*
268	<	* @return status upon exit
269	<	*/
270	<	private int awaitDone(ForkJoinWorkerThread w,
271	<	boolean maintainParallelism) {
272	<	ForkJoinPool pool = (w == null) ? null : w.pool;
273	<	int s;
274	<	while ((s = status) >= 0) {
275	<	if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
276	<	if (pool == null || !pool.preJoin(this, maintainParallelism))
277	<	doAwaitDone();
278	<	if (((s = status) & INTERNAL_SIGNAL_MASK) != 0)
279	<	adjustPoolCountsOnUnblock(pool);
280	<	break;
228	>	cancelIfTerminating();
229		}
230		}
283	–	return s;
231		}
232
233		/**
234	<	* Timed version of awaitDone
288	<	*
289	<	* @return status upon exit
234	>	* Blocks a non-worker-thread until completion.
235		*/
236	<	private int awaitDone(ForkJoinWorkerThread w, long nanos) {
292	<	ForkJoinPool pool = (w == null) ? null : w.pool;
236	>	private void externalAwaitDone() {
237		int s;
238		while ((s = status) >= 0) {
239	<	if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
240	<	long startTime = System.nanoTime();
241	<	if (pool == null || !pool.preJoin(this, false))
242	<	doAwaitDone(startTime, nanos);
243	<	if ((s = status) >= 0) {
244	<	adjustPoolCountsOnCancelledWait(pool);
245	<	s = status;
246	<	}
247	<	if (s < 0 && (s & INTERNAL_SIGNAL_MASK) != 0)
248	<	adjustPoolCountsOnUnblock(pool);
249	<	break;
250	<	}
307	<	}
308	<	return s;
309	<	}
310	<
311	<	/**
312	<	* Notifies pool that thread is unblocked. Called by signalled
313	<	* threads when woken by non-FJ threads (which is atypical).
314	<	*/
315	<	private void adjustPoolCountsOnUnblock(ForkJoinPool pool) {
316	<	int s;
317	<	do {} while ((s = status) < 0 && !casStatus(s, s & COMPLETION_MASK));
318	<	if (pool != null && (s &= INTERNAL_SIGNAL_MASK) != 0)
319	<	pool.updateRunningCount(s);
320	<	}
321	<
322	<	/**
323	<	* Notifies pool to adjust counts on cancelled or timed out wait.
324	<	*/
325	<	private void adjustPoolCountsOnCancelledWait(ForkJoinPool pool) {
326	<	if (pool != null) {
327	<	int s;
328	<	while ((s = status) >= 0 && (s & INTERNAL_SIGNAL_MASK) != 0) {
329	<	if (casStatus(s, s - 1)) {
330	<	pool.updateRunningCount(1);
239	>	synchronized(this) {
240	>	if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)){
241	>	boolean interrupted = false;
242	>	while (status >= 0) {
243	>	try {
244	>	wait();
245	>	} catch (InterruptedException ie) {
246	>	interrupted = true;
247	>	}
248	>	}
249	>	if (interrupted)
250	>	Thread.currentThread().interrupt();
251		break;
252		}
253		}
#	Line 335 | Line 255 | public abstract class ForkJoinTask<V> im
255		}
256
257		/**
258	<	* Handles interruptions during waits.
259	<	*/
260	<	private void onInterruptedWait() {
341	<	ForkJoinWorkerThread w = getWorker();
342	<	if (w == null)
343	<	Thread.currentThread().interrupt(); // re-interrupt
344	<	else if (w.isTerminating())
345	<	cancelIgnoringExceptions();
346	<	// else if FJworker, ignore interrupt
347	<	}
348	<
349	<	// Recording and reporting exceptions
350	<
351	<	private void setDoneExceptionally(Throwable rex) {
352	<	exceptionMap.put(this, rex);
353	<	setCompletion(EXCEPTIONAL);
354	<	}
355	<
356	<	/**
357	<	* Throws the exception associated with status s.
358	<	*
359	<	* @throws the exception
360	<	*/
361	<	private void reportException(int s) {
362	<	if ((s &= COMPLETION_MASK) < NORMAL) {
363	<	if (s == CANCELLED)
364	<	throw new CancellationException();
365	<	else
366	<	rethrowException(exceptionMap.get(this));
367	<	}
368	<	}
369	<
370	<	/**
371	<	* Returns result or throws exception using j.u.c.Future conventions.
372	<	* Only call when {@code isDone} known to be true.
373	<	*/
374	<	private V reportFutureResult()
375	<	throws ExecutionException, InterruptedException {
376	<	int s = status & COMPLETION_MASK;
377	<	if (s < NORMAL) {
378	<	Throwable ex;
379	<	if (s == CANCELLED)
380	<	throw new CancellationException();
381	<	if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
382	<	throw new ExecutionException(ex);
383	<	if (Thread.interrupted())
384	<	throw new InterruptedException();
385	<	}
386	<	return getRawResult();
387	<	}
388	<
389	<	/**
390	<	* Returns result or throws exception using j.u.c.Future conventions
391	<	* with timeouts.
392	<	*/
393	<	private V reportTimedFutureResult()
394	<	throws InterruptedException, ExecutionException, TimeoutException {
395	<	Throwable ex;
396	<	int s = status & COMPLETION_MASK;
397	<	if (s == NORMAL)
398	<	return getRawResult();
399	<	if (s == CANCELLED)
400	<	throw new CancellationException();
401	<	if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
402	<	throw new ExecutionException(ex);
403	<	if (Thread.interrupted())
404	<	throw new InterruptedException();
405	<	throw new TimeoutException();
406	<	}
407	<
408	<	// internal execution methods
409	<
410	<	/**
411	<	* Calls exec, recording completion, and rethrowing exception if
412	<	* encountered. Caller should normally check status before calling.
413	<	*
414	<	* @return true if completed normally
415	<	*/
416	<	private boolean tryExec() {
417	<	try { // try block must contain only call to exec
418	<	if (!exec())
419	<	return false;
420	<	} catch (Throwable rex) {
421	<	setDoneExceptionally(rex);
422	<	rethrowException(rex);
423	<	return false; // not reached
424	<	}
425	<	setNormalCompletion();
426	<	return true;
427	<	}
428	<
429	<	/**
430	<	* Main execution method used by worker threads. Invokes
431	<	* base computation unless already complete.
258	>	* Unless done, calls exec and records status if completed, but
259	>	* doesn't wait for completion otherwise. Primary execution method
260	>	* for ForkJoinWorkerThread.
261		*/
262		final void quietlyExec() {
434	–	if (status >= 0) {
435	–	try {
436	–	if (!exec())
437	–	return;
438	–	} catch (Throwable rex) {
439	–	setDoneExceptionally(rex);
440	–	return;
441	–	}
442	–	setNormalCompletion();
443	–	}
444	–	}
445	–
446	–	/**
447	–	* Calls exec(), recording but not rethrowing exception.
448	–	* Caller should normally check status before calling.
449	–	*
450	–	* @return true if completed normally
451	–	*/
452	–	private boolean tryQuietlyInvoke() {
263		try {
264	<	if (!exec())
265	<	return false;
264	>	if (status < 0 || !exec())
265	>	return;
266		} catch (Throwable rex) {
267	<	setDoneExceptionally(rex);
268	<	return false;
459	<	}
460	<	setNormalCompletion();
461	<	return true;
462	<	}
463	<
464	<	/**
465	<	* Cancels, ignoring any exceptions it throws.
466	<	*/
467	<	final void cancelIgnoringExceptions() {
468	<	try {
469	<	cancel(false);
470	<	} catch (Throwable ignore) {
267	>	setExceptionalCompletion(rex);
268	>	return;
269		}
270	<	}
473	<
474	<	/**
475	<	* Main implementation of helpJoin
476	<	*/
477	<	private int busyJoin(ForkJoinWorkerThread w) {
478	<	int s;
479	<	ForkJoinTask<?> t;
480	<	while ((s = status) >= 0 && (t = w.scanWhileJoining(this)) != null)
481	<	t.quietlyExec();
482	<	return (s >= 0) ? awaitDone(w, false) : s; // block if no work
270	>	setCompletion(NORMAL); // must be outside try block
271		}
272
273		// public methods
#	Line 487 | Line 275 | public abstract class ForkJoinTask<V> im
275		/**
276		* Arranges to asynchronously execute this task.  While it is not
277		* necessarily enforced, it is a usage error to fork a task more
278	<	* than once unless it has completed and been reinitialized.  This
279	<	* method may be invoked only from within ForkJoinTask
280	<	* computations (as may be determined using method {@link
281	<	* #inForkJoinPool}). Attempts to invoke in other contexts result
282	<	* in exceptions or errors, possibly including ClassCastException.
278	>	* than once unless it has completed and been reinitialized.
279	>	* Subsequent modifications to the state of this task or any data
280	>	* it operates on are not necessarily consistently observable by
281	>	* any thread other than the one executing it unless preceded by a
282	>	* call to {@link #join} or related methods, or a call to {@link
283	>	* #isDone} returning {@code true}.
284	>	*
285	>	* <p>This method may be invoked only from within {@code
286	>	* ForkJoinTask} computations (as may be determined using method
287	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
288	>	* result in exceptions or errors, possibly including {@code
289	>	* ClassCastException}.
290		*
291	<	* @return <code>this</code>, to simplify usage.
291	>	* @return {@code this}, to simplify usage
292		*/
293		public final ForkJoinTask<V> fork() {
294		((ForkJoinWorkerThread) Thread.currentThread())
#	Line 502 | Line 297 | public abstract class ForkJoinTask<V> im
297		}
298
299		/**
300	<	* Returns the result of the computation when it is ready.
301	<	* This method differs from {@code get} in that abnormal
302	<	* completion results in RuntimeExceptions or Errors, not
303	<	* ExecutionExceptions.
300	>	* Returns the result of the computation when it {@link #isDone is done}.
301	>	* This method differs from {@link #get()} in that
302	>	* abnormal completion results in {@code RuntimeException} or
303	>	* {@code Error}, not {@code ExecutionException}.
304		*
305		* @return the computed result
306		*/
307		public final V join() {
308	<	ForkJoinWorkerThread w = getWorker();
309	<	if (w == null || status < 0 || !w.unpushTask(this) || !tryExec())
310	<	reportException(awaitDone(w, true));
308	>	quietlyJoin();
309	>	Throwable ex;
310	>	if (status < NORMAL && (ex = getException()) != null)
311	>	UNSAFE.throwException(ex);
312		return getRawResult();
313		}
314
315		/**
316		* Commences performing this task, awaits its completion if
317	<	* necessary, and return its result.
317	>	* necessary, and return its result, or throws an (unchecked)
318	>	* exception if the underlying computation did so.
319		*
523	–	* @throws Throwable (a RuntimeException, Error, or unchecked
524	–	* exception) if the underlying computation did so
320		* @return the computed result
321		*/
322		public final V invoke() {
323	<	if (status >= 0 && tryExec())
324	<	return getRawResult();
325	<	else
326	<	return join();
323	>	quietlyInvoke();
324	>	Throwable ex;
325	>	if (status < NORMAL && (ex = getException()) != null)
326	>	UNSAFE.throwException(ex);
327	>	return getRawResult();
328		}
329
330		/**
331	<	* Forks both tasks, returning when {@code isDone} holds for
332	<	* both of them or an exception is encountered. This method may be
333	<	* invoked only from within ForkJoinTask computations (as may be
334	<	* determined using method {@link #inForkJoinPool}). Attempts to
335	<	* invoke in other contexts result in exceptions or errors,
336	<	* possibly including ClassCastException.
337	<	*
338	<	* @param t1 one task
339	<	* @param t2 the other task
340	<	* @throws NullPointerException if t1 or t2 are null
341	<	* @throws RuntimeException or Error if either task did so
331	>	* Forks the given tasks, returning when {@code isDone} holds for
332	>	* each task or an (unchecked) exception is encountered, in which
333	>	* case the exception is rethrown.  If either task encounters an
334	>	* exception, the other one may be, but is not guaranteed to be,
335	>	* cancelled.  If both tasks throw an exception, then this method
336	>	* throws one of them.  The individual status of each task may be
337	>	* checked using {@link #getException()} and related methods.
338	>	*
339	>	* <p>This method may be invoked only from within {@code
340	>	* ForkJoinTask} computations (as may be determined using method
341	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
342	>	* result in exceptions or errors, possibly including {@code
343	>	* ClassCastException}.
344	>	*
345	>	* @param t1 the first task
346	>	* @param t2 the second task
347	>	* @throws NullPointerException if any task is null
348		*/
349	<	public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) {
349	>	public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
350		t2.fork();
351		t1.invoke();
352		t2.join();
353		}
354
355		/**
356	<	* Forks the given tasks, returning when {@code isDone} holds
357	<	* for all of them. If any task encounters an exception, others
358	<	* may be cancelled.  This method may be invoked only from within
359	<	* ForkJoinTask computations (as may be determined using method
360	<	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
361	<	* result in exceptions or errors, possibly including
362	<	* ClassCastException.
356	>	* Forks the given tasks, returning when {@code isDone} holds for
357	>	* each task or an (unchecked) exception is encountered, in which
358	>	* case the exception is rethrown. If any task encounters an
359	>	* exception, others may be, but are not guaranteed to be,
360	>	* cancelled.  If more than one task encounters an exception, then
361	>	* this method throws any one of these exceptions.  The individual
362	>	* status of each task may be checked using {@link #getException()}
363	>	* and related methods.
364	>	*
365	>	* <p>This method may be invoked only from within {@code
366	>	* ForkJoinTask} computations (as may be determined using method
367	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
368	>	* result in exceptions or errors, possibly including {@code
369	>	* ClassCastException}.
370		*
371	<	* @param tasks the array of tasks
372	<	* @throws NullPointerException if tasks or any element are null
564	<	* @throws RuntimeException or Error if any task did so
371	>	* @param tasks the tasks
372	>	* @throws NullPointerException if any task is null
373		*/
374		public static void invokeAll(ForkJoinTask<?>... tasks) {
375		Throwable ex = null;
#	Line 576 | Line 384 | public abstract class ForkJoinTask<V> im
384		t.fork();
385		else {
386		t.quietlyInvoke();
387	<	if (ex == null)
387	>	if (ex == null && t.status < NORMAL)
388		ex = t.getException();
389		}
390		}
#	Line 587 | Line 395 | public abstract class ForkJoinTask<V> im
395		t.cancel(false);
396		else {
397		t.quietlyJoin();
398	<	if (ex == null)
398	>	if (ex == null && t.status < NORMAL)
399		ex = t.getException();
400		}
401		}
402		}
403		if (ex != null)
404	<	rethrowException(ex);
404	>	UNSAFE.throwException(ex);
405		}
406
407		/**
408	<	* Forks all tasks in the collection, returning when
409	<	* {@code isDone} holds for all of them. If any task
410	<	* encounters an exception, others may be cancelled.  This method
411	<	* may be invoked only from within ForkJoinTask computations (as
412	<	* may be determined using method {@link
413	<	* #inForkJoinPool}). Attempts to invoke in other contexts result
414	<	* in exceptions or errors, possibly including ClassCastException.
408	>	* Forks all tasks in the specified collection, returning when
409	>	* {@code isDone} holds for each task or an (unchecked) exception
410	>	* is encountered.  If any task encounters an exception, others
411	>	* may be, but are not guaranteed to be, cancelled.  If more than
412	>	* one task encounters an exception, then this method throws any
413	>	* one of these exceptions.  The individual status of each task
414	>	* may be checked using {@link #getException()} and related
415	>	* methods.  The behavior of this operation is undefined if the
416	>	* specified collection is modified while the operation is in
417	>	* progress.
418	>	*
419	>	* <p>This method may be invoked only from within {@code
420	>	* ForkJoinTask} computations (as may be determined using method
421	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
422	>	* result in exceptions or errors, possibly including {@code
423	>	* ClassCastException}.
424		*
425		* @param tasks the collection of tasks
426		* @return the tasks argument, to simplify usage
427		* @throws NullPointerException if tasks or any element are null
611	–	* @throws RuntimeException or Error if any task did so
428		*/
429		public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) {
430	<	if (!(tasks instanceof List<?>)) {
430	>	if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) {
431		invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
432		return tasks;
433		}
#	Line 630 | Line 446 | public abstract class ForkJoinTask<V> im
446		t.fork();
447		else {
448		t.quietlyInvoke();
449	<	if (ex == null)
449	>	if (ex == null && t.status < NORMAL)
450		ex = t.getException();
451		}
452		}
#	Line 641 | Line 457 | public abstract class ForkJoinTask<V> im
457		t.cancel(false);
458		else {
459		t.quietlyJoin();
460	<	if (ex == null)
460	>	if (ex == null && t.status < NORMAL)
461		ex = t.getException();
462		}
463		}
464		}
465		if (ex != null)
466	<	rethrowException(ex);
466	>	UNSAFE.throwException(ex);
467		return tasks;
468		}
469
470		/**
471	<	* Returns true if the computation performed by this task has
472	<	* completed (or has been cancelled).
473	<	*
474	<	* @return true if this computation has completed
475	<	*/
476	<	public final boolean isDone() {
477	<	return status < 0;
662	<	}
663	<
664	<	/**
665	<	* Returns true if this task was cancelled.
666	<	*
667	<	* @return true if this task was cancelled
668	<	*/
669	<	public final boolean isCancelled() {
670	<	return (status & COMPLETION_MASK) == CANCELLED;
671	<	}
672	<
673	<	/**
674	<	* Asserts that the results of this task's computation will not be
675	<	* used. If a cancellation occurs before attempting to execute this
676	<	* task, then execution will be suppressed, {@code isCancelled}
677	<	* will report true, and {@code join} will result in a
678	<	* {@code CancellationException} being thrown. Otherwise, when
679	<	* cancellation races with completion, there are no guarantees
680	<	* about whether {@code isCancelled} will report true, whether
681	<	* {@code join} will return normally or via an exception, or
682	<	* whether these behaviors will remain consistent upon repeated
683	<	* invocation.
471	>	* Attempts to cancel execution of this task. This attempt will
472	>	* fail if the task has already completed, has already been
473	>	* cancelled, or could not be cancelled for some other reason. If
474	>	* successful, and this task has not started when cancel is
475	>	* called, execution of this task is suppressed, {@link
476	>	* #isCancelled} will report true, and {@link #join} will result
477	>	* in a {@code CancellationException} being thrown.
478		*
479		* <p>This method may be overridden in subclasses, but if so, must
480		* still ensure that these minimal properties hold. In particular,
481	<	* the cancel method itself must not throw exceptions.
481	>	* the {@code cancel} method itself must not throw exceptions.
482		*
483	<	* <p> This method is designed to be invoked by <em>other</em>
483	>	* <p>This method is designed to be invoked by <em>other</em>
484		* tasks. To terminate the current task, you can just return or
485		* throw an unchecked exception from its computation method, or
486	<	* invoke {@code completeExceptionally}.
486	>	* invoke {@link #completeExceptionally}.
487		*
488		* @param mayInterruptIfRunning this value is ignored in the
489	<	* default implementation because tasks are not in general
489	>	* default implementation because tasks are not
490		* cancelled via interruption
491		*
492	<	* @return true if this task is now cancelled
492	>	* @return {@code true} if this task is now cancelled
493		*/
494		public boolean cancel(boolean mayInterruptIfRunning) {
495		setCompletion(CANCELLED);
496	<	return (status & COMPLETION_MASK) == CANCELLED;
496	>	return status == CANCELLED;
497	>	}
498	>
499	>	/**
500	>	* Cancels, ignoring any exceptions thrown by cancel. Used during
501	>	* worker and pool shutdown. Cancel is spec'ed not to throw any
502	>	* exceptions, but if it does anyway, we have no recourse during
503	>	* shutdown, so guard against this case.
504	>	*/
505	>	final void cancelIgnoringExceptions() {
506	>	try {
507	>	cancel(false);
508	>	} catch (Throwable ignore) {
509	>	}
510	>	}
511	>
512	>	/**
513	>	* Cancels ignoring exceptions if worker is terminating
514	>	*/
515	>	final void cancelIfTerminating() {
516	>	Thread t = Thread.currentThread();
517	>	if ((t instanceof ForkJoinWorkerThread) &&
518	>	((ForkJoinWorkerThread) t).isTerminating()) {
519	>	try {
520	>	cancel(false);
521	>	} catch (Throwable ignore) {
522	>	}
523	>	}
524	>	}
525	>
526	>	public final boolean isDone() {
527	>	return status < 0;
528	>	}
529	>
530	>	public final boolean isCancelled() {
531	>	return status == CANCELLED;
532		}
533
534		/**
535	<	* Returns true if this task threw an exception or was cancelled.
535	>	* Returns {@code true} if this task threw an exception or was cancelled.
536		*
537	<	* @return true if this task threw an exception or was cancelled
537	>	* @return {@code true} if this task threw an exception or was cancelled
538		*/
539		public final boolean isCompletedAbnormally() {
540	<	return (status & COMPLETION_MASK) < NORMAL;
540	>	return status < NORMAL;
541	>	}
542	>
543	>	/**
544	>	* Returns {@code true} if this task completed without throwing an
545	>	* exception and was not cancelled.
546	>	*
547	>	* @return {@code true} if this task completed without throwing an
548	>	* exception and was not cancelled
549	>	*/
550	>	public final boolean isCompletedNormally() {
551	>	return status == NORMAL;
552		}
553
554		/**
555		* Returns the exception thrown by the base computation, or a
556	<	* CancellationException if cancelled, or null if none or if the
557	<	* method has not yet completed.
556	>	* {@code CancellationException} if cancelled, or {@code null} if
557	>	* none or if the method has not yet completed.
558		*
559	<	* @return the exception, or null if none
559	>	* @return the exception, or {@code null} if none
560		*/
561		public final Throwable getException() {
562	<	int s = status & COMPLETION_MASK;
563	<	if (s >= NORMAL)
564	<	return null;
565	<	if (s == CANCELLED)
726	<	return new CancellationException();
727	<	return exceptionMap.get(this);
562	>	int s = status;
563	>	return ((s >= NORMAL)    ? null :
564	>	(s == CANCELLED) ? new CancellationException() :
565	>	exceptionMap.get(this));
566		}
567
568		/**
#	Line 733 | Line 571 | public abstract class ForkJoinTask<V> im
571		* {@code join} and related operations. This method may be used
572		* to induce exceptions in asynchronous tasks, or to force
573		* completion of tasks that would not otherwise complete.  Its use
574	<	* in other situations is likely to be wrong.  This method is
574	>	* in other situations is discouraged.  This method is
575		* overridable, but overridden versions must invoke {@code super}
576		* implementation to maintain guarantees.
577		*
578	<	* @param ex the exception to throw. If this exception is
579	<	* not a RuntimeException or Error, the actual exception thrown
580	<	* will be a RuntimeException with cause ex.
578	>	* @param ex the exception to throw. If this exception is not a
579	>	* {@code RuntimeException} or {@code Error}, the actual exception
580	>	* thrown will be a {@code RuntimeException} with cause {@code ex}.
581		*/
582		public void completeExceptionally(Throwable ex) {
583	<	setDoneExceptionally((ex instanceof RuntimeException) ||
584	<	(ex instanceof Error) ? ex :
585	<	new RuntimeException(ex));
583	>	setExceptionalCompletion((ex instanceof RuntimeException) ||
584	>	(ex instanceof Error) ? ex :
585	>	new RuntimeException(ex));
586		}
587
588		/**
#	Line 753 | Line 591 | public abstract class ForkJoinTask<V> im
591		* operations. This method may be used to provide results for
592		* asynchronous tasks, or to provide alternative handling for
593		* tasks that would not otherwise complete normally. Its use in
594	<	* other situations is likely to be wrong. This method is
594	>	* other situations is discouraged. This method is
595		* overridable, but overridden versions must invoke {@code super}
596		* implementation to maintain guarantees.
597		*
#	Line 763 | Line 601 | public abstract class ForkJoinTask<V> im
601		try {
602		setRawResult(value);
603		} catch (Throwable rex) {
604	<	setDoneExceptionally(rex);
604	>	setExceptionalCompletion(rex);
605		return;
606		}
607	<	setNormalCompletion();
607	>	setCompletion(NORMAL);
608		}
609
610		public final V get() throws InterruptedException, ExecutionException {
611	<	ForkJoinWorkerThread w = getWorker();
612	<	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
613	<	awaitDone(w, true);
614	<	return reportFutureResult();
611	>	quietlyJoin();
612	>	if (Thread.interrupted())
613	>	throw new InterruptedException();
614	>	int s = status;
615	>	if (s < NORMAL) {
616	>	Throwable ex;
617	>	if (s == CANCELLED)
618	>	throw new CancellationException();
619	>	if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
620	>	throw new ExecutionException(ex);
621	>	}
622	>	return getRawResult();
623		}
624
625		public final V get(long timeout, TimeUnit unit)
626		throws InterruptedException, ExecutionException, TimeoutException {
627	<	ForkJoinWorkerThread w = getWorker();
628	<	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
629	<	awaitDone(w, unit.toNanos(timeout));
630	<	return reportTimedFutureResult();
631	<	}
632	<
633	<	/**
634	<	* Possibly executes other tasks until this task is ready, then
635	<	* returns the result of the computation.  This method may be more
636	<	* efficient than {@code join}, but is only applicable when
637	<	* there are no potential dependencies between continuation of the
638	<	* current task and that of any other task that might be executed
639	<	* while helping. (This usually holds for pure divide-and-conquer
640	<	* tasks). This method may be invoked only from within
641	<	* ForkJoinTask computations (as may be determined using method
642	<	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
643	<	* result in exceptions or errors, possibly including
644	<	* ClassCastException.
645	<	*
646	<	* @return the computed result
647	<	*/
648	<	public final V helpJoin() {
649	<	ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
650	<	if (status < 0 || !w.unpushTask(this) || !tryExec())
651	<	reportException(busyJoin(w));
652	<	return getRawResult();
653	<	}
654	<
655	<	/**
656	<	* Possibly executes other tasks until this task is ready.  This
657	<	* method may be invoked only from within ForkJoinTask
658	<	* computations (as may be determined using method {@link
659	<	* #inForkJoinPool}). Attempts to invoke in other contexts result
660	<	* in exceptions or errors, possibly including ClassCastException.
661	<	*/
662	<	public final void quietlyHelpJoin() {
663	<	if (status >= 0) {
664	<	ForkJoinWorkerThread w =
665	<	(ForkJoinWorkerThread) Thread.currentThread();
666	<	if (!w.unpushTask(this) || !tryQuietlyInvoke())
667	<	busyJoin(w);
627	>	Thread t = Thread.currentThread();
628	>	ForkJoinPool pool;
629	>	if (t instanceof ForkJoinWorkerThread) {
630	>	ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
631	>	if (status >= 0 && w.unpushTask(this))
632	>	quietlyExec();
633	>	pool = w.pool;
634	>	}
635	>	else
636	>	pool = null;
637	>	/*
638	>	* Timed wait loop intermixes cases for FJ (pool != null) and
639	>	* non FJ threads. For FJ, decrement pool count but don't try
640	>	* for replacement; increment count on completion. For non-FJ,
641	>	* deal with interrupts. This is messy, but a little less so
642	>	* than is splitting the FJ and nonFJ cases.
643	>	*/
644	>	boolean interrupted = false;
645	>	boolean dec = false; // true if pool count decremented
646	>	for (;;) {
647	>	if (Thread.interrupted() && pool == null) {
648	>	interrupted = true;
649	>	break;
650	>	}
651	>	int s = status;
652	>	if (s < 0)
653	>	break;
654	>	if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)) {
655	>	long startTime = System.nanoTime();
656	>	long nanos = unit.toNanos(timeout);
657	>	long nt; // wait time
658	>	while (status >= 0 &&
659	>	(nt = nanos - (System.nanoTime() - startTime)) > 0) {
660	>	if (pool != null && !dec)
661	>	dec = pool.tryDecrementRunningCount();
662	>	else {
663	>	long ms = nt / 1000000;
664	>	int ns = (int) (nt % 1000000);
665	>	try {
666	>	synchronized(this) {
667	>	if (status >= 0)
668	>	wait(ms, ns);
669	>	}
670	>	} catch (InterruptedException ie) {
671	>	if (pool != null)
672	>	cancelIfTerminating();
673	>	else {
674	>	interrupted = true;
675	>	break;
676	>	}
677	>	}
678	>	}
679	>	}
680	>	break;
681	>	}
682		}
683	+	if (pool != null && dec)
684	+	pool.incrementRunningCount();
685	+	if (interrupted)
686	+	throw new InterruptedException();
687	+	int es = status;
688	+	if (es != NORMAL) {
689	+	Throwable ex;
690	+	if (es == CANCELLED)
691	+	throw new CancellationException();
692	+	if (es == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
693	+	throw new ExecutionException(ex);
694	+	throw new TimeoutException();
695	+	}
696	+	return getRawResult();
697		}
698
699		/**
700	<	* Joins this task, without returning its result or throwing an
700	>	* Joins this task, without returning its result or throwing its
701		* exception. This method may be useful when processing
702		* collections of tasks when some have been cancelled or otherwise
703		* known to have aborted.
704		*/
705		public final void quietlyJoin() {
706	<	if (status >= 0) {
707	<	ForkJoinWorkerThread w = getWorker();
708	<	if (w == null || !w.unpushTask(this) || !tryQuietlyInvoke())
709	<	awaitDone(w, true);
706	>	Thread t;
707	>	if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
708	>	ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
709	>	if (status >= 0) {
710	>	if (w.unpushTask(this)) {
711	>	boolean completed;
712	>	try {
713	>	completed = exec();
714	>	} catch (Throwable rex) {
715	>	setExceptionalCompletion(rex);
716	>	return;
717	>	}
718	>	if (completed) {
719	>	setCompletion(NORMAL);
720	>	return;
721	>	}
722	>	}
723	>	w.joinTask(this);
724	>	}
725		}
726	+	else
727	+	externalAwaitDone();
728		}
729
730		/**
731		* Commences performing this task and awaits its completion if
732	<	* necessary, without returning its result or throwing an
732	>	* necessary, without returning its result or throwing its
733		* exception. This method may be useful when processing
734		* collections of tasks when some have been cancelled or otherwise
735		* known to have aborted.
736		*/
737		public final void quietlyInvoke() {
738	<	if (status >= 0 && !tryQuietlyInvoke())
739	<	quietlyJoin();
738	>	if (status >= 0) {
739	>	boolean completed;
740	>	try {
741	>	completed = exec();
742	>	} catch (Throwable rex) {
743	>	setExceptionalCompletion(rex);
744	>	return;
745	>	}
746	>	if (completed)
747	>	setCompletion(NORMAL);
748	>	else
749	>	quietlyJoin();
750	>	}
751		}
752
753		/**
754		* Possibly executes tasks until the pool hosting the current task
755	<	* {@link ForkJoinPool#isQuiescent}. This method may be of use in
756	<	* designs in which many tasks are forked, but none are explicitly
757	<	* joined, instead executing them until all are processed.
755	>	* {@link ForkJoinPool#isQuiescent is quiescent}. This method may
756	>	* be of use in designs in which many tasks are forked, but none
757	>	* are explicitly joined, instead executing them until all are
758	>	* processed.
759	>	*
760	>	* <p>This method may be invoked only from within {@code
761	>	* ForkJoinTask} computations (as may be determined using method
762	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
763	>	* result in exceptions or errors, possibly including {@code
764	>	* ClassCastException}.
765		*/
766		public static void helpQuiesce() {
767		((ForkJoinWorkerThread) Thread.currentThread())
#	Line 865 | Line 774 | public abstract class ForkJoinTask<V> im
774		* this task, but only if reuse occurs when this task has either
775		* never been forked, or has been forked, then completed and all
776		* outstanding joins of this task have also completed. Effects
777	<	* under any other usage conditions are not guaranteed, and are
778	<	* almost surely wrong. This method may be useful when executing
777	>	* under any other usage conditions are not guaranteed.
778	>	* This method may be useful when executing
779		* pre-constructed trees of subtasks in loops.
780		*/
781		public void reinitialize() {
782	<	if ((status & COMPLETION_MASK) == EXCEPTIONAL)
782	>	if (status == EXCEPTIONAL)
783		exceptionMap.remove(this);
784		status = 0;
785		}
#	Line 879 | Line 788 | public abstract class ForkJoinTask<V> im
788		* Returns the pool hosting the current task execution, or null
789		* if this task is executing outside of any ForkJoinPool.
790		*
791	<	* @return the pool, or null if none
791	>	* @see #inForkJoinPool
792	>	* @return the pool, or {@code null} if none
793		*/
794		public static ForkJoinPool getPool() {
795		Thread t = Thread.currentThread();
#	Line 904 | Line 814 | public abstract class ForkJoinTask<V> im
814		* by the current thread, and has not commenced executing in
815		* another thread.  This method may be useful when arranging
816		* alternative local processing of tasks that could have been, but
817	<	* were not, stolen. This method may be invoked only from within
818	<	* ForkJoinTask computations (as may be determined using method
819	<	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
820	<	* result in exceptions or errors, possibly including
821	<	* ClassCastException.
817	>	* were not, stolen.
818	>	*
819	>	* <p>This method may be invoked only from within {@code
820	>	* ForkJoinTask} computations (as may be determined using method
821	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
822	>	* result in exceptions or errors, possibly including {@code
823	>	* ClassCastException}.
824		*
825	<	* @return true if unforked
825	>	* @return {@code true} if unforked
826		*/
827		public boolean tryUnfork() {
828		return ((ForkJoinWorkerThread) Thread.currentThread())
#	Line 923 | Line 835 | public abstract class ForkJoinTask<V> im
835		* value may be useful for heuristic decisions about whether to
836		* fork other tasks.
837		*
838	+	* <p>This method may be invoked only from within {@code
839	+	* ForkJoinTask} computations (as may be determined using method
840	+	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
841	+	* result in exceptions or errors, possibly including {@code
842	+	* ClassCastException}.
843	+	*
844		* @return the number of tasks
845		*/
846		public static int getQueuedTaskCount() {
#	Line 940 | Line 858 | public abstract class ForkJoinTask<V> im
858		* tasks, and to process computations locally if this threshold is
859		* exceeded.
860		*
861	+	* <p>This method may be invoked only from within {@code
862	+	* ForkJoinTask} computations (as may be determined using method
863	+	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
864	+	* result in exceptions or errors, possibly including {@code
865	+	* ClassCastException}.
866	+	*
867		* @return the surplus number of tasks, which may be negative
868		*/
869		public static int getSurplusQueuedTaskCount() {
#	Line 950 | Line 874 | public abstract class ForkJoinTask<V> im
874		// Extension methods
875
876		/**
877	<	* Returns the result that would be returned by {@code join},
878	<	* even if this task completed abnormally, or null if this task is
879	<	* not known to have been completed.  This method is designed to
880	<	* aid debugging, as well as to support extensions. Its use in any
881	<	* other context is discouraged.
877	>	* Returns the result that would be returned by {@link #join}, even
878	>	* if this task completed abnormally, or {@code null} if this task
879	>	* is not known to have been completed.  This method is designed
880	>	* to aid debugging, as well as to support extensions. Its use in
881	>	* any other context is discouraged.
882		*
883	<	* @return the result, or null if not completed
883	>	* @return the result, or {@code null} if not completed
884		*/
885		public abstract V getRawResult();
886
#	Line 975 | Line 899 | public abstract class ForkJoinTask<V> im
899		* called otherwise. The return value controls whether this task
900		* is considered to be done normally. It may return false in
901		* asynchronous actions that require explicit invocations of
902	<	* {@code complete} to become joinable. It may throw exceptions
903	<	* to indicate abnormal exit.
902	>	* {@link #complete} to become joinable. It may also throw an
903	>	* (unchecked) exception to indicate abnormal exit.
904		*
905	<	* @return true if completed normally
982	<	* @throws Error or RuntimeException if encountered during computation
905	>	* @return {@code true} if completed normally
906		*/
907		protected abstract boolean exec();
908
909		/**
910	<	* Returns, but does not unschedule or execute, the task queued by
911	<	* the current thread but not yet executed, if one is
910	>	* Returns, but does not unschedule or execute, a task queued by
911	>	* the current thread but not yet executed, if one is immediately
912		* available. There is no guarantee that this task will actually
913	<	* be polled or executed next.  This method is designed primarily
914	<	* to support extensions, and is unlikely to be useful otherwise.
915	<	* This method may be invoked only from within ForkJoinTask
916	<	* computations (as may be determined using method {@link
917	<	* #inForkJoinPool}). Attempts to invoke in other contexts result
918	<	* in exceptions or errors, possibly including ClassCastException.
913	>	* be polled or executed next. Conversely, this method may return
914	>	* null even if a task exists but cannot be accessed without
915	>	* contention with other threads.  This method is designed
916	>	* primarily to support extensions, and is unlikely to be useful
917	>	* otherwise.
918	>	*
919	>	* <p>This method may be invoked only from within {@code
920	>	* ForkJoinTask} computations (as may be determined using method
921	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
922	>	* result in exceptions or errors, possibly including {@code
923	>	* ClassCastException}.
924		*
925	<	* @return the next task, or null if none are available
925	>	* @return the next task, or {@code null} if none are available
926		*/
927		protected static ForkJoinTask<?> peekNextLocalTask() {
928		return ((ForkJoinWorkerThread) Thread.currentThread())
#	Line 1005 | Line 933 | public abstract class ForkJoinTask<V> im
933		* Unschedules and returns, without executing, the next task
934		* queued by the current thread but not yet executed.  This method
935		* is designed primarily to support extensions, and is unlikely to
936	<	* be useful otherwise.  This method may be invoked only from
1009	<	* within ForkJoinTask computations (as may be determined using
1010	<	* method {@link #inForkJoinPool}). Attempts to invoke in other
1011	<	* contexts result in exceptions or errors, possibly including
1012	<	* ClassCastException.
936	>	* be useful otherwise.
937		*
938	<	* @return the next task, or null if none are available
938	>	* <p>This method may be invoked only from within {@code
939	>	* ForkJoinTask} computations (as may be determined using method
940	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
941	>	* result in exceptions or errors, possibly including {@code
942	>	* ClassCastException}.
943	>	*
944	>	* @return the next task, or {@code null} if none are available
945		*/
946		protected static ForkJoinTask<?> pollNextLocalTask() {
947		return ((ForkJoinWorkerThread) Thread.currentThread())
#	Line 1026 | Line 956 | public abstract class ForkJoinTask<V> im
956		* {@code null} result does not necessarily imply quiescence
957		* of the pool this task is operating in.  This method is designed
958		* primarily to support extensions, and is unlikely to be useful
959	<	* otherwise.  This method may be invoked only from within
960	<	* ForkJoinTask computations (as may be determined using method
961	<	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
962	<	* result in exceptions or errors, possibly including
963	<	* ClassCastException.
959	>	* otherwise.
960	>	*
961	>	* <p>This method may be invoked only from within {@code
962	>	* ForkJoinTask} computations (as may be determined using method
963	>	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
964	>	* result in exceptions or errors, possibly including {@code
965	>	* ClassCastException}.
966		*
967	<	* @return a task, or null if none are available
967	>	* @return a task, or {@code null} if none are available
968		*/
969		protected static ForkJoinTask<?> pollTask() {
970		return ((ForkJoinWorkerThread) Thread.currentThread())
971		.pollTask();
972		}
973
974	<	// adaptors
974	>	/**
975	>	* Adaptor for Runnables. This implements RunnableFuture
976	>	* to be compliant with AbstractExecutorService constraints
977	>	* when used in ForkJoinPool.
978	>	*/
979	>	static final class AdaptedRunnable<T> extends ForkJoinTask<T>
980	>	implements RunnableFuture<T> {
981	>	final Runnable runnable;
982	>	final T resultOnCompletion;
983	>	T result;
984	>	AdaptedRunnable(Runnable runnable, T result) {
985	>	if (runnable == null) throw new NullPointerException();
986	>	this.runnable = runnable;
987	>	this.resultOnCompletion = result;
988	>	}
989	>	public T getRawResult() { return result; }
990	>	public void setRawResult(T v) { result = v; }
991	>	public boolean exec() {
992	>	runnable.run();
993	>	result = resultOnCompletion;
994	>	return true;
995	>	}
996	>	public void run() { invoke(); }
997	>	private static final long serialVersionUID = 5232453952276885070L;
998	>	}
999
1000		/**
1001	<	* Returns a new ForkJoinTask that performs the <code>run</code>
1002	<	* method of the given Runnable as its action, and returns a null
1003	<	* result upon <code>join</code>.
1001	>	* Adaptor for Callables
1002	>	*/
1003	>	static final class AdaptedCallable<T> extends ForkJoinTask<T>
1004	>	implements RunnableFuture<T> {
1005	>	final Callable<? extends T> callable;
1006	>	T result;
1007	>	AdaptedCallable(Callable<? extends T> callable) {
1008	>	if (callable == null) throw new NullPointerException();
1009	>	this.callable = callable;
1010	>	}
1011	>	public T getRawResult() { return result; }
1012	>	public void setRawResult(T v) { result = v; }
1013	>	public boolean exec() {
1014	>	try {
1015	>	result = callable.call();
1016	>	return true;
1017	>	} catch (Error err) {
1018	>	throw err;
1019	>	} catch (RuntimeException rex) {
1020	>	throw rex;
1021	>	} catch (Exception ex) {
1022	>	throw new RuntimeException(ex);
1023	>	}
1024	>	}
1025	>	public void run() { invoke(); }
1026	>	private static final long serialVersionUID = 2838392045355241008L;
1027	>	}
1028	>
1029	>	/**
1030	>	* Returns a new {@code ForkJoinTask} that performs the {@code run}
1031	>	* method of the given {@code Runnable} as its action, and returns
1032	>	* a null result upon {@link #join}.
1033		*
1034		* @param runnable the runnable action
1035		* @return the task
1036		*/
1037	<	public static ForkJoinTask<Void> adapt(Runnable runnable) {
1038	<	return new ForkJoinPool.AdaptedRunnable<Void>(runnable, null);
1037	>	public static ForkJoinTask<?> adapt(Runnable runnable) {
1038	>	return new AdaptedRunnable<Void>(runnable, null);
1039		}
1040
1041		/**
1042	<	* Returns a new ForkJoinTask that performs the <code>run</code>
1043	<	* method of the given Runnable as its action, and returns the
1044	<	* given result upon <code>join</code>.
1042	>	* Returns a new {@code ForkJoinTask} that performs the {@code run}
1043	>	* method of the given {@code Runnable} as its action, and returns
1044	>	* the given result upon {@link #join}.
1045		*
1046		* @param runnable the runnable action
1047		* @param result the result upon completion
1048		* @return the task
1049		*/
1050		public static <T> ForkJoinTask<T> adapt(Runnable runnable, T result) {
1051	<	return new ForkJoinPool.AdaptedRunnable<T>(runnable, result);
1051	>	return new AdaptedRunnable<T>(runnable, result);
1052		}
1053
1054		/**
1055	<	* Returns a new ForkJoinTask that performs the <code>call</code>
1056	<	* method of the given Callable as its action, and returns its
1057	<	* result upon <code>join</code>, translating any checked
1058	<	* exceptions encountered into <code>RuntimeException<code>.
1055	>	* Returns a new {@code ForkJoinTask} that performs the {@code call}
1056	>	* method of the given {@code Callable} as its action, and returns
1057	>	* its result upon {@link #join}, translating any checked exceptions
1058	>	* encountered into {@code RuntimeException}.
1059		*
1060		* @param callable the callable action
1061		* @return the task
1062		*/
1063	<	public static <T> ForkJoinTask<T> adapt(Callable<T> callable) {
1064	<	return new ForkJoinPool.AdaptedCallable<T>(callable);
1063	>	public static <T> ForkJoinTask<T> adapt(Callable<? extends T> callable) {
1064	>	return new AdaptedCallable<T>(callable);
1065		}
1066
1067		// Serialization support
#	Line 1084 | Line 1069 | public abstract class ForkJoinTask<V> im
1069		private static final long serialVersionUID = -7721805057305804111L;
1070
1071		/**
1072	<	* Save the state to a stream.
1072	>	* Saves the state to a stream.
1073		*
1074		* @serialData the current run status and the exception thrown
1075	<	* during execution, or null if none
1075	>	* during execution, or {@code null} if none
1076		* @param s the stream
1077		*/
1078		private void writeObject(java.io.ObjectOutputStream s)
#	Line 1097 | Line 1082 | public abstract class ForkJoinTask<V> im
1082		}
1083
1084		/**
1085	<	* Reconstitute the instance from a stream.
1085	>	* Reconstitutes the instance from a stream.
1086		*
1087		* @param s the stream
1088		*/
1089		private void readObject(java.io.ObjectInputStream s)
1090		throws java.io.IOException, ClassNotFoundException {
1091		s.defaultReadObject();
1107	–	status &= ~INTERNAL_SIGNAL_MASK; // clear internal signal counts
1108	–	status |= EXTERNAL_SIGNAL; // conservatively set external signal
1092		Object ex = s.readObject();
1093		if (ex != null)
1094	<	setDoneExceptionally((Throwable) ex);
1094	>	setExceptionalCompletion((Throwable) ex);
1095		}
1096
1097	<	// Unsafe mechanics for jsr166y 3rd party package.
1097	>	// Unsafe mechanics
1098	>
1099	>	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1100	>	private static final long statusOffset =
1101	>	objectFieldOffset("status", ForkJoinTask.class);
1102	>
1103	>	private static long objectFieldOffset(String field, Class<?> klazz) {
1104	>	try {
1105	>	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1106	>	} catch (NoSuchFieldException e) {
1107	>	// Convert Exception to corresponding Error
1108	>	NoSuchFieldError error = new NoSuchFieldError(field);
1109	>	error.initCause(e);
1110	>	throw error;
1111	>	}
1112	>	}
1113	>
1114	>	/**
1115	>	* Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
1116	>	* Replace with a simple call to Unsafe.getUnsafe when integrating
1117	>	* into a jdk.
1118	>	*
1119	>	* @return a sun.misc.Unsafe
1120	>	*/
1121		private static sun.misc.Unsafe getUnsafe() {
1122		try {
1123		return sun.misc.Unsafe.getUnsafe();
1124		} catch (SecurityException se) {
1125		try {
1126		return java.security.AccessController.doPrivileged
1127	<	(new java.security.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1127	>	(new java.security
1128	>	.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1129		public sun.misc.Unsafe run() throws Exception {
1130	<	return getUnsafeByReflection();
1130	>	java.lang.reflect.Field f = sun.misc
1131	>	.Unsafe.class.getDeclaredField("theUnsafe");
1132	>	f.setAccessible(true);
1133	>	return (sun.misc.Unsafe) f.get(null);
1134		}});
1135		} catch (java.security.PrivilegedActionException e) {
1136		throw new RuntimeException("Could not initialize intrinsics",
#	Line 1128 | Line 1138 | public abstract class ForkJoinTask<V> im
1138		}
1139		}
1140		}
1131	–
1132	–	private static sun.misc.Unsafe getUnsafeByReflection()
1133	–	throws NoSuchFieldException, IllegalAccessException {
1134	–	java.lang.reflect.Field f =
1135	–	sun.misc.Unsafe.class.getDeclaredField("theUnsafe");
1136	–	f.setAccessible(true);
1137	–	return (sun.misc.Unsafe) f.get(null);
1138	–	}
1139	–
1140	–	private static long fieldOffset(String fieldName, Class<?> klazz) {
1141	–	try {
1142	–	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(fieldName));
1143	–	} catch (NoSuchFieldException e) {
1144	–	// Convert Exception to Error
1145	–	NoSuchFieldError error = new NoSuchFieldError(fieldName);
1146	–	error.initCause(e);
1147	–	throw error;
1148	–	}
1149	–	}
1150	–
1151	–	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1152	–	private static final long statusOffset =
1153	–	fieldOffset("status", ForkJoinTask.class);
1154	–
1141		}

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines