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.73 by jsr166, Sun Nov 28 21:21:03 2010 UTC vs.
Revision 1.100 by jsr166, Tue Feb 5 17:09:54 2013 UTC

#	Line 1 | Line 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	<	* http://creativecommons.org/licenses/publicdomain
4	>	* http://creativecommons.org/publicdomain/zero/1.0/
5		*/
6
7		package jsr166y;
8
9		import java.io.Serializable;
10		import java.util.Collection;
11	–	import java.util.Collections;
11		import java.util.List;
12		import java.util.RandomAccess;
13	<	import java.util.Map;
14	<	import java.util.WeakHashMap;
13	>	import java.lang.ref.WeakReference;
14	>	import java.lang.ref.ReferenceQueue;
15		import java.util.concurrent.Callable;
16		import java.util.concurrent.CancellationException;
17		import java.util.concurrent.ExecutionException;
19	–	import java.util.concurrent.Executor;
20	–	import java.util.concurrent.ExecutorService;
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	+	import java.util.concurrent.locks.ReentrantLock;
24	+	import java.lang.reflect.Constructor;
25
26		/**
27		* Abstract base class for tasks that run within a {@link ForkJoinPool}.
#	Line 31 | Line 30 | import java.util.concurrent.TimeoutExcep
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	<	* <p>A "main" {@code ForkJoinTask} begins execution when submitted
34	<	* to a {@link ForkJoinPool}.  Once started, it will usually in turn
35	<	* start other subtasks.  As indicated by the name of this class,
36	<	* many programs using {@code ForkJoinTask} employ only methods
37	<	* {@link #fork} and {@link #join}, or derivatives such as {@link
33	>	* <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	>	* ForkJoinPool#commonPool()} via {@link #fork}, {@link #invoke}, or
37	>	* 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		* #invokeAll(ForkJoinTask...) invokeAll}.  However, this class also
42		* provides a number of other methods that can come into play in
43	<	* advanced usages, as well as extension mechanics that allow
44	<	* support of new forms of fork/join processing.
43	>	* advanced usages, as well as extension mechanics that allow support
44	>	* of new forms of fork/join processing.
45		*
46		* <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	<	* reflecting their intended use as computational tasks calculating
50	<	* pure functions or operating on purely isolated objects.  The
51	<	* primary coordination mechanisms are {@link #fork}, that arranges
49	>	* 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		* asynchronous execution, and {@link #join}, that doesn't proceed
53		* until the task's result has been computed.  Computations should
54	<	* avoid {@code synchronized} methods or blocks, and should minimize
55	<	* other blocking synchronization apart from joining other tasks or
56	<	* using synchronizers such as Phasers that are advertised to
57	<	* cooperate with fork/join scheduling. Tasks should also not perform
58	<	* blocking IO, and should ideally access variables that are
59	<	* completely independent of those accessed by other running
60	<	* tasks. Minor breaches of these restrictions, for example using
61	<	* shared output streams, may be tolerable in practice, but frequent
62	<	* use may result in poor performance, and the potential to
63	<	* indefinitely stall if the number of threads not waiting for IO or
64	<	* other external synchronization becomes exhausted. This usage
65	<	* restriction is in part enforced by not permitting checked
66	<	* exceptions such as {@code IOExceptions} to be thrown. However,
67	<	* computations may still encounter unchecked exceptions, that are
68	<	* rethrown to callers attempting to join them. These exceptions may
69	<	* additionally include {@link RejectedExecutionException} stemming
70	<	* from internal resource exhaustion, such as failure to allocate
71	<	* internal task queues.
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	>	* not perform blocking I/O, and should ideally access variables that
59	>	* 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	>	* that blocks on external synchronization or I/O. Event-style async
77	>	* 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	>	* 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		*
87		* <p>The primary method for awaiting completion and extracting
88		* results of a task is {@link #join}, but there are several variants:
#	Line 82 | Line 98 | import java.util.concurrent.TimeoutExcep
98		* performs the most common form of parallel invocation: forking a set
99		* of tasks and joining them all.
100		*
101	+	* <p>In the most typical usages, a fork-join pair act like a call
102	+	* (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		* <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);
#	Line 97 | Line 120 | import java.util.concurrent.TimeoutExcep
120		* <p>The ForkJoinTask class is not usually directly subclassed.
121		* Instead, you subclass one of the abstract classes that support a
122		* particular style of fork/join processing, typically {@link
123	<	* RecursiveAction} for computations that do not return results, or
124	<	* {@link RecursiveTask} for those that do.  Normally, a concrete
125	<	* ForkJoinTask subclass declares fields comprising its parameters,
126	<	* established in a constructor, and then defines a {@code compute}
127	<	* method that somehow uses the control methods supplied by this base
128	<	* class. While these methods have {@code public} access (to allow
129	<	* instances of different task subclasses to call each other's
107	<	* methods), some of them may only be called from within other
108	<	* ForkJoinTasks (as may be determined using method {@link
109	<	* #inForkJoinPool}).  Attempts to invoke them in other contexts
110	<	* result in exceptions or errors, possibly including
111	<	* {@code ClassCastException}.
123	>	* 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	>	* methods supplied by this base class.
130		*
131		* <p>Method {@link #join} and its variants are appropriate for use
132		* only when completion dependencies are acyclic; that is, the
#	Line 118 | Line 136 | import java.util.concurrent.TimeoutExcep
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	<	* are not statically structured as DAGs.
139	>	* are not statically structured as DAGs. To support such usages a
140	>	* ForkJoinTask may be atomically <em>tagged</em> with a {@code short}
141	>	* value using {@link #setForkJoinTaskTag} or {@link
142	>	* #compareAndSetForkJoinTaskTag} and checked using {@link
143	>	* #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		*
151		* <p>Most base support methods are {@code final}, to prevent
152		* overriding of implementations that are intrinsically tied to the
#	Line 158 | Line 186 | public abstract class ForkJoinTask<V> im
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	<	* to methods in ForkJoinWorkerThread and ForkJoinPool. The
190	<	* methods of this class are more-or-less layered into (1) basic
191	<	* status maintenance (2) execution and awaiting completion (3)
192	<	* user-level methods that additionally report results. This is
193	<	* sometimes hard to see because this file orders exported methods
194	<	* in a way that flows well in javadocs. In particular, most
195	<	* join mechanics are in method quietlyJoin, below.
189	>	* 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		*/
198
199		/*
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	<	* values until completed, upon which status holds value
204	<	* NORMAL, CANCELLED, or EXCEPTIONAL. Tasks undergoing blocking
205	<	* waits by other threads have the SIGNAL bit set.  Completion of
206	<	* a stolen task with SIGNAL set awakens any waiters via
207	<	* notifyAll. Even though suboptimal for some purposes, we use
208	<	* basic builtin wait/notify to take advantage of "monitor
209	<	* inflation" in JVMs that we would otherwise need to emulate to
210	<	* avoid adding further per-task bookkeeping overhead.  We want
211	<	* these monitors to be "fat", i.e., not use biasing or thin-lock
212	<	* techniques, so use some odd coding idioms that tend to avoid
213	<	* them.
203	>	* 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	>	*
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		*/
220
221		/** The run status of this task */
222		volatile int status; // accessed directly by pool and workers
223	+	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	+	static final int SIGNAL      = 0x00010000;  // must be >= 1 << 16
228	+	static final int SMASK       = 0x0000ffff;  // short bits for tags
229
230	<	private static final int NORMAL      = -1;
231	<	private static final int CANCELLED   = -2;
232	<	private static final int EXCEPTIONAL = -3;
233	<	private static final int SIGNAL      =  1;
230	>	/**
231	>	* Marks completion and wakes up threads waiting to join this
232	>	* task.
233	>	*
234	>	* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
235	>	* @return completion status on exit
236	>	*/
237	>	private int setCompletion(int completion) {
238	>	for (int s;;) {
239	>	if ((s = status) < 0)
240	>	return s;
241	>	if (U.compareAndSwapInt(this, STATUS, s, s | completion)) {
242	>	if ((s >>> 16) != 0)
243	>	synchronized (this) { notifyAll(); }
244	>	return completion;
245	>	}
246	>	}
247	>	}
248	>
249	>	/**
250	>	* 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	>	*
254	>	* @return status on exit from this method
255	>	*/
256	>	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	>	if (completed)
265	>	s = setCompletion(NORMAL);
266	>	}
267	>	return s;
268	>	}
269	>
270	>	/**
271	>	* Tries to set SIGNAL status unless already completed. Used by
272	>	* ForkJoinPool. Other variants are directly incorporated into
273	>	* externalAwaitDone etc.
274	>	*
275	>	* @return true if successful
276	>	*/
277	>	final boolean trySetSignal() {
278	>	int s = status;
279	>	return s >= 0 && U.compareAndSwapInt(this, STATUS, s, s | SIGNAL);
280	>	}
281	>
282	>	/**
283	>	* Blocks a non-worker-thread until completion.
284	>	* @return status upon completion
285	>	*/
286	>	private int externalAwaitDone() {
287	>	int s;
288	>	ForkJoinPool.externalHelpJoin(this);
289	>	boolean interrupted = false;
290	>	while ((s = status) >= 0) {
291	>	if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
292	>	synchronized (this) {
293	>	if (status >= 0) {
294	>	try {
295	>	wait();
296	>	} catch (InterruptedException ie) {
297	>	interrupted = true;
298	>	}
299	>	}
300	>	else
301	>	notifyAll();
302	>	}
303	>	}
304	>	}
305	>	if (interrupted)
306	>	Thread.currentThread().interrupt();
307	>	return s;
308	>	}
309	>
310	>	/**
311	>	* Blocks a non-worker-thread until completion or interruption.
312	>	*/
313	>	private int externalInterruptibleAwaitDone() throws InterruptedException {
314	>	int s;
315	>	if (Thread.interrupted())
316	>	throw new InterruptedException();
317	>	ForkJoinPool.externalHelpJoin(this);
318	>	while ((s = status) >= 0) {
319	>	if (U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
320	>	synchronized (this) {
321	>	if (status >= 0)
322	>	wait();
323	>	else
324	>	notifyAll();
325	>	}
326	>	}
327	>	}
328	>	return s;
329	>	}
330	>
331	>
332	>	/**
333	>	* Implementation for join, get, quietlyJoin. Directly handles
334	>	* only cases of already-completed, external wait, and
335	>	* unfork+exec.  Others are relayed to ForkJoinPool.awaitJoin.
336	>	*
337	>	* @return status upon completion
338	>	*/
339	>	private int doJoin() {
340	>	int s; Thread t; ForkJoinWorkerThread wt; ForkJoinPool.WorkQueue w;
341	>	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	>	}
348	>
349	>	/**
350	>	* Implementation for invoke, quietlyInvoke.
351	>	*
352	>	* @return status upon completion
353	>	*/
354	>	private int doInvoke() {
355	>	int s; Thread t; ForkJoinWorkerThread wt;
356	>	return (s = doExec()) < 0 ? s :
357	>	((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
358	>	(wt = (ForkJoinWorkerThread)t).pool.awaitJoin(wt.workQueue, this) :
359	>	externalAwaitDone();
360	>	}
361	>
362	>	// Exception table support
363
364		/**
365		* Table of exceptions thrown by tasks, to enable reporting by
#	Line 198 | Line 367 | public abstract class ForkJoinTask<V> im
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	<	* TODO: Use ConcurrentReferenceHashMap
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	<	static final Map<ForkJoinTask<?>, Throwable> exceptionMap =
204	<	Collections.synchronizedMap
205	<	(new WeakHashMap<ForkJoinTask<?>, Throwable>());
380	>	private static final int EXCEPTION_MAP_CAPACITY = 32;
381
382	<	// Maintaining completion status
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	>	* any ForkJoinPool will call helpExpungeStaleExceptions when its
392	>	* pool becomes isQuiescent.
393	>	*/
394	>	static final class ExceptionNode extends WeakReference<ForkJoinTask<?>> {
395	>	final Throwable ex;
396	>	ExceptionNode next;
397	>	final long thrower;  // use id not ref to avoid weak cycles
398	>	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	<	* Marks completion and wakes up threads waiting to join this task,
211	<	* also clearing signal request bits.
407	>	* Records exception and sets status.
408		*
409	<	* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
409	>	* @return status on exit
410		*/
411	<	private void setCompletion(int completion) {
411	>	final int recordExceptionalCompletion(Throwable ex) {
412		int s;
413	<	while ((s = status) >= 0) {
414	<	if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) {
415	<	if (s != 0)
416	<	synchronized (this) { notifyAll(); }
417	<	break;
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	>	}
429	>	} finally {
430	>	lock.unlock();
431		}
432	+	s = setCompletion(EXCEPTIONAL);
433		}
434	+	return s;
435		}
436
437		/**
438	<	* Records exception and sets exceptional completion.
438	>	* Records exception and possibly propagates.
439		*
440		* @return status on exit
441		*/
442	<	private void setExceptionalCompletion(Throwable rex) {
443	<	exceptionMap.put(this, rex);
444	<	setCompletion(EXCEPTIONAL);
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	<	* Blocks a worker thread until completed or timed out.  Called
238	<	* only by pool.
450	>	* Hook for exception propagation support for tasks with completers.
451		*/
452	<	final void internalAwaitDone(long millis, int nanos) {
453	<	int s = status;
454	<	if ((s == 0 &&
455	<	UNSAFE.compareAndSwapInt(this, statusOffset, 0, SIGNAL)) ||
456	<	s > 0)  {
457	<	try {     // the odd construction reduces lock bias effects
458	<	synchronized (this) {
459	<	if (status > 0)
460	<	wait(millis, nanos);
452	>	void internalPropagateException(Throwable ex) {
453	>	}
454	>
455	>	/**
456	>	* 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	>	* Removes exception node and clears status.
472	>	*/
473	>	private void clearExceptionalCompletion() {
474	>	int h = System.identityHashCode(this);
475	>	final ReentrantLock lock = exceptionTableLock;
476	>	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	<	notifyAll();
488	>	pred.next = next;
489	>	break;
490		}
491	<	} catch (InterruptedException ie) {
492	<	cancelIfTerminating();
491	>	pred = e;
492	>	e = next;
493		}
494	+	expungeStaleExceptions();
495	+	status = 0;
496	+	} finally {
497	+	lock.unlock();
498		}
499		}
500
501		/**
502	<	* Blocks a non-worker-thread until completion.
503	<	*/
504	<	private void externalAwaitDone() {
505	<	if (status >= 0) {
506	<	boolean interrupted = false;
507	<	synchronized (this) {
508	<	for (;;) {
509	<	int s = status;
510	<	if (s == 0)
511	<	UNSAFE.compareAndSwapInt(this, statusOffset,
512	<	0, SIGNAL);
513	<	else if (s < 0) {
514	<	notifyAll();
515	<	break;
516	<	}
517	<	else {
518	<	try {
519	<	wait();
520	<	} catch (InterruptedException ie) {
521	<	interrupted = true;
522	<	}
523	<	}
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	>	if ((status & DONE_MASK) != EXCEPTIONAL)
517	>	return null;
518	>	int h = System.identityHashCode(this);
519	>	ExceptionNode e;
520	>	final ReentrantLock lock = exceptionTableLock;
521	>	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	>	if (false && e.thrower != Thread.currentThread().getId()) {
535	>	Class<? extends Throwable> ec = ex.getClass();
536	>	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		}
283	–	if (interrupted)
284	–	Thread.currentThread().interrupt();
554		}
555	+	return ex;
556		}
557
558		/**
559	<	* Blocks a non-worker-thread until completion or interruption or timeout.
559	>	* Poll stale refs and remove them. Call only while holding lock.
560		*/
561	<	private void externalInterruptibleAwaitDone(boolean timed, long nanos)
562	<	throws InterruptedException {
563	<	if (Thread.interrupted())
564	<	throw new InterruptedException();
565	<	if (status >= 0) {
566	<	long startTime = timed ? System.nanoTime() : 0L;
567	<	synchronized (this) {
568	<	for (;;) {
569	<	long nt;
570	<	int s = status;
571	<	if (s == 0)
572	<	UNSAFE.compareAndSwapInt(this, statusOffset,
573	<	0, SIGNAL);
574	<	else if (s < 0) {
575	<	notifyAll();
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	<	else if (!timed)
579	<	wait();
310	<	else if ((nt = nanos - (System.nanoTime()-startTime)) > 0L)
311	<	wait(nt / 1000000, (int)(nt % 1000000));
312	<	else
313	<	break;
578	>	pred = e;
579	>	e = next;
580		}
581		}
582		}
583		}
584
585		/**
586	<	* Unless done, calls exec and records status if completed, but
587	<	* doesn't wait for completion otherwise. Primary execution method
322	<	* for ForkJoinWorkerThread.
586	>	* If lock is available, poll stale refs and remove them.
587	>	* Called from ForkJoinPool when pools become quiescent.
588		*/
589	<	final void quietlyExec() {
590	<	try {
591	<	if (status < 0 || !exec())
592	<	return;
593	<	} catch (Throwable rex) {
594	<	setExceptionalCompletion(rex);
595	<	return;
589	>	static final void helpExpungeStaleExceptions() {
590	>	final ReentrantLock lock = exceptionTableLock;
591	>	if (lock.tryLock()) {
592	>	try {
593	>	expungeStaleExceptions();
594	>	} finally {
595	>	lock.unlock();
596	>	}
597	>	}
598	>	}
599	>
600	>	/**
601	>	* 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	>	ForkJoinTask.<RuntimeException>uncheckedThrow(ex);
610		}
611	<	setCompletion(NORMAL); // must be outside try block
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	>	void uncheckedThrow(Throwable t) throws T {
620	>	if (t != null)
621	>	throw (T)t; // rely on vacuous cast
622	>	}
623	>
624	>	/**
625	>	* Throws exception, if any, associated with the given status.
626	>	*/
627	>	private void reportException(int s) {
628	>	if (s == CANCELLED)
629	>	throw new CancellationException();
630	>	if (s == EXCEPTIONAL)
631	>	rethrow(getThrowableException());
632		}
633
634		// public methods
635
636		/**
637	<	* Arranges to asynchronously execute this task.  While it is not
638	<	* necessarily enforced, it is a usage error to fork a task more
639	<	* than once unless it has completed and been reinitialized.
640	<	* Subsequent modifications to the state of this task or any data
641	<	* it operates on are not necessarily consistently observable by
642	<	* any thread other than the one executing it unless preceded by a
643	<	* call to {@link #join} or related methods, or a call to {@link
644	<	* #isDone} returning {@code true}.
645	<	*
646	<	* <p>This method may be invoked only from within {@code
647	<	* ForkJoinPool} computations (as may be determined using method
349	<	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
350	<	* result in exceptions or errors, possibly including {@code
351	<	* ClassCastException}.
637	>	* Arranges to asynchronously execute this task in the pool the
638	>	* current task is running in, if applicable, or using the {@link
639	>	* ForkJoinPool#commonPool()} if not {@link #inForkJoinPool}.  While
640	>	* 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		*
649		* @return {@code this}, to simplify usage
650		*/
651		public final ForkJoinTask<V> fork() {
652	<	((ForkJoinWorkerThread) Thread.currentThread())
653	<	.pushTask(this);
652	>	Thread t;
653	>	if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)
654	>	((ForkJoinWorkerThread)t).workQueue.push(this);
655	>	else
656	>	ForkJoinPool.common.externalPush(this);
657		return this;
658		}
659
#	Line 370 | Line 669 | public abstract class ForkJoinTask<V> im
669		* @return the computed result
670		*/
671		public final V join() {
672	<	quietlyJoin();
673	<	Throwable ex;
674	<	if (status < NORMAL && (ex = getException()) != null)
376	<	UNSAFE.throwException(ex);
672	>	int s;
673	>	if ((s = doJoin() & DONE_MASK) != NORMAL)
674	>	reportException(s);
675		return getRawResult();
676		}
677
#	Line 386 | Line 684 | public abstract class ForkJoinTask<V> im
684		* @return the computed result
685		*/
686		public final V invoke() {
687	<	quietlyInvoke();
688	<	Throwable ex;
689	<	if (status < NORMAL && (ex = getException()) != null)
392	<	UNSAFE.throwException(ex);
687	>	int s;
688	>	if ((s = doInvoke() & DONE_MASK) != NORMAL)
689	>	reportException(s);
690		return getRawResult();
691		}
692
#	Line 406 | Line 703 | public abstract class ForkJoinTask<V> im
703		* cancelled, completed normally or exceptionally, or left
704		* unprocessed.
705		*
409	–	* <p>This method may be invoked only from within {@code
410	–	* ForkJoinPool} computations (as may be determined using method
411	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
412	–	* result in exceptions or errors, possibly including {@code
413	–	* ClassCastException}.
414	–	*
706		* @param t1 the first task
707		* @param t2 the second task
708		* @throws NullPointerException if any task is null
709		*/
710		public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
711	+	int s1, s2;
712		t2.fork();
713	<	t1.invoke();
714	<	t2.join();
713	>	if ((s1 = t1.doInvoke() & DONE_MASK) != NORMAL)
714	>	t1.reportException(s1);
715	>	if ((s2 = t2.doJoin() & DONE_MASK) != NORMAL)
716	>	t2.reportException(s2);
717		}
718
719		/**
#	Line 434 | Line 728 | public abstract class ForkJoinTask<V> im
728		* related methods to check if they have been cancelled, completed
729		* normally or exceptionally, or left unprocessed.
730		*
437	–	* <p>This method may be invoked only from within {@code
438	–	* ForkJoinPool} computations (as may be determined using method
439	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
440	–	* result in exceptions or errors, possibly including {@code
441	–	* ClassCastException}.
442	–	*
731		* @param tasks the tasks
732		* @throws NullPointerException if any task is null
733		*/
#	Line 454 | Line 742 | public abstract class ForkJoinTask<V> im
742		}
743		else if (i != 0)
744		t.fork();
745	<	else {
746	<	t.quietlyInvoke();
459	<	if (ex == null && t.status < NORMAL)
460	<	ex = t.getException();
461	<	}
745	>	else if (t.doInvoke() < NORMAL && ex == null)
746	>	ex = t.getException();
747		}
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	<	else {
754	<	t.quietlyJoin();
470	<	if (ex == null && t.status < NORMAL)
471	<	ex = t.getException();
472	<	}
753	>	else if (t.doJoin() < NORMAL)
754	>	ex = t.getException();
755		}
756		}
757		if (ex != null)
758	<	UNSAFE.throwException(ex);
758	>	rethrow(ex);
759		}
760
761		/**
#	Line 489 | Line 771 | public abstract class ForkJoinTask<V> im
771		* cancelled, completed normally or exceptionally, or left
772		* unprocessed.
773		*
492	–	* <p>This method may be invoked only from within {@code
493	–	* ForkJoinPool} computations (as may be determined using method
494	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
495	–	* result in exceptions or errors, possibly including {@code
496	–	* ClassCastException}.
497	–	*
774		* @param tasks the collection of tasks
775		* @return the tasks argument, to simplify usage
776		* @throws NullPointerException if tasks or any element are null
#	Line 517 | Line 793 | public abstract class ForkJoinTask<V> im
793		}
794		else if (i != 0)
795		t.fork();
796	<	else {
797	<	t.quietlyInvoke();
522	<	if (ex == null && t.status < NORMAL)
523	<	ex = t.getException();
524	<	}
796	>	else if (t.doInvoke() < NORMAL && ex == null)
797	>	ex = t.getException();
798		}
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	<	else {
805	<	t.quietlyJoin();
533	<	if (ex == null && t.status < NORMAL)
534	<	ex = t.getException();
535	<	}
804	>	else if (t.doJoin() < NORMAL)
805	>	ex = t.getException();
806		}
807		}
808		if (ex != null)
809	<	UNSAFE.throwException(ex);
809	>	rethrow(ex);
810		return tasks;
811		}
812
#	Line 568 | Line 838 | public abstract class ForkJoinTask<V> im
838		* @return {@code true} if this task is now cancelled
839		*/
840		public boolean cancel(boolean mayInterruptIfRunning) {
841	<	setCompletion(CANCELLED);
572	<	return status == CANCELLED;
573	<	}
574	<
575	<	/**
576	<	* Cancels, ignoring any exceptions thrown by cancel. Used during
577	<	* worker and pool shutdown. Cancel is spec'ed not to throw any
578	<	* exceptions, but if it does anyway, we have no recourse during
579	<	* shutdown, so guard against this case.
580	<	*/
581	<	final void cancelIgnoringExceptions() {
582	<	try {
583	<	cancel(false);
584	<	} catch (Throwable ignore) {
585	<	}
586	<	}
587	<
588	<	/**
589	<	* Cancels if current thread is a terminating worker thread,
590	<	* ignoring any exceptions thrown by cancel.
591	<	*/
592	<	final void cancelIfTerminating() {
593	<	Thread t = Thread.currentThread();
594	<	if ((t instanceof ForkJoinWorkerThread) &&
595	<	((ForkJoinWorkerThread) t).isTerminating()) {
596	<	try {
597	<	cancel(false);
598	<	} catch (Throwable ignore) {
599	<	}
600	<	}
841	>	return (setCompletion(CANCELLED) & DONE_MASK) == CANCELLED;
842		}
843
844		public final boolean isDone() {
#	Line 605 | Line 846 | public abstract class ForkJoinTask<V> im
846		}
847
848		public final boolean isCancelled() {
849	<	return status == CANCELLED;
849	>	return (status & DONE_MASK) == CANCELLED;
850		}
851
852		/**
#	Line 625 | Line 866 | public abstract class ForkJoinTask<V> im
866		* exception and was not cancelled
867		*/
868		public final boolean isCompletedNormally() {
869	<	return status == NORMAL;
869	>	return (status & DONE_MASK) == NORMAL;
870		}
871
872		/**
#	Line 636 | Line 877 | public abstract class ForkJoinTask<V> im
877		* @return the exception, or {@code null} if none
878		*/
879		public final Throwable getException() {
880	<	int s = status;
880	>	int s = status & DONE_MASK;
881		return ((s >= NORMAL)    ? null :
882		(s == CANCELLED) ? new CancellationException() :
883	<	exceptionMap.get(this));
883	>	getThrowableException());
884		}
885
886		/**
#	Line 686 | Line 927 | public abstract class ForkJoinTask<V> im
927		}
928
929		/**
930	+	* 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	+	*/
937	+	public final void quietlyComplete() {
938	+	setCompletion(NORMAL);
939	+	}
940	+
941	+	/**
942		* Waits if necessary for the computation to complete, and then
943		* retrieves its result.
944		*
#	Line 697 | Line 950 | public abstract class ForkJoinTask<V> im
950		* member of a ForkJoinPool and was interrupted while waiting
951		*/
952		public final V get() throws InterruptedException, ExecutionException {
953	<	Thread t = Thread.currentThread();
954	<	if (t instanceof ForkJoinWorkerThread)
955	<	quietlyJoin();
956	<	else
957	<	externalInterruptibleAwaitDone(false, 0L);
958	<	int s = status;
959	<	if (s != NORMAL) {
707	<	Throwable ex;
708	<	if (s == CANCELLED)
709	<	throw new CancellationException();
710	<	if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
711	<	throw new ExecutionException(ex);
712	<	}
953	>	int s = (Thread.currentThread() instanceof ForkJoinWorkerThread) ?
954	>	doJoin() : externalInterruptibleAwaitDone();
955	>	Throwable ex;
956	>	if ((s &= DONE_MASK) == CANCELLED)
957	>	throw new CancellationException();
958	>	if (s == EXCEPTIONAL && (ex = getThrowableException()) != null)
959	>	throw new ExecutionException(ex);
960		return getRawResult();
961		}
962
#	Line 729 | Line 976 | public abstract class ForkJoinTask<V> im
976		*/
977		public final V get(long timeout, TimeUnit unit)
978		throws InterruptedException, ExecutionException, TimeoutException {
979	<	long nanos = unit.toNanos(timeout);
980	<	Thread t = Thread.currentThread();
981	<	if (t instanceof ForkJoinWorkerThread)
982	<	((ForkJoinWorkerThread)t).joinTask(this, true, nanos);
983	<	else
984	<	externalInterruptibleAwaitDone(true, nanos);
985	<	int s = status;
986	<	if (s != NORMAL) {
979	>	if (Thread.interrupted())
980	>	throw new InterruptedException();
981	>	// Messy in part because we measure in nanosecs, but wait in millisecs
982	>	int s; long ms;
983	>	long ns = unit.toNanos(timeout);
984	>	if ((s = status) >= 0 && ns > 0L) {
985	>	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	>	p.helpJoinOnce(w, this); // no retries on failure
994	>	}
995	>	else
996	>	ForkJoinPool.externalHelpJoin(this);
997	>	boolean canBlock = false;
998	>	boolean interrupted = false;
999	>	try {
1000	>	while ((s = status) >= 0) {
1001	>	if (w != null && w.qlock < 0)
1002	>	cancelIgnoringExceptions(this);
1003	>	else if (!canBlock) {
1004	>	if (p == null || p.tryCompensate())
1005	>	canBlock = true;
1006	>	}
1007	>	else {
1008	>	if ((ms = TimeUnit.NANOSECONDS.toMillis(ns)) > 0L &&
1009	>	U.compareAndSwapInt(this, STATUS, s, s | SIGNAL)) {
1010	>	synchronized (this) {
1011	>	if (status >= 0) {
1012	>	try {
1013	>	wait(ms);
1014	>	} catch (InterruptedException ie) {
1015	>	if (p == null)
1016	>	interrupted = true;
1017	>	}
1018	>	}
1019	>	else
1020	>	notifyAll();
1021	>	}
1022	>	}
1023	>	if ((s = status) < 0 || interrupted ||
1024	>	(ns = deadline - System.nanoTime()) <= 0L)
1025	>	break;
1026	>	}
1027	>	}
1028	>	} finally {
1029	>	if (p != null && canBlock)
1030	>	p.incrementActiveCount();
1031	>	}
1032	>	if (interrupted)
1033	>	throw new InterruptedException();
1034	>	}
1035	>	if ((s &= DONE_MASK) != NORMAL) {
1036		Throwable ex;
1037		if (s == CANCELLED)
1038		throw new CancellationException();
1039	<	if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
1039	>	if (s != EXCEPTIONAL)
1040	>	throw new TimeoutException();
1041	>	if ((ex = getThrowableException()) != null)
1042		throw new ExecutionException(ex);
745	–	throw new TimeoutException();
1043		}
1044		return getRawResult();
1045		}
#	Line 754 | Line 1051 | public abstract class ForkJoinTask<V> im
1051		* known to have aborted.
1052		*/
1053		public final void quietlyJoin() {
1054	<	Thread t;
758	<	if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
759	<	ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
760	<	if (status >= 0) {
761	<	if (w.unpushTask(this)) {
762	<	boolean completed;
763	<	try {
764	<	completed = exec();
765	<	} catch (Throwable rex) {
766	<	setExceptionalCompletion(rex);
767	<	return;
768	<	}
769	<	if (completed) {
770	<	setCompletion(NORMAL);
771	<	return;
772	<	}
773	<	}
774	<	w.joinTask(this, false, 0L);
775	<	}
776	<	}
777	<	else
778	<	externalAwaitDone();
1054	>	doJoin();
1055		}
1056
1057		/**
#	Line 784 | Line 1060 | public abstract class ForkJoinTask<V> im
1060		* exception.
1061		*/
1062		public final void quietlyInvoke() {
1063	<	if (status >= 0) {
788	<	boolean completed;
789	<	try {
790	<	completed = exec();
791	<	} catch (Throwable rex) {
792	<	setExceptionalCompletion(rex);
793	<	return;
794	<	}
795	<	if (completed)
796	<	setCompletion(NORMAL);
797	<	else
798	<	quietlyJoin();
799	<	}
1063	>	doInvoke();
1064		}
1065
1066		/**
#	Line 805 | Line 1069 | public abstract class ForkJoinTask<V> im
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.
808	–	*
809	–	* <p>This method may be invoked only from within {@code
810	–	* ForkJoinPool} computations (as may be determined using method
811	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
812	–	* result in exceptions or errors, possibly including {@code
813	–	* ClassCastException}.
1072		*/
1073		public static void helpQuiesce() {
1074	<	((ForkJoinWorkerThread) Thread.currentThread())
1075	<	.helpQuiescePool();
1074	>	Thread t;
1075	>	if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
1076	>	ForkJoinWorkerThread wt = (ForkJoinWorkerThread)t;
1077	>	wt.pool.helpQuiescePool(wt.workQueue);
1078	>	}
1079	>	else
1080	>	ForkJoinPool.quiesceCommonPool();
1081		}
1082
1083		/**
#	Line 834 | Line 1097 | public abstract class ForkJoinTask<V> im
1097		* setRawResult(null)}.
1098		*/
1099		public void reinitialize() {
1100	<	if (status == EXCEPTIONAL)
1101	<	exceptionMap.remove(this);
1102	<	status = 0;
1100	>	if ((status & DONE_MASK) == EXCEPTIONAL)
1101	>	clearExceptionalCompletion();
1102	>	else
1103	>	status = 0;
1104		}
1105
1106		/**
#	Line 866 | Line 1130 | public abstract class ForkJoinTask<V> im
1130
1131		/**
1132		* Tries to unschedule this task for execution. This method will
1133	<	* typically succeed if this task is the most recently forked task
1134	<	* by the current thread, and has not commenced executing in
1135	<	* another thread.  This method may be useful when arranging
1136	<	* alternative local processing of tasks that could have been, but
1137	<	* were not, stolen.
874	<	*
875	<	* <p>This method may be invoked only from within {@code
876	<	* ForkJoinPool} computations (as may be determined using method
877	<	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
878	<	* result in exceptions or errors, possibly including {@code
879	<	* ClassCastException}.
1133	>	* 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		*
1139		* @return {@code true} if unforked
1140		*/
1141		public boolean tryUnfork() {
1142	<	return ((ForkJoinWorkerThread) Thread.currentThread())
1143	<	.unpushTask(this);
1142	>	Thread t;
1143	>	return (((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1144	>	((ForkJoinWorkerThread)t).workQueue.tryUnpush(this) :
1145	>	ForkJoinPool.tryExternalUnpush(this));
1146		}
1147
1148		/**
#	Line 891 | Line 1151 | public abstract class ForkJoinTask<V> im
1151		* value may be useful for heuristic decisions about whether to
1152		* fork other tasks.
1153		*
894	–	* <p>This method may be invoked only from within {@code
895	–	* ForkJoinPool} computations (as may be determined using method
896	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
897	–	* result in exceptions or errors, possibly including {@code
898	–	* ClassCastException}.
899	–	*
1154		* @return the number of tasks
1155		*/
1156		public static int getQueuedTaskCount() {
1157	<	return ((ForkJoinWorkerThread) Thread.currentThread())
1158	<	.getQueueSize();
1157	>	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		}
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	<	* threads that might steal them.  This value may be useful for
1168	>	* threads that might steal them, or zero if this thread is not
1169	>	* operating in a ForkJoinPool. This value may be useful for
1170		* 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		*
917	–	* <p>This method may be invoked only from within {@code
918	–	* ForkJoinPool} computations (as may be determined using method
919	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
920	–	* result in exceptions or errors, possibly including {@code
921	–	* ClassCastException}.
922	–	*
1176		* @return the surplus number of tasks, which may be negative
1177		*/
1178		public static int getSurplusQueuedTaskCount() {
1179	<	return ((ForkJoinWorkerThread) Thread.currentThread())
927	<	.getEstimatedSurplusTaskCount();
1179	>	return ForkJoinPool.getSurplusQueuedTaskCount();
1180		}
1181
1182		// Extension methods
#	Line 950 | Line 1202 | public abstract class ForkJoinTask<V> im
1202		protected abstract void setRawResult(V value);
1203
1204		/**
1205	<	* Immediately performs the base action of this task.  This method
1206	<	* is designed to support extensions, and should not in general be
1207	<	* called otherwise. The return value controls whether this task
1208	<	* is considered to be done normally. It may return false in
1205	>	* 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		* asynchronous actions that require explicit invocations of
1211	<	* {@link #complete} to become joinable. It may also throw an
1212	<	* (unchecked) exception to indicate abnormal exit.
1211	>	* 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		*
1216	<	* @return {@code true} if completed normally
1216	>	* @return {@code true} if this task is known to have completed normally
1217		*/
1218		protected abstract boolean exec();
1219
#	Line 972 | Line 1227 | public abstract class ForkJoinTask<V> im
1227		* primarily to support extensions, and is unlikely to be useful
1228		* otherwise.
1229		*
975	–	* <p>This method may be invoked only from within {@code
976	–	* ForkJoinPool} computations (as may be determined using method
977	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
978	–	* result in exceptions or errors, possibly including {@code
979	–	* ClassCastException}.
980	–	*
1230		* @return the next task, or {@code null} if none are available
1231		*/
1232		protected static ForkJoinTask<?> peekNextLocalTask() {
1233	<	return ((ForkJoinWorkerThread) Thread.currentThread())
1234	<	.peekTask();
1233	>	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		}
1240
1241		/**
1242		* Unschedules and returns, without executing, the next task
1243	<	* queued by the current thread but not yet executed.  This method
1244	<	* is designed primarily to support extensions, and is unlikely to
1245	<	* be useful otherwise.
1246	<	*
994	<	* <p>This method may be invoked only from within {@code
995	<	* ForkJoinPool} computations (as may be determined using method
996	<	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
997	<	* result in exceptions or errors, possibly including {@code
998	<	* ClassCastException}.
1243	>	* 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		*
1248		* @return the next task, or {@code null} if none are available
1249		*/
1250		protected static ForkJoinTask<?> pollNextLocalTask() {
1251	<	return ((ForkJoinWorkerThread) Thread.currentThread())
1252	<	.pollLocalTask();
1251	>	Thread t;
1252	>	return ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1253	>	((ForkJoinWorkerThread)t).workQueue.nextLocalTask() :
1254	>	null;
1255		}
1256
1257		/**
1258	<	* Unschedules and returns, without executing, the next task
1258	>	* If the current thread is operating in a ForkJoinPool,
1259	>	* unschedules and returns, without executing, the next task
1260		* 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	<	* {@code null} result does not necessarily imply quiescence
1264	<	* of the pool this task is operating in.  This method is designed
1263	>	* {@code null} result does not necessarily imply quiescence of
1264	>	* the pool this task is operating in.  This method is designed
1265		* primarily to support extensions, and is unlikely to be useful
1266		* otherwise.
1267		*
1017	–	* <p>This method may be invoked only from within {@code
1018	–	* ForkJoinPool} computations (as may be determined using method
1019	–	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1020	–	* result in exceptions or errors, possibly including {@code
1021	–	* ClassCastException}.
1022	–	*
1268		* @return a task, or {@code null} if none are available
1269		*/
1270		protected static ForkJoinTask<?> pollTask() {
1271	<	return ((ForkJoinWorkerThread) Thread.currentThread())
1272	<	.pollTask();
1271	>	Thread t; ForkJoinWorkerThread wt;
1272	>	return ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) ?
1273	>	(wt = (ForkJoinWorkerThread)t).pool.nextTaskFor(wt.workQueue) :
1274	>	null;
1275	>	}
1276	>
1277	>	// tag operations
1278	>
1279	>	/**
1280	>	* Returns the tag for this task.
1281	>	*
1282	>	* @return the tag for this task
1283	>	* @since 1.8
1284	>	*/
1285	>	public final short getForkJoinTaskTag() {
1286	>	return (short)status;
1287	>	}
1288	>
1289	>	/**
1290	>	* Atomically sets the tag value for this task.
1291	>	*
1292	>	* @param tag the tag value
1293	>	* @return the previous value of the tag
1294	>	* @since 1.8
1295	>	*/
1296	>	public final short setForkJoinTaskTag(short tag) {
1297	>	for (int s;;) {
1298	>	if (U.compareAndSwapInt(this, STATUS, s = status,
1299	>	(s & ~SMASK) | (tag & SMASK)))
1300	>	return (short)s;
1301	>	}
1302	>	}
1303	>
1304	>	/**
1305	>	* Atomically conditionally sets the tag value for this task.
1306	>	* Among other applications, tags can be used as visit markers
1307	>	* in tasks operating on graphs, as in methods that check: {@code
1308	>	* if (task.compareAndSetForkJoinTaskTag((short)0, (short)1))}
1309	>	* before processing, otherwise exiting because the node has
1310	>	* already been visited.
1311	>	*
1312	>	* @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	>	* @since 1.8
1317	>	*/
1318	>	public final boolean compareAndSetForkJoinTaskTag(short e, short tag) {
1319	>	for (int s;;) {
1320	>	if ((short)(s = status) != e)
1321	>	return false;
1322	>	if (U.compareAndSwapInt(this, STATUS, s,
1323	>	(s & ~SMASK) | (tag & SMASK)))
1324	>	return true;
1325	>	}
1326		}
1327
1328		/**
#	Line 1035 | Line 1333 | public abstract class ForkJoinTask<V> im
1333		static final class AdaptedRunnable<T> extends ForkJoinTask<T>
1334		implements RunnableFuture<T> {
1335		final Runnable runnable;
1038	–	final T resultOnCompletion;
1336		T result;
1337		AdaptedRunnable(Runnable runnable, T result) {
1338		if (runnable == null) throw new NullPointerException();
1339		this.runnable = runnable;
1340	<	this.resultOnCompletion = result;
1340	>	this.result = result; // OK to set this even before completion
1341		}
1342	<	public T getRawResult() { return result; }
1343	<	public void setRawResult(T v) { result = v; }
1344	<	public boolean exec() {
1345	<	runnable.run();
1346	<	result = resultOnCompletion;
1347	<	return true;
1342	>	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		}
1359	<	public void run() { invoke(); }
1359	>	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		private static final long serialVersionUID = 5232453952276885070L;
1364		}
1365
#	Line 1064 | Line 1374 | public abstract class ForkJoinTask<V> im
1374		if (callable == null) throw new NullPointerException();
1375		this.callable = callable;
1376		}
1377	<	public T getRawResult() { return result; }
1378	<	public void setRawResult(T v) { result = v; }
1379	<	public boolean exec() {
1377	>	public final T getRawResult() { return result; }
1378	>	public final void setRawResult(T v) { result = v; }
1379	>	public final boolean exec() {
1380		try {
1381		result = callable.call();
1382		return true;
#	Line 1078 | Line 1388 | public abstract class ForkJoinTask<V> im
1388		throw new RuntimeException(ex);
1389		}
1390		}
1391	<	public void run() { invoke(); }
1391	>	public final void run() { invoke(); }
1392		private static final long serialVersionUID = 2838392045355241008L;
1393		}
1394
#	Line 1091 | Line 1401 | public abstract class ForkJoinTask<V> im
1401		* @return the task
1402		*/
1403		public static ForkJoinTask<?> adapt(Runnable runnable) {
1404	<	return new AdaptedRunnable<Void>(runnable, null);
1404	>	return new AdaptedRunnableAction(runnable);
1405		}
1406
1407		/**
#	Line 1125 | Line 1435 | public abstract class ForkJoinTask<V> im
1435		private static final long serialVersionUID = -7721805057305804111L;
1436
1437		/**
1438	<	* Saves the state to a stream (that is, serializes it).
1438	>	* Saves this task to a stream (that is, serializes it).
1439		*
1440		* @serialData the current run status and the exception thrown
1441		* during execution, or {@code null} if none
1132	–	* @param s the stream
1442		*/
1443		private void writeObject(java.io.ObjectOutputStream s)
1444		throws java.io.IOException {
#	Line 1138 | Line 1447 | public abstract class ForkJoinTask<V> im
1447		}
1448
1449		/**
1450	<	* Reconstitutes the instance from a stream (that is, deserializes it).
1142	<	*
1143	<	* @param s the stream
1450	>	* Reconstitutes this task from a stream (that is, deserializes it).
1451		*/
1452		private void readObject(java.io.ObjectInputStream s)
1453		throws java.io.IOException, ClassNotFoundException {
1454		s.defaultReadObject();
1455		Object ex = s.readObject();
1456		if (ex != null)
1457	<	setExceptionalCompletion((Throwable) ex);
1457	>	setExceptionalCompletion((Throwable)ex);
1458		}
1459
1460		// Unsafe mechanics
1461	+	private static final sun.misc.Unsafe U;
1462	+	private static final long STATUS;
1463
1464	<	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1465	<	private static final long statusOffset =
1466	<	objectFieldOffset("status", ForkJoinTask.class);
1467	<
1159	<	private static long objectFieldOffset(String field, Class<?> klazz) {
1464	>	static {
1465	>	exceptionTableLock = new ReentrantLock();
1466	>	exceptionTableRefQueue = new ReferenceQueue<Object>();
1467	>	exceptionTable = new ExceptionNode[EXCEPTION_MAP_CAPACITY];
1468		try {
1469	<	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1470	<	} catch (NoSuchFieldException e) {
1471	<	// Convert Exception to corresponding Error
1472	<	NoSuchFieldError error = new NoSuchFieldError(field);
1473	<	error.initCause(e);
1474	<	throw error;
1469	>	U = getUnsafe();
1470	>	Class<?> k = ForkJoinTask.class;
1471	>	STATUS = U.objectFieldOffset
1472	>	(k.getDeclaredField("status"));
1473	>	} catch (Exception e) {
1474	>	throw new Error(e);
1475		}
1476		}
1477
#	Line 1177 | Line 1485 | public abstract class ForkJoinTask<V> im
1485		private static sun.misc.Unsafe getUnsafe() {
1486		try {
1487		return sun.misc.Unsafe.getUnsafe();
1488	<	} catch (SecurityException se) {
1489	<	try {
1490	<	return java.security.AccessController.doPrivileged
1491	<	(new java.security
1492	<	.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1493	<	public sun.misc.Unsafe run() throws Exception {
1494	<	java.lang.reflect.Field f = sun.misc
1495	<	.Unsafe.class.getDeclaredField("theUnsafe");
1496	<	f.setAccessible(true);
1497	<	return (sun.misc.Unsafe) f.get(null);
1498	<	}});
1499	<	} catch (java.security.PrivilegedActionException e) {
1500	<	throw new RuntimeException("Could not initialize intrinsics",
1501	<	e.getCause());
1502	<	}
1488	>	} catch (SecurityException tryReflectionInstead) {}
1489	>	try {
1490	>	return java.security.AccessController.doPrivileged
1491	>	(new java.security.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1492	>	public sun.misc.Unsafe run() throws Exception {
1493	>	Class<sun.misc.Unsafe> k = sun.misc.Unsafe.class;
1494	>	for (java.lang.reflect.Field f : k.getDeclaredFields()) {
1495	>	f.setAccessible(true);
1496	>	Object x = f.get(null);
1497	>	if (k.isInstance(x))
1498	>	return k.cast(x);
1499	>	}
1500	>	throw new NoSuchFieldError("the Unsafe");
1501	>	}});
1502	>	} catch (java.security.PrivilegedActionException e) {
1503	>	throw new RuntimeException("Could not initialize intrinsics",
1504	>	e.getCause());
1505		}
1506		}
1507		}

Diff Legend

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