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.1 by dl, Tue Jan 6 14:30:31 2009 UTC vs.
Revision 1.18 by dl, Sat Jul 25 15:50:57 2009 UTC

#	Line 5 | Line 5
5		*/
6
7		package jsr166y;
8	<	import java.io.Serializable;
9	<	import java.util.*;
8	>
9		import java.util.concurrent.*;
10	<	import java.util.concurrent.atomic.*;
11	<	import sun.misc.Unsafe;
12	<	import java.lang.reflect.*;
10	>
11	>	import java.io.Serializable;
12	>	import java.util.Collection;
13	>	import java.util.Collections;
14	>	import java.util.List;
15	>	import java.util.Map;
16	>	import java.util.WeakHashMap;
17
18		/**
19	<	* Abstract base class for tasks that run within a ForkJoinPool.  A
20	<	* ForkJoinTask is a thread-like entity that is much lighter weight
21	<	* than a normal thread.  Huge numbers of tasks and subtasks may be
22	<	* hosted by a small number of actual threads in a ForkJoinPool,
23	<	* at the price of some usage limitations.
19	>	* Abstract base class for tasks that run within a {@link
20	>	* ForkJoinPool}.  A ForkJoinTask is a thread-like entity that is much
21	>	* lighter weight than a normal thread.  Huge numbers of tasks and
22	>	* subtasks may be hosted by a small number of actual threads in a
23	>	* ForkJoinPool, at the price of some usage limitations.
24		*
25	<	* <p> ForkJoinTasks are forms of <tt>Futures</tt> supporting a
26	<	* limited range of use.  The "lightness" of ForkJoinTasks is due to a
27	<	* set of restrictions (that are only partially statically
28	<	* enforceable) reflecting their intended use as computational tasks
29	<	* calculating pure functions or operating on purely isolated objects.
30	<	* The primary coordination mechanisms supported for ForkJoinTasks are
31	<	* <tt>fork</tt>, that arranges asynchronous execution, and
32	<	* <tt>join</tt>, that doesn't proceed until the task's result has
33	<	* been computed. (Cancellation is also supported).  The computation
34	<	* defined in the <tt>compute</tt> method should avoid
35	<	* <tt>synchronized</tt> methods or blocks, and should minimize
36	<	* blocking synchronization apart from joining other tasks or using
25	>	* <p> A "main" ForkJoinTask begins execution when submitted to a
26	>	* {@link ForkJoinPool}. Once started, it will usually in turn start
27	>	* other subtasks.  As indicated by the name of this class, many
28	>	* programs using ForkJoinTasks employ only methods {@code fork}
29	>	* and {@code join}, or derivatives such as
30	>	* {@code invokeAll}.  However, this class also provides a number
31	>	* of other methods that can come into play in advanced usages, as
32	>	* well as extension mechanics that allow support of new forms of
33	>	* fork/join processing.
34	>	*
35	>	* <p>A ForkJoinTask is a lightweight form of {@link Future}.  The
36	>	* efficiency of ForkJoinTasks stems from a set of restrictions (that
37	>	* are only partially statically enforceable) reflecting their
38	>	* intended use as computational tasks calculating pure functions or
39	>	* operating on purely isolated objects.  The primary coordination
40	>	* mechanisms are {@link #fork}, that arranges asynchronous execution,
41	>	* and {@link #join}, that doesn't proceed until the task's result has
42	>	* been computed.  Computations should avoid {@code synchronized}
43	>	* methods or blocks, and should minimize other blocking
44	>	* synchronization apart from joining other tasks or using
45		* synchronizers such as Phasers that are advertised to cooperate with
46		* fork/join scheduling. Tasks should also not perform blocking IO,
47		* and should ideally access variables that are completely independent
#	Line 38 | Line 49 | import java.lang.reflect.*;
49		* restrictions, for example using shared output streams, may be
50		* tolerable in practice, but frequent use may result in poor
51		* performance, and the potential to indefinitely stall if the number
52	<	* of threads not waiting for external synchronization becomes
53	<	* exhausted. This usage restriction is in part enforced by not
54	<	* permitting checked exceptions such as IOExceptions to be
55	<	* thrown. However, computations may still encounter unchecked
52	>	* of threads not waiting for IO or other external synchronization
53	>	* becomes exhausted. This usage restriction is in part enforced by
54	>	* not permitting checked exceptions such as {@code IOExceptions}
55	>	* to be thrown. However, computations may still encounter unchecked
56		* exceptions, that are rethrown to callers attempting join
57		* them. These exceptions may additionally include
58		* RejectedExecutionExceptions stemming from internal resource
59		* exhaustion such as failure to allocate internal task queues.
60		*
61	<	* <p> The <tt>ForkJoinTask</tt> class is not usually directly
62	<	* subclassed.  Instead, you subclass one of the abstract classes that
63	<	* support different styles of fork/join processing.  Normally, a
64	<	* concrete ForkJoinTask subclass declares fields comprising its
65	<	* parameters, established in a constructor, and then defines a
66	<	* <tt>compute</tt> method that somehow uses the control methods
67	<	* supplied by this base class. While these methods have
68	<	* <tt>public</tt> access, some of them may only be called from within
69	<	* other ForkJoinTasks. Attempts to invoke them in other contexts
70	<	* result in exceptions or errors including ClassCastException.  The
71	<	* only way to invoke a "main" driver task is to submit it to a
72	<	* ForkJoinPool. Once started, this will usually in turn start other
73	<	* subtasks.
61	>	* <p>The primary method for awaiting completion and extracting
62	>	* results of a task is {@link #join}, but there are several variants:
63	>	* The {@link Future#get} methods support interruptible and/or timed
64	>	* waits for completion and report results using {@code Future}
65	>	* conventions. Method {@link #helpJoin} enables callers to actively
66	>	* execute other tasks while awaiting joins, which is sometimes more
67	>	* efficient but only applies when all subtasks are known to be
68	>	* 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
72	>	* may be useful when a set of tasks are being executed, and you need
73	>	* to delay processing of results or exceptions until all complete.
74	>	* Method {@code invokeAll} (available in multiple versions)
75	>	* performs the most common form of parallel invocation: forking a set
76	>	* of tasks and joining them all.
77	>	*
78	>	* <p> The ForkJoinTask class is not usually directly subclassed.
79	>	* Instead, you subclass one of the abstract classes that support a
80	>	* particular style of fork/join processing.  Normally, a concrete
81	>	* ForkJoinTask subclass declares fields comprising its parameters,
82	>	* established in a constructor, and then defines a {@code compute}
83	>	* method that somehow uses the control methods supplied by this base
84	>	* class. While these methods have {@code public} access (to allow
85	>	* instances of different task subclasses to call each others
86	>	* methods), some of them may only be called from within other
87	>	* ForkJoinTasks (as may be determined using method {@link
88	>	* #inForkJoinPool}).  Attempts to invoke them in other contexts
89	>	* result in exceptions or errors, possibly including
90	>	* ClassCastException.
91		*
92	<	* <p>Most base support methods are <tt>final</tt> because their
92	>	* <p>Most base support methods are {@code final} because their
93		* implementations are intrinsically tied to the underlying
94		* lightweight task scheduling framework, and so cannot be overridden.
95		* Developers creating new basic styles of fork/join processing should
96	<	* minimally implement protected methods <tt>exec</tt>,
97	<	* <tt>setRawResult</tt>, and <tt>getRawResult</tt>, while also
98	<	* introducing an abstract computational method that can be
99	<	* implemented in its subclasses. To support such extensions,
100	<	* instances of ForkJoinTasks maintain an atomically updated
101	<	* <tt>short</tt> representing user-defined control state.  Control
74	<	* state is guaranteed initially to be zero, and to be negative upon
75	<	* completion, but may otherwise be used for any other control
76	<	* purposes, such as maintaining join counts.  The {@link
77	<	* ForkJoinWorkerThread} class supports additional inspection and
78	<	* tuning methods that can be useful when developing extensions.
96	>	* minimally implement {@code protected} methods
97	>	* {@code exec}, {@code setRawResult}, and
98	>	* {@code getRawResult}, while also introducing an abstract
99	>	* computational method that can be implemented in its subclasses,
100	>	* possibly relying on other {@code protected} methods provided
101	>	* by this class.
102		*
103		* <p>ForkJoinTasks should perform relatively small amounts of
104	<	* computations, othewise splitting into smaller tasks. As a very
104	>	* computations, otherwise splitting into smaller tasks. As a very
105		* rough rule of thumb, a task should perform more than 100 and less
106		* than 10000 basic computational steps. If tasks are too big, then
107	<	* parellelism cannot improve throughput. If too small, then memory
107	>	* parallelism cannot improve throughput. If too small, then memory
108		* and internal task maintenance overhead may overwhelm processing.
109		*
110	<	* <p>ForkJoinTasks are <tt>Serializable</tt>, which enables them to
111	<	* be used in extensions such as remote execution frameworks. However,
112	<	* it is in general safe to serialize tasks only before or after, but
110	>	* <p>ForkJoinTasks are {@code Serializable}, which enables them
111	>	* to be used in extensions such as remote execution frameworks. It is
112	>	* in general sensible to serialize tasks only before or after, but
113		* not during execution. Serialization is not relied on during
114		* execution itself.
115	+	*
116	+	* @since 1.7
117	+	* @author Doug Lea
118		*/
119		public abstract class ForkJoinTask<V> implements Future<V>, Serializable {
120	+
121		/**
122	<	* Status field holding all run status. We pack this into a single
123	<	* int both to minimize footprint overhead and to ensure atomicity
124	<	* (updates are via CAS).
98	<	*
99	<	* Status is initially zero, and takes on nonnegative values until
122	>	* Run control status bits packed into a single int to minimize
123	>	* footprint and to ensure atomicity (via CAS).  Status is
124	>	* initially zero, and takes on nonnegative values until
125		* completed, upon which status holds COMPLETED. CANCELLED, or
126		* EXCEPTIONAL, which use the top 3 bits.  Tasks undergoing
127		* blocking waits by other threads have SIGNAL_MASK bits set --
#	Line 111 | Line 136 | public abstract class ForkJoinTask<V> im
136		* currently unused. Also value 0x80000000 is available as spare
137		* completion value.
138		*/
139	<	volatile int status; // accessed directy by pool and workers
139	>	volatile int status; // accessed directly by pool and workers
140
141		static final int COMPLETION_MASK      = 0xe0000000;
142		static final int NORMAL               = 0xe0000000; // == mask
#	Line 124 | Line 149 | public abstract class ForkJoinTask<V> im
149		/**
150		* Table of exceptions thrown by tasks, to enable reporting by
151		* callers. Because exceptions are rare, we don't directly keep
152	<	* them with task objects, but instead us a weak ref table.  Note
152	>	* them with task objects, but instead use a weak ref table.  Note
153		* that cancellation exceptions don't appear in the table, but are
154		* instead recorded as status values.
155	<	* Todo: Use ConcurrentReferenceHashMap
155	>	* TODO: Use ConcurrentReferenceHashMap
156		*/
157		static final Map<ForkJoinTask<?>, Throwable> exceptionMap =
158		Collections.synchronizedMap
#	Line 136 | Line 161 | public abstract class ForkJoinTask<V> im
161		// within-package utilities
162
163		/**
164	<	* Get current worker thread, or null if not a worker thread
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);
145	<	}
146	<
147	<	/**
148	<	* Get pool of current worker thread, or null if not a worker thread
149	<	*/
150	<	static ForkJoinPool getWorkerPool() {
151	<	Thread t = Thread.currentThread();
152	<	return ((t instanceof ForkJoinWorkerThread)?
153	<	((ForkJoinWorkerThread)t).pool : null);
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);
173	>	return UNSAFE.compareAndSwapInt(this, statusOffset, cmp, val);
174		}
175
176		/**
#	Line 162 | Line 178 | public abstract class ForkJoinTask<V> im
178		*/
179		static void rethrowException(Throwable ex) {
180		if (ex != null)
181	<	_unsafe.throwException(ex);
181	>	UNSAFE.throwException(ex);
182		}
183
184		// Setting completion status
185
186		/**
187	<	* Mark completion and wake up threads waiting to join this task.
187	>	* Marks completion and wakes up threads waiting to join this task.
188	>	*
189		* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
190		*/
191		final void setCompletion(int completion) {
192	<	ForkJoinPool pool = getWorkerPool();
192	>	ForkJoinPool pool = getPool();
193		if (pool != null) {
194		int s; // Clear signal bits while setting completion status
195	<	do;while ((s = status) >= 0 && !casStatus(s, completion));
195	>	do {} while ((s = status) >= 0 && !casStatus(s, completion));
196
197		if ((s & SIGNAL_MASK) != 0) {
198		if ((s &= INTERNAL_SIGNAL_MASK) != 0)
199		pool.updateRunningCount(s);
200	<	synchronized(this) { notifyAll(); }
200	>	synchronized (this) { notifyAll(); }
201		}
202		}
203		else
#	Line 193 | Line 210 | public abstract class ForkJoinTask<V> im
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(); }
213	>	do {} while ((s = status) >= 0 &&
214	>	!casStatus(s, (s & SIGNAL_MASK) | completion));
215	>	synchronized (this) { notifyAll(); }
216		}
217
218		/**
219	<	* Sets status to indicate normal completion
219	>	* Sets status to indicate normal completion.
220		*/
221		final void setNormalCompletion() {
222		// Try typical fast case -- single CAS, no signal, not already done.
223		// Manually expand casStatus to improve chances of inlining it
224	<	if (!_unsafe.compareAndSwapInt(this, statusOffset, 0, NORMAL))
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
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(); }
238	>	synchronized (this) { if (status >= 0) wait(); }
239		} catch (InterruptedException ie) {
240		onInterruptedWait();
241		}
242		}
243
244		/**
245	<	* Performs the actual monitor wait for awaitDone
245	>	* Performs the actual timed monitor wait for awaitDone.
246		*/
247		private void doAwaitDone(long startTime, long nanos) {
248	<	synchronized(this) {
248	>	synchronized (this) {
249		try {
250		while (status >= 0) {
251		long nt = nanos - System.nanoTime() - startTime;
252		if (nt <= 0)
253		break;
254	<	wait(nt / 1000000, (int)(nt % 1000000));
254	>	wait(nt / 1000000, (int) (nt % 1000000));
255		}
256		} catch (InterruptedException ie) {
257		onInterruptedWait();
#	Line 247 | Line 264 | public abstract class ForkJoinTask<V> im
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	<	final int awaitDone(ForkJoinWorkerThread w, boolean maintainParallelism) {
271	<	ForkJoinPool pool = w == null? null : w.pool;
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)) {
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)
#	Line 266 | Line 285 | public abstract class ForkJoinTask<V> im
285
286		/**
287		* Timed version of awaitDone
288	+	*
289		* @return status upon exit
290		*/
291	<	final int awaitDone(ForkJoinWorkerThread w, long nanos) {
292	<	ForkJoinPool pool = w == null? null : w.pool;
291	>	private int awaitDone(ForkJoinWorkerThread w, long nanos) {
292	>	ForkJoinPool pool = (w == null) ? null : w.pool;
293		int s;
294		while ((s = status) >= 0) {
295	<	if (casStatus(s, pool == null? s|EXTERNAL_SIGNAL : s+1)) {
295	>	if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
296		long startTime = System.nanoTime();
297		if (pool == null || !pool.preJoin(this, false))
298		doAwaitDone(startTime, nanos);
#	Line 289 | Line 309 | public abstract class ForkJoinTask<V> im
309		}
310
311		/**
312	<	* Notify pool that thread is unblocked. Called by signalled
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));
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	<	* Notify pool to adjust counts on cancelled or timed out wait
323	>	* Notifies pool to adjust counts on cancelled or timed out wait.
324		*/
325		private void adjustPoolCountsOnCancelledWait(ForkJoinPool pool) {
326		if (pool != null) {
#	Line 314 | Line 334 | public abstract class ForkJoinTask<V> im
334		}
335		}
336
337	+	/**
338	+	* Handles interruptions during waits.
339	+	*/
340		private void onInterruptedWait() {
341	<	Thread t = Thread.currentThread();
342	<	if (t instanceof ForkJoinWorkerThread) {
343	<	ForkJoinWorkerThread w = (ForkJoinWorkerThread)t;
344	<	if (w.isTerminating())
345	<	cancelIgnoreExceptions();
346	<	}
324	<	else { // re-interrupt
325	<	try {
326	<	t.interrupt();
327	<	} catch (SecurityException ignore) {
328	<	}
329	<	}
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
#	Line 337 | Line 354 | public abstract class ForkJoinTask<V> im
354		}
355
356		/**
357	<	* Throws the exception associated with status s;
357	>	* Throws the exception associated with status s.
358	>	*
359		* @throws the exception
360		*/
361		private void reportException(int s) {
#	Line 350 | Line 368 | public abstract class ForkJoinTask<V> im
368		}
369
370		/**
371	<	* Returns result or throws exception using j.u.c.Future conventions
372	<	* Only call when isDone known to be true.
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 {
#	Line 370 | Line 388 | public abstract class ForkJoinTask<V> im
388
389		/**
390		* Returns result or throws exception using j.u.c.Future conventions
391	<	* with timeouts
391	>	* with timeouts.
392		*/
393		private V reportTimedFutureResult()
394		throws InterruptedException, ExecutionException, TimeoutException {
#	Line 391 | Line 409 | public abstract class ForkJoinTask<V> im
409
410		/**
411		* Calls exec, recording completion, and rethrowing exception if
412	<	* encountered. Caller should normally check status before calling
412	>	* encountered. Caller should normally check status before calling.
413	>	*
414		* @return true if completed normally
415		*/
416		private boolean tryExec() {
#	Line 409 | Line 428 | public abstract class ForkJoinTask<V> im
428
429		/**
430		* Main execution method used by worker threads. Invokes
431	<	* base computation unless already complete
431	>	* base computation unless already complete.
432		*/
433		final void quietlyExec() {
434		if (status >= 0) {
435		try {
436		if (!exec())
437		return;
438	<	} catch(Throwable rex) {
438	>	} catch (Throwable rex) {
439		setDoneExceptionally(rex);
440		return;
441		}
#	Line 425 | Line 444 | public abstract class ForkJoinTask<V> im
444		}
445
446		/**
447	<	* Calls exec, recording but not rethrowing exception
448	<	* Caller should normally check status before calling
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() {
#	Line 442 | Line 462 | public abstract class ForkJoinTask<V> im
462		}
463
464		/**
465	<	* Cancel, ignoring any exceptions it throws
465	>	* Cancels, ignoring any exceptions it throws.
466		*/
467	<	final void cancelIgnoreExceptions() {
467	>	final void cancelIgnoringExceptions() {
468		try {
469		cancel(false);
470	<	} catch(Throwable ignore) {
470	>	} catch (Throwable ignore) {
471		}
472		}
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
483	+	}
484	+
485		// public methods
486
487		/**
488		* Arranges to asynchronously execute this task.  While it is not
489		* necessarily enforced, it is a usage error to fork a task more
490		* than once unless it has completed and been reinitialized.  This
491	<	* method may be invoked only from within other ForkJoinTask
492	<	* computations. Attempts to invoke in other contexts result in
493	<	* exceptions or errors including ClassCastException.
491	>	* method may be invoked only from within ForkJoinTask
492	>	* computations (as may be determined using method {@link
493	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
494	>	* in exceptions or errors, possibly including ClassCastException.
495	>	*
496	>	* @return <code>this</code>, to simplify usage.
497		*/
498	<	public final void fork() {
499	<	((ForkJoinWorkerThread)(Thread.currentThread())).pushTask(this);
498	>	public final ForkJoinTask<V> fork() {
499	>	((ForkJoinWorkerThread) Thread.currentThread())
500	>	.pushTask(this);
501	>	return this;
502		}
503
504		/**
505		* Returns the result of the computation when it is ready.
506	<	* This method differs from <tt>get</tt> in that abnormal
506	>	* This method differs from {@code get} in that abnormal
507		* completion results in RuntimeExceptions or Errors, not
508		* ExecutionExceptions.
509		*
#	Line 480 | Line 516 | public abstract class ForkJoinTask<V> im
516		return getRawResult();
517		}
518
483	–	public final V get() throws InterruptedException, ExecutionException {
484	–	ForkJoinWorkerThread w = getWorker();
485	–	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
486	–	awaitDone(w, true);
487	–	return reportFutureResult();
488	–	}
489	–
490	–	public final V get(long timeout, TimeUnit unit)
491	–	throws InterruptedException, ExecutionException, TimeoutException {
492	–	ForkJoinWorkerThread w = getWorker();
493	–	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
494	–	awaitDone(w, unit.toNanos(timeout));
495	–	return reportTimedFutureResult();
496	–	}
497	–
498	–	/**
499	–	* Possibly executes other tasks until this task is ready, then
500	–	* returns the result of the computation.  This method may be more
501	–	* efficient than <tt>join</tt>, but is only applicable when there
502	–	* are no potemtial dependencies between continuation of the
503	–	* current task and that of any other task that might be executed
504	–	* while helping. (This usually holds for pure divide-and-conquer
505	–	* tasks).
506	–	* @return the computed result
507	–	*/
508	–	public final V helpJoin() {
509	–	ForkJoinWorkerThread w = (ForkJoinWorkerThread)(Thread.currentThread());
510	–	if (status < 0 || !w.unpushTask(this) || !tryExec())
511	–	reportException(w.helpJoinTask(this));
512	–	return getRawResult();
513	–	}
514	–
519		/**
520	<	* Performs this task, awaits its completion if necessary, and
521	<	* return its result.
520	>	* Commences performing this task, awaits its completion if
521	>	* necessary, and return its result.
522	>	*
523		* @throws Throwable (a RuntimeException, Error, or unchecked
524	<	* exception) if the underlying computation did so.
524	>	* exception) if the underlying computation did so
525		* @return the computed result
526		*/
527		public final V invoke() {
#	Line 527 | Line 532 | public abstract class ForkJoinTask<V> im
532		}
533
534		/**
535	<	* Joins this task, without returning its result or throwing an
536	<	* exception. This method may be useful when processing
537	<	* collections of tasks when some have been cancelled or otherwise
538	<	* known to have aborted.
535	>	* Forks both tasks, returning when {@code isDone} holds for
536	>	* both of them or an exception is encountered. This method may be
537	>	* invoked only from within ForkJoinTask computations (as may be
538	>	* determined using method {@link #inForkJoinPool}). Attempts to
539	>	* invoke in other contexts result in exceptions or errors,
540	>	* possibly including ClassCastException.
541	>	*
542	>	* @param t1 one task
543	>	* @param t2 the other task
544	>	* @throws NullPointerException if t1 or t2 are null
545	>	* @throws RuntimeException or Error if either task did so
546		*/
547	<	public final void quietlyJoin() {
548	<	if (status >= 0) {
549	<	ForkJoinWorkerThread w = getWorker();
550	<	if (w == null || !w.unpushTask(this) || !tryQuietlyInvoke())
539	<	awaitDone(w, true);
540	<	}
547	>	public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) {
548	>	t2.fork();
549	>	t1.invoke();
550	>	t2.join();
551		}
552
553		/**
554	<	* Possibly executes other tasks until this task is ready.
554	>	* Forks the given tasks, returning when {@code isDone} holds
555	>	* for all of them. If any task encounters an exception, others
556	>	* may be cancelled.  This method may be invoked only from within
557	>	* ForkJoinTask computations (as may be determined using method
558	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
559	>	* result in exceptions or errors, possibly including
560	>	* ClassCastException.
561	>	*
562	>	* @param tasks the array of tasks
563	>	* @throws NullPointerException if tasks or any element are null
564	>	* @throws RuntimeException or Error if any task did so
565		*/
566	<	public final void quietlyHelpJoin() {
567	<	if (status >= 0) {
568	<	ForkJoinWorkerThread w =
569	<	(ForkJoinWorkerThread)(Thread.currentThread());
570	<	if (!w.unpushTask(this) || !tryQuietlyInvoke())
571	<	w.helpJoinTask(this);
566	>	public static void invokeAll(ForkJoinTask<?>... tasks) {
567	>	Throwable ex = null;
568	>	int last = tasks.length - 1;
569	>	for (int i = last; i >= 0; --i) {
570	>	ForkJoinTask<?> t = tasks[i];
571	>	if (t == null) {
572	>	if (ex == null)
573	>	ex = new NullPointerException();
574	>	}
575	>	else if (i != 0)
576	>	t.fork();
577	>	else {
578	>	t.quietlyInvoke();
579	>	if (ex == null)
580	>	ex = t.getException();
581	>	}
582		}
583	+	for (int i = 1; i <= last; ++i) {
584	+	ForkJoinTask<?> t = tasks[i];
585	+	if (t != null) {
586	+	if (ex != null)
587	+	t.cancel(false);
588	+	else {
589	+	t.quietlyJoin();
590	+	if (ex == null)
591	+	ex = t.getException();
592	+	}
593	+	}
594	+	}
595	+	if (ex != null)
596	+	rethrowException(ex);
597		}
598
599		/**
600	<	* Performs this task and awaits its completion if necessary,
601	<	* without returning its result or throwing an exception. This
602	<	* method may be useful when processing collections of tasks when
603	<	* some have been cancelled or otherwise known to have aborted.
600	>	* Forks all tasks in the collection, returning when
601	>	* {@code isDone} holds for all of them. If any task
602	>	* encounters an exception, others may be cancelled.  This method
603	>	* may be invoked only from within ForkJoinTask computations (as
604	>	* may be determined using method {@link
605	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
606	>	* in exceptions or errors, possibly including ClassCastException.
607	>	*
608	>	* @param tasks the collection of tasks
609	>	* @throws NullPointerException if tasks or any element are null
610	>	* @throws RuntimeException or Error if any task did so
611		*/
612	<	public final void quietlyInvoke() {
613	<	if (status >= 0 && !tryQuietlyInvoke())
614	<	quietlyJoin();
612	>	public static void invokeAll(Collection<? extends ForkJoinTask<?>> tasks) {
613	>	if (!(tasks instanceof List<?>)) {
614	>	invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
615	>	return;
616	>	}
617	>	@SuppressWarnings("unchecked")
618	>	List<? extends ForkJoinTask<?>> ts =
619	>	(List<? extends ForkJoinTask<?>>) tasks;
620	>	Throwable ex = null;
621	>	int last = ts.size() - 1;
622	>	for (int i = last; i >= 0; --i) {
623	>	ForkJoinTask<?> t = ts.get(i);
624	>	if (t == null) {
625	>	if (ex == null)
626	>	ex = new NullPointerException();
627	>	}
628	>	else if (i != 0)
629	>	t.fork();
630	>	else {
631	>	t.quietlyInvoke();
632	>	if (ex == null)
633	>	ex = t.getException();
634	>	}
635	>	}
636	>	for (int i = 1; i <= last; ++i) {
637	>	ForkJoinTask<?> t = ts.get(i);
638	>	if (t != null) {
639	>	if (ex != null)
640	>	t.cancel(false);
641	>	else {
642	>	t.quietlyJoin();
643	>	if (ex == null)
644	>	ex = t.getException();
645	>	}
646	>	}
647	>	}
648	>	if (ex != null)
649	>	rethrowException(ex);
650		}
651
652		/**
653		* Returns true if the computation performed by this task has
654		* completed (or has been cancelled).
655	+	*
656		* @return true if this computation has completed
657		*/
658		public final boolean isDone() {
#	Line 574 | Line 661 | public abstract class ForkJoinTask<V> im
661
662		/**
663		* Returns true if this task was cancelled.
664	+	*
665		* @return true if this task was cancelled
666		*/
667		public final boolean isCancelled() {
#	Line 581 | Line 669 | public abstract class ForkJoinTask<V> im
669		}
670
671		/**
584	–	* Returns true if this task threw an exception or was cancelled
585	–	* @return true if this task threw an exception or was cancelled
586	–	*/
587	–	public final boolean completedAbnormally() {
588	–	return (status & COMPLETION_MASK) < NORMAL;
589	–	}
590	–
591	–	/**
592	–	* Returns the exception thrown by the base computation, or a
593	–	* CancellationException if cancelled, or null if none or if the
594	–	* method has not yet completed.
595	–	* @return the exception, or null if none
596	–	*/
597	–	public final Throwable getException() {
598	–	int s = status & COMPLETION_MASK;
599	–	if (s >= NORMAL)
600	–	return null;
601	–	if (s == CANCELLED)
602	–	return new CancellationException();
603	–	return exceptionMap.get(this);
604	–	}
605	–
606	–	/**
672		* Asserts that the results of this task's computation will not be
673	<	* used. If a cancellation occurs before this task is processed,
674	<	* then its <tt>compute</tt> method will not be executed,
675	<	* <tt>isCancelled</tt> will report true, and <tt>join</tt> will
676	<	* result in a CancellationException being thrown. Otherwise, when
673	>	* used. If a cancellation occurs before attempting to execute this
674	>	* task, then execution will be suppressed, {@code isCancelled}
675	>	* will report true, and {@code join} will result in a
676	>	* {@code CancellationException} being thrown. Otherwise, when
677		* cancellation races with completion, there are no guarantees
678	<	* about whether <tt>isCancelled</tt> will report true, whether
679	<	* <tt>join</tt> will return normally or via an exception, or
678	>	* about whether {@code isCancelled} will report true, whether
679	>	* {@code join} will return normally or via an exception, or
680		* whether these behaviors will remain consistent upon repeated
681		* invocation.
682		*
#	Line 622 | Line 687 | public abstract class ForkJoinTask<V> im
687		* <p> This method is designed to be invoked by <em>other</em>
688		* tasks. To terminate the current task, you can just return or
689		* throw an unchecked exception from its computation method, or
690	<	* invoke <tt>completeExceptionally(someException)</tt>.
690	>	* invoke {@code completeExceptionally}.
691		*
692		* @param mayInterruptIfRunning this value is ignored in the
693		* default implementation because tasks are not in general
694	<	* cancelled via interruption.
694	>	* cancelled via interruption
695		*
696		* @return true if this task is now cancelled
697		*/
#	Line 636 | Line 701 | public abstract class ForkJoinTask<V> im
701		}
702
703		/**
704	+	* Returns true if this task threw an exception or was cancelled.
705	+	*
706	+	* @return true if this task threw an exception or was cancelled
707	+	*/
708	+	public final boolean isCompletedAbnormally() {
709	+	return (status & COMPLETION_MASK) < NORMAL;
710	+	}
711	+
712	+	/**
713	+	* Returns the exception thrown by the base computation, or a
714	+	* CancellationException if cancelled, or null if none or if the
715	+	* method has not yet completed.
716	+	*
717	+	* @return the exception, or null if none
718	+	*/
719	+	public final Throwable getException() {
720	+	int s = status & COMPLETION_MASK;
721	+	if (s >= NORMAL)
722	+	return null;
723	+	if (s == CANCELLED)
724	+	return new CancellationException();
725	+	return exceptionMap.get(this);
726	+	}
727	+
728	+	/**
729		* Completes this task abnormally, and if not already aborted or
730		* cancelled, causes it to throw the given exception upon
731	<	* <tt>join</tt> and related operations. This method may be used
731	>	* {@code join} and related operations. This method may be used
732		* to induce exceptions in asynchronous tasks, or to force
733	<	* completion of tasks that would not otherwise complete.  This
734	<	* method is overridable, but overridden versions must invoke
735	<	* <tt>super</tt> implementation to maintain guarantees.
733	>	* completion of tasks that would not otherwise complete.  Its use
734	>	* in other situations is likely to be wrong.  This method is
735	>	* overridable, but overridden versions must invoke {@code super}
736	>	* implementation to maintain guarantees.
737	>	*
738		* @param ex the exception to throw. If this exception is
739		* not a RuntimeException or Error, the actual exception thrown
740		* will be a RuntimeException with cause ex.
741		*/
742		public void completeExceptionally(Throwable ex) {
743		setDoneExceptionally((ex instanceof RuntimeException) ||
744	<	(ex instanceof Error)? ex :
744	>	(ex instanceof Error) ? ex :
745		new RuntimeException(ex));
746		}
747
748		/**
749		* Completes this task, and if not already aborted or cancelled,
750	<	* returning a <tt>null</tt> result upon <tt>join</tt> and related
750	>	* returning a {@code null} result upon {@code join} and related
751		* operations. This method may be used to provide results for
752		* asynchronous tasks, or to provide alternative handling for
753	<	* tasks that would not otherwise complete normally.
753	>	* tasks that would not otherwise complete normally. Its use in
754	>	* other situations is likely to be wrong. This method is
755	>	* overridable, but overridden versions must invoke {@code super}
756	>	* implementation to maintain guarantees.
757		*
758	<	* @param value the result value for this task.
758	>	* @param value the result value for this task
759		*/
760		public void complete(V value) {
761		try {
762		setRawResult(value);
763	<	} catch(Throwable rex) {
763	>	} catch (Throwable rex) {
764		setDoneExceptionally(rex);
765		return;
766		}
767		setNormalCompletion();
768		}
769
770	+	public final V get() throws InterruptedException, ExecutionException {
771	+	ForkJoinWorkerThread w = getWorker();
772	+	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
773	+	awaitDone(w, true);
774	+	return reportFutureResult();
775	+	}
776	+
777	+	public final V get(long timeout, TimeUnit unit)
778	+	throws InterruptedException, ExecutionException, TimeoutException {
779	+	ForkJoinWorkerThread w = getWorker();
780	+	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
781	+	awaitDone(w, unit.toNanos(timeout));
782	+	return reportTimedFutureResult();
783	+	}
784	+
785	+	/**
786	+	* Possibly executes other tasks until this task is ready, then
787	+	* returns the result of the computation.  This method may be more
788	+	* efficient than {@code join}, but is only applicable when
789	+	* there are no potential dependencies between continuation of the
790	+	* current task and that of any other task that might be executed
791	+	* while helping. (This usually holds for pure divide-and-conquer
792	+	* tasks). This method may be invoked only from within
793	+	* ForkJoinTask computations (as may be determined using method
794	+	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
795	+	* result in exceptions or errors, possibly including
796	+	* ClassCastException.
797	+	*
798	+	* @return the computed result
799	+	*/
800	+	public final V helpJoin() {
801	+	ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
802	+	if (status < 0 || !w.unpushTask(this) || !tryExec())
803	+	reportException(busyJoin(w));
804	+	return getRawResult();
805	+	}
806	+
807	+	/**
808	+	* Possibly executes other tasks until this task is ready.  This
809	+	* method may be invoked only from within ForkJoinTask
810	+	* computations (as may be determined using method {@link
811	+	* #inForkJoinPool}). Attempts to invoke in other contexts result
812	+	* in exceptions or errors, possibly including ClassCastException.
813	+	*/
814	+	public final void quietlyHelpJoin() {
815	+	if (status >= 0) {
816	+	ForkJoinWorkerThread w =
817	+	(ForkJoinWorkerThread) Thread.currentThread();
818	+	if (!w.unpushTask(this) || !tryQuietlyInvoke())
819	+	busyJoin(w);
820	+	}
821	+	}
822	+
823	+	/**
824	+	* Joins this task, without returning its result or throwing an
825	+	* exception. This method may be useful when processing
826	+	* collections of tasks when some have been cancelled or otherwise
827	+	* known to have aborted.
828	+	*/
829	+	public final void quietlyJoin() {
830	+	if (status >= 0) {
831	+	ForkJoinWorkerThread w = getWorker();
832	+	if (w == null || !w.unpushTask(this) || !tryQuietlyInvoke())
833	+	awaitDone(w, true);
834	+	}
835	+	}
836	+
837	+	/**
838	+	* Commences performing this task and awaits its completion if
839	+	* necessary, without returning its result or throwing an
840	+	* exception. This method may be useful when processing
841	+	* collections of tasks when some have been cancelled or otherwise
842	+	* known to have aborted.
843	+	*/
844	+	public final void quietlyInvoke() {
845	+	if (status >= 0 && !tryQuietlyInvoke())
846	+	quietlyJoin();
847	+	}
848	+
849	+	/**
850	+	* Possibly executes tasks until the pool hosting the current task
851	+	* {@link ForkJoinPool#isQuiescent}. This method may be of use in
852	+	* designs in which many tasks are forked, but none are explicitly
853	+	* joined, instead executing them until all are processed.
854	+	*/
855	+	public static void helpQuiesce() {
856	+	((ForkJoinWorkerThread) Thread.currentThread())
857	+	.helpQuiescePool();
858	+	}
859	+
860		/**
861		* Resets the internal bookkeeping state of this task, allowing a
862	<	* subsequent <tt>fork</tt>. This method allows repeated reuse of
862	>	* subsequent {@code fork}. This method allows repeated reuse of
863		* this task, but only if reuse occurs when this task has either
864		* never been forked, or has been forked, then completed and all
865		* outstanding joins of this task have also completed. Effects
#	Line 689 | Line 874 | public abstract class ForkJoinTask<V> im
874		}
875
876		/**
877	<	* Tries to unschedule this task for execution. This method will
878	<	* typically succeed if this task is the next task that would be
879	<	* executed by the current thread, and will typically fail (return
880	<	* false) otherwise. This method may be useful when arranging
696	<	* faster local processing of tasks that could have been, but were
697	<	* not, stolen.
698	<	* @return true if unforked
877	>	* Returns the pool hosting the current task execution, or null
878	>	* if this task is executing outside of any ForkJoinPool.
879	>	*
880	>	* @return the pool, or null if none
881		*/
882	<	public boolean tryUnfork() {
883	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).unpushTask(this);
882	>	public static ForkJoinPool getPool() {
883	>	Thread t = Thread.currentThread();
884	>	return (t instanceof ForkJoinWorkerThread) ?
885	>	((ForkJoinWorkerThread) t).pool : null;
886		}
887
888		/**
889	<	* Forks both tasks, returning when <tt>isDone</tt> holds for both
890	<	* of them or an exception is encountered. This method may be
891	<	* invoked only from within other ForkJoinTask
892	<	* computations. Attempts to invoke in other contexts result in
893	<	* exceptions or errors including ClassCastException.
710	<	* @param t1 one task
711	<	* @param t2 the other task
712	<	* @throws NullPointerException if t1 or t2 are null
713	<	* @throws RuntimeException or Error if either task did so.
889	>	* Returns {@code true} if the current thread is executing as a
890	>	* ForkJoinPool computation.
891	>	*
892	>	* @return {@code true} if the current thread is executing as a
893	>	* ForkJoinPool computation, or false otherwise
894		*/
895	<	public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) {
896	<	t2.fork();
717	<	t1.invoke();
718	<	t2.join();
895	>	public static boolean inForkJoinPool() {
896	>	return Thread.currentThread() instanceof ForkJoinWorkerThread;
897		}
898
899		/**
900	<	* Forks the given tasks, returning when <tt>isDone</tt> holds for
901	<	* all of them. If any task encounters an exception, others may be
902	<	* cancelled.  This method may be invoked only from within other
903	<	* ForkJoinTask computations. Attempts to invoke in other contexts
904	<	* result in exceptions or errors including ClassCastException.
905	<	* @param tasks the array of tasks
906	<	* @throws NullPointerException if tasks or any element are null.
907	<	* @throws RuntimeException or Error if any task did so.
908	<	*/
909	<	public static void invokeAll(ForkJoinTask<?>... tasks) {
910	<	Throwable ex = null;
911	<	int last = tasks.length - 1;
734	<	for (int i = last; i >= 0; --i) {
735	<	ForkJoinTask<?> t = tasks[i];
736	<	if (t == null) {
737	<	if (ex == null)
738	<	ex = new NullPointerException();
739	<	}
740	<	else if (i != 0)
741	<	t.fork();
742	<	else {
743	<	t.quietlyInvoke();
744	<	if (ex == null)
745	<	ex = t.getException();
746	<	}
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();
755	<	if (ex == null)
756	<	ex = t.getException();
757	<	}
758	<	}
759	<	}
760	<	if (ex != null)
761	<	rethrowException(ex);
762	<	}
763	<
764	<	/**
765	<	* Forks all tasks in the collection, returning when
766	<	* <tt>isDone</tt> holds for all of them. If any task encounters
767	<	* an exception, others may be cancelled.  This method may be
768	<	* invoked only from within other ForkJoinTask
769	<	* computations. Attempts to invoke in other contexts result in
770	<	* exceptions or errors including ClassCastException.
771	<	* @param tasks the collection of tasks
772	<	* @throws NullPointerException if tasks or any element are null.
773	<	* @throws RuntimeException or Error if any task did so.
900	>	* Tries to unschedule this task for execution. This method will
901	>	* typically succeed if this task is the most recently forked task
902	>	* by the current thread, and has not commenced executing in
903	>	* another thread.  This method may be useful when arranging
904	>	* alternative local processing of tasks that could have been, but
905	>	* were not, stolen. This method may be invoked only from within
906	>	* ForkJoinTask computations (as may be determined using method
907	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
908	>	* result in exceptions or errors, possibly including
909	>	* ClassCastException.
910	>	*
911	>	* @return true if unforked
912		*/
913	<	public static void invokeAll(Collection<? extends ForkJoinTask<?>> tasks) {
914	<	if (!(tasks instanceof List)) {
915	<	invokeAll(tasks.toArray(new ForkJoinTask[tasks.size()]));
778	<	return;
779	<	}
780	<	List<? extends ForkJoinTask<?>> ts =
781	<	(List<? extends ForkJoinTask<?>>)tasks;
782	<	Throwable ex = null;
783	<	int last = ts.size() - 1;
784	<	for (int i = last; i >= 0; --i) {
785	<	ForkJoinTask<?> t = ts.get(i);
786	<	if (t == null) {
787	<	if (ex == null)
788	<	ex = new NullPointerException();
789	<	}
790	<	else if (i != 0)
791	<	t.fork();
792	<	else {
793	<	t.quietlyInvoke();
794	<	if (ex == null)
795	<	ex = t.getException();
796	<	}
797	<	}
798	<	for (int i = 1; i <= last; ++i) {
799	<	ForkJoinTask<?> t = ts.get(i);
800	<	if (t != null) {
801	<	if (ex != null)
802	<	t.cancel(false);
803	<	else {
804	<	t.quietlyJoin();
805	<	if (ex == null)
806	<	ex = t.getException();
807	<	}
808	<	}
809	<	}
810	<	if (ex != null)
811	<	rethrowException(ex);
913	>	public boolean tryUnfork() {
914	>	return ((ForkJoinWorkerThread) Thread.currentThread())
915	>	.unpushTask(this);
916		}
917
918		/**
919	<	* Possibly executes tasks until the pool hosting the current task
920	<	* {@link ForkJoinPool#isQuiescent}. This method may be of use in
921	<	* designs in which many tasks are forked, but none are explicitly
922	<	* joined, instead executing them until all are processed.
919	>	* Returns an estimate of the number of tasks that have been
920	>	* forked by the current worker thread but not yet executed. This
921	>	* value may be useful for heuristic decisions about whether to
922	>	* fork other tasks.
923	>	*
924	>	* @return the number of tasks
925		*/
926	<	public static void helpQuiesce() {
927	<	((ForkJoinWorkerThread)(Thread.currentThread())).
928	<	helpQuiescePool();
926	>	public static int getQueuedTaskCount() {
927	>	return ((ForkJoinWorkerThread) Thread.currentThread())
928	>	.getQueueSize();
929		}
930
931		/**
932	<	* Returns a estimate of how many more locally queued tasks are
932	>	* Returns an estimate of how many more locally queued tasks are
933		* held by the current worker thread than there are other worker
934	<	* threads that might want to steal them.  This value may be
935	<	* useful for heuristic decisions about whether to fork other
936	<	* tasks. In many usages of ForkJoinTasks, at steady state, each
937	<	* worker should aim to maintain a small constant surplus (for
938	<	* example, 3) of tasks, and to process computations locally if
939	<	* this threshold is exceeded.
934	>	* threads that might steal them.  This value may be useful for
935	>	* heuristic decisions about whether to fork other tasks. In many
936	>	* usages of ForkJoinTasks, at steady state, each worker should
937	>	* aim to maintain a small constant surplus (for example, 3) of
938	>	* tasks, and to process computations locally if this threshold is
939	>	* exceeded.
940	>	*
941		* @return the surplus number of tasks, which may be negative
942		*/
943	<	public static int surplus() {
944	<	return ((ForkJoinWorkerThread)(Thread.currentThread()))
943	>	public static int getSurplusQueuedTaskCount() {
944	>	return ((ForkJoinWorkerThread) Thread.currentThread())
945		.getEstimatedSurplusTaskCount();
946		}
947
948	<	// Extension kit
948	>	// Extension methods
949
950		/**
951	<	* Returns the result that would be returned by <tt>join</tt>, or
952	<	* null if this task is not known to have been completed.  This
953	<	* method is designed to aid debugging, as well as to support
954	<	* extensions. Its use in any other context is discouraged.
951	>	* Returns the result that would be returned by {@code join},
952	>	* even if this task completed abnormally, or null if this task is
953	>	* not known to have been completed.  This method is designed to
954	>	* aid debugging, as well as to support extensions. Its use in any
955	>	* other context is discouraged.
956		*
957	<	* @return the result, or null if not completed.
957	>	* @return the result, or null if not completed
958		*/
959		public abstract V getRawResult();
960
#	Line 865 | Line 973 | public abstract class ForkJoinTask<V> im
973		* called otherwise. The return value controls whether this task
974		* is considered to be done normally. It may return false in
975		* asynchronous actions that require explicit invocations of
976	<	* <tt>complete</tt> to become joinable. It may throw exceptions
976	>	* {@code complete} to become joinable. It may throw exceptions
977		* to indicate abnormal exit.
978	+	*
979		* @return true if completed normally
980		* @throws Error or RuntimeException if encountered during computation
981		*/
982		protected abstract boolean exec();
983
984	+	/**
985	+	* Returns, but does not unschedule or execute, the task queued by
986	+	* the current thread but not yet executed, if one is
987	+	* available. There is no guarantee that this task will actually
988	+	* be polled or executed next.  This method is designed primarily
989	+	* to support extensions, and is unlikely to be useful otherwise.
990	+	* This method may be invoked only from within ForkJoinTask
991	+	* computations (as may be determined using method {@link
992	+	* #inForkJoinPool}). Attempts to invoke in other contexts result
993	+	* in exceptions or errors, possibly including ClassCastException.
994	+	*
995	+	* @return the next task, or null if none are available
996	+	*/
997	+	protected static ForkJoinTask<?> peekNextLocalTask() {
998	+	return ((ForkJoinWorkerThread) Thread.currentThread())
999	+	.peekTask();
1000	+	}
1001	+
1002	+	/**
1003	+	* Unschedules and returns, without executing, the next task
1004	+	* queued by the current thread but not yet executed.  This method
1005	+	* is designed primarily to support extensions, and is unlikely to
1006	+	* be useful otherwise.  This method may be invoked only from
1007	+	* within ForkJoinTask computations (as may be determined using
1008	+	* method {@link #inForkJoinPool}). Attempts to invoke in other
1009	+	* contexts result in exceptions or errors, possibly including
1010	+	* ClassCastException.
1011	+	*
1012	+	* @return the next task, or null if none are available
1013	+	*/
1014	+	protected static ForkJoinTask<?> pollNextLocalTask() {
1015	+	return ((ForkJoinWorkerThread) Thread.currentThread())
1016	+	.pollLocalTask();
1017	+	}
1018	+
1019	+	/**
1020	+	* Unschedules and returns, without executing, the next task
1021	+	* queued by the current thread but not yet executed, if one is
1022	+	* available, or if not available, a task that was forked by some
1023	+	* other thread, if available. Availability may be transient, so a
1024	+	* {@code null} result does not necessarily imply quiescence
1025	+	* of the pool this task is operating in.  This method is designed
1026	+	* primarily to support extensions, and is unlikely to be useful
1027	+	* otherwise.  This method may be invoked only from within
1028	+	* ForkJoinTask computations (as may be determined using method
1029	+	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
1030	+	* result in exceptions or errors, possibly including
1031	+	* ClassCastException.
1032	+	*
1033	+	* @return a task, or null if none are available
1034	+	*/
1035	+	protected static ForkJoinTask<?> pollTask() {
1036	+	return ((ForkJoinWorkerThread) Thread.currentThread())
1037	+	.pollTask();
1038	+	}
1039	+
1040	+	// adaptors
1041	+
1042	+	/**
1043	+	* Returns a new ForkJoinTask that performs the <code>run</code>
1044	+	* method of the given Runnable as its action, and returns a null
1045	+	* result upon <code>join</code>.
1046	+	*
1047	+	* @param runnable the runnable action
1048	+	* @return the task
1049	+	*/
1050	+	public static ForkJoinTask<Void> adapt(Runnable runnable) {
1051	+	return new ForkJoinPool.AdaptedRunnable<Void>(runnable, null);
1052	+	}
1053	+
1054	+	/**
1055	+	* Returns a new ForkJoinTask that performs the <code>run</code>
1056	+	* method of the given Runnable as its action, and returns the
1057	+	* given result upon <code>join</code>.
1058	+	*
1059	+	* @param runnable the runnable action
1060	+	* @param result the result upon completion
1061	+	* @return the task
1062	+	*/
1063	+	public static <T> ForkJoinTask<T> adapt(Runnable runnable, T result) {
1064	+	return new ForkJoinPool.AdaptedRunnable<T>(runnable, result);
1065	+	}
1066	+
1067	+	/**
1068	+	* Returns a new ForkJoinTask that performs the <code>call</code>
1069	+	* method of the given Callable as its action, and returns its
1070	+	* result upon <code>join</code>, translating any checked
1071	+	* exceptions encountered into <code>RuntimeException<code>.
1072	+	*
1073	+	* @param callable the callable action
1074	+	* @return the task
1075	+	*/
1076	+	public static <T> ForkJoinTask<T> adapt(Callable<T> callable) {
1077	+	return new ForkJoinPool.AdaptedCallable<T>(callable);
1078	+	}
1079	+
1080		// Serialization support
1081
1082		private static final long serialVersionUID = -7721805057305804111L;
#	Line 880 | Line 1085 | public abstract class ForkJoinTask<V> im
1085		* Save the state to a stream.
1086		*
1087		* @serialData the current run status and the exception thrown
1088	<	* during execution, or null if none.
1088	>	* during execution, or null if none
1089		* @param s the stream
1090		*/
1091		private void writeObject(java.io.ObjectOutputStream s)
#	Line 891 | Line 1096 | public abstract class ForkJoinTask<V> im
1096
1097		/**
1098		* Reconstitute the instance from a stream.
1099	+	*
1100		* @param s the stream
1101		*/
1102		private void readObject(java.io.ObjectInputStream s)
1103		throws java.io.IOException, ClassNotFoundException {
1104		s.defaultReadObject();
1105	<	//        status &= ~INTERNAL_SIGNAL_MASK; //  todo: define policy
1105	>	status &= ~INTERNAL_SIGNAL_MASK; // clear internal signal counts
1106	>	status |= EXTERNAL_SIGNAL; // conservatively set external signal
1107		Object ex = s.readObject();
1108		if (ex != null)
1109	<	setDoneExceptionally((Throwable)ex);
1109	>	setDoneExceptionally((Throwable) ex);
1110		}
1111
1112	<	// Temporary Unsafe mechanics for preliminary release
1112	>	// Unsafe mechanics for jsr166y 3rd party package.
1113	>	private static sun.misc.Unsafe getUnsafe() {
1114	>	try {
1115	>	return sun.misc.Unsafe.getUnsafe();
1116	>	} catch (SecurityException se) {
1117	>	try {
1118	>	return java.security.AccessController.doPrivileged
1119	>	(new java.security.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1120	>	public sun.misc.Unsafe run() throws Exception {
1121	>	return getUnsafeByReflection();
1122	>	}});
1123	>	} catch (java.security.PrivilegedActionException e) {
1124	>	throw new RuntimeException("Could not initialize intrinsics",
1125	>	e.getCause());
1126	>	}
1127	>	}
1128	>	}
1129
1130	<	static final Unsafe _unsafe;
1131	<	static final long statusOffset;
1130	>	private static sun.misc.Unsafe getUnsafeByReflection()
1131	>	throws NoSuchFieldException, IllegalAccessException {
1132	>	java.lang.reflect.Field f =
1133	>	sun.misc.Unsafe.class.getDeclaredField("theUnsafe");
1134	>	f.setAccessible(true);
1135	>	return (sun.misc.Unsafe) f.get(null);
1136	>	}
1137
1138	<	static {
1138	>	private static long fieldOffset(String fieldName, Class<?> klazz) {
1139		try {
1140	<	if (ForkJoinTask.class.getClassLoader() != null) {
1141	<	Field f = Unsafe.class.getDeclaredField("theUnsafe");
1142	<	f.setAccessible(true);
1143	<	_unsafe = (Unsafe)f.get(null);
1144	<	}
1145	<	else
1146	<	_unsafe = Unsafe.getUnsafe();
919	<	statusOffset = _unsafe.objectFieldOffset
920	<	(ForkJoinTask.class.getDeclaredField("status"));
921	<	} catch (Exception ex) { throw new Error(ex); }
1140	>	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(fieldName));
1141	>	} catch (NoSuchFieldException e) {
1142	>	// Convert Exception to Error
1143	>	NoSuchFieldError error = new NoSuchFieldError(fieldName);
1144	>	error.initCause(e);
1145	>	throw error;
1146	>	}
1147		}
1148
1149	+	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1150	+	static final long statusOffset =
1151	+	fieldOffset("status", ForkJoinTask.class);
1152	+
1153		}

Diff Legend

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