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.3 by dl, Wed Jan 7 19:12:36 2009 UTC vs.
Revision 1.17 by jsr166, Sat Jul 25 00:34:00 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 {@link
#	Line 18 | Line 21 | import java.lang.reflect.*;
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	<	*
24	>	*
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</code>
29	<	* and <code>join</code>, or derivatives such as
30	<	* <code>invokeAll</code>.  However, this class also provides a number
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	<	*
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
#	Line 36 | Line 39 | import java.lang.reflect.*;
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</code>
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
#	Line 48 | Line 51 | import java.lang.reflect.*;
51		* performance, and the potential to indefinitely stall if the number
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</code>
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
#	Line 58 | Line 61 | import java.lang.reflect.*;
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</code>
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()</code> but always attempts to
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</code> (available in multiple versions)
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		*
#	Line 76 | Line 79 | import java.lang.reflect.*;
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</code>
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</code> access (to allow
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. Attempts to invoke them in other contexts result in
88	<	* exceptions or errors including ClassCastException.
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 <code>final</code> 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 <code>protected</code> methods
97	<	* <code>exec</code>, <code>setRawResult</code>, and
98	<	* <code>getRawResult</code>, while also introducing an abstract
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</code> methods provided
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 <code>Serializable</code>, which enables them
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
#	Line 128 | 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 141 | 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 153 | 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);
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 170 | 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 = 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 201 | 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 255 | 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	<	private 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 274 | Line 285 | public abstract class ForkJoinTask<V> im
285
286		/**
287		* Timed version of awaitDone
288	+	*
289		* @return status upon exit
290		*/
291		private int awaitDone(ForkJoinWorkerThread w, long nanos) {
292	<	ForkJoinPool pool = w == null? null : w.pool;
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 297 | 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 323 | Line 335 | public abstract class ForkJoinTask<V> im
335		}
336
337		/**
338	<	* Handle interruptions during waits.
338	>	* Handles interruptions during waits.
339		*/
340		private void onInterruptedWait() {
341		ForkJoinWorkerThread w = getWorker();
#	Line 342 | 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 355 | 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 375 | 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 396 | 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 414 | 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 430 | 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 447 | 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 cancelIgnoringExceptions() {
468		try {
469		cancel(false);
470	<	} catch(Throwable ignore) {
470	>	} catch (Throwable ignore) {
471		}
472		}
473
#	Line 464 | Line 479 | public abstract class ForkJoinTask<V> im
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
482	>	return (s >= 0) ? awaitDone(w, false) : s; // block if no work
483		}
484
485		// public methods
#	Line 474 | Line 489 | public abstract class ForkJoinTask<V> im
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 ForkJoinTask
492	<	* computations. Attempts to invoke in other contexts result in
493	<	* exceptions or errors including ClassCastException.
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		public final void fork() {
497	<	((ForkJoinWorkerThread)(Thread.currentThread())).pushTask(this);
497	>	((ForkJoinWorkerThread) Thread.currentThread())
498	>	.pushTask(this);
499		}
500
501		/**
502		* Returns the result of the computation when it is ready.
503	<	* This method differs from <code>get</code> in that abnormal
503	>	* This method differs from {@code get} in that abnormal
504		* completion results in RuntimeExceptions or Errors, not
505		* ExecutionExceptions.
506		*
#	Line 499 | Line 516 | public abstract class ForkJoinTask<V> im
516		/**
517		* Commences performing this task, awaits its completion if
518		* necessary, and return its result.
519	+	*
520		* @throws Throwable (a RuntimeException, Error, or unchecked
521	<	* exception) if the underlying computation did so.
521	>	* exception) if the underlying computation did so
522		* @return the computed result
523		*/
524		public final V invoke() {
#	Line 511 | Line 529 | public abstract class ForkJoinTask<V> im
529		}
530
531		/**
532	<	* Forks both tasks, returning when <code>isDone</code> holds for
532	>	* Forks both tasks, returning when {@code isDone} holds for
533		* both of them or an exception is encountered. This method may be
534	<	* invoked only from within ForkJoinTask computations. Attempts to
535	<	* invoke in other contexts result in exceptions or errors
536	<	* including ClassCastException.
534	>	* invoked only from within ForkJoinTask computations (as may be
535	>	* determined using method {@link #inForkJoinPool}). Attempts to
536	>	* invoke in other contexts result in exceptions or errors,
537	>	* possibly including ClassCastException.
538	>	*
539		* @param t1 one task
540		* @param t2 the other task
541		* @throws NullPointerException if t1 or t2 are null
542	<	* @throws RuntimeException or Error if either task did so.
542	>	* @throws RuntimeException or Error if either task did so
543		*/
544		public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) {
545		t2.fork();
#	Line 528 | Line 548 | public abstract class ForkJoinTask<V> im
548		}
549
550		/**
551	<	* Forks the given tasks, returning when <code>isDone</code> holds
551	>	* Forks the given tasks, returning when {@code isDone} holds
552		* for all of them. If any task encounters an exception, others
553		* may be cancelled.  This method may be invoked only from within
554	<	* ForkJoinTask computations. Attempts to invoke in other contexts
555	<	* result in exceptions or errors including ClassCastException.
554	>	* ForkJoinTask computations (as may be determined using method
555	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
556	>	* result in exceptions or errors, possibly including
557	>	* ClassCastException.
558	>	*
559		* @param tasks the array of tasks
560	<	* @throws NullPointerException if tasks or any element are null.
561	<	* @throws RuntimeException or Error if any task did so.
560	>	* @throws NullPointerException if tasks or any element are null
561	>	* @throws RuntimeException or Error if any task did so
562		*/
563		public static void invokeAll(ForkJoinTask<?>... tasks) {
564		Throwable ex = null;
#	Line 572 | Line 595 | public abstract class ForkJoinTask<V> im
595
596		/**
597		* Forks all tasks in the collection, returning when
598	<	* <code>isDone</code> holds for all of them. If any task
598	>	* {@code isDone} holds for all of them. If any task
599		* encounters an exception, others may be cancelled.  This method
600	<	* may be invoked only from within ForkJoinTask
601	<	* computations. Attempts to invoke in other contexts resul!t in
602	<	* exceptions or errors including ClassCastException.
600	>	* may be invoked only from within ForkJoinTask computations (as
601	>	* may be determined using method {@link
602	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
603	>	* in exceptions or errors, possibly including ClassCastException.
604	>	*
605		* @param tasks the collection of tasks
606	<	* @throws NullPointerException if tasks or any element are null.
607	<	* @throws RuntimeException or Error if any task did so.
606	>	* @throws NullPointerException if tasks or any element are null
607	>	* @throws RuntimeException or Error if any task did so
608		*/
609		public static void invokeAll(Collection<? extends ForkJoinTask<?>> tasks) {
610	<	if (!(tasks instanceof List)) {
611	<	invokeAll(tasks.toArray(new ForkJoinTask[tasks.size()]));
610	>	if (!(tasks instanceof List<?>)) {
611	>	invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
612		return;
613		}
614	+	@SuppressWarnings("unchecked")
615		List<? extends ForkJoinTask<?>> ts =
616	<	(List<? extends ForkJoinTask<?>>)tasks;
616	>	(List<? extends ForkJoinTask<?>>) tasks;
617		Throwable ex = null;
618		int last = ts.size() - 1;
619		for (int i = last; i >= 0; --i) {
#	Line 623 | Line 649 | public abstract class ForkJoinTask<V> im
649		/**
650		* Returns true if the computation performed by this task has
651		* completed (or has been cancelled).
652	+	*
653		* @return true if this computation has completed
654		*/
655		public final boolean isDone() {
#	Line 631 | Line 658 | public abstract class ForkJoinTask<V> im
658
659		/**
660		* Returns true if this task was cancelled.
661	+	*
662		* @return true if this task was cancelled
663		*/
664		public final boolean isCancelled() {
#	Line 639 | Line 667 | public abstract class ForkJoinTask<V> im
667
668		/**
669		* Asserts that the results of this task's computation will not be
670	<	* used. If a cancellation occurs before atempting to execute this
671	<	* task, then execution will be suppressed, <code>isCancelled</code>
672	<	* will report true, and <code>join</code> will result in a
673	<	* <code>CancellationException</code> being thrown. Otherwise, when
670	>	* used. If a cancellation occurs before attempting to execute this
671	>	* task, then execution will be suppressed, {@code isCancelled}
672	>	* will report true, and {@code join} will result in a
673	>	* {@code CancellationException} being thrown. Otherwise, when
674		* cancellation races with completion, there are no guarantees
675	<	* about whether <code>isCancelled</code> will report true, whether
676	<	* <code>join</code> will return normally or via an exception, or
675	>	* about whether {@code isCancelled} will report true, whether
676	>	* {@code join} will return normally or via an exception, or
677		* whether these behaviors will remain consistent upon repeated
678		* invocation.
679		*
#	Line 656 | Line 684 | public abstract class ForkJoinTask<V> im
684		* <p> This method is designed to be invoked by <em>other</em>
685		* tasks. To terminate the current task, you can just return or
686		* throw an unchecked exception from its computation method, or
687	<	* invoke <code>completeExceptionally</code>.
687	>	* invoke {@code completeExceptionally}.
688		*
689		* @param mayInterruptIfRunning this value is ignored in the
690		* default implementation because tasks are not in general
691	<	* cancelled via interruption.
691	>	* cancelled via interruption
692		*
693		* @return true if this task is now cancelled
694		*/
#	Line 670 | Line 698 | public abstract class ForkJoinTask<V> im
698		}
699
700		/**
701	<	* Returns true if this task threw an exception or was cancelled
701	>	* Returns true if this task threw an exception or was cancelled.
702	>	*
703		* @return true if this task threw an exception or was cancelled
704		*/
705		public final boolean isCompletedAbnormally() {
#	Line 681 | Line 710 | public abstract class ForkJoinTask<V> im
710		* Returns the exception thrown by the base computation, or a
711		* CancellationException if cancelled, or null if none or if the
712		* method has not yet completed.
713	+	*
714		* @return the exception, or null if none
715		*/
716		public final Throwable getException() {
#	Line 695 | Line 725 | public abstract class ForkJoinTask<V> im
725		/**
726		* Completes this task abnormally, and if not already aborted or
727		* cancelled, causes it to throw the given exception upon
728	<	* <code>join</code> and related operations. This method may be used
728	>	* {@code join} and related operations. This method may be used
729		* to induce exceptions in asynchronous tasks, or to force
730		* completion of tasks that would not otherwise complete.  Its use
731		* in other situations is likely to be wrong.  This method is
732	<	* overridable, but overridden versions must invoke <code>super</code>
732	>	* overridable, but overridden versions must invoke {@code super}
733		* implementation to maintain guarantees.
734		*
735		* @param ex the exception to throw. If this exception is
#	Line 708 | Line 738 | public abstract class ForkJoinTask<V> im
738		*/
739		public void completeExceptionally(Throwable ex) {
740		setDoneExceptionally((ex instanceof RuntimeException) ||
741	<	(ex instanceof Error)? ex :
741	>	(ex instanceof Error) ? ex :
742		new RuntimeException(ex));
743		}
744
745		/**
746		* Completes this task, and if not already aborted or cancelled,
747	<	* returning a <code>null</code> result upon <code>join</code> and related
747	>	* returning a {@code null} result upon {@code join} and related
748		* operations. This method may be used to provide results for
749		* asynchronous tasks, or to provide alternative handling for
750		* tasks that would not otherwise complete normally. Its use in
751		* other situations is likely to be wrong. This method is
752	<	* overridable, but overridden versions must invoke <code>super</code>
752	>	* overridable, but overridden versions must invoke {@code super}
753		* implementation to maintain guarantees.
754		*
755	<	* @param value the result value for this task.
755	>	* @param value the result value for this task
756		*/
757		public void complete(V value) {
758		try {
759		setRawResult(value);
760	<	} catch(Throwable rex) {
760	>	} catch (Throwable rex) {
761		setDoneExceptionally(rex);
762		return;
763		}
#	Line 752 | Line 782 | public abstract class ForkJoinTask<V> im
782		/**
783		* Possibly executes other tasks until this task is ready, then
784		* returns the result of the computation.  This method may be more
785	<	* efficient than <code>join</code>, but is only applicable when
786	<	* there are no potemtial dependencies between continuation of the
785	>	* efficient than {@code join}, but is only applicable when
786	>	* there are no potential dependencies between continuation of the
787		* current task and that of any other task that might be executed
788		* while helping. (This usually holds for pure divide-and-conquer
789		* tasks). This method may be invoked only from within
790	<	* ForkJoinTask computations. Attempts to invoke in other contexts
791	<	* resul!t in exceptions or errors including ClassCastException.
790	>	* ForkJoinTask computations (as may be determined using method
791	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
792	>	* result in exceptions or errors, possibly including
793	>	* ClassCastException.
794	>	*
795		* @return the computed result
796		*/
797		public final V helpJoin() {
798	<	ForkJoinWorkerThread w = (ForkJoinWorkerThread)(Thread.currentThread());
798	>	ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
799		if (status < 0 || !w.unpushTask(this) || !tryExec())
800		reportException(busyJoin(w));
801		return getRawResult();
#	Line 771 | Line 804 | public abstract class ForkJoinTask<V> im
804		/**
805		* Possibly executes other tasks until this task is ready.  This
806		* method may be invoked only from within ForkJoinTask
807	<	* computations. Attempts to invoke in other contexts resul!t in
808	<	* exceptions or errors including ClassCastException.
807	>	* computations (as may be determined using method {@link
808	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
809	>	* in exceptions or errors, possibly including ClassCastException.
810		*/
811		public final void quietlyHelpJoin() {
812		if (status >= 0) {
813		ForkJoinWorkerThread w =
814	<	(ForkJoinWorkerThread)(Thread.currentThread());
814	>	(ForkJoinWorkerThread) Thread.currentThread();
815		if (!w.unpushTask(this) || !tryQuietlyInvoke())
816		busyJoin(w);
817		}
#	Line 816 | Line 850 | public abstract class ForkJoinTask<V> im
850		* joined, instead executing them until all are processed.
851		*/
852		public static void helpQuiesce() {
853	<	((ForkJoinWorkerThread)(Thread.currentThread())).
854	<	helpQuiescePool();
853	>	((ForkJoinWorkerThread) Thread.currentThread())
854	>	.helpQuiescePool();
855		}
856
857		/**
858		* Resets the internal bookkeeping state of this task, allowing a
859	<	* subsequent <code>fork</code>. This method allows repeated reuse of
859	>	* subsequent {@code fork}. This method allows repeated reuse of
860		* this task, but only if reuse occurs when this task has either
861		* never been forked, or has been forked, then completed and all
862		* outstanding joins of this task have also completed. Effects
#	Line 838 | Line 872 | public abstract class ForkJoinTask<V> im
872
873		/**
874		* Returns the pool hosting the current task execution, or null
875	<	* if this task is executing outside of any pool.
876	<	* @return the pool, or null if none.
875	>	* if this task is executing outside of any ForkJoinPool.
876	>	*
877	>	* @return the pool, or null if none
878		*/
879		public static ForkJoinPool getPool() {
880		Thread t = Thread.currentThread();
881	<	return ((t instanceof ForkJoinWorkerThread)?
882	<	((ForkJoinWorkerThread)t).pool : null);
881	>	return (t instanceof ForkJoinWorkerThread) ?
882	>	((ForkJoinWorkerThread) t).pool : null;
883	>	}
884	>
885	>	/**
886	>	* Returns {@code true} if the current thread is executing as a
887	>	* ForkJoinPool computation.
888	>	*
889	>	* @return {@code true} if the current thread is executing as a
890	>	* ForkJoinPool computation, or false otherwise
891	>	*/
892	>	public static boolean inForkJoinPool() {
893	>	return Thread.currentThread() instanceof ForkJoinWorkerThread;
894		}
895
896		/**
#	Line 854 | Line 900 | public abstract class ForkJoinTask<V> im
900		* another thread.  This method may be useful when arranging
901		* alternative local processing of tasks that could have been, but
902		* were not, stolen. This method may be invoked only from within
903	<	* ForkJoinTask computations. Attempts to invoke in other contexts
904	<	* result in exceptions or errors including ClassCastException.
903	>	* ForkJoinTask computations (as may be determined using method
904	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
905	>	* result in exceptions or errors, possibly including
906	>	* ClassCastException.
907	>	*
908		* @return true if unforked
909		*/
910		public boolean tryUnfork() {
911	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).unpushTask(this);
911	>	return ((ForkJoinWorkerThread) Thread.currentThread())
912	>	.unpushTask(this);
913		}
914
915		/**
#	Line 867 | Line 917 | public abstract class ForkJoinTask<V> im
917		* forked by the current worker thread but not yet executed. This
918		* value may be useful for heuristic decisions about whether to
919		* fork other tasks.
920	+	*
921		* @return the number of tasks
922		*/
923		public static int getQueuedTaskCount() {
924	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).
925	<	getQueueSize();
924	>	return ((ForkJoinWorkerThread) Thread.currentThread())
925	>	.getQueueSize();
926		}
927
928		/**
929	<	* Returns a estimate of how many more locally queued tasks are
929	>	* Returns an estimate of how many more locally queued tasks are
930		* held by the current worker thread than there are other worker
931		* threads that might steal them.  This value may be useful for
932		* heuristic decisions about whether to fork other tasks. In many
#	Line 883 | Line 934 | public abstract class ForkJoinTask<V> im
934		* aim to maintain a small constant surplus (for example, 3) of
935		* tasks, and to process computations locally if this threshold is
936		* exceeded.
937	+	*
938		* @return the surplus number of tasks, which may be negative
939		*/
940		public static int getSurplusQueuedTaskCount() {
941	<	return ((ForkJoinWorkerThread)(Thread.currentThread()))
941	>	return ((ForkJoinWorkerThread) Thread.currentThread())
942		.getEstimatedSurplusTaskCount();
943		}
944
945		// Extension methods
946
947		/**
948	<	* Returns the result that would be returned by <code>join</code>,
948	>	* Returns the result that would be returned by {@code join},
949		* even if this task completed abnormally, or null if this task is
950		* not known to have been completed.  This method is designed to
951		* aid debugging, as well as to support extensions. Its use in any
952		* other context is discouraged.
953		*
954	<	* @return the result, or null if not completed.
954	>	* @return the result, or null if not completed
955		*/
956		public abstract V getRawResult();
957
#	Line 918 | Line 970 | public abstract class ForkJoinTask<V> im
970		* called otherwise. The return value controls whether this task
971		* is considered to be done normally. It may return false in
972		* asynchronous actions that require explicit invocations of
973	<	* <code>complete</code> to become joinable. It may throw exceptions
973	>	* {@code complete} to become joinable. It may throw exceptions
974		* to indicate abnormal exit.
975	+	*
976		* @return true if completed normally
977		* @throws Error or RuntimeException if encountered during computation
978		*/
979		protected abstract boolean exec();
980
981		/**
982	<	* Returns, but does not unschedule or execute, the task most
983	<	* recently forked by the current thread but not yet executed, if
984	<	* one is available. There is no guarantee that this task will
985	<	* actually be polled or executed next.
986	<	* This method is designed primarily to support extensions,
987	<	* and is unlikely to be useful otherwise.
982	>	* Returns, but does not unschedule or execute, the task queued by
983	>	* the current thread but not yet executed, if one is
984	>	* available. There is no guarantee that this task will actually
985	>	* be polled or executed next.  This method is designed primarily
986	>	* to support extensions, and is unlikely to be useful otherwise.
987	>	* This method may be invoked only from within ForkJoinTask
988	>	* computations (as may be determined using method {@link
989	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
990	>	* in exceptions or errors, possibly including ClassCastException.
991		*
992		* @return the next task, or null if none are available
993		*/
994		protected static ForkJoinTask<?> peekNextLocalTask() {
995	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).peekTask();
995	>	return ((ForkJoinWorkerThread) Thread.currentThread())
996	>	.peekTask();
997		}
998
999		/**
1000	<	* Unschedules and returns, without executing, the task most
1001	<	* recently forked by the current thread but not yet executed.
1002	<	* This method is designed primarily to support extensions,
1003	<	* and is unlikely to be useful otherwise.
1000	>	* Unschedules and returns, without executing, the next task
1001	>	* queued by the current thread but not yet executed.  This method
1002	>	* is designed primarily to support extensions, and is unlikely to
1003	>	* be useful otherwise.  This method may be invoked only from
1004	>	* within ForkJoinTask computations (as may be determined using
1005	>	* method {@link #inForkJoinPool}). Attempts to invoke in other
1006	>	* contexts result in exceptions or errors, possibly including
1007	>	* ClassCastException.
1008		*
1009		* @return the next task, or null if none are available
1010		*/
1011		protected static ForkJoinTask<?> pollNextLocalTask() {
1012	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).popTask();
1012	>	return ((ForkJoinWorkerThread) Thread.currentThread())
1013	>	.pollLocalTask();
1014		}
1015
1016		/**
1017	<	* Unschedules and returns, without executing, the task most
1018	<	* recently forked by the current thread but not yet executed, if
1019	<	* one is available, or if not available, a task that was forked
1020	<	* by some other thread, if available. Availability may be
1021	<	* transient, so a <code>null</code> result does not necessarily
1022	<	* imply quiecence of the pool this task is operating in.
1023	<	* This method is designed primarily to support extensions,
1024	<	* and is unlikely to be useful otherwise.
1025	<	*
1017	>	* Unschedules and returns, without executing, the next task
1018	>	* queued by the current thread but not yet executed, if one is
1019	>	* available, or if not available, a task that was forked by some
1020	>	* other thread, if available. Availability may be transient, so a
1021	>	* {@code null} result does not necessarily imply quiescence
1022	>	* of the pool this task is operating in.  This method is designed
1023	>	* primarily to support extensions, and is unlikely to be useful
1024	>	* otherwise.  This method may be invoked only from within
1025	>	* ForkJoinTask computations (as may be determined using method
1026	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
1027	>	* result in exceptions or errors, possibly including
1028	>	* ClassCastException.
1029	>	*
1030		* @return a task, or null if none are available
1031		*/
1032		protected static ForkJoinTask<?> pollTask() {
1033	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).
1034	<	pollLocalOrStolenTask();
1033	>	return ((ForkJoinWorkerThread) Thread.currentThread())
1034	>	.pollTask();
1035		}
1036
1037		// Serialization support
#	Line 976 | Line 1042 | public abstract class ForkJoinTask<V> im
1042		* Save the state to a stream.
1043		*
1044		* @serialData the current run status and the exception thrown
1045	<	* during execution, or null if none.
1045	>	* during execution, or null if none
1046		* @param s the stream
1047		*/
1048		private void writeObject(java.io.ObjectOutputStream s)
#	Line 987 | Line 1053 | public abstract class ForkJoinTask<V> im
1053
1054		/**
1055		* Reconstitute the instance from a stream.
1056	+	*
1057		* @param s the stream
1058		*/
1059		private void readObject(java.io.ObjectInputStream s)
#	Line 996 | Line 1063 | public abstract class ForkJoinTask<V> im
1063		status |= EXTERNAL_SIGNAL; // conservatively set external signal
1064		Object ex = s.readObject();
1065		if (ex != null)
1066	<	setDoneExceptionally((Throwable)ex);
1066	>	setDoneExceptionally((Throwable) ex);
1067		}
1068
1069	<	// Temporary Unsafe mechanics for preliminary release
1069	>	// Unsafe mechanics for jsr166y 3rd party package.
1070	>	private static sun.misc.Unsafe getUnsafe() {
1071	>	try {
1072	>	return sun.misc.Unsafe.getUnsafe();
1073	>	} catch (SecurityException se) {
1074	>	try {
1075	>	return java.security.AccessController.doPrivileged
1076	>	(new java.security.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1077	>	public sun.misc.Unsafe run() throws Exception {
1078	>	return getUnsafeByReflection();
1079	>	}});
1080	>	} catch (java.security.PrivilegedActionException e) {
1081	>	throw new RuntimeException("Could not initialize intrinsics",
1082	>	e.getCause());
1083	>	}
1084	>	}
1085	>	}
1086
1087	<	static final Unsafe _unsafe;
1088	<	static final long statusOffset;
1087	>	private static sun.misc.Unsafe getUnsafeByReflection()
1088	>	throws NoSuchFieldException, IllegalAccessException {
1089	>	java.lang.reflect.Field f =
1090	>	sun.misc.Unsafe.class.getDeclaredField("theUnsafe");
1091	>	f.setAccessible(true);
1092	>	return (sun.misc.Unsafe) f.get(null);
1093	>	}
1094
1095	<	static {
1095	>	private static long fieldOffset(String fieldName, Class<?> klazz) {
1096		try {
1097	<	if (ForkJoinTask.class.getClassLoader() != null) {
1098	<	Field f = Unsafe.class.getDeclaredField("theUnsafe");
1099	<	f.setAccessible(true);
1100	<	_unsafe = (Unsafe)f.get(null);
1101	<	}
1102	<	else
1103	<	_unsafe = Unsafe.getUnsafe();
1016	<	statusOffset = _unsafe.objectFieldOffset
1017	<	(ForkJoinTask.class.getDeclaredField("status"));
1018	<	} catch (Exception ex) { throw new Error(ex); }
1097	>	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(fieldName));
1098	>	} catch (NoSuchFieldException e) {
1099	>	// Convert Exception to Error
1100	>	NoSuchFieldError error = new NoSuchFieldError(fieldName);
1101	>	error.initCause(e);
1102	>	throw error;
1103	>	}
1104		}
1105
1106	+	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1107	+	static final long statusOffset =
1108	+	fieldOffset("status", ForkJoinTask.class);
1109	+
1110		}

Diff Legend

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